Returns information about the running Tableau Studio process, including its version, edition, build, operating system, locale, and repository and log paths.

Opens a local file by path. A .twb/.twbx opens as a workbook; a datasource file (Excel, text, spatial, extract, .tds, and the like) attaches to the open workbook, creating one if none is open. An extension Tableau cannot open is rejected before dispatch. Note: opening a workbook when one is already open launches it in a NEW Studio window, and this API session stays bound to the workbook it started with -- GET /v0/workbook continues to report the original, not the newly opened one.

Sets whether the Tableau Studio start page is visible and returns the resulting visibility. Repeated requests for the same visibility have no additional effect.

Lists the dashboards contained in the open workbook.

Returns the metadata for a single dashboard in the open workbook identified by its id.

Returns a single dashboard from the open workbook serialized as a Tableau XML subtree.

Replaces a single dashboard with the submitted Tableau XML, leaving the workbook's other sheets intact. The payload is checked for well-formed XML only and is NOT validated against the schema; use POST /v0/workbook/document:validate for XSD validation. This apply is unconditional last-writer-wins: it performs no precondition/If-Match check and will overwrite a concurrent edit to the same sheet. A concurrent rename of the target sheet is rejected as a failed operation (Tableau error 0xC655862E).

Renders a single dashboard (resolved by id) as an image, returned inline as base64 or written to a caller-supplied file path.

Deletes a single dashboard by id. Deleting the workbook's last visible sheet is a no-op.

Pauses automatic query execution for a dashboard so several edits can be batched before the next refresh.

Renames a dashboard identified by id.

Resumes automatic query execution for a dashboard.

Creates a single blank dashboard with a generated name. Any request body is ignored.

Refreshes the live data for the datasource resolved by {id} (its internal name from GET /v0/workbook/datasources) the way the toolbar Refresh Data Source does: it lowers the query-cache timestamp and clears the mapped-image cache, then re-fetches the datasource from its source. This is NOT an extract refresh -- if the datasource is backed by an extract, the data stays fresh only through the extract's metadata date. A datasource with no data connection to refresh is a no-op SUCCEEDED Operation.

Kicks off an extract refresh on the datasource resolved by {id} (its internal name from GET /v0/workbook/datasources). By default the refresh is incremental when the extract supports it; send isFullRefresh=true to force a full refresh. A datasource that has no refreshable extract is a no-op SUCCEEDED Operation.

Lists in-flight and recently-completed async operations.

Polls a single async operation by id until it reaches a terminal state.

Returns the RFC 9728 OAuth Protected Resource Metadata document, which advertises the authorization servers and bearer methods that clients use to authenticate against this loopback API.

Returns the OpenAPI 3.1 document that formally describes every resource, operation, and schema exposed by this API.

Returns the API and application version strings together with a link map that points to the available top-level resources.

Returns a liveness probe result that confirms the External Client API is running and able to serve requests.

Returns the Tableau site that the current user is signed in to, or a 404 response when no site is connected.

Lists the datasources that have been published to the connected Tableau site.

Lists the workbooks that have been published to the connected Tableau site.

Lists the storyboards contained in the open workbook.

Returns the metadata for a single storyboard in the open workbook identified by its id.

Returns a single storyboard from the open workbook serialized as a Tableau XML subtree.

Replaces a single storyboard with the submitted Tableau XML, leaving the workbook's other sheets intact. The payload is checked for well-formed XML only and is NOT validated against the schema; use POST /v0/workbook/document:validate for XSD validation. This apply is unconditional last-writer-wins: it performs no precondition/If-Match check and will overwrite a concurrent edit to the same sheet. A concurrent rename of the target sheet is rejected as a failed operation (Tableau error 0xC655862E).

Renders a storyboard's active story point (resolved by id) as an image, returned inline as base64 or written to a caller-supplied file path.

Deletes a single storyboard by id. Deleting the workbook's last visible sheet is a no-op.

Renames a storyboard identified by id.

Creates a single blank storyboard with a generated name. Any request body is ignored.

Returns the metadata and sheet inventory of the workbook currently open in Tableau Studio, or a 404 response when no workbook is open.

Lists the datasources that the open workbook uses.

Returns metadata for a single datasource by its URL-encoded inventory id.

Returns the datasource's local workbook representation as a Tableau XML subtree.

Replaces one datasource's local workbook representation with the submitted Tableau XML, leaving all other datasources and sheets intact. A missing or empty body is rejected with 400 and a non-XML Content-Type with 415. Malformed or invalid workbook XML is rejected with 422. The payload must contain exactly one datasource whose internal name matches {id}; a mismatch is rejected with 409. The apply is unconditional last-writer-wins and does not publish changes to a server-side datasource.