Connector Management Overview

REST API supports the following connector management actions:

• Retrieve source metadata
• Create a connector
• Retrieve connector details
• Modify a connector
• Sync connector data
• Re-sync connector table data
• Run connector setup tests
• Delete a connector
• Retrieve a connector schema config
• Retrieve source table columns config
• Reload a connector schema config
• Modify a connector schema config
• Modify a connector database schema config
• Modify a connector table config
• Modify a connector column config
• Use Case: Create a new connector based on an existing connector’s parameters
• Use Case: How to enable sync only for columns that you need
• Use case: How to set a custom sync frequency
• Use case: How to set a time for your daily syncs
• Use case: How to trigger syncs manually only when you need them

Retrieve source metadatalink

Returns all available source types within your Fivetran account. This endpoint makes it easier to display Fivetran connectors within your application because it provides metadata including the proper source name (‘Facebook Ad Account’ instead of facebook_ad_account), the source icon, and links to Fivetran resources. As we update source names and icons, that metadata will automatically update within this endpoint.

Requestlink

GET api.fivetran.com/v1/metadata/connectors

Responselink

HTTP 200 OK

{
    "code": "Success",
    "data": {
        "items": [
            {
                "id": "facebook_ad_account",
                "name": "Facebook Ad Account",
                "type": "Marketing",
                "description": "Facebook Ad Account provides attribute data on Facebook Ad Accounts",
                "icon_url": "https://fivetran.com/integrations/facebook/resources/facebook.svg",
                "link_to_docs": "https://fivetran.com/docs/applications/facebook-ad-account",
                "link_to_erd": "https://fivetran.com/docs/applications/facebook-ad-account#schemainformation"
            }
        ],
        "next_cursor": "eyJza2lwIjoxMDB9"
    }
}

Create a Connectorlink

Creates a new connector within a specified group in your Fivetran account. Runs setup tests and returns testing results.

Requestlink

POST api.fivetran.com/v1/connectors

{
    "service": "criteo",
    "group_id": "projected_sickle",
    "trust_certificates": true,
    "run_setup_tests": true,
    "paused": true,
    "pause_after_trial": true,
    "sync_frequency": 1440,
    "daily_sync_time": "03:00",
    "config": {
        "schema": "criteo",
        "username": "myuser",
        "password": "mypassword",
        "app_token": "myapptoken"
    },
    "auth": {
        "client_access": {
            "client_id": "my_client_id",
            "client_secret": "my_client_secret"
        },
        "refresh_token": "my_refresh_token"
    }
}

Responselink

HTTP 201 Created

{
    "code": "Success",
    "message": "Connector has been created",
    "data": {
        "id": "speak_inexpensive",
        "group_id": "projected_sickle",
        "service": "criteo",
        "service_version": 0,
        "schema": "criteo",
        "paused": true,
        "pause_after_trial": true,
        "connected_by": "interment_burdensome",
        "created_at": "2018-12-01T15:43:29.013729Z",
        "succeeded_at": null,
        "failed_at": null,
        "sync_frequency": 1440,
        "daily_sync_time": "03:00",
        "status": {
            "setup_state": "incomplete",
            "sync_state": "scheduled",
            "update_state": "on_schedule",
            "is_historical_sync": true,
            "tasks": [],
            "warnings": []
        },
        "setup_tests": [{
            "title": "Validate Login",
            "status": "FAILED",
            "message": "Invalid login credentials"
        }],
        "config": {
            "username": "myuser",
            "password": "******",
            "api_token": "******",
            "service_version": "0"
        }
    }
}

If run_setup_tests is set to FALSE in the request, the response will not contain the setup_tests field.

See how to create a new connector based on an existing connector’s parameters.

Note that the config parameter can be presented in v2 configuration format. For more information, see our Retrieve Connector Details endpoint documentation.

Retrieve Connector Detailslink

Returns a connector object if a valid identifier was provided.

Currently, we support two formats for the connector configuration response payload. The first is the default legacy format of the configuration. The second one is a new configuration format (v2) we introduced in January 2021.

To retrieve the connector configuration info in the v2 format, you should add version=2 to the Accept request header: --header 'Accept: application/json;version=2'

The v2 config format is consistent with the configuration payload parameter used for Modifying a connector.

The connector configuration response depends on the connector type.

Below are examples of the legacy and new v2 connector configuration request and response that have different Accept header values, respectively. These examples are based on the Google Ads connector:

Legacy request:

