Sigma Computing Connections API
The Connections API from Sigma Computing — 13 operation(s) for connections.
Sigma Computing Connections API is one of 40 APIs that Sigma Computing publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Connections. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.
This API exposes 22 operations across 15 paths, and defines 346 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 13 base URLs: https://api.sigmacomputing.com, https://api.sa.gcp.sigmacomputing.com, https://aws-api.sigmacomputing.com, https://api.us-a.aws.sigmacomputing.com, https://api.ca.aws.sigmacomputing.com, https://api.eu.aws.sigmacomputing.com, https://api.au.aws.sigmacomputing.com, https://api.uk.aws.sigmacomputing.com, https://api.us.azure.sigmacomputing.com, https://api.eu.azure.sigmacomputing.com, https://api.ca.azure.sigmacomputing.com, https://api.uk.azure.sigmacomputing.com, https://api.au.azure.sigmacomputing.com.
22 operations
15 paths
346 schemas
3 DELETE9 GET2 PATCH7 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 4
Sigma Computing Connections API declares
4 security schemes
for authenticating requests.
It accepts HTTP basic authentication (basicAuth).
It accepts HTTP bearer tokens (bearerAuth).
It supports OAuth 2.0 (oauth2) using the clientCredentials flow.
It accepts HTTP bearer tokens (OAuth).
OAuth— OAuth 2.0 authentication
Paths & Operations 22
Across 15 paths, the API surfaces 22 operations — 3 DELETE, 9 GET, 2 PATCH, 7 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
connections 22
POST
/v2/connection/{connectionId}/lookup
Look up connections by path
GET
/v2/connections
List connections
POST
/v2/connections
Create a connection
PATCH
/v2/connections/{connectionId}deprecated
Update a connection
GET
/v2/connections/{connectionId}
Get connection details
DELETE
/v2/connections/{connectionId}
Delete a connection
PUT
/v2/connections/{connectionId}
Update a connection
POST
/v2/connections/{connectionId}/dbtArtifacts
Add dbt metadata for a connection
POST
/v2/connections/{connectionId}/grants
Add grants to a connection
GET
/v2/connections/{connectionId}/grants
List grants for a connection
DELETE
/v2/connections/{connectionId}/grants/{grantId}
Delete a grant for a connection
POST
/v2/connections/{connectionId}/sync
Sync a connection by path
GET
/v2/connections/{connectionId}/test
Test a connection
GET
/v2/connections/paths
List connection paths
POST
/v2/connections/paths/{connectionPathId}/grants
Add grants to a connection path
GET
/v2/connections/paths/{connectionPathId}/grants
List grants for a connection path
DELETE
/v2/connections/paths/{connectionPathId}/grants/{grantId}
Delete a grant for a connection path
GET
/v2/connections/paths/{inodeId}
Get connection path for a table
GET
/v2/connections/tables/{tableId}/columns
List columns for a warehouse table
POST
/v3alpha/connections
Create a connection (Beta)
PATCH
/v3alpha/connections/{connectionId}
Update a connection (Beta)
GET
/v3alpha/connections/{connectionId}
Get connection details (Beta)
Schemas 346
The contract defines 346 schemas that model the data the API accepts and returns. The most detailed are connections_getConnection_Response_200 (37 properties), connections_updateConnectionDeprecated_Response_200 (37 properties), connections_updateConnection_Response_200 (37 properties), connections_createConnection_Response_201 (37 properties). Each schema is shown below with its type and property counts.
connections_getConnection_Response_200
object
37 properties
12 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password2
object
2 properties
2 required
V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaPoolSizes
object
Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize
5 properties
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password1
object
2 properties
2 required
V2ConnectionsPathsConnectionPathIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission2
string
Valid inode types: version tag.
V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType7
string
V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaRoleSwitching
string
Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections.
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType5
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType9
string
V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsUserAttributes
object
User attributes associated with the connection
2 properties
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3ClientSecret
Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API.
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails
V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaRead0
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3WriteAccess
object
Configure write-back for non-OAuth connections
2 properties
2 required
V2ConnectionsTablesTableIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItemsVisibility
string
Visibility of the column. If "included", the column is visible. If "hidden", the column is hidden but available to be used. If "removed", the column has been d…
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3Type
string
V2ConnectionsConnectionIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee0
object
The UUID of the member receiving the grant
1 property
1 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType2
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess1
object
2 properties
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password2
object
2 properties
2 required
connections_updateConnection_Response_200
object
37 properties
12 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3ClientSecret1
object
2 properties
2 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaPoolSizes
object
Connection pool sizes. Each pool bounds how many queries of a given type (ad hoc, scheduled, catalog, result cache) run concurrently against the warehouse.
5 properties
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType6
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4WriteAccess
object
1 property
1 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType0
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1Type
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails1
object
Details of the BigQuery connection.
14 properties
2 required
V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType6
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4Type
string
V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaWrite2
string
V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaWritebacksItems
object
4 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails1
object
Details of the BigQuery connection.
14 properties
2 required
V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaUserAttributes
object
User attributes associated with the connection
2 properties
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0PasswordOneOf1Type
string
V2ConnectionsPathsGetResponsesContentApplicationJsonSchemaEntriesItems
object
3 properties
3 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType4
string
V2ConnectionsPathsGetResponsesContentApplicationJsonSchemaEntriesItemsPath
V2ConnectionConnectionIdLookupPostRequestBodyContentApplicationJsonSchemaPath
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1WriteAccess
object
2 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails2
object
Details of the Snowflake connection.
25 properties
1 required
V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType
OAuth provider type configured or inferred for this connection.
V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType4
string
connections_listConnectionPathGrants_Response_200
object
3 properties
2 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7Type
string
Starburst connection type.
V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaWrite
V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType2
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType4
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType8
string
V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType3
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password
Password used to authenticate to the database. This value is write-only and is not returned by the API.
V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType6
string
V2ConnectionsConnectionIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsPermission
string
Connection permissions of Can Use & Annotate and Can Use.
V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaRoleSwitching
string
Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections.
V2ConnectionsConnectionIdSyncPostRequestBodyContentApplicationJsonSchemaPath
V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType6
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6WriteAccess
object
Configure write-back for the connection.
2 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType
OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, awsdatabricks, azuredatabricks, gcpdatabricks, and unknown.
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2ClientSecret1
object
2 properties
2 required
V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaWritebackSchemasItems
object
4 properties
2 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType3
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3ClientSecret
Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API.
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1WriteAccess
object
2 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails3
object
Details of the Databricks connection.
15 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType6
string
V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType8
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2AuthType
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password
The password for the service account set up by your Starburst administrator. This value is write-only and is not returned by the API.
V2ConnectionsPostResponsesContentApplicationJsonSchemaTimeout
object
Timeout settings for the connection, with a default value in seconds
4 properties
1 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2ClientSecret
Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API.
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType3
string
V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType5
string
V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType8
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2RoleSwitching
string
Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful when useOauth is true.
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType1
string
V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaTimeout
object
Timeout settings for the connection, with a default value in seconds
4 properties
1 required
V2ConnectionsPathsConnectionPathIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItems
object
2 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails7
object
Details of the Starburst connection.
6 properties
5 required
connections_listConnectionTableColumns_Response_200
object
2 properties
1 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType0
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0WriteAccess
object
1 property
1 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5WriteAccess
object
Configure write-back for the connection.
2 properties
2 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password1
object
2 properties
2 required
V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaPoolSizes
object
Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize
5 properties
V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType2
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType7
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3InputTableAuditLogSchema
object
Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection.
3 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails0
object
Details of the PostgreSQL connection.
8 properties
3 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType
OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, awsdatabricks, azuredatabricks, gcpdatabricks, and unknown.
V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaWritebacksItems
object
4 properties
2 required
V2ConnectionsConnectionIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission1
string
Valid inode types: folder, workspace, workbook, dataset, and data model. Can Contribute permissions are listed as organize and Can Manage permissions are liste…
V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType
OAuth provider type configured or inferred for this connection.
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2UserAttributes
object
2 properties
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5PasswordOneOf1Type
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType4
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password
connections_updateConnectionDeprecated_Response_200
object
37 properties
12 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6PasswordOneOf1Type
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7WriteAccess
object
Configure write-back for the connection.
2 properties
2 required
V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsTimeout
object
Timeout settings for the connection, with a default value in seconds
4 properties
1 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType7
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ClientSecret1
object
2 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2WritebackSchemasItems
object
4 properties
2 required
V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType1
string
V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType
OAuth provider type configured or inferred for this connection.
V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType1
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6Type
string
SQL Server connection type.
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess
Specify write access for non-OAuth connections
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7PasswordOneOf1Type
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType5
string
V2ConnectionConnectionIdLookupPostResponsesContentApplicationJsonSchemaKind
string
V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType4
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType2
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType8
string
V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType4
string
V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType2
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails6
object
Details of the SQL Server connection.
7 properties
5 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password
The password for the service account set up by your Starburst administrator. This value is write-only and is not returned by the API.
V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaTimeout
object
Timeout settings for the connection, with a default value in seconds
4 properties
1 required
V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsWritebacksItems
object
4 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1ServiceAccount1
object
2 properties
2 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5Type
string
Azure SQL DB connection type.
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3Type
string
V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType3
string
V2ConnectionsPostResponsesContentApplicationJsonSchemaPoolSizes
object
Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize
5 properties
V2ConnectionsPathsConnectionPathIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsPermission
string
connections_postConnectionDbtArtifacts_Response_201
object
V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaUserAttributes
object
User attributes associated with the connection
2 properties
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails4
object
Details of the MySQL connection.
6 properties
5 required
V2ConnectionsPostResponsesContentApplicationJsonSchemaRoleSwitching
string
Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections.
V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType0
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password2
object
2 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType7
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType3
string
V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType5
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType5
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6PasswordOneOf1Type
string
V2ConnectionsConnectionIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItems
object
2 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2InputTableAuditLogSchema
object
Specify a schema for input table write access logs
3 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType3
string
V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType5
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails4
object
Details of the MySQL connection.
6 properties
5 required
V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType
OAuth provider type configured or inferred for this connection.
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3InputTableAuditLogSchema
object
Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection.
3 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3WritebackSchemasItems
object
4 properties
2 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5WriteAccess
object
Configure write-back for the connection.
2 properties
2 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess0
object
4 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType7
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails6
object
Details of the SQL Server connection.
7 properties
5 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2Type
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password2
object
2 properties
2 required
V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType7
string
connections_syncConnectionPath_Response_200
object
V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaPoolSizes
object
Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize
5 properties
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2RoleSwitching
string
Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful when useOauth is true.
V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType0
string
V2ConnectionsPostResponsesContentApplicationJsonSchemaUserAttributes
object
User attributes associated with the connection
2 properties
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecrets
object
2 properties
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password2
object
2 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess1
object
2 properties
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecretsPythonUser
object
3 properties
2 required
V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaRoleSwitching
string
Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections.
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType2
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonProperties
object
Python configuration for this Snowflake connection.
4 properties
V2ConnectionsConnectionIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission0
string
Valid inode types: table, connection database, and connection schema.
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Type
string
V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType6
string
V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType9
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecretsSetupUser
object
3 properties
2 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4PasswordOneOf1Type
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType5
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType1
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1ClientSecret
Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API.
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2Type
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType6
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType5
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2UserAttributes
object
2 properties
connections_deleteConnectionPathGrant_Response_200
object
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7PasswordOneOf1Type
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password2
object
2 properties
2 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails7
object
Details of the Starburst connection.
6 properties
5 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0PasswordOneOf1Type
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1ServiceAccount
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password1
object
2 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType4
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType1
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType9
string
V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItems
object
37 properties
12 required
connections_listConnections_Response_200
object
4 properties
2 required
V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType2
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess
Specify write access for non-OAuth connections
V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType
OAuth provider type configured or inferred for this connection.
V2ConnectionsPathsConnectionPathIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission
The permission granted to the member
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType3
string
V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType7
string
V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType9
string
V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaInputTableAuditLogSchema
object
Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection.
3 properties
2 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password1
object
2 properties
2 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType1
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType8
string
V2ConnectionsPostResponsesContentApplicationJsonSchemaWritebackSchemasItems
object
4 properties
2 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType
OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, awsdatabricks, azuredatabricks, gcpdatabricks, and unknown.
V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaTimeout
object
Timeout settings for the connection, with a default value in seconds
4 properties
1 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password
Password used to authenticate to the database. This value is write-only and is not returned by the API.
V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaWrite0
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails0
object
Details of the PostgreSQL connection.
8 properties
3 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3WritebackSchemasItems
object
4 properties
2 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2WritebackSchemasItems
object
4 properties
2 required
V2ConnectionsPathsConnectionPathIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee0
object
The UUID of the member receiving the grant
1 property
1 required
V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType5
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecretsPythonUser
object
3 properties
2 required
V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsRoleSwitching
string
Whether a Snowflake OAuth connection allows users to switch roles when running queries. Only meaningful for Snowflake OAuth connections.
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password1
object
2 properties
2 required
V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaOauthIdpType1
string
connections_lookupConnection_Response_200
object
3 properties
3 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType2
string
V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaWritebackSchemasItems
object
4 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0Type
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1ClientSecret1
object
2 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType6
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType6
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails5
object
Details of the Azure SQL DB connection.
8 properties
6 required
V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType1
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType0
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ServiceAccount1
object
2 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType9
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1Type
string
V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType8
string
V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType0
string
V2ConnectionsTablesTableIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItemsType
object
The column's data type, represented as a recursive type object.
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password2
object
2 properties
2 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecrets
object
2 properties
V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaWritebacksItems
object
4 properties
2 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password2
object
2 properties
2 required
V2ConnectionsConnectionIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItems
object
10 properties
10 required
V2ConnectionsPathsConnectionPathIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType0
string
V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType2
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType4
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6Type
string
SQL Server connection type.
V2ConnectionsPathsConnectionPathIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission1
string
Valid inode types: folder, workspace, workbook, dataset, and data model. Can Contribute permissions are listed as organize and Can Manage permissions are liste…
connections_createConnectionGrant_Response_200
object
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType6
string
V2ConnectionsTablesTableIdColumnsGetResponsesContentApplicationJsonSchemaEntriesItems
object
4 properties
3 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType3
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5PasswordOneOf1Type
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password1
object
2 properties
2 required
V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaRead1
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2ClientSecret
Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API.
V2ConnectionsPostResponsesContentApplicationJsonSchemaWritebacksItems
object
4 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password1
object
2 properties
2 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0WriteAccess
object
1 property
1 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2InputTableAuditLogSchema
object
Specify a schema for input table write access logs
3 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType0
string
V2ConnectionsConnectionIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType5
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType4
string
V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType9
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf4Password
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password
Password used to authenticate to the database. This value is write-only and is not returned by the API.
connections_createConnectionPathGrant_Response_200
object
connections_testConnection_Response_200
object
2 properties
2 required
V2ConnectionsConnectionIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission
The permission granted to the member
V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType0
string
V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaInputTableAuditLogSchema
object
Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection.
3 properties
2 required
V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsWritebackSchemasItems
object
4 properties
2 required
V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType3
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonSecretsSetupUser
object
3 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType9
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4WriteAccess
object
1 property
1 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType
OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, awsdatabricks, azuredatabricks, gcpdatabricks, and unknown.
V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsInputTableAuditLogSchema
object
Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection.
3 properties
2 required
V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType7
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ClientSecret
Client secret for the OAuth application used by this connection. This value is write-only and is not returned by the API.
V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType0
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType1
string
V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType8
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2PythonProperties
object
Python configuration for this Snowflake connection.
4 properties
connections_getInodeConnectionPath_Response_200
object
2 properties
2 required
connections_listConnectionGrants_Response_200
object
4 properties
2 required
V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType9
string
V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType4
string
V2ConnectionsPathsInodeIdGetResponsesContentApplicationJsonSchemaPath
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1ServiceAccount
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType2
string
V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsPoolSizes
object
Pool sizes for the connection, such as for adhocPoolSize or schedulePoolSize
5 properties
V2ConnectionsConnectionIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee1
object
The UUID of the team receiving the grant
1 property
1 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf7Type
string
Starburst connection type.
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf6WriteAccess
object
Configure write-back for the connection.
2 properties
2 required
V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType6
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType9
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5Type
string
Azure SQL DB connection type.
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType8
string
V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType7
string
V2ConnectionsPathsConnectionPathIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItems
object
10 properties
10 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails2
object
Details of the Snowflake connection.
25 properties
1 required
V2ConnectionsPathsConnectionPathIdGrantsPostRequestBodyContentApplicationJsonSchemaGrantsItemsGrantee1
object
The UUID of the team receiving the grant
1 property
1 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3WriteAccess
object
Configure write-back for non-OAuth connections
2 properties
2 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType
OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, awsdatabricks, azuredatabricks, gcpdatabricks, and unknown.
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetails5
object
Details of the Azure SQL DB connection.
8 properties
6 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType
OAuth provider type. Supported values are adfs, auth0, azuread, okta, ping, snowflake, awsdatabricks, azuredatabricks, gcpdatabricks, and unknown.
connections_deleteConnectionGrant_Response_200
object
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType8
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf0Password2
object
2 properties
2 required
V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaWrite1
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password1
object
2 properties
2 required
V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType9
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7Password2
object
2 properties
2 required
V2ConnectionsPostResponsesContentApplicationJsonSchemaOauthIdpType8
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType7
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf5Password1
object
2 properties
2 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf1IdpType8
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf0Type
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2AuthType
string
V2ConnectionsConnectionIdPutResponsesContentApplicationJsonSchemaInputTableAuditLogSchema
object
Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection.
3 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaPoolSizes
object
Connection pool sizes. Each pool bounds how many queries of a given type (ad hoc, scheduled, catalog, result cache) run concurrently against the warehouse.
5 properties
connections_listConnectionPaths_Response_200
object
4 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType9
string
V2ConnectionsPostResponsesContentApplicationJsonSchemaInputTableAuditLogSchema
object
Schema to use for the input table write-ahead log (WAL). Cannot be changed without breaking write behavior on this connection.
3 properties
2 required
V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaWritebackSchemasItems
object
4 properties
2 required
V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType5
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType0
string
V2ConnectionsConnectionIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission2
string
Valid inode types: version tag.
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf4PasswordOneOf1Type
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetails3
object
Details of the Databricks connection.
15 properties
2 required
V2ConnectionsConnectionIdTestGetResponsesContentApplicationJsonSchemaRead
V2ConnectionsPathsConnectionPathIdGrantsGetResponsesContentApplicationJsonSchemaEntriesItemsPermission0
string
Valid inode types: table, connection database, and connection schema.
V2ConnectionsGetResponsesContentApplicationJsonSchemaEntriesItemsOauthIdpType3
string
connections_deleteConnection_Response_200
object
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password
Password used to authenticate to the database. This value is write-only and is not returned by the API.
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2IdpType7
string
V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaOauthIdpType4
string
V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType1
string
connections_createConnection_Response_201
object
37 properties
12 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3ClientSecret1
object
2 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType1
string
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf7WriteAccess
object
Configure write-back for the connection.
2 properties
2 required
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf6Password1
object
2 properties
2 required
V2ConnectionsConnectionIdPutRequestBodyContentApplicationJsonSchemaDetailsOneOf3IdpType2
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2ClientSecret1
object
2 properties
2 required
V2ConnectionsConnectionIdGetResponsesContentApplicationJsonSchemaOauthIdpType3
string
V2ConnectionsPostRequestBodyContentApplicationJsonSchemaDetailsOneOf2WriteAccess0
object
4 properties
2 required
V2ConnectionsConnectionIdPatchResponsesContentApplicationJsonSchemaUserAttributes
object
User attributes associated with the connection
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Sigma Computing 12
Other APIs Sigma Computing publishes across the network.
Sigma MCP Server
Sigma Embed API
Sigma Computing Account Types API
Sigma Computing API Connectors API
Sigma Computing API Credentials API
Sigma Computing Auth API
Sigma Computing Credentials API
Sigma Computing Data Models API
Sigma Computing Datasets API
Sigma Computing Deployment Policies API
Sigma Computing Favorites API
Sigma Computing Files API
#Connections
Where this information came from
This is an independent, third-party profile of Sigma Computing Connections API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.