How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ThoughtSpot Connections API

The Connections API from ThoughtSpot — 11 operation(s) for connections.

ThoughtSpot Connections API is one of 29 APIs that ThoughtSpot 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, a getting-started guide, and authentication docs.

This API exposes 11 operations across 11 paths, and defines 22 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, {base-url}.

11 operations 11 paths 22 schemas 11 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://my.thoughtspot.cloud/api/rest/2.0
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

ThoughtSpot Connections API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 11

Across 11 paths, the API surfaces 11 operations — 11 POST. Each is listed below with its method, path, parameters, and response codes.

Connections 11
POST
/api/rest/2.0/connection/create
Version: 9.2.0.cl or later Creates a connection to a data warehouse for live query services. Requires DATAMANAGEMENT (Can manage data) or ADMINISTRATION (Can administer ThoughtSpot) privilege. If [Ro…
createConnection body → 200400401403500
POST
/api/rest/2.0/connection/deletedeprecated
Version: 9.2.0.cl or later Important: This endpoint is deprecated and will be removed from ThoughtSpot in September 2025. ThoughtSpot strongly recommends using the [Delete Connection V2](/http/api-en…
deleteConnection body → 204400401403500
POST
/api/rest/2.0/connections/{connection_identifier}/delete
Version: 10.4.0.cl or later Deletes a connection object. Note: If a connection has dependent objects, make sure you remove its associations before the delete operation. Requires DATAMANAGEMENT (Can m…
deleteConnectionV2 1 param → 204400401403500
POST
/api/rest/2.0/connections/download-connection-metadata-changes/{connection_identifier}
Version: 9.9.0.cl or later Exports the difference in connection metadata between CDW and ThoughtSpot Requires DATAMANAGEMENT (Can manage data) privilege. If [Role-Based Access Control (RBAC)](https:/…
downloadConnectionMetadataChanges 1 param → 200400401403500
POST
/api/rest/2.0/connections/fetch-connection-diff-status/{connection_identifier}
Version: 9.9.0.cl or later Validates the difference in connection metadata between CDW and ThoughtSpot. Requires DATAMANAGEMENT (Can manage data) privilege. If [Role-Based Access Control (RBAC)](http…
fetchConnectionDiffStatus 1 param → 200400401403500
POST
/api/rest/2.0/connections/{connection_identifier}/revoke-refresh-tokens
Version: 26.2.0.cl or later Revokes OAuth refresh tokens for users who no longer require access to a data warehouse connection. When a token is revoked, the affected user's session for that connectio…
revokeRefreshTokens 1 param body → 200400401403404409500
POST
/api/rest/2.0/connection/search
Version: 9.2.0.cl or later Gets connection objects. Requires DATAMANAGEMENT (Can manage data) or ADMINISTRATION (Can administer ThoughtSpot) privilege. If [Role-Based Access Control (RBAC)](https://d…
searchConnection body → 200400401403500
POST
/api/rest/2.0/connections/{connection_identifier}/resync-metadata
Version: 26.5.0.cl or later Synchronizes connection metadata attributes from your Cloud Data Warehouse (CDW) with ThoughtSpot. Requires the DATAMANAGEMENT (Can manage data) privilege. If [Role-Based…
syncMetadata 1 param body → 200400401403404500
POST
/api/rest/2.0/connection/updatedeprecated
Version: 9.2.0.cl or later Important: This endpoint is deprecated and will be removed from ThoughtSpot in September 2025. ThoughtSpot strongly recommends using the [Update connection V2](/http/api-en…
updateConnection body → 204400401403500
POST
/api/rest/2.0/connections/{connection_identifier}/status
Version: 26.6.0.cl or later Activates or deactivates a connection. A deactivated connection cannot be used for queries or operations until it is activated again. Requires DATAMANAGEMENT (Can manage d…
updateConnectionStatus 1 param body → 204400401403404500
POST
/api/rest/2.0/connections/{connection_identifier}/update
Version: 10.4.0.cl or later Updates a connection object. Requires DATAMANAGEMENT (Can manage data) and edit permissions to the connection object, or ADMINISTRATION (Can administer ThoughtSpot) privil…
updateConnectionV2 1 param body → 204400401403500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are SearchConnectionRequest (11 properties), SearchConnectionResponse (7 properties), Table (7 properties), Column (6 properties). Each schema is shown below with its type and property counts.

FetchConnectionDiffStatusResponse
object
1 property
SearchConnectionResponse
object
7 properties 3 required
DataWarehouseObjects
object
1 property 1 required
RevokeRefreshTokensRequest
object
3 properties
ConnectionInput
object
3 properties
UpdateConnectionStatusRequest
object
1 property
SortOptionInput
object
2 properties
Column
object
6 properties 2 required
SyncMetadataResponse
object
Response from sync metadata operation.
6 properties
CreateConnectionRequest
object
5 properties 3 required
UpdateConnectionV2Request
object
4 properties
SearchConnectionRequest
object
11 properties
CreateConnectionResponse
object
4 properties 3 required
SyncMetadataRequest
object
2 properties
DataWarehouseObjectInput
object
4 properties
UpdateConnectionRequest
object
5 properties 1 required
Table
object
7 properties 1 required
ErrorResponse
object
1 property
RevokeRefreshTokensResponse
object
1 property 1 required
SchemaObject
object
2 properties 1 required
DeleteConnectionRequest
object
1 property 1 required
Database
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thoughtspot-connections-api-openapi.yml Raw ↑

Other APIs ThoughtSpot publishes across the network.

ThoughtSpot AI API
ThoughtSpot Authentication API
ThoughtSpot Collections API
ThoughtSpot Connection Configurations API
ThoughtSpot Custom Action API
ThoughtSpot Custom Calendars API
ThoughtSpot Data API
ThoughtSpot DBT API
ThoughtSpot Email Customization API
ThoughtSpot Groups API
ThoughtSpot Input Tables API
ThoughtSpot Jobs API
Where this information came from

This is an independent, third-party profile of ThoughtSpot 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.