Get Workspace Extensions
Lists the workspace extensions installed in the connected Tableau Studio instance, including disabled ones. Each entry's id stays the same across sessions and is the value reload-workspace-extension passes as extensionId. The tool returns the list from the External Client API: an extensions array whose entries include id, name, author, isEnabled, and extensionKey (id, version, and url). isEnabled is false for a disabled extension, and that entry is still in the list. This is a read-only, idempotent call.
APIs called
This tool reads workspace extensions from the running Tableau Studio instance, not from the Tableau Cloud or Tableau Server REST API. Under the hood this is a call to the local Tableau Studio External Client API — a REST API the running Tableau Studio instance serves at http://127.0.0.1:<port>/v<x> over the loopback interface, where <x> is the latest API version. Because this API is local rather than a cloud service, it uses no OAuth scopes; the call is authorized instead by the running Tableau Studio instance's per-session bearer token over the loopback interface.
- Lists the workspace extensions installed in the instance, including disabled ones. Authorized by the session's loopback bearer token.
GET /v0/app/extensions— list installed workspace extensions. [API reference link TBD]
Optional arguments
session
Identifier of the target Tableau Studio session. Type: string. Optional when a session is pinned or when it is the only running instance. When session is omitted, blank, or default, the tool uses the pinned session if one is set, and otherwise the sole running instance. An explicit session selects that instance, including when a different session is pinned.
Example
"studio-1"
With no session to resolve — none pinned, and either no running instance or more than one — the tool refuses instead of choosing. The multiple-instance refusal lists the session ids and points at list-instances. A session that is not among the running instances is refused as well.
Notes and caveats
- This tool is left out when the connected External Client API version is known to be older than 0.2.34. The compared version is the pinned session's version, or, when no session is pinned, the highest version among running instances. An unknown version leaves the tool available.
- When the list call is not found, the tool returns
This Tableau Desktop build does not serve the GET /v0/app/extensions endpoint yet. Tell the user their Desktop build is too old for this read and that a Desktop update enables it. Do not retry.
Example results
No workspace extensions
{
"extensions": []
}
Enabled and disabled extensions
{
"extensions": [
{
"id": "ws-ext-enabled",
"extensionKey": {
"id": "com.example.enabled",
"version": "1.2.0",
"url": "file:///Packages/a/index.html"
},
"name": "Enabled Extension",
"author": "Example Co",
"isEnabled": true
},
{
"id": "ws-ext-disabled",
"extensionKey": {
"id": "com.example.disabled",
"version": "0.1.0",
"url": "file:///Packages/b/index.html"
},
"name": "Disabled Extension",
"author": "Example Co",
"isEnabled": false
}
]
}
Related
reload-workspace-extension— reloads one listed extension by the stableidfrom this list