Retrieve Destination Details
Returns a destination object if a valid identifier was provided.
Request schema
Path parameters
The unique identifier for the destination within your Fivetran account.
Header parameters
HTTP: basicAuth
HTTP AuthorizationScheme: basic
GET /v1/destinations/destination_id HTTP/1.1
Accept: application/json;version=2
Authorization: Basic REPLACE_BASIC_AUTH
Host: api.fivetran.com
Responses
Successful response schema
Response status code
Response status text
The unique identifier for the destination within the Fivetran system
The name for the destination type within the Fivetran system.
Data processing location. This is where Fivetran will operate and run computation on data.
Destination setup status
Shift my UTC offset with daylight savings time (US Only)
The unique identifier for the group within the Fivetran system.
Determines the time zone for the Fivetran sync schedule.
Setup tests results for this destination
Setup test title
Setup test status
Setup test message
Setup test details.
(Deprecated) The unique identifier for the hybrid deployment agent within the Fivetran system
The unique identifier for the self-served private link that is used by the connection
The unique identifier for the hybrid deployment agent within the Fivetran system
Tenant id of service principal
Authentication type
(Immutable) Storage account for Azure Data Lake Storage Gen2 name
Connection method. Default value: Directly.
Catalog name
Should maintain tables in Databricks
HTTP path
OAuth 2.0 secret
Snapshots older than the retention period are deleted every week. Default value: ONE_WEEK.
Server Host name
Client id of service principal
(Immutable) path/to/data within the container
(Immutable) Container to store delta table files
Server port number
Databricks Connection method. Default value: Directly.
Secret value for service principal
OAuth 2.0 client ID
Personal access token
{
"code": "Success",
"message": "Operation performed.",
"data": {
"id": "destination_id",
"service": "adls",
"region": "GCP_US_EAST4",
"networking_method": "Directly",
"setup_status": "CONNECTED",
"daylight_saving_time_enabled": true,
"group_id": "group_id",
"time_zone_offset": "+3",
"setup_tests": [
{
"title": "Test Title",
"status": "PASSED",
"message": "Test Passed",
"details": "Test Details"
}
],
"local_processing_agent_id": "local_processing_agent_id",
"private_link_id": "private_link_id",
"hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
"config": {
"tenant_id": "service_principal_tenant_id",
"auth_type": "PERSONAL_ACCESS_TOKEN | OAUTH2",
"storage_account_name": "adls_storage_account_name",
"connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
"catalog": "string",
"should_maintain_tables_in_databricks": true,
"http_path": "string",
"oauth2_secret": "string",
"snapshot_retention_period": "RETAIN_ALL_SNAPSHOTS | ONE_WEEK | TWO_WEEKS | FOUR_WEEKS | SIX_WEEKS",
"server_host_name": "string",
"client_id": "service_principal_client_id",
"prefix_path": "adls_container_path_prefix",
"container_name": "adls_container_name",
"port": 0,
"databricks_connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
"secret_value": "service_principal_secret_value",
"oauth2_client_id": "string",
"personal_access_token": "string"
}
}
}