Overview

These examples are designed as standalone scripts that act as examples for interacting with our REST API.

Please Note: These are representative samples, and should not be used in production implementaions "as is".

Common Use Cases

I want to sync a connector using an external orchestration tool.

1. List All Groups
2. List All Connectors In Group
3. Sync Connector Data

I want to manage schema for a database using only the API (after setting up connection in UI)

1. List All Groups
2. List All Connectors In Group
3. Reload Connector Schema Config setting exclusion_mode = EXCLUDE
4. Modify Connector Database Schema Config with just the schema/table you would like

Directory Contents

Group Management

These scripts are a subset of the available endpoints with the group management endpoints. They are some of the most frequently used endpoints, and will be used in getting group_ids and connector_ids for usage in the connector management scripts.

Link to Docs

Scripts

• List All Groups
• Retrieve Group Details
• List All Connectors In Group

Connector Managemement

These scripts are designed to interact with individual endpoints that provide control over some of the basic operations that Fivetran allows. As with the Group Managment section above, the scripts provided do not provide full coverage of the available endpoints.

Link to Docs

Scripts

• Create Connector
• Delete Connector
• Modify Connector
• Retrieve Connector Details
• Sync Connector Data
• Sync Connector Data Return
• Reload Connector Schema Config
• Modify Connector Database Schema Config