GET api.fivetran.com/v1/connectors/{connector_id} --header 'Accept: application/json'

Legacy response:

{
    "code": "Success",
    "data": {
        ...
        "config": {
            "sync_mode": "Selected Accounts",
            "latest_version": "4",
            "configuration": "Custom Report",
            "accounts": "0987654321",
            "report_type": "AD_PERFORMANCE_REPORT",
            "service_version": "4",
            "customer_id": "123-456-7890",
            "fields": "PolicySummary, AdType, Date",
            "conversion_window_size": 30,
            "historical_sync_timeframe": "12 months"
        }
    }
}

New v2 request:

GET api.fivetran.com/v1/connectors/{connector_id} --header 'Accept: application/json;version=2'

New v2 response:

{
    "code": "Success",
    "data": {
        ...
        "config": {
            "sync_mode": "SpecificAccounts",
            "customer_id": "123-456-7890",
            "accounts": [
                "0987654321"
            ],
            "conversion_window_size": 30,
            "report_type": "AD_PERFORMANCE_REPORT",
            "fields": [
                "PolicySummary",
                "AdType",
                "Date"
            ]
        },
        "source_sync_details": {
            "accounts": [
                "0987654321"
            ]
        }
    }
}

The exact set of fields we return when the source_sync_details parameter is specified depends on the connector type. The source_sync_details section is not included in the response, if the parameter is omitted in the request. The source_sync_details section in the above example contains the information about synced accounts.

We return source syncs details for the following connectors in V2 configuration mode:

• Asana
• Facebook Ads
• Facebook Ad Insights
• Google Ads
• Google Ads Account
• Google Analytics
• Google Analytics (MCF)
• Google Campaign Manager 360
• Google Sheets
• Microsoft Advertising
• Salesforce

Requestlink

GET api.fivetran.com/v1/connectors/{connector_id}

Responselink

HTTP 200 OK

{
    "code": "Success",
    "data": {
        "id": "connector_id",
        "group_id": "group_id",
        "service": "adwords",
        "service_version": 4,
        "schema": "adwords.schema",
        "paused": true,
        "pause_after_trial": true,
        "connected_by": "monitoring_assuring",
        "created_at": "2020-03-11T15:03:55.743708Z",
        "succeeded_at": "2020-03-17T12:31:40.870504Z",
        "failed_at": "2021-01-15T10:55:00.056497Z",
        "sync_frequency": 360,
        "schedule_type": "auto",
        "status": {
            "setup_state": "broken",
            "sync_state": "scheduled",
            "update_state": "delayed",
            "is_historical_sync": false,
            "tasks": [
                {
                    "code": "reconnect",
                    "message": "Reconnect"
                }
            ],
            "warnings": []
        },
        "config": {
            "sync_mode": "SpecificAccounts",
            "customer_id": "XXX-XXX-XXXX",
            "accounts": [
                "1234567890"
            ],
            "conversion_window_size": 30,
            "report_type": "AD_PERFORMANCE_REPORT",
            "fields": [
                "PolicySummary",
                "AdType",
                "Date"
            ]
        },
        "source_sync_details": {
            "accounts": [
                "1234567890"
            ]
        }
    }
}

Modify a Connectorlink

Updates the information for an existing connector within your Fivetran account.

Requestlink

PATCH api.fivetran.com/v1/connectors/{connector_id}

{
    "paused": false,
    "pause_after_trial": true,
    "sync_frequency": 60,
    "trust_certificates": true,
    "run_setup_tests": true,
    "config": {
        "username": "newuser",
        "password": "newpassword"
    },
    "auth": {
        "client_access": {
            "client_id": "my_client_id",
            "client_secret": "my_client_secret"
        },
        "refresh_token": "my_refresh_token"
    },
    "schedule_type": "manual"
}

Responselink

HTTP 200 OK

{
    "code": "Success",
    "message": "Connector has been updated",
    "data": {
        "id": "speak_inexpensive",
        "group_id": "projected_sickle",
        "service": "criteo",
        "service_version": 0,
        "schema": "criteo",
        "paused": true,
        "pause_after_trial": true,
        "connected_by": "interment_burdensome",
        "created_at": "2018-12-01T15:43:29.013729Z",
        "succeeded_at": null,
        "failed_at": null,
        "sync_frequency":60,
        "status": {
            "setup_state": "incomplete",
            "sync_state": "scheduled",
            "update_state": "on_schedule",
            "is_historical_sync": true,
            "tasks": [],
            "warnings": []
        },
        "setup_tests": [{
            "title": "Validate Login",
            "status": "FAILED",
            "message": "Invalid login credentials"
        }],
        "config": {
            "username": "newuser",
            "password": "******",
            "api_token": "******",
            "service_version": "0"
        }
    }
}

