SIsigmacomputing
Connections

Sync a connection by path

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 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.
post/v2/connections/{connectionId}/sync

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

connectionIdstring required

Query parameters

useServiceAccountboolean

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

Request body

Response

The response body.

ConnectionsSyncConnectionPathResponse200 required

Changes

No recorded changes to this operation across all 1 revision of this API.