Sync a connection by path

View as Markdown
Sync the connection for a data source to retrieve any changes from the data warehouse. ### Usage notes - Specify the path to a table, stored procedure, schema, or database in your data warehouse that you want to sync. To trigger a full connection sync, provide an empty path (`[]`). - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint. - Different connections support different paths: - For a Snowflake connection, you can specify `DATABASE.SCHEMA.TABLE`, `DATABASE.SCHEMA.STORED_PROCEDURE`, or a less-specific path. - For Amazon Redshift, you can specify `SCHEMA.TABLE`, `SCHEMA.STORED_PROCEDURE`, or a less-specific path. - For Databricks, you can specify `CATALOG.SCHEMA.TABLE` or a less-specific path.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

connectionIdstringRequired

Query parameters

useServiceAccountbooleanOptional
Whether to use the OAuth connection's service account to perform the sync.

Request

The request body.
pathlist of strings or list of anyRequired

Response

The response body.