If the run_setup_tests parameter is set to FALSE in the request, then the response will not contain the setup_tests field.

Note that the config parameter can be presented in v2 configuration format. For more information, see our Retrieve Connector Details endpoint documentation.

Sync Connector Datalink

Triggers a data sync for an existing connector within your Fivetran account without waiting for the next scheduled sync. This action does not override the standard sync frequency you defined in the Fivetran dashboard.

If there is a data sync already in progress, that sync is immediately stopped and restarted. If the connector is paused, the data sync will be scheduled to be performed when the connector is re-enabled.

Requestlink

POST api.fivetran.com/v1/connectors/{connector_id}/force

Responselink

HTTP 200 OK

{
    "code": "Success",
    "message": "Sync has been successfully triggered for connector with id 'connector_id1'"
}

Re-sync Connector Table Datalink

Triggers a historical sync of all data for a single table within a connector. This action does not override the standard sync frequency you defined in the Fivetran dashboard.

If the connector is paused, the table sync will be scheduled to be performed when the connector is re-enabled. If there is a data sync already in progress, we will try to complete it. If it fails, the request will be declined and the HTTP 409 Conflict error will be returned.

Requestlink

POST api.fivetran.com/v1/connectors/{connector_id}/schemas/{schema}/tables/{table}/resync

Responselink

HTTP 200 OK

{
    "code": "Success",
    "message": "Re-sync has been successfully triggered for 'schema1.table1'"
}

Run connector setup testslink

Runs the setup tests for an existing connector within your Fivetran account.

Requestlink

POST api.fivetran.com/v1/connectors/{connector_id}/test

{
    "trust_certificates": true,
    "trust_fingerprints": true
}

Responselink

HTTP 200 OK

{
    "code": "Success",
    "message": "Setup tests were completed",
    "data": {
        "id": "speak_inexpensive",
        "group_id": "projected_sickle",
        "service": "criteo",
        "service_version": 0,
        "schema": "criteo",
        "paused": false,
        "pause_after_trial": true,
        "connected_by": "interment_burdensome",
        "created_at": "2018-12-01T15:43:29.013729Z",
        "succeeded_at": null,
        "failed_at": null,
        "sync_frequency":60,
        "status": {
            "setup_state": "incomplete",
            "sync_state": "scheduled",
            "update_state": "on_schedule",
            "is_historical_sync": true,
            "tasks": [],
            "warnings": []
        },
        "setup_tests": [{
            "title": "Validate Login",
            "status": "FAILED",
            "message": "Invalid login credentials"
        }],
        "config": {
            "username": "newuser",
            "password": "******",
            "api_token": "******",
            "service_version": "0"
        }
    }
}

Note that the config parameter can be presented in v2 configuration format. For more information, see our Retrieve Connector Details endpoint documentation.

Delete a Connectorlink

Deletes a connector from your Fivetran account.

Requestlink

DELETE api.fivetran.com/v1/connectors/{connector_id}

Responselink

HTTP 200 OK

{
    "code": "Success",
    "message": "Connector with id 'speak_inexpensive' has been deleted"
}

Retrieve a Connector Schema Configlink

Returns the connector schema config for an existing connector within your Fivetran account.

Requestlink

GET api.fivetran.com/v1/connectors/{connector_id}/schemas

Responselink

HTTP 200 OK

