ThoughtSpot System API is one of 29 APIs that ThoughtSpot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include System. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and authentication docs.
This API exposes
9 operations
across 9 paths,
and defines 36 schemas.
It is described by OpenAPI 3.2.0, at version 2.0.
Requests are made against a single base URL, {base-url}.
9 operations9 paths36 schemas3 GET6 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 System API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
Paths & Operations 9
Across 9 paths, the API surfaces 9 operations — 3 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.
Beta Version: 10.14.0.cl or later Configure communication channel preferences. - Use clusterpreferences to update the default preferences for your ThoughtSpot application instance. - If your instance…
Version: 26.2.0.cl or later Configure security settings for your ThoughtSpot application instance. - Use clusterpreferences to update cluster-level security settings including CORS whitelisted URLs,…
configureSecuritySettingsbody→ 204400401403500
GET
/api/rest/2.0/system/config
Version: 9.0.0.cl or later Retrieves the current configuration details of the cluster. If the request is successful, the API returns a list configuration settings applied on the cluster. Requires ADM…
getSystemConfig→ 200400401403500
GET
/api/rest/2.0/system
Version: 9.0.0.cl or later Gets system information such as the release version, locale, time zone, deployment environment, date format, and date time format of the cluster. Requires ADMINISTRATION (C…
getSystemInformation→ 200400401403500
GET
/api/rest/2.0/system/config-overrides
Version: 9.2.0.cl or later Gets a list of configuration overrides applied on the cluster. Requires ADMINISTRATION (Can administer ThoughtSpot) privilege. If [Role-Based Access Control (RBAC)](https:/…
Beta Version: 10.14.0.cl or later Fetch communication channel preferences. - Use clusterpreferences to fetch the default preferences for your ThoughtSpot application instance. - If your instance has…
Version: 26.2.0.cl or later Fetch security settings for your ThoughtSpot application instance. - Use scope: CLUSTER to retrieve cluster-level security settings, including CORS and CSP allowlists, SAM…
searchSecuritySettingsbody→ 200400401403500
POST
/api/rest/2.0/system/config-update
Version: 9.2.0.cl or later Updates the current configuration of the cluster. You must send the configuration data in JSON format. Requires ADMINISTRATION (Can administer ThoughtSpot) privileges. If […
Beta Version: 26.4.0.cl or later Validates a communication channel configuration to ensure it is properly set up and can receive events. - Use channeltype to specify the type of communication channel…
validateCommunicationChannelbody→ 200400401403500
Schemas 36
The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are SystemInfo (23 properties), CommunicationChannelValidateResponse (7 properties), CspSettings (7 properties), CspSettingsInput (7 properties). Each schema is shown below with its type and property counts.
SecuritySettingsOrgDetails
object
Org details for security settings.
2 properties
SecuritySettingsClusterPreferences
object
Cluster-level security preferences.
6 properties
CommunicationChannelValidateResponse
object
Response containing validation results for communication channel configuration.
7 properties5 required
CspSettings
object
CSP (Content Security Policy) settings.
7 properties
ValidateCommunicationChannelRequest
object
3 properties3 required
SystemOverrideInfo
object
1 property
SecuritySettingsResponse
object
Response type for security settings search.
2 properties
OrgChannelConfigInput
object
4 properties1 required
SearchCommunicationChannelPreferencesRequest
object
2 properties
SystemInfo
object
23 properties
ChannelValidationGcpGcsInfo
object
GCP GCS storage information returned from a validation step.
3 properties
ClusterNonEmbedAccessInput
object
Input for cluster-level non-embed access configuration.
2 properties
ConfigureCommunicationChannelPreferencesRequest
object
2 properties
UpdateSystemConfigRequest
object
1 property1 required
ScriptSrcUrls
object
Script-src CSP settings.
2 properties
EventChannelConfig
object
2 properties2 required
GroupInfo
object
Group information for non-embed access.
2 properties
ConfigureSecuritySettingsRequest
object
2 properties
ScriptSrcUrlsInput
object
Input for script-src CSP settings.
2 properties
SearchSecuritySettingsRequest
object
1 property
OrgChannelConfigResponse
object
2 properties2 required
SystemConfig
object
3 properties
OrgNonEmbedAccess
object
Org-level non-embed access configuration.
2 properties
OrgNonEmbedAccessInput
object
Input for org-level non-embed access configuration.
2 properties
CommunicationChannelPreferencesResponse
object
2 properties
ChannelValidationAwsS3Info
object
AWS S3 storage information returned from a validation step.
3 properties
EventChannelConfigInput
object
2 properties2 required
ErrorResponse
object
1 property
SecuritySettingsOrgPreferences
object
Org-level security preferences.
4 properties
SecuritySettingsOrgPreferencesInput
object
Input for org-level security preferences configuration. Note: cross-org operations are not supported currently.
3 properties1 required
OrgDetails
object
2 properties2 required
OrgPreferenceSearchCriteriaInput
object
2 properties1 required
ChannelValidationDetail
object
Validation detail result for a sub-step.
6 properties2 required
CspSettingsInput
object
Input for CSP (Content Security Policy) settings.
7 properties
SecuritySettingsClusterPreferencesInput
object
Input for cluster-level security preferences configuration.
5 properties
ClusterNonEmbedAccess
object
Cluster-level non-embed access configuration.
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of ThoughtSpot System 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.