PATCH /v1/connections/{connectionId}/schemas

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

NOTE: For backward compatibility, the response may contain the 'enable_new_by_default' boolean field. It defines whether new schemas and tables discovered in the source are synced. The value is 'true' if you specify 'ALLOW_ALL' as a value of 'schema_change_handling'. In the future API versions, we may remove this field.

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
`schemas`	Object	Yes	The set of schemas within your connection schema config.
`schemas.schema`	Object	No
`schemas.schema.enabled`	Boolean	Yes	The boolean value specifying whether the sync for the table into the destination is enabled.
`schemas.schema.tables`	Object	No	The set of tables within your database schema config.
`schemas.schema.tables.table`	Object	No
`schemas.schema.tables.table.enabled`	Boolean	Yes	The boolean value specifying whether the sync for the table into the destination is enabled.
`schemas.schema.tables.table.columns`	Object	No	The set of columns within your table schema config. The `columns` object in the response contains the columns whose `enabled` value has been set by the user after the initial sync.
`schemas.schema.tables.table.columns.column`	Object	No
`schemas.schema.tables.table.columns.column.hashed`	Boolean	No	The boolean value specifying whether a column should be hashed
`schemas.schema.tables.table.columns.column.enabled`	Boolean	Yes	The boolean value specifying whether the sync for the table into the destination is enabled.
`schemas.schema.tables.table.columns.column.is_primary_key`	Boolean	No
`schemas.schema.tables.table.columns.column.masking_algorithm`	String	No	Possible values: `"ENCRYPTED"` `"HASHED"` `"PLAINTEXT"`
`schemas.schema.tables.table.sync_mode`	String	No	This field appears in the response if the connection supports switching sync modes for tables Possible values: `"LIVE"` `"SOFT_DELETE"` `"HISTORY"`
`schema_change_handling`	String	No	The possible values for the schema_change_handling parameter are as follows: ALLOW_ALL - all new schemas, tables, and columns which appear in the source after the initial setup are included in syncs ALLOW_COLUMNS - all new schemas and tables which appear in the source after the initial setup are excluded from syncs, but new columns are included BLOCK_ALL - all new schemas, tables, and columns which appear in the source after the initial setup are excluded from syncs Possible values: `"ALLOW_ALL"` `"BLOCK_ALL"` `"ALLOW_COLUMNS"`

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.