Download OpenAPI specification:Download
Versions: Tableau Server 2021.1 / Tableau Cloud March 2022 and later
This documentation describes the growing number OpenAPI endpoints being released alongside more than 150 classic REST endpoints that are currently in wide usage in the Tableau community.
There are some differences users of the classic endpoints will recognize when viewing these new endpoints.
Request bodies for these new REST endpoints must be formatted using JSON.
Endpoint URIs may contain a hyphen ('-') instead of an API version number, indicating that the resource is versioned separately from the numbered API release. For more information, see REST API and Resource Versions.
Starting in Tableau Server 2022.1 / Tableau Cloud March 2022, differences between releases will be noted in this reference.To view the previous version of this reference, see Tableau REST API OpenAPI Endpoints (v2021.4).
Enable and configure analytics extensions on sites and, for on premise installations, on servers. With these extensions you can extend Tableau dynamic calculations with languages like R and python, and with other tools and platforms. For more information, see Analytics Extensions API.
When upgrading from a server version less than 2020.2, analytics extensions must be enabled on each site even if external services were enabled on the server being upgraded. Connections for sites must be ported manually.
Using the analytics extensions settings methods you can:
Get the details of a specified analytics extension connection to an external service.
Version: Available in API 3.11 (Tableau Cloud March 2021/ Server 2021.1) and later. Versioning Overview
Permissions: Can only be called by users with site or server administrator permissions. Permissions Overview
License: No additional license required.
Access Scope: Not available.
Access Scopes Overview: Cloud | Server-Windows | Server-Linux
connection_luid required | string |
X-Tableau-Auth | string The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource. |
{- "connection_luid": "string",
- "host": "string",
- "port": 0,
- "is_auth_enabled": true,
- "username": "string",
- "password": "string",
- "is_ssl_enabled": true,
- "connection_brief": {
- "connection_name": "string",
- "connection_type": "UNDEFINED"
}
}
Updates the details of specified analytics extension connection for an external service to a site.
Version: Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. Versioning Overview
Permissions: Can only be called by users with site or server administrator permissions. Permissions Overview
License: No additional license required.
Access Scope: Not available.
Access Scopes Overview: Cloud | Server-Windows | Server-Linux
connection_luid required | string |
X-Tableau-Auth | string The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource. |
connection_luid | string |
host | string Required. The location of an external service (TabPy, Rserve, EINSTEIN_DISCOVERY, Generic API, or other) that responds to your analytics extension requests. The case sensitive value must be a URI, IPv4 or IPv6 address that is a maximum of 255 Unicode characters. Starting in Tableau Server 2022.1 / Tableau Cloud April 2022, a host address can include path information ( |
port | integer <int32> Required. Integer between 1 and 65535. |
is_auth_enabled | boolean For Tableau Cloud: The value is always true. For on premise Tableau servers: Optional. Set to true if authentication is enabled on the external service. If true, username and password are required. Default is false. |
username | string For Tableau Cloud: A username is always required. |
password | string For Tableau Cloud: A password is always required. |
is_ssl_enabled | boolean For Tableau Cloud: The value is always true. For on premise Tableau servers: Optional. Set to true if authentication is enabled on the external service. If true, username and password are required. Default is false. |
object (tableau.analyticsextensions.v1.ConnectionBrief) |
{- "connection_luid": "string",
- "host": "string",
- "port": 0,
- "is_auth_enabled": true,
- "username": "string",
- "password": "string",
- "is_ssl_enabled": true,
- "connection_brief": {
- "connection_name": "string",
- "connection_type": "UNDEFINED"
}
}
{- "connection_luid": "string",
- "host": "string",
- "port": 0,
- "is_auth_enabled": true,
- "username": "string",
- "password": "string",
- "is_ssl_enabled": true,
- "connection_brief": {
- "connection_name": "string",
- "connection_type": "UNDEFINED"
}
}
Deletes a specific analytics extension connection for an external service from a site.
Version: Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. Versioning Overview
Permissions: Can only be called by users with site or server administrator permissions. Permissions Overview
License: No additional license required.
Access Scope: Not available.
Access Scopes Overview: Cloud | Server-Windows | Server-Linux
connection_luid required | string |
X-Tableau-Auth | string The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource. |
{- "httpErrorCode": "string",
- "message": "string"
}
Lists basic details of each analytics extension connection available for a specified workbook, including connection type and name.
Version: Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. Versioning Overview
Permissions: This method can be called by users that have permissions to the specified workbook. Permissions Overview
License: No additional license required.
Access Scope: Not available.
Access Scopes Overview: Cloud | Server-Windows | Server-Linux
workbook_luid required | string |
X-Tableau-Auth | string The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource. |
{- "connectionMetadataList": [
- {
- "connection_luid": "string",
- "connection_brief": {
- "connection_name": "string",
- "connection_type": "UNDEFINED"
}
}
]
}