{
    "code": "Success",
    "data": {
        "enable_new_by_default": false,
        "schemas": {
            "schema_1": {
                "name_in_destination": "schema_1",
                "enabled": true,
                "tables": {
                    "table_1": {
                        "name_in_destination": "table_1",
                        "enabled": true,
                        "enabled_patch_settings": {
                            "allowed": true
                        },
                        "columns": {
                            "column_1": {
                                "name_in_destination": "column_1",
                                "enabled": true,
                                "hashed": false,
                                "enabled_patch_settings": {
                                    "allowed": false,
                                    "reason_code": "SYSTEM_COLUMN",
                                    "reason": "The column does not support exclusion as it is a Primary Key"
                                }
                            },
                            "column_2": {
                                "name_in_destination": "column_2",
                                "enabled": true,
                                "hashed": false,
                                "enabled_patch_settings": {
                                    "allowed": true
                                }
                            },
                            "column_3": {
                                "name_in_destination": "column_3",
                                "enabled": true,
                                "hashed": true,
                                "enabled_patch_settings": {
                                    "allowed": true
                                }
                            }
                        }
                    },
                    "table_2": {
                        "name_in_destination": "table_2",
                        "enabled": true,
                        "enabled_patch_settings": {
                            "allowed": false,
                            "reason_code": "SYSTEM_TABLE"
                        }
                    }
                }
            },
            "schema_2": {
                "name_in_destination": "schema_2",
                "enabled": true,
                "tables": {
                    "table_1": {
                        "name_in_destination": "table_1",
                        "enabled": true,
                        "enabled_patch_settings": {
                            "allowed": true
                        },
                        "columns": {
                            "name_in_destination": "column_1",
                            "column_1": {
                                "enabled": false
                            }
                        }
                    },
                    "table_2": {
                        "name_in_destination": "table_2",
                        "enabled": false,
                        "enabled_patch_settings": {
                            "allowed": false,
                            "reason_code": "OTHER",
                            "reason": "Permission denied"
                        }
                    }
                }
            }
        }
    }
}

Retrieve Source Table Columns Configlink

Returns the source table columns config for an existing connector within your Fivetran account.

Requestlink

GET api.fivetran.com/v1/connectors/{connector_id}/schemas/{schema}/tables/{table}/columns

Responselink

HTTP 200 OK

{
    "code": "Success",
    "columns": {
        "column_1": {
            "name_in_destination": "column_1",
            "enabled": true,
            "hashed": false,
            "enabled_patch_settings": {
                "allowed": false,
                "reason_code": "SYSTEM_COLUMN",
                "reason": "The column does not support exclusion as it is a Primary Key"
            }
        },
        "column_2": {
            "name_in_destination": "column_2",
            "enabled": true,
            "hashed": false,
            "enabled_patch_settings": {
                "allowed": true
            }
        },
        "column_3": {
            "name_in_destination": "column_3",
            "enabled": false,
            "hashed": false,
            "enabled_patch_settings": {
                "allowed": true
            }
        }
    }
}

The response contains an array of columns with the Fivetran sync settings for each column.

Reload a Connector Schema Configlink

Reloads the connector schema config for an existing connector within your Fivetran account.

We advise that you use this method if the connector was recently created or its schema is outdated.

Requestlink

POST api.fivetran.com/v1/connectors/{connector_id}/schemas/reload

{
    "exclude_mode":"PRESERVE"
}

Responselink

HTTP 200 OK

{
    "code": "Success",
    "data": {
        "enable_new_by_default": false,
        "schemas": {
            "schema_1": {
                "name_in_destination": "schema_1",
                "enabled": true,
                "tables": {
                    "table_1": {
                        "name_in_destination": "table_1",
                        "enabled": true,
                        "enabled_patch_settings": {
                            "allowed": true
                        },
                        "columns": {
                            "column_1": {
                                "name_in_destination": "column_1",
                                "enabled": true,
                                "hashed": false,
                                "enabled_patch_settings": {
                                    "allowed": false,
                                    "reason_code": "SYSTEM_COLUMN",
                                    "reason": "The column does not support exclusion as it is a Primary Key"
                                }
                            },
                            "column_2": {
                                "name_in_destination": "column_2",
                                "enabled": true,
                                "hashed": false,
                                "enabled_patch_settings": {
                                    "allowed": true
                                }
                            },
                            "column_3": {
                                "name_in_destination": "column_3",
                                "enabled": true,
                                "hashed": true,
                                "enabled_patch_settings": {
                                    "allowed": true
                                }
                            }
                        }
                    },
                    "table_2": {
                        "name_in_destination": "table_2",
                        "enabled": true,
                        "enabled_patch_settings": {
                            "allowed": false,
                            "reason_code": "SYSTEM_TABLE"
                        }
                    }
                }
            },
            "schema_2": {
                "name_in_destination": "schema_2",
                "enabled": true,
                "tables": {
                    "table_1": {
                        "name_in_destination": "table_1",
                        "enabled": true,
                        "enabled_patch_settings": {
                            "allowed": true
                        },
                        "columns": {
                            "column_1": {
                                "name_in_destination": "column_1",
                                "enabled": false
                            }
                        }
                    },
                    "table_2": {
                        "name_in_destination": "table_2",
                        "enabled": false,
                        "enabled_patch_settings": {
                            "allowed": false,
                            "reason_code": "OTHER",
                            "reason": "Permission denied"
                        }
                    }
                }
            }
        }
    }
}

