POST /v1/connections/{connectionId}/schemas/reload

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

NOTE: This method reloads the full schema from the connection's data source. It may take a long time to complete the request. The method execution speed depends on the schema size and the number of databases, tables, and columns.

The response contains all known schemas and tables. Also, it contains columns whose state has ever been set by the user. For more information, see also the Connection Schema config tutorial.

Servers

https://api.fivetran.com

Path parameters

Name	Type	Required	Description
`connectionId`	String	Yes	The unique identifier for the connection within the Fivetran system

Request headers

Name	Type	Required	Description
`Accept`	String	No	Default value: "application/json"
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name Type Required Description

Name	Type	Required	Description
`exclude_mode`	String	No	Specifies whether all schemas and tables will be enabled or disabled in the standard config. By specifying the `exclude_mode` parameter value, you can enable or disable syncing for all schemas and tables when reloading the connection schema config. When the default `PRESERVE` value is set, all selected schemas and tables in the standard config preserve their state. When the `EXCLUDE` value is set, the columns that haven't been updated by user yet are not excluded from the sync. Such columns may be present in the source and not displayed in the response, but they are considered to be included in the sync by default. If you enable syncing of their table, then all of these columns from the source will be synced in the next sync cycle. See also Troubleshooting: How to enable syncs only for the columns you need.

exclude_mode

String

No

Specifies whether all schemas and tables will be enabled or disabled in the standard config. By specifying the exclude_mode parameter value, you can enable or disable syncing for all schemas and tables when reloading the connection schema config.

When the default PRESERVE value is set, all selected schemas and tables in the standard config preserve their state.

When the EXCLUDE value is set, the columns that haven't been updated by user yet are not excluded from the sync. Such columns may be present in the source and not displayed in the response, but they are considered to be included in the sync by default. If you enable syncing of their table, then all of these columns from the source will be synced in the next sync cycle. See also Troubleshooting: How to enable syncs only for the columns you need.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.

All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.

Pricing Templates Integrations Blog Contact Us Help

Terms of Service Privacy Policy