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 Sites API

Manage sites on Tableau Server. A site is a collection of users, groups, projects, workbooks, data sources, and other resources.

Tableau Sites 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 Sites. 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 5 operations across 2 paths, and defines 7 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}.

5 operations 2 paths 7 schemas 1 DELETE2 GET1 POST1 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 Sites 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 5

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

Sites 5

Manage sites on Tableau Server. A site is a collection of users, groups, projects, workbooks, data sources, and other resources.

GET
/sites
Tableau Query Sites
querySites 2 params → 200401403
POST
/sites
Tableau Create Site
createSite body → 201400401403409
GET
/sites/{site-id}
Tableau Query Site
querySite 2 params → 200401403404
PUT
/sites/{site-id}
Tableau Update Site
updateSite 1 param body → 200400401403404
DELETE
/sites/{site-id}
Tableau Delete Site
deleteSite 1 param → 204401403404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Site (13 properties), Pagination (3 properties), SiteListResponse (2 properties), CreateSiteRequest (1 property). Each schema is shown below with its type and property counts.

UpdateSiteRequest
object
1 property
Pagination
object
3 properties
Site
object
13 properties
SiteResponse
object
1 property
ErrorResponse
object
1 property
SiteListResponse
object
2 properties
CreateSiteRequest
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tableau-sites-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