Dashboard Extensions Settings Methods
Enable and configure security for dashboard extensions on sites and, for on premise installations, on servers. With these extensions you can add custom features to a dashboard using JavaScript.
Using the extension methods of the Tableau Server REST API you can:
- List the settings for extensions of a server or site
- Enable or disable extensions or sandboxed extensions for a server or site
- List, get, create, and delete entries in server blocked extensions list
- List, get, create, update, and delete entries in server allowed (safe) extensions list
This functionality relates to the UI elements and concepts described at Manage Dashboard Settings.
Block dashboard extension on server
Adds a dashboard extension to the block list of a server.
Version: Available in API 3.11 ( Tableau Server 2021.1) and later. Not available for Tableau Cloud. Version Overview
Permissions: This method can only be called by users with server administrator permissions. Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
POST {server}/api/-/settings/server/extensions/dashboard/blockListItems
Allow dashboard extension on site
Adds a dashboard extension to the safe list of the site you are signed into.
Version: Available in API 3.11 (Tableau Online March 2021 / Server 2021.1) and later. Version Overview
Permissions: This method can only be called by users with server or site administrator permissions. Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
POST {server}/api/-/settings/site/extensions/dashboard/safeListItems
Unblock dashboard extension on server
Deletes a specific extension from the block list of a server.
Version: Available in API 3.11 ( Tableau Server 2021.1) and later. Not available for Tableau Cloud. Version Overview
Permissions: This method can only be called by users with server administrator permissions. Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
DELETE {server}/api/-/settings/server/extensions/dashboard/blockListItems/{block_list_item_luid}
Get blocked dashboard extension on server
Gets the details of a specific dashboard extension on the blocked list of a server.
Version: Available in API 3.11 ( Tableau Server 2021.1) and later. Not available for Tableau Cloud. Version Overview
Permissions: This method can only be called by users with server administrator permissions. Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
GET {server}/api/-/settings/server/extensions/dashboard/blockListItems/{block_list_item_luid}
List blocked dashboard extensions on server
Lists the dashboard extensions on the blocked list of a server.
Version: Available in API 3.11 ( Tableau Server 2021.1) and later. Not available for Tableau Cloud. Version Overview
Permissions: This method can only be called by users with server administrator permissions. Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
GET {server}/api/-/settings/server/extensions/dashboard/blockListItems
List allowed dashboard extensions on site
Lists the dashboard extensions on the safe list of the site you are signed into.
Version: Available in API 3.11 (Tableau Online March 2021 / Server 2021.1) and later. Version Overview
Permissions: This method can only be called by users with server or site administrator permissions. Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
GET {server}/api/-/settings/site/extensions/dashboard/safeListItems
List settings for dashboard extensions on server
Lists the dashboard extension settings of a server.
Version: Available in API 3.11 ( Tableau Server 2021.1) and later. Not available for Tableau Cloud. Version Overview
Permissions: This method can only be called by users with server administrator permissions. Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
GET {server}/api/-/settings/server/extensions/dashboard
Update dashboard extensions settings of server
Updates the settings for dashboard extensions of a server
Version: Available in API 3.11 ( Tableau Server 2021.1) and later. Not available for Tableau Cloud. Version Overview
Permissions: This method can only be called by users with server administrator permissions. Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
PUT {server}/api/-/settings/server/extensions/dashboard
Disallow dashboard extension on site
Deletes a specific dashboard extension from the safe list of the site you are signed into.
Version: Available in API 3.11 (Tableau Online March 2021 / Server 2021.1) and later. Version Overview
Permissions: Can only be called by users with site or server administrator permissions. Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
DELETE {server}/api/-/settings/site/extensions/dashboard/safeListItems/{safe_list_item_luid}
Get allowed dashboard extension on site
Gets the details of a specific dashboard extension on the safe list of the site you are signed into.
Version: Available in API 3.11 (Tableau Online March 2021 / Server 2021.1) and later. Version Overview
Permissions: Can only be called by users with site or server administrator permissions. Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
GET {server}/api/-/settings/site/extensions/dashboard/safeListItems/{safe_list_item_luid}
List dashboard extension settings of site
Lists the dashboard extension settings of the site you are signed into.
Version: Available in API 3.11 (Tableau Online March 2021 / Server 2021.1) and later. Version Overview
Permissions: This method can only be called by users with server or site administrator permissions. Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
GET {server}/api/-/settings/site/extensions/dashboard
Update settings for allowed dashboard extension on site
Updates the settings of a specific dashboard extension in the safe list of the site you are signed into.
Version: Available in API 3.11 (Tableau Online March 2021 / Server 2021.1) and later. Version Overview
Permissions: Can only be called by users with site or server administrator permissions. Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
PUT {server}/api/-/settings/site/extensions/dashboard/safeListItems/{safe_list_item_luid}
Update dashboard extension settings of site
Updates the settings for dashboard extensions for the site you are signed into.
Version: Available in API 3.11 (Tableau Online March 2021 / Server 2021.1) and later. Version Overview
Permissions: This method can only be called by users with server or site administrator permissions. Permissions Overview
License: No additional license required.
Access Scope: Not available. Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
PUT {server}/api/-/settings/site/extensions/dashboard