Modify a Connector Schema Configlink

Updates the schema config for an existing connector within your Fivetran account (for a single schema for a connector with multiple schemas).

Requestlink

PATCH api.fivetran.com/v1/connectors/{connector_id}/schemas

{
    "enable_new_by_default": true,
    "schemas": {
        "schema_1": {
            "enabled": true,
            "tables": {
                "table_1": {
                    "enabled": true
                },
                "table_2": {
                    "enabled": false,
                    "columns": {
                        "column_2": {
                            "enabled": true,
                            "hashed": false
                        },
                        "column_3": {
                            "hashed": true
                        }
                    }
                }
            }
        },
        "schema_2": {
            "enabled": false
        }
    }
}

Responselink

HTTP 200 OK

{
    "code": "Success",
    "data": {
        "enable_new_by_default": true,
        "schemas": {
            "schema_1": {
                "name_in_destination": "schema_1",
                "enabled": true,
                "tables": {
                    "table_1": {
                        "name_in_destination": "table_1",
                        "enabled": true,
                        "enabled_patch_settings": {
                            "allowed": true
                        }
                    },
                    "table_2": {
                        "name_in_destination": "table_2",
                        "enabled": false,
                        "enabled_patch_settings": {
                            "allowed": true
                        },
                        "columns": {
                            "column_1": {
                                "name_in_destination": "column_1",
                                "enabled": true,
                                "hashed": false,
                                "enabled_patch_settings": {
                                    "allowed": false,
                                    "reason_code": "SYSTEM_COLUMN",
                                    "reason": "The column does not support exclusion as it is a Primary Key"
                                }
                            },
                            "column_2": {
                                "name_in_destination": "column_2",
                                "enabled": true,
                                "hashed": false,
                                "enabled_patch_settings": {
                                    "allowed": true
                                }
                            },
                            "column_3": {
                                "name_in_destination": "column_3",
                                "enabled": true,
                                "hashed": true,
                                "enabled_patch_settings": {
                                    "allowed": true
                                }
                            }
                        }
                    }
                }
            },
            "schema_2": {
                "name_in_destination": "schema_2",
                "enabled": false,
                "tables": {
                    "table_1": {
                        "name_in_destination": "table_1",
                        "enabled": true,
                        "enabled_patch_settings": {
                            "allowed": true
                        }
                    },
                    "table_2": {
                        "name_in_destination": "table_2",
                        "enabled": false,
                        "enabled_patch_settings": {
                            "allowed": false,
                            "reason_code": "SYSTEM_TABLE"
                        }
                    }
                }
            }
        }
    }
}

The response contains only the difference between your selections and the schema config. The schema config includes schemas, tables, and columns. If you have not specified any schema configurations that differ from the default, the response will consist of only the top schema level.

Modify a Connector Database Schema Configlink

Updates the database schema config for an existing connector within your Fivetran account (for a single schema within a connector with multiple schemas).

Requestlink

PATCH api.fivetran.com/v1/connectors/{connector_id}/schemas/{schemaName}

{
        "enabled": true,
        "tables": {
            "table_1": {
                "enabled": true
            },
            "table_2": {
                "enabled": false,
                "columns": {
                    "column_2": {
                        "enabled": true,
                        "hashed": false
                    },
                    "column_3": {
                        "hashed": true
                    }
                }
            }
        }
}

Responselink

HTTP 200 OK

