How to Set Up Connectors Programmaticallylink
Updated January 31, 2024
You want to programmatically create connectors at scale without using the Fivetran dashboard.
The following are the most common use cases:
- Powered by Fivetran
- Enterprise: Different Business Units
Our REST API is a crucial aspect of limiting manual work for setting up dozens or hundreds of connectors.
Find the source Connector Config that you want to sync.
In the request body of the Create a Connector endpoint, replace the
configfield with the specific connector’s config from Step 1.
Change the payload parameters in the request body to the
POSTrequest to the Create a Connector endpoint.
Validate that the new connector has been created successfully. Check that you've received the correct HTTP 201 response from Fivetran’s REST API.
(Optional) Send a
PATCHrequest to the Modify a Connector endpoint to make additional changes to any of the following:
- Sync frequency
- Daily sync time
- Schedule type (auto or manual)
- Config parameters
Repeat Steps 1 through 5 to set up additional sources.
Common Use Caseslink
See the following Connector Management API Troubleshooting pages:
- How to clone a Fivetran connector
- How to set a custom sync frequency
- How to set a time for your daily syncs
- How to trigger syncs manually
- How to enable syncs only for the columns you need
- How to select columns to sync and block new tables and columns for new connectors
Our REST API is available only for Free, Standard, Enterprise, and Business Critical accounts.
Powered by Fivetran customers can leverage this process programmatically to implement a smooth customer onboarding process for all of your SaaS applications or databases. See our Powered by Fivetran Quickstart Guide and Powered by Fivetran Detailed Guide for details.