Skip to main content

Reload a Workspace Extension

Available November 2026 and later.

Reloads one workspace extension from the repository Packages folder in the connected Tableau Studio instance, so a new or changed extension shows up in the Extensions menu and toolbar, and reloads any of its open pages without opening new ones. It also removes Packages extensions that are no longer in that folder. Name the extension with extensionId, the stable id from get-workspace-extensions. When the reload finishes, the result message says the extension was reloaded. When it has been accepted and is still being applied, the message says the reload was requested. The call is idempotent.

Not read-only

This tool is not read-only. It reloads the named workspace extension in the live Tableau Studio session and can remove Packages extensions that are no longer in the repository Packages folder.

APIs called​

This tool reloads a workspace extension in the running Tableau Studio instance, not through 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.

  • Reloads the workspace extension named by extensionId from the repository Packages folder, refreshes its open pages without opening new ones, and removes Packages extensions that are no longer in that folder. The request has no body. The id is percent-encoded in the path, so ab12 cd is sent as ab12%20cd. Authorized by the session's loopback bearer token.
    • POST /v0/app/extensions/{id}:reload — reload one workspace extension. [API reference link TBD]

Required arguments​

extensionId​

The workspace extension to reload. Type: string. Minimum length: 1. Use the id from get-workspace-extensions. That id stays the same across sessions. The extension's name and its extensionKey.id are different values.

Example​

{ "extensionId": "ab12 cd" }
note

When no installed extension has that id, the tool returns an error and does not report that the extension was reloaded. The text is No workspace extension has id followed by the id and a period, for example No workspace extension has id missing. A synchronous not-found adds a second line, tableau-error-code: workspace-extension-not-found. The same id sentence is returned when the reload is accepted and then fails, as in No workspace extension has id ws-ext-disabled.

A disabled extension fails with Workspace extension is disabled. An extension that is not in the repository Packages folder fails with Not in the Packages folder.

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"

note

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 reload route itself is not found, the tool returns This Tableau Desktop build does not serve the reload-workspace-extension endpoint yet. Tell the user their Desktop build is too old for this read and that a Desktop update enables it. Do not retry. An unknown extension id is a different refusal, described under extensionId.

Example results​

Reload finished (extensionId: "ab12 cd")​

{
"extensionId": "ab12 cd",
"message": "Reloaded workspace extension \"ab12 cd\"."
}

Reload accepted, still being applied​

{
"extensionId": "ab12 cd",
"message": "Requested reload of workspace extension \"ab12 cd\"; Desktop is still applying it."
}
  • get-workspace-extensions — lists installed workspace extensions, including disabled ones, and returns the stable id this tool reloads