{
    "code": "Success",
    "data": {
        "enable_new_by_default": true,
        "schemas": {
            "schema_1": {
                "name_in_destination": "schema_1",
                "enabled": true,
                "tables": {
                    "table_1": {
                        "name_in_destination": "table_1",
                        "enabled": true,
                        "enabled_patch_settings": {
                            "allowed": true
                        }
                    },
                    "table_2": {
                        "name_in_destination": "table_2",
                        "enabled": false,
                        "enabled_patch_settings": {
                            "allowed": true
                        },
                        "columns": {
                            "column_1": {
                                "name_in_destination": "column_1",
                                "enabled": true,
                                "hashed": false,
                                "enabled_patch_settings": {
                                    "allowed": false,
                                    "reason_code": "SYSTEM_COLUMN",
                                    "reason": "The column does not support exclusion as it is a Primary Key"
                                }
                            },
                            "column_2": {
                                "name_in_destination": "column_2",
                                "enabled": true,
                                "hashed": false,
                                "enabled_patch_settings": {
                                    "allowed": true
                                }
                            },
                            "column_3": {
                                "name_in_destination": "column_3",
                                "enabled": true,
                                "hashed": true,
                                "enabled_patch_settings": {
                                    "allowed": true
                                }
                            }
                        }
                    }
                }
            },
            "schema_2": {
                "name_in_destination": "schema_2",
                "enabled": false,
                "tables": {
                    "table_1": {
                        "name_in_destination": "table_1",
                        "enabled": true,
                        "enabled_patch_settings": {
                            "allowed": true
                        }
                    },
                    "table_2": {
                        "name_in_destination": "table_2",
                        "enabled": false,
                        "enabled_patch_settings": {
                            "allowed": false,
                            "reason_code": "SYSTEM_TABLE"
                        }
                    }
                }
            }
        }
    }
}

The response contains only the difference between your selections and the schema config. The schema config includes schemas, tables, and columns. If you have not specified any schema configurations that differ from the default, the response will consist of only the top schema level.

Modify a Connector Table Configlink

Updates the table config within your database schema for an existing connector within your Fivetran account.

Requestlink

PATCH api.fivetran.com/v1/connectors/{connector_id}/schemas/{schema}/tables/{table}

{
    "enabled": false,
    "columns": {
        "column_2": {
            "enabled": true,
            "hashed": false
        },
        "column_3": {
            "hashed": true
        }
    }
}

Responselink

HTTP 200 OK

{
    "code": "Success",
    "data": {
        "enable_new_by_default": true,
        "schemas": {
            "schema_1": {
                "name_in_destination": "schema_1",
                "enabled": true,
                "tables": {
                    "table_1": {
                        "name_in_destination": "table_1",
                        "enabled": true,
                        "enabled_patch_settings": {
                            "allowed": true
                        }
                    },
                    "table_2": {
                        "name_in_destination": "table_2",
                        "enabled": false,
                        "enabled_patch_settings": {
                            "allowed": true
                        },
                        "columns": {
                            "column_1": {
                                "name_in_destination": "column_1",
                                "enabled": true,
                                "hashed": false,
                                "enabled_patch_settings": {
                                    "allowed": false,
                                    "reason_code": "SYSTEM_COLUMN",
                                    "reason": "The column does not support exclusion as it is a Primary Key"
                                }
                            },
                            "column_2": {
                                "name_in_destination": "column_2",
                                "enabled": true,
                                "hashed": false,
                                "enabled_patch_settings": {
                                    "allowed": true
                                }
                            },
                            "column_3": {
                                "name_in_destination": "column_3",
                                "enabled": true,
                                "hashed": true,
                                "enabled_patch_settings": {
                                    "allowed": true
                                }
                            }
                        }
                    }
                }
            },
            "schema_2": {
                "name_in_destination": "schema_2",
                "enabled": false,
                "tables": {
                    "table_1": {
                        "name_in_destination": "table_1",
                        "enabled": true,
                        "enabled_patch_settings": {
                            "allowed": true
                        }
                    },
                    "table_2": {
                        "name_in_destination": "table_2",
                        "enabled": false,
                        "enabled_patch_settings": {
                            "allowed": false,
                            "reason_code": "SYSTEM_TABLE"
                        }
                    }
                }
            }
        }
    }
}

The response contains only the difference between your selections and the schema config. The schema config includes schemas, tables, and columns. If you have not specified any schema configurations that differ from the default, the response will consist of only the top schema level.

Modify a Connector Column Configlink

Updates the column config within your table for an existing connector within your Fivetran account.

Requestlink

PATCH api.fivetran.com/v1/connectors/{connector_id}/schemas/{schema}/tables/{table}/columns/{column}

{
    "enabled": true,
    "hashed": false
}

Responselink

HTTP 200 OK

