{
"opencollection": "1.0.0",
"info": {
"name": "ThoughtSpot Public REST 10.1.0.cl 10.14.0.cl API",
"version": "2.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "10.14.0.cl",
"type": "folder"
},
"items": [
{
"info": {
"name": "configureCommunicationChannelPreferences",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/system/preferences/communication-channels/configure",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\nBeta Version: 10.14.0.cl or later\n\nConfigure communication channel preferences.\n- Use `cluster_preferences` to update the default preferences for your ThoughtSpot application instance.\n- If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), use `org_preferences` to specify Org-specific preferences that override the defaults.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVE"
},
{
"info": {
"name": "searchCommunicationChannelPreferences",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/system/preferences/communication-channels/search",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\nBeta Version: 10.14.0.cl or later\n\nFetch communication channel preferences.\n- Use `cluster_preferences` to fetch the default preferences for your ThoughtSpot application instance.\n- If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), use `org_preferences` to fetch any Org-specific preferences that override the defaults.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOP"
},
{
"info": {
"name": "deleteVariable",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/template/variables/:identifier/delete",
"params": [
{
"name": "identifier",
"value": "",
"type": "path",
"description": "Unique id or name of the variable"
}
]
},
"docs": "\nDelete a variable
Version: 10.14.0.cl or later\n\n**Note:** This API endpoint is deprecated and will be removed from ThoughtSpot in a future release. Use [POST /api/rest/2.0/template/variables/delete](/api/rest/2.0/template/variables/delete) instead.\n\nAllows deleting a variable from ThoughtSpot.\n\nRequires ADMINISTRATION role and TENANT scope.\nThe CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope.\n\nTh"
},
{
"info": {
"name": "updateVariableValues",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/template/variables/update-values",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\nUpdate values for multiple variables
Version: 10.14.0.cl or later\n\n**Note:** This API endpoint is deprecated and will be removed from ThoughtSpot in a future release. Use [POST /api/rest/2.0/template/variables/{identifier}/update-values](/api/rest/2.0/template/variables/%7Bidentifier%7D/update-values) instead.\n\nAllows updating values for multiple variables in ThoughtSpot.\n\nRequires ADMINISTRATION role.\nThe CAN_MANAGE_VARIABLES permission allows you to "
},
{
"info": {
"name": "createWebhookConfiguration",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/webhooks/create",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Version: 10.14.0.cl or later\n\nCreates a new webhook configuration to receive notifications for specified events. The webhook will be triggered when the configured events occur in the system.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can ma"
},
{
"info": {
"name": "deleteWebhookConfigurations",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/webhooks/delete",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Version: 10.14.0.cl or later\n\nDeletes one or more webhook configurations by their unique id or name. Returns status of each deletion operation, including successfully deleted webhooks and any failures with error details.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `"
},
{
"info": {
"name": "searchWebhookConfigurations",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/webhooks/search",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Version: 10.14.0.cl or later\n\nSearches for webhook configurations based on various criteria such as Org, webhook identifier, event type, with support for pagination and sorting. Returns matching webhook configurations with their complete details.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on y"
},
{
"info": {
"name": "updateWebhookConfiguration",
"type": "http"
},
"http": {
"method": "POST",
"url": "{base-url}/api/rest/2.0/webhooks/:webhook_identifier/update",
"params": [
{
"name": "webhook_identifier",
"value": "",
"type": "path",
"description": "Unique ID or name of the webhook configuration."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "\n Version: 10.14.0.cl or later\n\nUpdates an existing webhook configuration by its unique id or name. Only the provided fields will be updated.\n\nRequires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to p"
}
]
}
],
"bundled": true
}