client.remote_hosts.list

A method of the Remote Hosts endpoint.

list(*, type: str = None) ListResponse

List Remote Hosts

API URL: GET /remote_hosts

import civis
client = civis.APIClient()
response = client.remote_hosts.list(...)
Parameters:
typestr, optional

The type of remote host. One of: RemoteHostTypes::Bigquery, RemoteHostTypes::Bitbucket, RemoteHostTypes::GitSSH, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::S3Storage, and RemoteHostTypes::Salesforce

Returns:
civis.ListResponse
  • idint

    The ID of the remote host.

  • namestr

    The human readable name for the remote host.

  • typestr

    The type of remote host. One of: RemoteHostTypes::Bigquery, RemoteHostTypes::Bitbucket, RemoteHostTypes::GitSSH, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::S3Storage, and RemoteHostTypes::Salesforce

  • urlstr

    The URL for the remote host.