{
    "code": "Success",
    "data": {
        "enable_new_by_default": true,
        "schemas": {
            "schema_1": {
                "name_in_destination": "schema_1",
                "enabled": true,
                "tables": {
                    "table_1": {
                        "name_in_destination": "table_1",
                        "enabled": true,
                        "enabled_patch_settings": {
                            "allowed": true
                        }
                    },
                    "table_2": {
                        "name_in_destination": "table_2",
                        "enabled": false,
                        "enabled_patch_settings": {
                            "allowed": true
                        },
                        "columns": {
                            "column_1": {
                                "name_in_destination": "column_1",
                                "enabled": true,
                                "hashed": false,
                                "enabled_patch_settings": {
                                    "allowed": false,
                                    "reason_code": "SYSTEM_COLUMN",
                                    "reason": "The column does not support exclusion as it is a Primary Key"
                                }
                            },
                            "column_2": {
                                "name_in_destination": "column_2",
                                "enabled": true,
                                "hashed": false,
                                "enabled_patch_settings": {
                                    "allowed": true
                                }
                            },
                            "column_3": {
                                "name_in_destination": "column_3",
                                "enabled": true,
                                "hashed": true,
                                "enabled_patch_settings": {
                                    "allowed": true
                                }
                            }
                        }
                    }
                }
            },
            "schema_2": {
                "name_in_destination": "schema_2",
                "enabled": false,
                "tables": {
                    "table_1": {
                        "name_in_destination": "table_1",
                        "enabled": true,
                        "enabled_patch_settings": {
                            "allowed": true
                        }
                    },
                    "table_2": {
                        "name_in_destination": "table_2",
                        "enabled": false,
                        "enabled_patch_settings": {
                            "allowed": false,
                            "reason_code": "SYSTEM_TABLE"
                        }
                    }
                }
            }
        }
    }
}

The response contains only the difference between your selections and the schema config. The schema config includes schemas, tables, and columns. If you have not specified any schema configurations that differ from the default, the response will consist of only the top schema level.

Use Case: Create a new connector based on an existing connector’s parameterslink

You can create new connectors using the parameters of an existing connector. That is, you can clone a Fivetran connector.

1. Retrieve the connector object details. See Retrieve Connector Details.

   Requestlink

   GET api.fivetran.com/v1/connectors/{connector_id}

   Path parameters

   Name	Description
   connector_id (required)	The unique identifier for the connector within the Fivetran system.

   Responselink

   HTTP 200 OK

2. Make a note of the following fields from the API response:

   {
       "group_id": "projected_sickle",
       "service": "criteo",
       "config": {
           "username": "myuser",
           "password": "******",
           "api_token": "******",
           "service_version": "0"
       }
   }
   

3. Create the new connector using the fields from the previous step. See Create a connector.

   Requestlink

   POST api.fivetran.com/v1/connectors

   {
       "service": "criteo",
       "group_id": "projected_sickle",
       "trust_certificates": true,
       "run_setup_tests": true,
       "config": {
           "schema": "criteo",
           "username": "myuser",
           "password": "mypassword",
           "app_token": "myapptoken"
       }
   }
   

   Payload parameters

   Name	Description
   group_id (required)	The unique identifier for the group within the Fivetran system. Find you group_id by fetching your account’s group list.
   service (required)	The name for the connector type within the Fivetran system.
   config (required)	The connector setup configuration. The format is specific for each connector.
   trust_certificates	Specifies whether we should trust the certificate automatically. Applicable only for database connectors. The default value is FALSE. If a certificate is not trusted automatically, it has to be approved using the Certificates Management API.
   run_setup_tests	Specifies whether setup tests should be run automatically. The default value is TRUE.

   Responselink

   HTTP 201 Created

Use Case: How to enable sync only for columns that you needlink

The connector standard config only stores the information on the difference between the schema config in the source and the changes made to it by the user. To clarify this, let’s have a look at this example:

Requestlink

GET api.fivetran.com/v1/connectors/connector_id_1/schemas/schema_1/tables/table_1/columns

Responselink

HTTP 200 OK

{
    "code": "Success",
    "columns": {
        "column_1": {
            "name_in_destination": "column_1",
            "enabled": false,
            "hashed": false,
            "enabled_patch_settings": {
                "allowed": true
            }
        }
    }
}

This example shows that we have only one disabled sync for column_1, but it does not necessarily mean we do not have other columns in the source. For example, the source might have column_2 and column_3 in this table. Syncing is enabled for all table columns by default, they will be synced in the next connector sync cycle.

Assume we want to enable sync only for column column_3. First of all, to exclude other unwanted columns you need to know all column names of your table:

