PATCH /v1/connections/{connectionId}/schemas/{schemaName}
Updates the database schema config for an existing connection within your Fivetran account (for a single schema within a connection with multiple schemas).
NOTE: 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.
In this API call, the NetSuite SuiteAnalytics, Salesforce and Salesforce Sandbox connectors always return the schema name as 'netsuite' and 'salesforce', respectively.
For more information about this API call for the Oracle Fusion Cloud Applications connectors, see our Schema information documentation.
Servers
- https://api.fivetran.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
schemaName |
String | Yes |
The database schema name within your destination (different from the connection schema) |
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 |
|---|---|---|---|
enabled |
Boolean | Yes |
The boolean value specifying whether the sync for the table into the destination is enabled. |
tables |
Object | No |
The set of tables within your database schema config. |
tables.table |
Object | No | |
tables.table.enabled |
Boolean | Yes |
The boolean value specifying whether the sync for the table into the destination is enabled. |
tables.table.columns |
Object | No |
The set of columns within your table schema config. The |
tables.table.columns.column |
Object | No | |
tables.table.columns.column.hashed |
Boolean | No |
The boolean value specifying whether a column should be hashed |
tables.table.columns.column.enabled |
Boolean | Yes |
The boolean value specifying whether the sync for the table into the destination is enabled. |
tables.table.columns.column.is_primary_key |
Boolean | No | |
tables.table.columns.column.masking_algorithm |
String | No |
Possible values:
|
tables.table.sync_mode |
String | No |
This field appears in the response if the connection supports switching sync modes for tables Possible values:
|
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.