Modify a Destination
Updates information for an existing destination within your Fivetran account.
Request schema
Path parameters
The unique identifier for the destination within your Fivetran account.
Header parameters
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Request
Data processing location. This is where Fivetran will operate and run computation on data.
The setup configuration. Check possible config formats in create method
Specifies whether we should trust the certificate automatically. The default value is FALSE. If a certificate is not trusted automatically, it has to be approved with Certificates Management API Approve a destination certificate.
Specifies whether we should trust the SSH fingerprint automatically. The default value is FALSE. If a fingerprint is not trusted automatically, it has to be approved with Certificates Management API Approve a destination fingerprint.
Specifies whether setup tests should be run automatically.
Shift my UTC offset with daylight savings time (US Only)
Determines the time zone for the Fivetran sync schedule.
PATCH /v1/destinations/destination_id HTTP/1.1
Accept: application/json;version=2
Authorization: Basic REPLACE_BASIC_AUTH
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 302
{
"value": {
"region": "GCP_AUSTRALIA_SOUTHEAST1",
"time_zone_offset": "+10",
"config": {
"host": "your-account.snowflakecomputing.com",
"port": 1433,
"database": "fivetran",
"auth": "PASSWORD",
"user": "fivetran_user",
"password": "123456"
}
}
}
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 hybrid deployment agent within the Fivetran system
Tenant id of service principal
Container to store delta table files
Storage account for Azure Data Lake Storage Gen2 name
Connection method. Default value: Directly.
Secret value for service principal
Snapshots older than the retention period are deleted every week. Default value: ONE_WEEK.
Client id of service principal
path/to/data within the container
{
"code": "Success",
"message": "Destination has been updated",
"data": {
"id": "decent_dropsy",
"group_id": "decent_dropsy",
"service": "snowflake",
"region": "GCP_AUSTRALIA_SOUTHEAST1",
"time_zone_offset": "+10",
"setup_status": "connected",
"setup_tests": [
{
"title": "Host Connection",
"status": "PASSED",
"message": ""
},
{
"title": "Database Connection",
"status": "PASSED",
"message": ""
},
{
"title": "Permission Test",
"status": "PASSED",
"message": ""
}
],
"config": {
"host": "your-account.snowflakecomputing.com",
"port": 1433,
"database": "fivetran",
"auth": "PASSWORD",
"user": "fivetran_user",
"password": "******"
}
}
}