1. We can use the Retrieve source table columns config endpoint for this purpose.

   Requestlink

   GET api.fivetran.com/v1/connectors/connector_id_1/schemas/schema_1/tables/table_1/columns

   Responselink

   HTTP 200 OK

   {
       "code": "Success",
       "columns": {
           "column_1": {
               "name_in_destination": "column_1",
               "enabled": false,
               "hashed": false,
               "enabled_patch_settings": {
                   "allowed": true
               }
           },
           "column_2": {
               "name_in_destination": "column_2",
               "enabled": true,
               "hashed": false,
               "enabled_patch_settings": {
                   "allowed": true
               }
           },
           "column_3": {
               "name_in_destination": "column_3",
               "enabled": true,
               "hashed": false,
               "enabled_patch_settings": {
                   "allowed": true
               }
           }
       }
   }
   

2. Once we know column names, we can explicitly exclude from the sync the columns we do not want to be synced and include the ones we need through the Modify a connector table config endpoint.

   Requestlink

   PATCH api.fivetran.com/v1/connectors/connector_id_1/schemas/schema_1/tables/table_1

   {
       "enabled": true,
       "columns": {
           "column_1": {
               "enabled": false,
               "hashed": false
           },
           "column_2": {
               "enabled": false,
               "hashed": false
           },
           "column_3": {
                "enabled": true,
                "hashed": false
           }
       }
   }
   

   Responselink

   HTTP 200 OK

   {
       "code": "Success",
       "data": {
           "enable_new_by_default": false,
           "schemas": {
               "schema_1": {
                   "name_in_destination": "schema_1",
                   "enabled": true,
                   "tables": {
                       "table_1": {
                           "name_in_destination": "table_1",
                           "enabled": true,
                           "enabled_patch_settings": {
                               "allowed": true
                           },
                           "columns": {
                               "column_1": {
                                   "name_in_destination": "column_1",
                                   "enabled": false,
                                   "hashed": false,
                                   "enabled_patch_settings": {
                                       "allowed": true
                                   }
                               },
                               "column_2": {
                                   "name_in_destination": "column_2",
                                   "enabled": false,
                                   "hashed": false,
                                   "enabled_patch_settings": {
                                       "allowed": true
                                   }
                               },
                               "column_3": {
                                   "name_in_destination": "column_3",
                                   "enabled": true,
                                   "hashed": false,
                                   "enabled_patch_settings": {
                                       "allowed": true
                                   }
                               }
                           }
                       }
                   }
               }
           }
       }
   }
   

Use case: How to set a custom sync frequencylink

You can override Fivetran’s default sync frequency for a connector. You set your custom sync frequency by specifying your chosen time interval between syncs in minutes as a value of the sync_frequency parameter in the Modify a Connector endpoint request.

Assume we want to set a custom frequency for connector connector_id_1 to be synced once every hour.

PATCH api.fivetran.com/v1/connectors/connector_id_1

{
    "sync_frequency": 60
}

To learn how the sync scheduling works in Fivetran, read our sync frequency and scheduling documentation.

Use case: How to set a time for your daily syncslink

You can choose what time your daily syncs start if you don’t want to use Fivetran’s default midnight starting time.

Assume we want to set a 03:00 starting time for connector connector_id_1.

There are two ways to do this:

1. To be sure connector_id_1 already has sync frequency is equal to 1440 and make request:

PATCH api.fivetran.com/v1/connectors/connector_id_1

  {
      "daily_sync_time": "03:00"
  }

1. Determine both sync_frequency and daily_sync_time in one request:

PATCH api.fivetran.com/v1/connectors/connector_id_1

  {
      "sync_frequency": 1440,
      "daily_sync_time": "03:00"
  }

Use case: How to trigger syncs only when you need themlink

You can enable manual sync scheduling and trigger data syncs only when you want them. To enable manual sync scheduling for a connector, specify manual as a value of the schedule_type parameter using the Modify a Connector endpoint. The manual sync scheduling ignores the set sync_frequency.

IMPORTANT: You need to manually trigger your syncs after you make this change.

Assume we want to enable manual sync scheduling for connector connector_id_1 and trigger its sync.

1. Use the example request below to switch your connector’s schedule_type to manual:

   PATCH api.fivetran.com/v1/connectors/connector_id_1

   {
       "schedule_type": "manual",
       "run_setup_tests": false
   }
   

2. Next, use the Sync Connector Data endpoint to trigger a data sync according to your own schedule. Alternatively, you can trigger a sync in your Fivetran dashboard.

   POST api.fivetran.com/v1/connectors/connector_id_1/force

   NOTE: The payload for this request should be empty.