Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tableau Data Sources API

Publish, query, update, delete, and download data sources. Data sources define the connection to data and can be shared across multiple workbooks.

Tableau Data Sources API is one of 25 APIs that Tableau publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Data Sources. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, authentication docs, a changelog, a getting-started guide, and 1 JSON Schema.

This API exposes 11 operations across 7 paths, and defines 16 schemas. It is described by OpenAPI 3.1.0, at version 3.24.0.

Requests are made against a single base URL, https://{server}/api/{api-version}.

11 operations 7 paths 16 schemas 1 DELETE7 GET3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.24.0
Base URL
https://[server]/api/[api-version]
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Tableau Data Sources API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Tableau-Auth (TableauAuth). By default, every request must be authenticated.

  • TableauAuth — The authentication token obtained from the Sign In method. Include this token in the X-Tableau-Auth header of all subsequent requests.

Paths & Operations 11

Across 7 paths, the API surfaces 11 operations — 1 DELETE, 7 GET, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Data Sources 11

Publish, query, update, delete, and download data sources. Data sources define the connection to data and can be shared across multiple workbooks.

GET
/sites/{site-id}/datasources
Tableau Query Data Sources
queryDataSources 6 params → 200401403
GET
/sites/{site-id}/datasources/{datasource-id}
Tableau Query Data Source
queryDataSource 2 params → 200401403404
PUT
/sites/{site-id}/datasources/{datasource-id}
Tableau Update Data Source
updateDataSource 2 params body → 200400401403404
DELETE
/sites/{site-id}/datasources/{datasource-id}
Tableau Delete Data Source
deleteDataSource 2 params → 204401403404
GET
/sites/{site-id}/datasources/{datasource-id}/content
Tableau Download Data Source
downloadDataSource 3 params → 200401403404
GET
/sites/{site-id}/datasources/{datasource-id}/connections
Tableau Query Data Source Connections
queryDataSourceConnections 2 params → 200401403404
GET
/sites/{site-id}/datasources/{datasource-id}/revisions
Tableau Get Data Source Revisions
getDataSourceRevisions 4 params → 200
GET
/sites/{site-id}/datasources/{datasource-id}/tags
Tableau Query Data Source Tags
queryDataSourceTags 2 params → 200
PUT
/sites/{site-id}/datasources/{datasource-id}/tags
Tableau Add Tags to Data Source
addTagsToDataSource 2 params body → 200
GET
/sites/{site-id}/datasources/{datasource-id}/permissions
Tableau Query Data Source Permissions
queryDataSourcePermissions 2 params → 200
PUT
/sites/{site-id}/datasources/{datasource-id}/permissions
Tableau Add Data Source Permissions
addDataSourcePermissions 2 params body → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are DataSource (15 properties), Revision (6 properties), Connection (6 properties), Pagination (3 properties). Each schema is shown below with its type and property counts.

DataSourceListResponse
object
2 properties
AddPermissionsRequest
object
1 property
PermissionListResponse
object
2 properties
ErrorResponse
object
1 property
Tag
object
1 property
Pagination
object
3 properties
ConnectionListResponse
object
1 property
RevisionListResponse
object
2 properties
Revision
object
6 properties
Permission
object
1 property
DataSource
object
15 properties
TagListResponse
object
1 property
TagListRequest
object
1 property
UpdateDataSourceRequest
object
1 property
DataSourceResponse
object
1 property
Connection
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tableau-data-sources-api-openapi.yml Raw ↑

Other APIs Tableau publishes across the network.

Tableau Metadata API
Tableau Hyper API
Tableau Embedding API
Tableau Document API
Tableau Server Client (Python)
Tableau Extensions API
Tableau Web Data Connector
Tableau Connector SDK
Tableau Analytics Extensions API
Tableau Webhooks
Tableau VizQL Data Service
Tableau Pulse API