Tableau Jobs API
Query and cancel background jobs on a site, including extract refreshes, subscriptions, and flow runs.
Tableau Jobs 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 Jobs. 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 3 operations across 2 paths, and defines 4 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}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Tableau Jobs 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 3
Across 2 paths, the API surfaces 3 operations — 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Query and cancel background jobs on a site, including extract refreshes, subscriptions, and flow runs.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Job (13 properties), Pagination (3 properties), JobListResponse (2 properties), JobResponse (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Tableau 12
Other APIs Tableau publishes across the network.