# REST API v2.0 Reference > For the complete documentation index, see [llms.txt](https://developers.thoughtspot.com/docs/llms.txt) Source: https://developers.thoughtspot.com/docs/rest-apiv2-reference # REST API v2.0 Reference This API Reference page lists the REST API v2.0 endpoints and provides basic information about the resource URLs and supported operations. If you want to try out these APIs, view detailed documentation, and download code samples, visit the [REST API v2.0 Playground]({{navprefix}}/restV2-playground?apiResourceId=http%2Fgetting-started%2Fintroduction). > **NOTE:** Access to ThoughtSpot data is controlled based on user privileges and object-level permissions. Some operations are available to all users and may require at least view access to the metadata object. ThoughtSpot users are assigned access privileges based on the group to which they belong. Additionally, object owners can control access to a metadata object using MODIFY (Can edit), READ\_ONLY (Can view), or NO\_ACCESS permission when sharing an object with other users and groups. ## AI | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/ai/agent/conversation/create` Creates a conversation session with ThoughtSpot’s Spotter agent. | ThoughtSpot Cloud: _10.13.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fai%2Fcreate-agent-conversation) | | `POST /api/rest/2.0/ai/conversation/create` Creates a conversation session with ThoughtSpot Spotter | ThoughtSpot Cloud: _10.4.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fai%2Fcreate-conversation) | | `POST /api/rest/2.0/ai/data-source-suggestions` Gets data source recommendations for a given query. | ThoughtSpot Cloud: _26.2.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fai%2Fget-data-source-suggestions) | | `POST /api/rest/2.0/ai/relevant-questions/` Breaks down a user submitted query into relevant questions | ThoughtSpot Cloud: _10.13.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fai%2Fget-relevant-questions) | | `POST /api/rest/2.0/ai/agent/converse/sse` Allows sending a natural language query or a follow-up question to an ongoing conversation session and returns the AI agent’s response, including answers, tokens, and visualization details. | ThoughtSpot Cloud: _10.13.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fai%2Fsend-agent-message-streaming) | | `POST /api/rest/2.0/ai/conversation/{conversation_identifier}/converse` Generates responses to user queries and follow-up questions sent in the specified conversation session. | ThoughtSpot Cloud: _10.4.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fai%2Fsend-message) | | `POST /api/rest/2.0/ai/answer/create` Generates an Answer for a Natural Language Search query. | ThoughtSpot Cloud: _10.4.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fai%2Fsingle-answer) | | `POST /api/rest/2.0/ai/agent/{conversation_identifier}/converse` Allows sending a query to an ongoing conversation session with Spotter agent and generate response. | ThoughtSpot Cloud: _10.15.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fai%2Fsend-agent-message) | | `POST /api/rest/2.0/ai/agent/conversation/{conversation_identifier}/stop-response` Stops an in-progress Spotter agent response for a given conversation session. | ThoughtSpot Cloud: _26.6.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fai%2Fstop-agent-response) | | `POST /api/rest/2.0/ai/instructions/set` Sets data model instructions. | ThoughtSpot Cloud: _10.15.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fai%2Fset-nl-instructions) | | `POST /api/rest/2.0/ai/instructions/get` Retrieves data model instructions. | ThoughtSpot Cloud: _10.15.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fai%2Fget-nl-instructions) | | `PUT /api/rest/2.0/ai/agent/instructions/set` Sets custom instructions for the Spotter agent. | ThoughtSpot Cloud: _26.7.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fai%2Fset-agent-instructions) | | `GET /api/rest/2.0/ai/agent/instructions/get` Retrieves the custom instructions currently configured for the Spotter agent. | ThoughtSpot Cloud: _26.7.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fai%2Fget-agent-instructions) | | `GET /api/rest/2.0/ai/agent/conversations` Retrieves a paginated list of saved Spotter agent conversations for the authenticated user. Only conversations created with `enable_save_chat: true` are returned. Requires `CAN_USE_SPOTTER` privilege. | ThoughtSpot Cloud: _26.7.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fai%2Fget-conversation-list) | | `GET /api/rest/2.0/ai/agent/conversations/{conversation_identifier}` Retrieves the full message history of a single saved Spotter agent conversation, including user prompts and agent response items for each turn. Requires `CAN_USE_SPOTTER` privilege. | ThoughtSpot Cloud: _26.7.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fai%2Fget-agent-conversation) | | `POST /api/rest/2.0/ai/agent/conversations/{conversation_identifier}/update` Updates the display title of a saved Spotter agent conversation. Requires `CAN_USE_SPOTTER` privilege and ownership of the conversation. | ThoughtSpot Cloud: _26.7.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fai%2Fupdate-agent-conversation) | | `DELETE /api/rest/2.0/ai/agent/conversations/{conversation_identifier}/delete` Permanently deletes a saved Spotter agent conversation and all its associated messages. This operation is irreversible. Requires `CAN_USE_SPOTTER` privilege and ownership of the conversation. | ThoughtSpot Cloud: _26.7.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fai%2Fdelete-agent-conversation) | | `POST /api/rest/2.0/ai/memory/import` Imports Spotter memory entries in bulk for backup, migration, or seeding purposes. | ThoughtSpot Cloud: _26.8.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fai%2Fimport-memory) | | `POST /api/rest/2.0/ai/memory/export` Exports Spotter memory entries for audit, backup, or cross-environment migration. | ThoughtSpot Cloud: _26.8.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fai%2Fexport-memory) | ## Authentication | API endpoint | Release version | Playground link | | --- | --- | --- | | `GET /api/rest/2.0/auth/session/user` Gets session information for the currently logged-in user. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fauthentication%2Fget-current-user-info) | | `GET /api/rest/2.0/auth/session/token` Generates a new bearer token from an existing authenticated session. | ThoughtSpot Cloud: _9.4.0.cl or later_ ThoughtSpot Software: _9.5.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fauthentication%2Fget-current-user-token) | | `POST /api/rest/2.0/auth/session/login` Creates a login session for a ThoughtSpot user. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fauthentication%2Flogin) | | `POST /api/rest/2.0/auth/token/object` Gets an authentication token that grants access only to the metadata object specified in the API request. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fauthentication%2Fget-object-access-token) | | `POST /api/rest/2.0/auth/token/full` Gets an authentication token from ThoughtSpot that grants access to a full application session. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fauthentication%2Fget-full-access-token) | | `POST /api/rest/2.0/auth/session/logout` Logs out the currently logged-in user. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fauthentication%2Flogout) | | `POST /api/rest/2.0/auth/token/revoke` Revokes authentication token granted for a user. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fauthentication%2Frevoke-token) | | `POST /api/rest/2.0/auth/token/validate` Validates the authentication token specified in the API request. | ThoughtSpot Cloud: _9.12.0.cl or later_ ThoughtSpot Software: _10.0.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fauthentication%2Fvalidate-token) | | `POST /api/rest/2.0/auth/token/custom` Generates an authentication token with pre-defined RLS rules and filter attributes for a user. | ThoughtSpot Cloud: _10.4.0.cl or later_ ThoughtSpot Software: _10.7.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fauthentication%2Fget-custom-access-token) | | `POST /api/rest/2.0/auth/configure` Enables or disables authentication. | ThoughtSpot Cloud: _26.6.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fauthentication%2Fconfigure-auth-settings) | | `POST /api/rest/2.0/auth/search` Retrieves the authentication configuration for the specified auth type. | ThoughtSpot Cloud: _26.6.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fauthentication%2Fsearch-auth-settings) | ## Collections | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/collections/create` Creates a new Collection. | ThoughtSpot Cloud: _26.4.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fcollections%2Fcreate-collection) | | `POST /api/rest/2.0/collections/search` Gets a list of Collections available in ThoughtSpot. | ThoughtSpot Cloud: _26.4.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fcollections%2Fsearch-collections) | | `POST /api/rest/2.0/collections/{collection_identifier}/update` Updates an existing Collection. | ThoughtSpot Cloud: _26.4.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fcollections%2Fupdate-collection) | | `POST /api/rest/2.0/collections/delete` Deletes one or more Collections. | ThoughtSpot Cloud: _26.4.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fcollections%2Fdelete-collection) | ## Connections | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/connection/search` Gets connection objects from ThoughtSpot. | ThoughtSpot Cloud: _9.2.0.cl or later_ ThoughtSpot Software: _9.5.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fconnections%2Fsearch-connection) | | `POST /api/rest/2.0/connection/create` Creates a connection to the data warehouse specified in the API request. | ThoughtSpot Cloud: _9.2.0.cl or later_ ThoughtSpot Software: _9.5.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fconnections%2Fcreate-connection) | | `POST /api/rest/2.0/connection/update` DEPRECATED Updates a connection object. _Note: This API endpoint is deprecated in ThoughtSpot 10.4.0.cl and later versions. To update a connection, use `POST /api/rest/2.0/connections/{connection_identifier}/update`._ | ThoughtSpot Cloud: _9.2.0.cl or later_ ThoughtSpot Software: _9.5.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fconnections%2Fupdate-connection) | | `POST /api/rest/2.0/connections/{connection_identifier}/update` Updates a connection object. | ThoughtSpot Cloud: _10.4.0.cl or later_ ThoughtSpot Software: _10.7.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fconnections%2Fupdate-connection-v2) | | `POST /api/rest/2.0/connection/delete` DEPRECATED Deletes a connection object. _Note: This API endpoint is deprecated in ThoughtSpot 10.4.0.cl and later versions. To delete a connection, use `api/rest/2.0/connections/delete/{connection_identifier}`._ | ThoughtSpot Cloud: _9.2.0.cl or later_ ThoughtSpot Software: _9.5.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fconnections%2Fdelete-connection) | | `POST /api/rest/2.0/connections/{connection_identifier}/delete` Deletes a connection | ThoughtSpot Cloud: _10.4.0.cl or later_ ThoughtSpot Software: _10.7.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fconnections%2Fdelete-connection-v2) | | `POST /api/rest/2.0/connections/fetch-connection-diff-status/{connection_identifier}` Validates the connection metadata differences between Cloud Data Warehouse and ThoughtSpot. | ThoughtSpot Cloud: _9.10.5.cl or later_ ThoughtSpot Software: _10.0.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fconnections%2Ffetch-connection-diff-status) | | `POST /api/rest/2.0/connections/download-connection-metadata-changes/{connection_identifier}` Downloads connection metadata differences between Cloud Data Warehouse and ThoughtSpot. | ThoughtSpot Cloud: _9.10.5.cl or later_ ThoughtSpot Software: _10.0.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fconnections%2Fdownload-connection-metadata-changes) | | `POST /api/rest/2.0/connections/{connection_identifier}/status` Deactivates or activates a connection. | ThoughtSpot Cloud: _26.6.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fconnections%2Fupdate-connection-status) | ## Connection Configuration | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/connection-configurations/create` Creates a connection configuration to the connection object specified in the API request. | ThoughtSpot Cloud: _10.12.0.cl or later_ ThoughtSpot Software: _26.3.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fconnection-configurations%2Fcreate-connection-configuration) | | `POST /api/rest/2.0/connection-configurations/search` Gets the connection configuration for the specified connection object. | ThoughtSpot Cloud: _10.12.0.cl or later_ ThoughtSpot Software: _26.3.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fconnection-configurations%2Fconnection-configuration-search) | | `POST /api/rest/2.0/connection-configurations/{configuration_identifier}/update` Updates the connection configuration object. | ThoughtSpot Cloud: _10.12.0.cl or later_ ThoughtSpot Software: _26.3.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fconnection-configurations%2Fdelete-connection-configuration) | | `POST /api/rest/2.0/connection-configurations/delete` Deletes the connection configuration object. | ThoughtSpot Cloud: _10.12.0.cl or later_ ThoughtSpot Software: _26.3.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fconnection-configurations%2Fdelete-connection-configuration) | ## Custom actions | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/customization/custom-actions/search` Gets custom action objects. | ThoughtSpot Cloud: _9.6.0.cl or later_ ThoughtSpot Software: _9.8.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fcustom-action%2Fsearch-custom-actions) | | `POST /api/rest/2.0/customization/custom-actions` Creates a custom action and assigns it to a given metadata object. | ThoughtSpot Cloud: _9.6.0.cl or later_ ThoughtSpot Software: _9.8.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fcustom-action%2Fcreate-custom-action) | | `POST /api/rest/2.0/customization/custom-actions/{custom_action_identifier}/update` Updates the properties of a custom action object. | ThoughtSpot Cloud: _9.6.0.cl or later_ ThoughtSpot Software: _9.8.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fcustom-action%2Fupdate-custom-action) | | `POST /api/rest/2.0/customization/custom-actions/{custom_action_identifier}/delete` Deletes a custom action. | ThoughtSpot Cloud: _9.6.0.cl or later_ ThoughtSpot Software: _9.8.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fcustom-action%2Fdelete-custom-action) | ## Custom calendars | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/calendars/create` Creates a custom calendar. | ThoughtSpot Cloud: _10.12.0.cl or later_ ThoughtSpot Software: _26.3.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fcustom-calendars%2Fcreate-calendar) | | `POST /api/rest/2.0/calendars/{calendar_identifier}/delete` Deletes a custom calendar. | ThoughtSpot Cloud: _10.12.0.cl or later_ ThoughtSpot Software: _26.3.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fcustom-calendars%2Fdelete-calendar) | | `POST /api/rest/2.0/calendars/generate-csv` Exports a custom calendar in the CSV format. | ThoughtSpot Cloud: _10.12.0.cl or later_ ThoughtSpot Software: _26.3.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fcustom-calendars%2Fgenerate-csv) | | `POST /api/rest/2.0/calendars/search` Gets custom calendars for the connection ID specified in the API request. | ThoughtSpot Cloud: _10.12.0.cl or later_ ThoughtSpot Software: _26.3.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fcustom-calendars%2Fsearch-calendars) | | `POST /api/rest/2.0/calendars/{calendar_identifier}/update` Updates a custom calendar. | ThoughtSpot Cloud: _10.12.0.cl or later_ ThoughtSpot Software: _26.3.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fcustom-calendars%2Fupdate-calendar) | ## Data | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/searchdata` Generates results for the search query specified in the API request. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fdata%2Fsearch-data) | | `POST /api/rest/2.0/metadata/liveboard/data` Gets details of a Liveboard and its visualizations. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fdata%2Ffetch-liveboard-data) | | `POST /api/rest/2.0/metadata/answer/data` Gets Answer data from ThoughtSpot. You can fetch data for saved Answers only. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fdata%2Ffetch-answer-data) | ## DBT | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/dbt/dbt-connection` Creates a DBT connection object in ThoughtSpot. | ThoughtSpot Cloud: _9.10.0.cl or later_ ThoughtSpot Software: _10.0.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fdbt%2Fdbt-connection) | | `POST /api/rest/2.0/dbt/generate-tml` Creates TML for the given data objects and imports the TML data to ThoughtSpot. | ThoughtSpot Cloud: _9.10.0.cl or later_ ThoughtSpot Software: _10.0.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fdbt%2Fgenerate-tml) | | `POST /api/rest/2.0/dbt/generate-sync-tml` Resynchronizes the existing list of Models and Tables TML content for the specified DBT connection object and imports these to ThoughtSpot. | ThoughtSpot Cloud: _9.10.0.cl or later_ ThoughtSpot Software: _10.0.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fdbt%2Fgenerate-sync-tml) | | `POST /api/rest/2.0/dbt/search` Gets a list of DBT connection objects. | ThoughtSpot Cloud: _9.10.0.cl or later_ ThoughtSpot Software: _10.0.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fdbt%2Fdbt-connection) | | `POST /api/rest/2.0/dbt/{dbt_connection_identifier}` Updates a DBT connection object. | ThoughtSpot Cloud: _9.10.0.cl or later_ ThoughtSpot Software: _10.0.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fdbt%2Fupdate-dbt-connection) | ## Email customization | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/customization/email` Creates the customized configuration for the notification emails. | ThoughtSpot Cloud: _10.10.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Femail-customization%2Fcreate-email-customization) | | `POST /api/rest/2.0/customization/email/delete` Deletes the existing customized configuration set for the notification emails. | ThoughtSpot Cloud: _10.10.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Femail-customization%2Fdelete-org-email-customization) | | `POST /api/rest/2.0/customization/email/search` Searches the customized configuration set for the notification emails. | ThoughtSpot Cloud: _10.10.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Femail-customization%2Fsearch-email-customization) | | `POST /api/rest/2.0/customization/email/update` Updates an existing email customization set for the notification emails. | ThoughtSpot Cloud: _10.12.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Femail-customization%2Fupdate-email-customization) | | `POST /api/rest/2.0/customization/email/validate` Validates the customized configuration set for the notification emails. | ThoughtSpot Cloud: _10.10.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Femail-customization%2Fvalidate-email-customization) | ## Groups | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/groups/search` Gets details of one or several Groups. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fgroups%2Fsearch-user-groups) | | `POST /api/rest/2.0/groups/create` Creates a Group object. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fgroups%2Fcreate-user-group) | | `POST /api/rest/2.0/groups/{group_identifier}/update` Updates the object properties of a group. You can also use this API to add or remove users, sub-groups, and privileges. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fgroups%2Fupdate-user-group) | | `POST /api/rest/2.0/groups/{group_identifier}/delete` Removes a group object from ThoughtSpot. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fgroups%2Fdelete-user-group) | | `POST /api/rest/2.0/groups/import` Imports group objects from external databases into ThoughtSpot. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fgroups%2Fimport-user-groups) | ## Jobs | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/jobs/history/communication-channels/search` Gets information about the execution and delivery status for scheduled jobs such as webhook delivery. | ThoughtSpot Cloud: _26.4.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fjobs%2Fsearch-channel-history) | ## Logs | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/logs/fetch` Gets security audit logs from the ThoughtSpot system. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Flog%2Ffetch-logs) | ## Localizations | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/localizations/manual-translation/import` Imports a CSV file containing custom locale-specific translations for ThoughtSpot UI strings. New entries are inserted and existing entries are updated (upsert). | ThoughtSpot Cloud: _26.7.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmanual-translation%2Fimport-manual-translations) | | `POST /api/rest/2.0/localizations/manual-translation/export` Exports all manual translations for the specified org scope as a CSV file. | ThoughtSpot Cloud: _26.7.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmanual-translation%2Fexport-manual-translations) | | `POST /api/rest/2.0/localizations/manual-translation/locales/{locale}/export` Returns all manual translations for the specified locale as a JSON object. Accessible to all authenticated users. | ThoughtSpot Cloud: _26.7.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmanual-translation%2Fget-manual-translation-bundle) | | `POST /api/rest/2.0/localizations/manual-translation/delete` Deletes all manual translations for the specified org scope. | ThoughtSpot Cloud: _26.7.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmanual-translation%2Fdelete-manual-translations) | ## Metadata | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/metadata/worksheets/convert` Converts a Worksheet to a Model. | ThoughtSpot Cloud: _10.6.0.cl or later_ ThoughtSpot Software: _10.7.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmetadata%2Fconvert-worksheet-to-model) | | `POST /api/rest/2.0/metadata/copyobject` Creates a copy of an object. | ThoughtSpot Cloud: _10.6.0.cl or later_ ThoughtSpot Software: _10.7.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmetadata%2Fcopy-object) | | `POST /api/rest/2.0/metadata/delete` Removes a metadata object. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmetadata%2Fdelete-metadata) | | `POST /api/rest/2.0/metadata/tml/export` Exports TML representation of the metadata objects from ThoughtSpot in JSON or YAML format. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmetadata%2Fexport-metadata-tml) | | `POST /api/rest/2.0/metadata/tml/export/batch` Exports a complete set of TML for a user, user group, or Role object. | ThoughtSpot Cloud: _10.1.0.cl or later_ ThoughtSpot Software: _10.1.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmetadata%2Fexport-metadata-tml-batched) | | `POST /api/rest/2.0/metadata/answer/sql` Gets SQL query data for a saved Answer. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmetadata%2Ffetch-answer-sql-query) | | `POST /api/rest/2.0/metadata/tml/async/status` Gets status details for scheduled TML import tasks. | ThoughtSpot Cloud: _10.4.0.cl or later_ ThoughtSpot Software: _10.7.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmetadata%2Ffetch-async-import-task-status) | | `POST /api/rest/2.0/metadata/liveboard/sql` Gets SQL query data for the visualizations on a Liveboard. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmetadata%2Ffetch-liveboard-sql-query) | | `POST /api/rest/2.0/metadata/tml/import` Imports TML representation of the metadata objects into ThoughtSpot. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmetadata%2Fimport-metadata-tml) | | `POST /api/rest/2.0/metadata/tml/async/import` Schedules an asynchronous TML import task for the given objects. | ThoughtSpot Cloud: _10.4.0.cl or later_ ThoughtSpot Software: _10.7.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmetadata%2Fimport-metadata-tml-async) | | `POST /api/rest/2.0/metadata/search` Gets details of metadata objects from ThoughtSpot. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmetadata%2Fsearch-metadata) | | `POST /api/rest/2.0/metadata/parameterize-fields` Allows you to parameterize multiple fields for a given metadata object. | ThoughtSpot Cloud: _26.4.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmetadata%2Fparameterize-metadata-fields) | | `POST /api/rest/2.0/metadata/parameterize` DEPRECATED Allows you to parameterize fields in metadata objects. | ThoughtSpot Cloud: _10.9.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmetadata%2Fparameterize-metadata) | | `POST /api/rest/2.0/metadata/unparameterize` Beta Allows removing parameterization from fields in metadata objects | ThoughtSpot Cloud: _10.9.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmetadata%2Funparameterize-metadata) | | `POST /api/rest/2.0/metadata/headers/update` Updates the header attributes of a metadata object. | ThoughtSpot Cloud: _10.6.0.cl or later_ ThoughtSpot Software: _10.7.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fmetadata%2Fupdate-metadata-header) | | `POST /api/rest/2.0/metadata/update-obj-id` Updates object IDs for given metadata objects. | ThoughtSpot Cloud: _10.8.0.cl or later_ ThoughtSpot Software: _10.10.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints/metadata/update-metadata-obj-id) | ## Orgs | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/orgs/search` Gets a list of Orgs configured on the ThoughtSpot system. | ThoughtSpot Cloud: _9.2.0.cl or later_ ThoughtSpot Software: _Not Applicable_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Forgs%2Fsearch-orgs) | | `POST /api/rest/2.0/orgs/create` Creates an Org object. | ThoughtSpot Cloud: _9.2.0.cl or later_ ThoughtSpot Software: _Not Applicable_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Forgs%2Fcreate-org) | | `POST /api/rest/2.0/orgs/{org_identifier}/update` Modifies the object properties of an Org. | ThoughtSpot Cloud: _9.2.0.cl or later_ ThoughtSpot Software: _Not Applicable_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Forgs%2Fupdate-org) | | `POST /api/rest/2.0/orgs/{org_identifier}/delete` Deletes an Org object from ThoughtSpot. | ThoughtSpot Cloud: _9.2.0.cl or later_ ThoughtSpot Software: _Not Applicable_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Forgs%2Fdelete-org) | ## Reports | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/report/liveboard` Exports a Liveboard and its visualizations as a PDF or PNG file. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Freports%2Fexport-liveboard-report) | | `POST /api/rest/2.0/report/answer` Downloads a saved Answer in PDF, CSV, PNG, or XLSX format. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Freports%2Fexport-answer-report) | ## Roles | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/roles/search` Gets Role objects from ThoughtSpot. | ThoughtSpot Cloud: _9.5.0.cl or later_ ThoughtSpot Software: _Not applicable_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Froles%2Fsearch-roles) | | `POST /api/rest/2.0/roles/create` Creates a Role with a defined set of privileges. | ThoughtSpot Cloud: _9.5.0.cl or later_ ThoughtSpot Software: _Not applicable_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Froles%2Fcreate-role) | | `POST /api/rest/2.0/roles/{role_identifier}/update` Updates a Role object. | ThoughtSpot Cloud: _9.5.0.cl or later_ ThoughtSpot Software: _Not applicable_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Froles%2Fupdate-role) | | `POST /api/rest/2.0/roles/{role_identifier}/delete` Deletes a Role object. | ThoughtSpot Cloud: _9.5.0.cl or later_ ThoughtSpot Software: _Not applicable_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Froles%2Fdelete-role) | ## Schedules | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/schedules/create` Creates a Liveboard schedule job. | ThoughtSpot Cloud: _9.4.0.cl or later_ ThoughtSpot Software: _9.5.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fschedules%2Fcreate-schedule) | | `POST /api/rest/2.0/schedules/search` Gets details of the scheduled Liveboard jobs. | ThoughtSpot Cloud: _9.4.0.cl or later_ ThoughtSpot Software: _9.5.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fschedules%2Fsearch-schedules) | | `POST /api/rest/2.0/schedules/{schedule_identifier}/update` Updates a Liveboard job schedule. | ThoughtSpot Cloud: _9.4.0.cl or later_ ThoughtSpot Software: _9.5.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fschedules%2Fupdate-schedule) | | `POST /api/rest/2.0/schedules/{schedule_identifier}/delete` Deletes a scheduled Liveboard job. | ThoughtSpot Cloud: _9.4.0.cl or later_ ThoughtSpot Software: _9.5.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fschedules%2Fdelete-schedule) | ## Security | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/security/metadata/assign` Assigns a new author or changes the author of a metadata object. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsecurity%2Fassign-change-author) | | `POST /api/rest/2.0/security/column/rules/fetch` Fetches column security rules for the Tables specified in the API request. | ThoughtSpot Cloud: _10.12.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsecurity%2Ffetch-column-security-rules) | | `POST /api/rest/2.0/security/principals/fetch-permissions` Gets a list of objects that a user or group has access to. You can also specify the metadata type in the API request to fetch user permission details for Liveboards, Worksheets, or Answers. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsecurity%2Ffetch-permissions-of-principals) | | `POST /api/rest/2.0/security/metadata/fetch-object-privileges` Retrieves details of object-level privileges assigned to users or groups for a specified set of data objects. | ThoughtSpot Cloud: _26.3.0.cl or later_ ThoughtSpot Software: Not available | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsecurity%2Ffetch-object-privileges) | | `POST /api/rest/2.0/security/metadata/fetch-permissions` Gets access permission details for metadata objects. To get object access details for a user or group, specify the user or group identifiers. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsecurity%2Ffetch-permissions-on-metadata) | | `POST /api/rest/2.0/security/metadata/manage-object-privilege` Allows assigning object-level permissions to other users and groups and granting access to Spotter coaching information. | ThoughtSpot Cloud: _26.3.0.cl or later_ ThoughtSpot Software: Not available | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsecurity%2Fmanage-object-privilege) | | `POST /api/rest/2.0/security/metadata/publish` Beta Allows publishing metadata objects to one or several Orgs on an instance. | ThoughtSpot Cloud: _10.9.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsecurity%2Fpublish-metadata) | | `POST /api/rest/2.0/security/metadata/share` Allows sharing metadata objects, such as Liveboards, saved Answers, and Worksheets with another user or group in ThoughtSpot. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsecurity%2Fshare-metadata) | | `POST /api/rest/2.0/security/metadata/unpublish` Beta Removes published metadata objects from the Orgs specified in the API request. | ThoughtSpot Cloud: _10.9.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsecurity%2Funpublish-metadata) | | `POST /api/rest/2.0/security/column/rules/update` Adds or updates column security rules applied on the Table specified in the API request. | ThoughtSpot Cloud: _10.12.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsecurity%2Fupdate-column-security-rules) | ## Style customization | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/customization/styles/search` Gets the current style configuration at the cluster and active Org scope. | ThoughtSpot Cloud: _26.7.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fstyle-customization%2Fsearch-style-customizations) | | `POST /api/rest/2.0/customization/styles/update` Updates style settings such as the navigation panel color, chart color palette, logos, embedded footer text, and visualization font assignments at the cluster or Org scope. | ThoughtSpot Cloud: _26.7.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fstyle-customization%2Fupdate-style-customization) | | `POST /api/rest/2.0/customization/styles/fonts/upload` Uploads a custom font file to ThoughtSpot. | ThoughtSpot Cloud: _26.7.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fstyle-customization%2Fupload-style-font) | | `POST /api/rest/2.0/customization/styles/fonts/search` Gets custom fonts uploaded to the ThoughtSpot instance. | ThoughtSpot Cloud: _26.7.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fstyle-customization%2Fsearch-style-fonts) | | `PUT /api/rest/2.0/customization/styles/fonts/{font_identifier}/update` Updates the display name, weight, style, or color of an existing custom font. | ThoughtSpot Cloud: _26.7.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fstyle-customization%2Fupdate-style-font) | | `POST /api/rest/2.0/customization/styles/fonts/delete` Deletes one or more custom fonts from the font library. | ThoughtSpot Cloud: _26.7.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fstyle-customization%2Fdelete-style-fonts) | | `POST /api/rest/2.0/customization/styles/logos/export` Exports the current logo files as a ZIP archive. | ThoughtSpot Cloud: _26.7.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fstyle-customization%2Fexport-style-logos) | ## System | API endpoint | Release version | Playground link | | --- | --- | --- | | `Get System Information` Gets system information of your current logged-in cluster. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http/api-endpoints/system/get-system-information) | | `GET /api/rest/2.0/system` Gets details of the current configuration running on your cluster. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http/api-endpoints/system/get-system-config) | | `GET /api/rest/2.0/system/config-overrides` Gets details of the configuration overrides on your cluster. | ThoughtSpot Cloud: _9.2.0.cl or later_ ThoughtSpot Software: _9.5.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http/api-endpoints/system/get-system-override-info) | | `POST /api/rest/2.0/system/config-update` Updates the current configuration of your instance. | ThoughtSpot Cloud: _9.2.0.cl or later_ ThoughtSpot Software: _9.5.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http/api-endpoints/system/update-system-config) | | `POST /api/rest/2.0/system/preferences/communication-channels/configure` Allows configuring communication channel preferences. | ThoughtSpot Cloud: _10.14.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsystem%2Fconfigure-communication-channel-preferences) | | `POST /api/rest/2.0/system/communication-channels/validate` Validates a communication channel, for example, a webhook connection. | ThoughtSpot Cloud: _26.4.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsystem%2Fvalidate-communication-channel) | | `POST /api/rest/2.0/system/preferences/communication-channels/search` Allows searching communication channel preferences. | ThoughtSpot Cloud: _10.14.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsystem%2Fsearch-communication-channel-preferences) | | `POST /api/rest/2.0/system/security-settings/configure` Allows configuring security settings. | ThoughtSpot Cloud: _26.2.0.cl or later_ ThoughtSpot Software: _26.3.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsystem%2Fconfigure-security-settings) | | `POST /api/rest/2.0/system/security-settings/search` Allows fetching security settings. | ThoughtSpot Cloud: _26.2.0.cl or later_ ThoughtSpot Software: _26.3.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsystem%2Fsearch-security-settings) | ## Tags | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/tags/search` Gets details of tag objects from ThoughtSpot. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Ftags%2Fsearch-tags) | | `POST /api/rest/2.0/tags/create` Creates a tag object in ThoughtSpot. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Ftags%2Fcreate-tag) | | `POST /api/rest/2.0/tags/{tag_identifier}/update` Modifies the object properties of a tag. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Ftags%2Fupdate-tag) | | `POST /api/rest/2.0/tags/{tag_identifier}/delete` Deletes a tag object from ThoughtSpot. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Ftags%2Fdelete-tag) | | `POST /api/rest/2.0/tags/assign` Assigns a tag to metadata objects. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Ftags%2Fassign-tag) | | `POST /api/rest/2.0/tags/unassign` Removes the tag assigned to a metadata object. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Ftags%2Funassign-tag) | ## Users | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/users/search` Gets details of one or several ThoughtSpot users. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fusers%2Fsearch-users) | | `POST /api/rest/2.0/users/create` Creates a user. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fusers%2Fcreate-user) | | `POST /api/rest/2.0/users/{user_identifier}/update` Updates the properties of a user object. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fusers%2Fupdate-user) | | `POST /api/rest/2.0/users/{user_identifier}/delete` Deletes a user object from ThoughtSpot. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fusers%2Fdelete-user) | | `POST /api/rest/2.0/users/import` Imports users from an external database to ThoughtSpot. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fusers%2Fimport-users) | | `POST /api/rest/2.0/users/change-password` Allows ThoughtSpot users to change the password of their account. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http/api-endpoints/users/change-user-password) | | `POST /api/rest/2.0/users/reset-password` Resets the password of a user account. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http/api-endpoints/users/reset-user-password) | | `POST /api/rest/2.0/users/force-logout` Logs out users from their current sessions. | ThoughtSpot Cloud: _9.0.0.cl or later_ ThoughtSpot Software: _9.0.1.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fusers%2Fforce-logout-users) | | `POST /api/rest/2.0/users/activate` Activates a deactivated user account. | ThoughtSpot Cloud: _9.7.0.cl or later_ ThoughtSpot Software: _9.8.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fusers%2Factivate-user) | | `POST /api/rest/2.0/users/deactivate` Deactivates a user account. | ThoughtSpot Cloud: _9.7.0.cl or later_ ThoughtSpot Software: _9.8.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fusers%2Fdeactivate-user) | ## Version control | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/vcs/git/config/search` Gets Git repository connections configured on the ThoughtSpot instance. | ThoughtSpot Cloud: _9.2.0.cl or later_ ThoughtSpot Software: _9.5.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fversion-control%2Fsearch-config) | | `POST /api/rest/2.0/vcs/git/commits/search` Gets Git commit history for a given metadata object. | ThoughtSpot Cloud: _9.2.0.cl or later_ ThoughtSpot Software: _9.5.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fversion-control%2Fsearch-commits) | | `POST /api/rest/2.0/vcs/git/config/create` Connects your ThoughtSpot instance to a Git repository. | ThoughtSpot Cloud: _9.2.0.cl or later_ ThoughtSpot Software: _9.5.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fversion-control%2Fcreate-config) | | `POST /api/rest/2.0/vcs/git/config/update` Updates the Git repository settings configured for a ThoughtSpot instance. | ThoughtSpot Cloud: _9.2.0.cl or later_ ThoughtSpot Software: _9.5.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fversion-control%2Fupdate-config) | | `POST /api/rest/2.0/vcs/git/config/delete` Deletes the Git repository configuration. | ThoughtSpot Cloud: _9.2.0.cl or later_ ThoughtSpot Software: _9.5.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fversion-control%2Fdelete-config) | | `POST /api/rest/2.0/vcs/git/branches/commit` Commits TML files to the Git branch configured on your instance. | ThoughtSpot Cloud: _9.2.0.cl or later_ ThoughtSpot Software: _9.5.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fversion-control%2Fcommit-branch) | | `POST /api/rest/2.0/vcs/git/commits/{commit_id}/revert` Reverts to a previous commit in the Git branch. | ThoughtSpot Cloud: _9.2.0.cl or later_ ThoughtSpot Software: _9.5.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fversion-control%2Frevert-commit) | | `POST /api/rest/2.0/vcs/git/branches/validate` Validates the content of your source branch against the objects in your destination environment and identifies merge conflicts. | ThoughtSpot Cloud: _9.2.0.cl or later_ ThoughtSpot Software: _9.5.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fversion-control%2Fvalidate-merge) | | `POST /api/rest/2.0/vcs/git/commits/deploy` Deploys commits to the destination environment (`Staging` or `Production`). | ThoughtSpot Cloud: _9.2.0.cl or later_ ThoughtSpot Software: _9.5.0.sw or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fversion-control%2Fdeploy-commit) | ## Variable Beta | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/template/variables/create` Allows creating a template variable. | ThoughtSpot Cloud: _10.9.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fvariable%2Fcreate-variable) | | `POST /api/rest/2.0/template/variables/search` Allows searching template variables. | ThoughtSpot Cloud: _10.9.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fvariable%2Fsearch-variables) | | `POST /api/rest/2.0/template/variables/update` DEPRECATED Allows you to add, remove, or replace properties of one or several template variables. | ThoughtSpot Cloud: _10.9.0.cl or later_ | Not available in the Playground | | `POST /api/rest/2.0/template/variables/{identifier}/update` Allows updating properties of a variable. | ThoughtSpot Cloud: _10.9.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fvariable%2Fupdate-variable) | | `POST /api/rest/2.0/template/variables/{identifier}/update-values` Allows you to assign, modify, replace, or reset variable values, and define the Org and object scope for each set of variable values. | ThoughtSpot Cloud: _26.4.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fvariable%2Fput-variable-values) | | `POST /api/rest/2.0/template/variables/delete` Deletes one or more template variables. | ThoughtSpot Cloud: _26.4.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fvariable%2Fdelete-variables) | | `POST /api/rest/2.0/template/variables/update-values` DEPRECATED Allows updating properties of one or several variables. | ThoughtSpot Cloud: _10.9.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fvariable%2Fupdate-variable-values) | | `POST /api/rest/2.0/template/variables/{identifier}/delete` DEPRECATED Deletes a template variable. | ThoughtSpot Cloud: _10.9.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fvariable%2Fdelete-variable) | ## Webhooks Beta | API endpoint | Release version | Playground link | | --- | --- | --- | | `POST /api/rest/2.0/webhooks/create` Allows creating a webhook and configuring a destination endpoint for webhook payloads. | ThoughtSpot Cloud: _10.14.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fwebhooks%2Fcreate-webhook-configuration) | | `POST /api/rest/2.0/webhooks/search` Retrieves webhook objects. | ThoughtSpot Cloud: _10.14.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fwebhooks%2Fsearch-webhook-configurations) | | `GET /api/rest/2.0/webhooks/storage-config` Retrieves the AWS S3 storage destination configuration for a webhook. Returns data only if the webhook has a storage destination configured. Requires `ADMINISTRATION` or `DEVELOPER` privilege. | ThoughtSpot Cloud: _26.7.0.cl or later_ ThoughtSpot Software: _Not available_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fwebhooks%2Fget-webhook-storage-config) | | `POST /api/rest/2.0/webhooks/{webhook_identifier}/update` Allows you to edit properties of a webhook object. | ThoughtSpot Cloud: _10.14.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fwebhooks%2Fupdate-webhook-configuration) | | `POST /api/rest/2.0/webhooks/delete` Deletes a webhook object. | ThoughtSpot Cloud: _10.14.0.cl or later_ | [Try it out]({{navprefix}}/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fwebhooks%2Fdelete-webhook-configurations) |