API Reference for Tableau Resource Versioned RESTful Endpoints (2021.2)

Download OpenAPI specification:Download

The following OpenAPI documentation describes the details of the new Tableau RESTful APIs. A growing number of these are 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 don't contain an API version number. For more information, see REST API and Resource Versions.

Analytics Extensions Settings Methods

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:

  • Enable and disable analytics extensions for a Tableau server (on-premise only) or for a site.
  • Create and manage an extension's connections to the service hosting your custom calculations.

Get analytics extension details

Get the details of a specified analytics extension connection to an external service. Permissions - This method can only be called by users with server or site administrator permissions.

path Parameters
connection_luid
required
string
header Parameters
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.

Responses

Response samples

Content type
application/vnd.tableau.analyticsextensions.v1.ConnectionItem+json
{
  • "connection_luid": "string",
  • "host": "string",
  • "port": 0,
  • "is_auth_enabled": true,
  • "username": "string",
  • "password": "string",
  • "is_ssl_enabled": true,
  • "connection_brief": {
    }
}

Update analytics extension connection of site

Updates the details of specified analytics extension connection for an external service to a site. Permissions - This method can be called by site and server administrators.

path Parameters
connection_luid
required
string
header Parameters
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.

Request Body schema: application/vnd.tableau.analyticsextensions.v1.ConnectionItem+json
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.

port
integer <int32>

Required. Integer between 1 and 65535.

is_auth_enabled
boolean

For Tableau Online: 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 Online: A username is always required.

password
string

For Tableau Online: A password is always required.

is_ssl_enabled
boolean

For Tableau Online: 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)

Responses

Request samples

Content type
application/vnd.tableau.analyticsextensions.v1.ConnectionItem+json
{
  • "connection_luid": "string",
  • "host": "string",
  • "port": 0,
  • "is_auth_enabled": true,
  • "username": "string",
  • "password": "string",
  • "is_ssl_enabled": true,
  • "connection_brief": {
    }
}

Response samples

Content type
application/vnd.tableau.analyticsextensions.v1.ConnectionItem+json
{
  • "connection_luid": "string",
  • "host": "string",
  • "port": 0,
  • "is_auth_enabled": true,
  • "username": "string",
  • "password": "string",
  • "is_ssl_enabled": true,
  • "connection_brief": {
    }
}

Delete analytics extension connection from site

Deletes a specific analytics extension connection for an external service from a site. Permissions - This method can be called by site and server administrators.

path Parameters
connection_luid
required
string
header Parameters
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.

Responses

Response samples

Content type
application/json
null

List analytics extension connections of workbook

Lists basic details of each analytics extension connection available for a specified workbook, including connection type and name. Permissions - This method can be called by users that have permissions to the specified workbook.

path Parameters
workbook_luid
required
string
header Parameters
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.

Responses