--- schema_version: "1" id: cefc7db6b4e049b11ee298db308c350ab59f9a096c4d82d0eaa900f7667b62ea title: Reference-Tableau Server REST API collection: tableau version: current locale: en-us portal_url: https://docs.salesforce.com/tableau/current/en-us/api/rest_api/REST/rest_api_ref.md canonical_url: https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm source_site: help.tableau.com content_type: documentation content_hash: 53e9d110e4cbaff019baec5c92d2760049477c3018b7c6f94473670da9cdd294 description: Using the Tableau Server REST API, you can manage and change Tableau Server resources programmatically, via HTTP --- [Skip to main content](#main-content) # API Reference—All Methods Using the Tableau Server REST API, you can manage and change Tableau Server resources programmatically, via HTTP. The API gives you simple access to the functionality behind the data sources, projects, workbooks, site users, and sites on a Tableau server. You can use this access to create your own custom applications or to script interactions with Tableau Server resources. - On this page, use the [API Method Categories list](#api-method-categories), or find keywords in the [API Method Details list](#api-method-details) with **ctrl/cmd-f** search. - For more information, see [Fundamentals of the Tableau Server REST API](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_fundamentals.htm) and [REST API Example Requests](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_example_requests.htm). **Note:** For help with your code that uses the Tableau REST API, submit questions and ask for help on the [Tableau developer community forums](https://community.tableau.com/s/topic/0TO4T000000QF8eWAG/developers). For potential bugs in the Tableau REST API code itself, and for any issue with unmodified sample code we provide, use the feedback widget at the bottom of API reference pages. ## API Method Categories The following table lists the Tableau Server REST API methods by category. The table also indicates which methods can be used with Tableau Cloud. Analytics Extensions Settings Methods

Add analytics extension connection to site	Adds a new analytics extension connection for an external service to a site.
Delete analytics extension connection from site	Deletes a specific analytics extension connection for an external service from a site.
Enable or disable analytics extensions on server - Not available for Tableau Cloud	Enables or disables analytics extensions on a server.
Get analytics extension details	Get the details of a specified analytics extension connection to an external service.
Get current analytics extension for workbook	Gets basic details, including connection type and name, of the analytics extension connection to an external service that the specified workbook is currently using.
Get enabled state of analytics extensions on server - Not available for Tableau Cloud	Gets the enabled/disabled state of analytics extensions on a server.
Get enabled state of analytics extensions on site	Gets the enabled/disabled state of analytics extensions on a site.
List analytics extension connections of workbook	Lists basic details of each analytics extension connection available for a specified workbook, including connection type and name.
List analytics extension connections on site	Lists a site's analytics extension connections for external services.
Remove current analytics extension connection for workbook	Remove the currently used analytics extension connection to an external service from the specified workbook. The connection remains configured, and is available for further usage by the workbook.
Update analytics extension connection of site	Updates the details of specified analytics extension connection for an external service to a site.
Update analytics extension for workbook	Updates the analytics extension connection to external service currently used by a workbook.
Update enabled state of analytics extensions on site	Enables or disables analytics extensions on a site.

Ask Data Lens Methods - Retired

Create ask data lens - Retired in API 3.22	Create an ask data lens.
Delete ask data lens - Retired in API 3.22	Delete an ask data lens.
Get ask data lens - Retired in API 3.22	Get the details of the specified ask data lens.
Import ask data lens - Retired in API 3.22	Import an existing ask data lens on a server to a site, and optionally transform the metadata of the lens in the process.
List ask data lenses in site - Retired in API 3.22	Returns a list of ask data lenses in a site.

Authentication Methods

List Personal Access Tokens - Not available for Tableau Server.	List all personal access tokens (PATs). If you're a site admin, list PATs of a user when you are the site admin on all sites that the PAT owner is a member of.
Revoke Administrator Personal Access Tokens - Not available for Tableau Cloud.	Revokes all personal access tokens (PATs) created by server administrators. This method is not available for Tableau Cloud.
Revoke Personal Access Token - Not available for Tableau Server.	Revoke a personal access token (PAT). If you're a site admin, you can revoke a users PAT owhen you are the site admin on all sites that the PAT owner is a member of.
Sign In	Signs you in as a user on the specified site on Tableau Server or Tableau Cloud.
Sign Out	Signs you out of the current session. This call invalidates the authentication token that is created by a call to Sign In.
Switch Site - Not available for Tableau Cloud.	Switches you onto another site without having to provide a user name and password again.

Bridge Methods

Add Domain to Pool - Not available for Tableau Server.	Associates a domain with a specific Bridge pool, allowing Bridge clients from that domain to use the pool.
Add Projects to Routing Rule - Not available for Tableau Server.	Adds one or more project filtering conditions to an existing allow rule, narrowing the rule so it applies only to the listed projects.
Block Domain - Not available for Tableau Server.	Blocks a domain from being used with any Bridge pool, preventing Bridge clients from that domain from connecting.
Create Bridge Pool - Not available for Tableau Server.	Creates a new Bridge pool with the specified name.
Create Routing Rule - Not available for Tableau Server.	Creates a Bridge routing rule for a site.
Delete Bridge Client - Not available for Tableau Server.	Permanently removes a Bridge client from the site.
Delete Bridge Pool - Not available for Tableau Server.	Permanently deletes a Bridge pool and all its associated domain mappings.
Delete Domain - Not available for Tableau Server.	Removes a domain mapping from the system.
Delete Routing Rule - Not available for Tableau Server.	Permanently deletes a Bridge routing rule identified by its ID.
Get Bridge Client - Not available for Tableau Server.	Retrieves detailed information about a single Bridge client.
Get Domain Mapping - Not available for Tableau Server.	Retrieves information about all domain mappings for the site, including pool assignment and status (ALLOWED or BLOCKED).
Get Routing Rule - Not available for Tableau Server.	Returns a single Bridge routing rule identified by its ID.
Get Routing Rules - Not available for Tableau Server.	Returns all Bridge routing rules for the site.
List Bridge Clients - Not available for Tableau Server.	Retrieves a list of all Bridge clients for a specific site, with optional filtering by pool.
List Bridge Pools - Not available for Tableau Server.	Retrieves a list of all Bridge pools for the specified site, including pool details and associated domain mappings.
Move Bridge Client - Not available for Tableau Server.	Moves a Bridge client between pools or to unassigned status.
Remove Projects from Routing Rule - Not available for Tableau Server.	Removes one or more project filtering conditions from an existing allow rule, broadening the rule so it no longer applies only to those projects.
Update Bridge Pool - Not available for Tableau Server.	Updates the display name of an existing Bridge pool.
Update Domain Among Pools - Not available for Tableau Server.	Moves a domain from its current pool to a different pool.
Update Domain Name - Not available for Tableau Server.	Updates an existing domain mapping by renaming the domain.
Update Routing Rule - Not available for Tableau Server.	Partially updates an existing Bridge routing rule.

Collections Methods

Add Collection Permissions	Adds permissions to the specified collection for a user or group. You can specify multiple sets of permissions using one call.
Add items to a collection	Adds items to a collection.
Batch update collections	Batch updates collections.
Create a collection	Creates a new collection.
Delete Collection Permission	Removes the specified collection permission for the specified group or user.
Delete collections	Deletes collections.
Delete collections	Deletes collections.
Get details of a collection	Gets the details of a collection.
List Collection Permissions	Returns a list of permissions for a specific collection.
List collections	Lists collections.
List items in a collection	Lists items in a collection.
Remove items from a collection	Removes items from a collection.
Reorder items in a collection	Reorders items in a collection.

Connected App Methods

Create Connected App	Create a connected app.
Create Connected App Secret	Generate a secret for a connected app.
Delete Connected App	Permanently remove a connected app.
Delete Connected App Secret	Permanently remove a secret associated with a connected app.
Delete EAS	Delete a registered external authorization server (EAS).
Get Connected App	Query a connected app by its ID.
Get Connected App Secret	Query a connected app secret and the token value using the connected app's ID.
List All Registered EAS	Get all external authorization servers (EASs) registered to a site.
List Connected Apps	Query all connected apps configured on a site.
List Registered EAS	Get an external authorization server (EAS) registered to a site.
Register EAS	Create a connected app with OAuth 2.0 trust by registering an external authorization server (EAS) to a site.
Update Connected App	Update a connected app.
Update EAS - Not available for Tableau Server.	Update a connected app with OAuth 2.0 trust.

Content Exploration Methods

Get batch content usage statistics - Not available for Tableau Server	Gets usage statistics for multiple content items. The batch of can include multiple content types.
Get content search results	Searches across all supported content types for objects relevant to the search expression specified in the querystring of the request URI.
Get Content Suggestions	Returns a specified number of suggestions for auto-completion of user input as they type. You can specify content types of suggestions and prioritize recently viewed content.
Get usage statistics for content item - Not available for Tableau Server	Gets the usage statistics for a Tableau content item, specified by LUID and content type, such as workbook, datasource, or flow.

Custom Domain Methods

Create custom domain settings - Not available for Tableau Server	Starts the process of custom domain setup for a Tableau site.
Delete custom domain settings - Not available for Tableau Server	Deletes the custom domain setup for a Tableau site.
Get Custom Domain Name - Not available for Tableau Server	Gets the custom domain for a Tableau site, if one is provisioned. For more information about how, see.
Get custom domain settings - Not available for Tableau Server	Gets the custom domain settings for a Tableau site.
Update custom domain settings - Not available for Tableau Server	Updates the custom domain setup for a Tableau site.

Dashboard Extensions Settings Methods - Retired

Allow dashboard extension on site - Retired in API 3.21	Adds a dashboard extension to the safe list of the site you are signed into.
Block dashboard extension on server - Retired in API 3.21 - Not available for Tableau Cloud	Adds a dashboard extension to the block list of a server.
Disallow dashboard extension on site - Retired in API 3.21	Deletes a specific dashboard extension from the safe list of the site you are signed into.
Get allowed dashboard extension on site - Retired in API 3.21	Gets the details of a specific dashboard extension on the safe list of the site you are signed into.
Get blocked dashboard extension on server - Retired in API 3.21 - Not available for Tableau Cloud	Gets the details of a specific dashboard extension on the blocked list of a server.
List allowed dashboard extensions on site - Retired in API 3.21	Lists the dashboard extensions on the safe list of the site you are signed into.
List blocked dashboard extensions on server - Retired in API 3.21 - Not available for Tableau Cloud	Lists the dashboard extensions on the blocked list of a server.
List dashboard extension settings of site - Retired in API 3.21	Lists the dashboard extension settings of the site you are signed into.
List settings for dashboard extensions on server - Retired in API 3.21 - Not available for Tableau Cloud	Lists the dashboard extension settings of a server.
Unblock dashboard extension on server - Retired in API 3.21 - Not available for Tableau Cloud	Deletes a specific extension from the block list of a server.
Update dashboard extension settings of site - Retired in API 3.21	Updates the settings for dashboard extensions for the site you are signed into.
Update dashboard extensions settings of server - Retired in API 3.21 - Not available for Tableau Cloud	Updates the settings for dashboard extensions of a server.
Update settings for allowed dashboard extension on site - Retired in API 3.21	Updates the settings of a specific dashboard extension in the safe list of the site you are signed into.

Data Sources Methods

Add Tags to Data Source	Adds one or more tags to the specified data source.
Add Work Copy Elements	Adds field descriptions or table descriptions to a work copy. Returns HTTP 201 when every element is added. The success body omits the elements that succeeded.
Create Work Copy	Creates a work copy of a published data source and returns the work copy LUID. Composable data sources and Semantic Data Model (SDM) data sources are not supported. The call is rejected when the caller already has the maximum number of open work copies.
Delete Data Source	Deletes the specified data source from a site. When a data source is deleted, its associated data connection is also deleted. Workbooks that use the data source are not deleted, but they will no longer work properly.
Delete Tag from Data Source	Deletes a tag from the specified data source.
Delete Work Copy Elements	Deletes elements from a work copy. Send `elementType` and `name` for each element. Other content is ignored. Returns HTTP 200 when every element is deleted. The success body omits the elements that succeeded.
Download Data Source	Downloads a data source in `.tdsx` format.
Download Data Source Encrypted Keychain	Gets an encrypted version of the embedded credentials from the data source. These credentials can only be migrated to the linked destination Tableau Cloud or Tableau Server.
Download Data Source Revision	Downloads a specific version of a data source prior to the current one in `.tdsx` format. To down load the current version of a data source use the Download Data Source method.
Get Data Source Revisions	Returns a list of revision information (history) for the specified data source.
Publish Data Source	Publishes a data source on the specified site, or appends data to an existing data source.
Publish Work Copy	Publishes a work copy as a data source. Send the published data source `name` and an optional `description`. The response returns the new data source LUID. A blank name is rejected.
Query Data Source	Returns information about the specified data source.
Query Data Source Connections	Returns a list of data connections for the specified data source.
Query Data Sources	Returns a list of published data sources on the specified site, with optional parameters for specifying the paging of large results. To get a list of data sources embedded in a workbook, use the Query Workbook Connections method.
Read Data Source Elements	Reads columns, field descriptions, or table descriptions from a published data source. Set `elementType` to the kind of element, and optionally set `name` to read one element.
Read Work Copy Elements	Reads columns, field descriptions, or table descriptions from a work copy. Set `elementType` to the kind of element, and optionally set `name` to read one element.
Remove Data Source Revision	Removes a specific version of a data source from the specified site.
Update Data in Hyper Connection	Incrementally updates data (insert, update, upsert, replace and delete) in a published data source from a live-to-Hyper connection, where the data source has multiple connections.
Update Data in Hyper Data Source	Incrementally updates data (insert, update, upsert, replace and delete) in a published data source from a live-to-Hyper connection, where the data source has a single connection.
Update Data Source	Updates the owner, project or certification status of the specified data source.
Update Data Source Connection	Updates the server address, port, authentication type, username, or password for the specified data source connection.
Update Data Source Connections	Updates the server address, port, authentication type, username, or password for one or more connections in a data source. To update all connections in a given data source with the same connection information, see Update Data Source Connection.
Update Data Source Now	Runs an extract refresh on the specified data source.
Update Work Copy Elements	Updates columns, field descriptions, or table descriptions on a work copy. Returns HTTP 200 when every element is updated. The success body omits the elements that succeeded.
Upload Data Source Encrypted Keychain	Uploads the encrypted version of the embedded credentials. This method will only work if the credentials are encrypted with the latest public key used to link the source Tableau Server with the destination Tableau Cloud or Tableau Server site.

Extract and Encryption Methods

Create an Extract for a Data Source	Create an extract for a data source in a site. Optionally, encrypt the extract if the site and workbooks using it are configured to allow it.
Create Cloud Extract Refresh Task - Not available for Tableau Server.	Creates a custom schedule for an extract refresh on Tableau Cloud. The target of the schedule can be a data source, a workbook, or a virtual connection. For Tableau Server, see Add data source to server schedule, Add workbook to server schedule, and Add virtual connection to server schedule.
Create Extracts for Embedded Data Sources in a Workbook	Create extracts for all embedded data sources of a workbook. Optionally, encrypt the extracts if the site and workbook using them are configured to allow it.
Decrypt Extracts in a Site	Extract encryption at rest is a data security feature that allows you to encrypt .hyper extracts while they are stored on Tableau Server. For more information, see Extract Encryption at Rest.
Delete Extract from Data Source	Delete the extract from a data source.
Delete Extract Refresh Task	Deletes the specified extract refresh task on Tableau Server or Tableau Cloud.
Delete Extracts from Virtual Connection - Available with a Data Management, Enterprise, Server+, Cloud+, or Tableau+ Bundle license.	Deletes the extracts from a virtual connection, which changes it from extract to live mode.
Delete Extracts of Embedded Data Sources from a Workbook	Delete all extracts of embedded data sources in a workbook.
Encrypt Extracts in a Site	Extract encryption at rest is a data security feature that allows you to encrypt .hyper extracts while they are stored on Tableau Server. For more information, see Extract Encryption at Rest.
Get Extract Refresh Task	Returns information about a site's scheduled extract refresh task for a data source, workbook, or virtual connection.
List Extract Refresh Tasks in Server Schedule - Not available for Tableau Cloud.	Returns a list of the extract refresh tasks for a specified server schedule on the specified site on Tableau Server.
List Extract Refresh Tasks in Site	Returns a list of extract refresh tasks for the site. Tasks include extract refreshes for data sources, workbooks, and virtual connections.
Reencrypt Extracts in a Site	Extract encryption at rest is a data security feature that allows you to encrypt .hyper extracts while they are stored on Tableau Server. For more information, see Extract Encryption at Rest.
Run Extract Refresh Task	Runs the specified extract refresh task.
Update Cloud Extract Refresh Task - Not available for Tableau Server.	Updates an extract refresh task on Tableau Cloud.

Favorites Methods

Add Data Source to Favorites	Adds the specified data source to the user's favorites.
Add Flow to Favorites	Adds the specified flow to the user's favorites.
Add Metric to Favorites - Retired in API 3.22	Adds the specified metric to the user's favorites.
Add Project to Favorites	Adds the specified project to a user's favorites.
Add View to Favorites	Adds the specified view to a user's favorites.
Add Workbook to Favorites	Adds the specified workbook to a user's favorites.
Delete Data Source from Favorites	Deletes the specified data source from the user's favorites. If the specified data source is not a favorite, the operation has no effect.
Delete Flow from Favorites	Deletes the specified flow from the user's favorites. If the specified flow is not a favorite, the operation has no effect.
Delete Project from Favorites	Deletes the specified project from the user's favorites. If the specified project is not a favorite, the operation has no effect.
Delete View from Favorites	Deletes the specified view from user's favorites. If the specified view is not a favorite, the operation has no effect.
Delete Workbook from Favorites	Deletes a workbook from a user's favorites. If the specified workbook is not a favorite of the specified user, this call has no effect.
Get Favorites for User	Returns a list of favorite projects, data sources, views, workbooks, and flows for a user.
Organize Favorites	Move an item to organize a user's favorites.

Flow Methods

Add Flow Permissions	Adds permissions to the specified flow for a Tableau Server user or group. You can specify multiple sets of permissions using one call.
Add Flow Task to Server Schedule	The Add Flow Task to Schedule method is renamed and retired for Tableau Cloud in API 3.22 (Tableau Cloud March 2024). It will remain available for Tableau Server only. For Tableau Cloud in March 2024, this method will be replaced with Create Cloud Flow Task method.
Cancel Flow Run	Cancels a flow run that is in progress.
Create Cloud Flow Task - Not available for Tableau Server. Available only with a Data Management license.	Creates a flow task on Tableau Cloud, and set its schedule.
Delete Flow	Deletes a flow. When a flow is deleted, its associated connections, the output and input steps, any associated scheduled tasks, and run history are also deleted.
Delete Flow Permission	Deletes the specified permission from the specified flow for a group or user.
Download Flow	Downloads a flow in .tfl or .tflx format.
Download Flow Encrypted Keychain	Gets an encrypted version of the embedded credentials in a flow. These credentials can only be migrated to the linked destination Tableau Cloud or Tableau Server.
Get Flow Run	Gets a flow run.
Get Flow Run Task	Returns information about the specified flow run task. This method shows you information about the scheduled task for the flow.
Get Flow Run Tasks	Returns a list of scheduled flow tasks for the site.
Get Flow Runs	Get flow runs.
Get Linked Task - Available only with a Data Management license.	Returns information about a specific linked task. This method shows you information about the scheduled linked task.
Get Linked Tasks - Available only with a Data Management license.	Returns a list of scheduled linked tasks for a site.
List Flow Permissions	Returns a list of permissions for the specific flow.
Publish Flow	Publishes a flow on the specified site.
Query Flow	Returns information about the specified flow, including information about the project, owner, and output steps.
Query Flow Connections	Returns a list of data connections for the specific flow.
Query Flows for a Site	Returns the flows on a site. If the user is not an administrator, the method returns just the flows that the user has permissions to view.
Query Flows for User	Returns the flows that the specified user owns in addition to those that the user has Read (view) permissions for.
Run Flow Now - Available only with a Data Management license.	Runs the specified flow.
Run Flow Task	Runs the specified flow run task.
Run Linked Task Now - Available only with a Data Management license.	Runs the specified linked task.
Update Flow	Updates the project and/or owner of the specified flow.
Update Flow Connection	Updates the server address, port, username, or password for the specified flow connection. The connection can be an input or an output connection.
Update Flow Connections	Updates the server address, port, username, or password for one or more flow connections. The connection can be an input or an output connection.
Update Flow Owner	Updates a flow's owner.
Upload Flow Encrypted Keychain	Uploads the encrypted version of the embedded credentials of a flow. This method will only work if the credentials are encrypted with the latest public key used to link the source Tableau Server with the destination Tableau Cloud or Tableau Server site.

Identity Pools Methods

Add User to Identity Pool - Not available for Tableau Cloud.	Add a user to a specified identity pool.
Configure Identity Store - Not available for Tableau Cloud	Configure a new local identity store to provision users.
Create Authentication Configuration - Not available for Tableau Cloud	Create an instance of OpenID Connect (OIDC) authentication.
Create Identity Pool - Not available for Tableau Cloud	Create an identity pool.
Delete Authentication Configuration - Not available for Tableau Cloud	Delete an authentication instance.
Delete Identity Pool - Not available for Tableau Cloud	Delete an identity pool.
Delete Identity Store - Not available for Tableau Cloud	Delete an identity store.
Get Identity Pool - Not available for Tableau Cloud	Get information about an identity pool.
List Authentication Configurations on Server - Not available for Tableau Cloud	List information about all authentication instances associated with identity pools.
List Identity Pools - Not available for Tableau Cloud	List all identity pools.
List Identity Stores - Not available for Tableau Cloud	List information about all identity store instances used to provision users.
Remove User from Identity Pool - Not available for Tableau Cloud.	Remove a user from a specified identity pool.
Update Authentication Configuration - Not available for Tableau Cloud	Update an authentication instance.
Update Identity Pool - Not available for Tableau Cloud	Update information about an identity pool.

Jobs, Tasks, and Schedules Methods

Add Data Source to Server Schedule - Not available for Tableau Cloud.	Adds a task to refresh a data source to an existing server schedule on Tableau Server. For Tableau Cloud, see Create Cloud Extract Refresh Task.
Add Virtual Connection to Server Schedule - Not available for Tableau Cloud.	Adds a task to refresh a virtual connection to an existing server schedule on Tableau Server. For Tableau Cloud, see Create Cloud Extract Refresh Task.
Add Workbook to Server Schedule - Not available for Tableau Cloud.	Adds a task to refresh or accelerate a workbook to an existing schedule on Tableau Server.
Batch Update Schedule State - Not available for Tableau Cloud	Updates the state of one or more schedules.
Cancel Job	Cancels a job specified by job ID. To get a list of job IDs for jobs that are currently queued or in-progress, use the Query Jobs method.
Create Cloud Extract Refresh Task - Not available for Tableau Server.	Creates a custom schedule for an extract refresh on Tableau Cloud. The target of the schedule can be a data source, a workbook, or a virtual connection. For Tableau Server, see Add data source to server schedule, Add workbook to server schedule, and Add virtual connection to server schedule.
Create Server Schedule - Not available for Tableau Cloud.	Creates a new server schedule on Tableau Server. For Tableau Cloud, see Create Cloud Extract Refresh Task and Create subscription.
Delete Data Acceleration Task	Deletes a data acceleration task.
Delete Server Schedule - Not available for Tableau Cloud.	Deletes the specified schedule on Tableau Server. For Tableau Cloud, see Delete Extract Refresh Task and Delete Subscription.
Get Data Acceleration Tasks in a Site	Returns a list of data acceleration tasks for the site.
Get Extract Refresh Task	Returns information about a site's scheduled extract refresh task for a data source, workbook, or virtual connection.
Get Server Schedule - Not available for Tableau Cloud.	Returns detailed information about the specified server schedule on Tableau Server.
List Extract Refresh Tasks in Server Schedule - Not available for Tableau Cloud.	Returns a list of the extract refresh tasks for a specified server schedule on the specified site on Tableau Server.
List Extract Refresh Tasks in Site	Returns a list of extract refresh tasks for the site. Tasks include extract refreshes for data sources, workbooks, and virtual connections.
List Server Schedules - Not available for Tableau Cloud.	Returns a list of flows, extract and subscription server schedules on Tableau Server. For each schedule, the API returns the name, frequency, priority, and other information.
Query Job	Returns status information about an asynchronous process that is tracked using a job. This method can be used to query jobs that are used to do the following:.
Query Jobs	Returns a list of active jobs on the specified site. To get details on a specific job, pass a job ID returned by this method to the Query Job method. To cancel an active job, pass a job ID returned by this method to the Cancel Job method.
Run Extract Refresh Task	Runs the specified extract refresh task.
Update Server Schedule - Not available for Tableau Cloud.	Modifies settings for the specified server schedule, including the name, priority, and frequency details on Tableau Server. For Tableau Cloud, see Update cloud extract refresh task and Update subscription .
Update Virtual Connection Now - Available with a Data Management, Enterprise, Server+, Cloud+, or Tableau+ Bundle license.	Runs an extract refresh on the specified virtual connection.

Metadata Methods

Add Data Quality Warning - Available only with a Data Management license.	Add a data quality warning to a database, table, column, published data source, flow, virtual connection, or virtual connection table.
Add Database Permissions - Available only with a Data Management license.	Add permissions to a database asset.
Add Default Database Permissions - Available only with a Data Management license.	Adds default permission capabilities to a user or group for table resources in that database.
Add or Update Monitoring Quality Warning on Content - Available only with a Data Management license.	Create or update one or more monitoring quality warnings.
Add Table Permissions - Available only with a Data Management license.	Add permissions to a table asset.
Add Tags to Column	Add one or more tags to a column.
Add Tags to Database	Add one or more tags to a database.
Add Tags to Table	Add one or more tags to a table.
Add Tags to Virtual Connection - Available only with a Data Management license.	Adds tags to a virtual connection.
Batch Add or Update Data Quality Certifications - Available only with a Data Management license.	Create or update one or more data quality certifications for different content and asset items.
Batch Add or Update Data Quality Warnings - Available only with a Data Management license.	Add or update multiple data quality warnings on assets.
Batch Add Tags - Available only with a Data Management license.	Add multiple tags to items that are different content and asset types.
Batch Delete Data Quality Warnings - Available only with a Data Management license.	Delete multiple data quality warnings from assets.
Batch Delete Tags - Available only with a Data Management license.	Delete multiple tags from items that are different content and asset types.
Create Label Category - Available only with a Data Management license.	Creates a data label category.
Create or Update labelValue - Available only with a Data Management license.	Creates a label value with the specified name if it doesn't exist, or updates the existing label value if the label value name already exists.
Delete Data Quality Certification by ID - Available only with a Data Management license.	Delete a data quality certification from an asset using the data quality certification ID.
Delete Data Quality Certifications by Content - Available only with a Data Management license.	Delete multiple data quality certifications from assets.
Delete Data Quality Warning by Content - Available only with a Data Management license.	Delete the data quality warnings from an asset.
Delete Data Quality Warning by ID - Available only with a Data Management license.	Delete a data quality warning from an asset using the data quality warning ID.
Delete Database Permissions - Available only with a Data Management license.	Permanently remove the permissions applied to a database asset.
Delete Default Database Permissions - Available only with a Data Management license.	Permanently remove the default permissions on a database asset.
Delete Label - Available only with a Data Management license.	Deletes a data label by its LUID.
Delete Label Category - Available only with a Data Management license.	Deletes a label category.
Delete Labels - Available only with a Data Management license.	Deletes the data labels on one or more assets.
Delete labelValue - Available only with a Data Management license.	Deletes a label value.
Delete Quality Warning Trigger by ID - Available only with a Data Management license.	Permanently remove a quality warning trigger using the quality warning trigger ID.
Delete Quality Warning Triggers by Content - Available only with a Data Management license.	Permanently remove all quality warning triggers for one or more data sources or flows, or both.
Delete Table Permissions - Available only with a Data Management license.	Permanently remove the permissions applied to a table asset.
Delete Tag from Column	Delete a tag from a column.
Delete Tag from Database	Delete a tag from a database.
Delete Tag from Table	Delete a tag from a table.
Delete Tag from Virtual Connection - Available only with a Data Management license.	Deletes a tag from a virtual connection.
Get Databases and Tables from Connection	Query databases and tables from the connection information in the data source (.tds or .tdsx) or workbook (.tws or .twbx) file's XML.
Get Label - Available only with a Data Management license.	Gets a data label by its LUID.
Get Labels - Available only with a Data Management license.	Displays information about the data labels on one or more assets.
Get labelValue - Available only with a Data Management license.	Displays label value properties for a single label value.
Get Metadata Suggestion - Available only with Tableau+	Gets a suggestion from generative AI about asset metadata.
List Database Permissions	Get information about the permissions on a database asset.
List Default Database Permissions	Get the default permissions applied to the database asset and its children tables.
List Label Categories on Site - Available only with a Data Management license.	Lists all data label categories on the site.
List labelValues on Site - Available only with a Data Management license.	Lists all label values on the site.
List Table Permissions	Get information about the permissions on a table asset.
Move Database - Available only with a Data Management license.	Move one or more databases to a project.
Move Table - Available only with a Data Management license.	Moves one or more tables to a project.
Query All Quality Warning Triggers by Content	Get information about all quality warning triggers for a content item.
Query Column in a Table	Get information about a column in a table asset.
Query Columns in a Table	Get information about the columns in a table asset.
Query Data Quality Certification by ID	Get information about a data quality certification.
Query Data Quality Certifications by Content	Get all data quality certifications for content or asset items.
Query Data Quality Warning by Content - Available only with a Data Management license.	Get information about the data quality warning for the database, table, column, published data source, flow, virtual connection, or virtual connection table.
Query Data Quality Warning by ID	Get information about a specific data quality warning.
Query Database	Get information about a database asset.
Query Databases	Get information about all database assets for a site.
Query Quality Warning Trigger	Get information about a quality warning trigger.
Query Table	Get information about a table asset.
Query Tables	Get information about all table assets for a site.
Remove Column - Available only with a Data Management license.	Permanently remove the column from a table asset.
Remove Database - Available only with a Data Management license.	Permanently remove the database asset.
Remove Table - Available only with a Data Management license.	Permanently remove the table asset.
Update Column - Available only with a Data Management license.	Update the description of the column.
Update Data Quality Warning - Available only with a Data Management license.	Update the warning type, status, and message of a data quality warning.
Update Database - Available only with a Data Management license.	Update the database description, certify a database, set database permissions, or assign a Tableau Cloud or Server user as the database contact.
Update Label - Available only with a Data Management license.	Updates a label by its LUID.
Update Label Category - Available only with a Data Management license.	Updates a data label category.
Update Labels - Available only with a Data Management license.	Creates or updates labels on one or more assets.
Update labelValue - Available only with a Data Management license.	Updates a label value.
Update Monitoring Quality Warning - Available only with a Data Management license.	Update a monitoring quality warning.
Update Table - Available only with a Data Management license.	Update the table description, certify a table, or a assign a user contact to the table asset.

Metrics Methods - Retired

Delete Metric - Retired in API 3.22	Deletes a specified metric from a site.
Get Metric - Retired in API 3.22	Returns the details of the specified metric.
Get Metric Data - Retired in API 3.22	Returns the data for the specified metric as comma separated (CSV) format. The maximum number of rows returned is 10,000.
List Metrics for Site - Retired in API 3.22	Returns the metrics configured for a site.
Update Metric - Retired in API 3.22	Updates the owner, project, suspended status, or name of the specified metric.

Mobile Settings Methods

Get Mobile Security Settings for Server	Gets the mobile security settings for the server.
Get Mobile Security Settings for Site	Gets the mobile security settings for the specified site.
Update Mobile Security Settings for Site	Updates the mobile security sections for a specified site.

Notifications Methods

Add User to Data-Driven Alert	Adds a specified user to the recipients list for a data-driven alert.
Create a Webhook	Creates a new webhook for a site.
Create Data Driven Alert - Not available for Tableau Server.	Create a data driven alert (DDA) for a view with a single data axis.
Delete a Webhook	Deletes the specified webhook.
Delete Data-Driven Alert	Deletes the specified data-driven alert from the specified site.
Delete User from Data-Driven Alert	Removes a specified user from the recipients list for a data-driven alert.
Get a Webhook	Returns information about the specified webhook.
Get Data-Driven Alert	Returns details on a specified data-driven alert, including the recipients of the alert.
Get User Notification Preferences	Returns the notification preferences for the specified site. You can filter by channel and notification type. For more information about notifications, see Manage Your Account Settings.
List Data-Driven Alerts on Site	Returns a list of data-driven alerts in use on the specified site.
List Webhooks	Returns a list of all the webhooks on the specified site.
Test a Webhook	Tests the specified webhook. Sends an empty payload to the configured destination URL of the webhook and returns the response from the server. This is useful for testing, to ensure that things are being sent from Tableau and received back as expected.
Update a Webhook	Modify the properties of an existing webhook.
Update Data-Driven Alert	Update one or more settings for the specified data-driven alert; including the alert subject, frequency, and owner.
Update User Notification Preferences	Updates user notifications preferences to enabled or disabled on the specified site. For more information about notifications, see Manage Your Account Settings.

OpenID Connect Methods

Create OpenID Connect Configuration - Not available for Tableau Server.	Create the Tableau Cloud site's OpenID Connect (OIDC) configuration.
Get OpenID Connect Configuration - Not available for Tableau Server.	Get details about the Tableau Cloud site's OpenID Connect (OIDC) configuration.
Remove OpenID Connect Configuration - Not available for Tableau Server.	Disable and clear the Tableau Cloud site's OpenID Connect (OIDC) configuration.
Update OpenID Connect Configuration - Not available for Tableau Server.	Update the Tableau Cloud site's OpenID Connect (OIDC) configuration.

Permissions Methods

Add Ask Data Lens Permissions - Retired in API 3.22	Adds permissions to the specified ask data lens for a user or group. You can specify multiple sets of permissions using one request.
Add Collection Permissions	Adds permissions to the specified collection for a user or group. You can specify multiple sets of permissions using one call.
Add Data Source Permissions	Adds permissions to the specified data source for a user or group. You can specify multiple sets of permissions using one call.
Add Default Permissions	Adds default permission rules for workbook, data source, data role, lens, flow, metric, or virtual connection resources in a project for a user or group. If Tableau Catalog is enabled, also adds default permission rules for database or table resources in a project for a user or group. After adding default permission rules, new resources of the type you specify that are added to the project will have those permission rules. If permissions are locked to the project, then the same is true for all existing child content of the project. For more information, see Permissions.
Add Project Permissions	Adds permissions to the specified project for a user or group. You can specify multiple sets of permissions using one call.
Add View Permissions	Adds permissions to the specified view (also known as a sheet) for a user or group. You can specify multiple sets of permissions using one call.
Add Virtual Connection Permissions - Available only with a Data Management license.	Adds permissions to the specified virtual connection for a user or group. You can specify multiple sets of permissions using one call.
Add Workbook Permissions	Adds permissions to the specified workbook for a user or group. You can specify multiple sets of permissions using one call.
Add Workbook to Server Schedule - Not available for Tableau Cloud.	Adds a task to refresh or accelerate a workbook to an existing schedule on Tableau Server.
Delete Ask Data Lens Permission - Retired in API 3.22	Deletes the specified permissions to the specified ask data lens for a user or group.
Delete Collection Permission	Removes the specified collection permission for the specified group or user.
Delete Data Source Permission	Removes the specified data source permission for the specified group or user.
Delete Default Permission	Removes default permission rules for workbook, data source, data role, lens, flow, metric, or virtual connection resources in a project for a user or group. If Tableau Catalog is enabled, also removes default permission rules for database or table resources in a project for a user or group. After removing default permission rules, new resources of the type you specify that are added to the project will no longer have those permission rules. If permissions are locked to the project, then the same is true for all existing child content of the project.
Delete Project Permission	Removes the specified project permission for the specified group or user.
Delete View Permission	Deletes permission to the specified view (also known as a sheet) for a Tableau Server user or group.
Delete Virtual Connection Permission - Available only with a Data Management license.	Removes the specified virtual connection permission for the specified group or user.
Delete Workbook Permission	Deletes the specified permission from the specified workbook for a group or user.
List Ask Data Lens Permissions	List all permissions configured for the specified ask data lens that the user has read capability for.
List Collection Permissions	Returns a list of permissions for a specific collection.
List Data Source Permissions	Returns a list of permissions for a specific data source.
List Default Permissions	Returns details of default permission rules granted to users and groups for workbook, data source, data role, lens, flow, metric, or virtual connection resources in a project for a user or group. If Tableau Catalog is enabled, this method can also return details of default permission rules granted to users and groups for database or table resources in a project.
List Project Permissions	Returns information about the set of permissions allowed or denied for groups and users in a project.
List View Permissions	Returns a list of permissions for the specific view.
List Virtual Connection Permissions - Available only with a Data Management license.	Returns a list of permissions for a specific virtual connection.
List Workbook Permissions	Returns a list of permissions for the specific workbook.
Replace Content Permissions	Replaces existing permissions in the specified content. You can specify multiple sets of permissions using one call.
Replace Project's Default Permissions	Replaces default permissions in the specified content. If Tableau Catalog is enabled, it also adds default permission rules for database or table resources in a project. After adding default permission rules, new resources of the type you specify that are added to the project will have those permission rules. If permissions are locked to the project, then the same is true for all existing child content of the project. For more information, see Permissions.

Projects Methods

Create Project	Creates a project on the specified site. You can also create project hierarchies by creating a project under the specified parent project on the site. To make changes to an existing project, call Update Project.
Delete Project	Deletes the specified project on a specific site. When a project is deleted, all Tableau assets inside of it are also deleted, including assets like associated workbooks, data sources, project view options, and rights.
Query Projects	Returns a list of projects on the specified site, with optional parameters for specifying the paging of large results.
Update Project	Updates the name, description, or project hierarchy of the specified project. You can create or update project hierarchies by specifying a parent project for the project that you are updating using this method.

Publishing Methods

Append to File Upload	Uploads a block of data and appends it to the data that is already uploaded.
Initiate File Upload	Initiates the upload process for a file. After the upload has been initiated, you call Append to File Upload to send individual blocks of the file to the server. When the complete file has been sent to the server, you call Publish Data Source, Publish Flow, or Publish Workbook to commit the upload.
Publish Data Source	Publishes a data source on the specified site, or appends data to an existing data source.
Publish Flow	Publishes a flow on the specified site.
Publish Virtual Connection - Available only with a Data Management license.	Publishes a virtual connection on the specified site, either from a packaged virtual connection file (`.tvcx`) or from a downloaded JSON representation.
Publish Workbook	Publishes a workbook on the specified site.

Pulse Methods

Batch create Pulse subscriptions - Not available for Tableau Server	Creates multiple subscriptions to a metric for specified users and/or groups.
Batch get Pulse subscriber counts - Not available for Tableau Server	Gets the number of unique users subscribed to a set of metrics specified in a comma separated list of metric LUIDs.
Batch get Pulse subscriptions - Not available for Tableau Server	Gets a batch of subscriptions, specified in a comma delimited list of subscriptions LUIDs.
Batch list metric definitions (few) - Not available for Tableau Server	Gets the details of a batch of metric definitions and metrics on a site, specified in a brief comma delimited list of LUIDs.
Batch list metric definitions (many) - Not available for Tableau Server	Gets the details of a batch of definitions specified in a comma delimited list of LUIDs. This method is optimized for batches with large numbers of definitions.
Batch list metrics (few) - Not available for Tableau Server	Gets a batch of metrics from a definition, specified in a comma delimited list.
Batch list metrics (many) - Not available for Tableau Server	Gets batches of metrics available on a server. Only metrics a user has privileges to view will be visible. This endpoint uses POST as an alternative to GET, where long lists of URL parameters could be problematic.
Create metric - Not available for Tableau Server	Creates a metric.
Create metric definition - Not available for Tableau Server	Creates a metric definition.
Create metric tag for user - Not available for Tableau Server	Creates a tag for the specified metric, for the signed in user.
Create subscription - Not available for Tableau Server	Creates a subscription to a specified metric for a specified user or group.
Delete metric - Not available for Tableau Server	Deletes a metric.
Delete metric definition - Not available for Tableau Server	Deletes a metric definition.
Delete metric tag - Not available for Tableau Server	Deletes the specified metric tag.
Delete Pulse subscription - Not available for Tableau Server	Deletes a specified subscription to a metric.
Generate basic insight bundle - Not available for Tableau Server	Generates a basic insight bundle.
Generate breakdown insight bundle - Not available for Tableau Server	Generates a breakdown insight bundle. This provides the BAN and breakdown groups of insights.
Generate current metric value insight bundle - Not available for Tableau Server	Generates a bundle the current aggregated value for each metric.
Generate detail insight bundle - Not available for Tableau Server	Generates a detail insight bundle.
Generate exploration insight bundle - Not available for Tableau Server	Generates an exploration insight bundle. This provides the BAN, anchor, and followup groups of insights.
Generate insight brief - Not available for Tableau Server	Generates an insight brief based on a user utterance by gathering insights for the specified metrics. For supplemental information, see.
Generate metric card image - Not available for Tableau Server	Generates a PNG image of a Pulse metric card with full visual parity to the web UI homepage.
Generate springboard insight bundle - Not available for Tableau Server	Generates a springboard insight bundle.
Get metric - Not available for Tableau Server	Gets the details of the specified metric.
Get metric definition - Not available for Tableau Server	Gets a metric definition and optionally metrics it contains.
Get or create metric - Not available for Tableau Server	Returns the details of a metric in a definition if it exists, or creates a new metric if it does not. Also returns 'true' if a new metric was created, or 'false' if it already existed.
Get Pulse subscription - Not available for Tableau Server	Gets a specified subscription to a metric.
Get site entitlements - Not available for Tableau Server	Returns entitlements available for a site. If entitlements are True, then Pulse premium features are enabled for the site.
Gets recommended metrics - Not available for Tableau Server	Gets personalized groups of metrics to recommend to a user. Only metric that the user has privileges to view will be returned.
List followed metrics groups - Not available for Tableau Server	Gets the user's followed metrics. Optionally metrics can be grouped by characteristics like datasource, and sorted.
List metric definition measurement periods - Not available for Tableau Server	Gets the measurement periods for the specified metric definition.
List metric definitions - Not available for Tableau Server	Lists the metric definitions configured for a site or, optionally, the details and definition for a specific metric.
List metrics in definition - Not available for Tableau Server	Lists the metrics contained in a metric definition.
List Pulse user preferences - Not available for Tableau Server	Gets the signed in user's preferences for notifications channels and cadence, and for grouping and sorting followed metrics in REST responses and UI.
List site alerts - Not available for Tableau Server	List the alerts for the authorized user user on a specified site.
List subscriptions - Not available for Tableau Server	Lists the subscriptions to a specified metric and/or for a specified user.
Lists all definition tags for the site. - Not available for Tableau Server	Lists all definition tags for the site. Results can be filtered by tag value, definition name, or datasource ID. Each result includes the tag value and a count of how many definitions use it.
Update metric - Not available for Tableau Server	Updates the specification of a metric.
Update metric definition - Not available for Tableau Server	Updates a metric definition.
Update Pulse user preferences - Not available for Tableau Server	Updates the signed in user's preferences for notifications channels and cadence, and for grouping and sorting followed metrics in REST responses and UI.

Recycle Bin Methods

Delete All Recycle Bin Contents	Permanently deletes all content in a site's Recycle Bin.
Delete Recycle Bin Content Item	Permanently deletes the specified Recycle Bin content item.
Get Recycle Bin Content Item	Returns information about the specified Recycle Bin content item.
List Recycle Bin Content by Type	Gets a list of Recycle Bin content of the specified type.
Restore Recycle Bin Content Item	Restores the specified content item from the Recycle Bin to a project.

Revisions Methods

Download Data Source Revision	Downloads a specific version of a data source prior to the current one in `.tdsx` format. To down load the current version of a data source use the Download Data Source method.
Download Workbook Revision - Available only if version history is enabled for the specified site.	Downloads a specific version of a workbook in `.twb` or `.twbx` format.
Get Data Source Revisions	Returns a list of revision information (history) for the specified data source.
Get Workbook Revisions	Returns a list of revision information (history) for the specified workbook.
Remove Data Source Revision	Removes a specific version of a data source from the specified site.
Remove Workbook Revision	Removes a specific version of a workbook from the specified site.

Server Methods

Delete Server Session	Deletes a specified session. This method is not available for Tableau Cloud and is typically used in programmatic management of the life cycles of embedded Tableau sessions.
Get Current Server Session	Returns details of the current session of Tableau Server.
List Server Active Directory Domains - Not available for Tableau Cloud.	Returns the details of the Active Directory domains that are in use on the server, including their full domain names, nicknames and IDs. If the server is configured to use local authentication, the command returns only the domain name `local`.
Server Info	Returns the version of Tableau Server and the supported version of the REST API.
Update Server Active Directory Domain - Not available for Tableau Cloud.	Changes the nickname or full domain name of an Active Directory domain on the server. This method is not available on Tableau Cloud.

Site Methods

Create Site - Not available for Tableau Cloud.	Creates a site on Tableau Server. To make changes to an existing site, call Update Site. This method isn’t available for Tableau Cloud.
Delete Site - Not available for Tableau Cloud.	Deletes the specified site.
Get Data Acceleration Report for a Site	Returns a report about data acceleration for the site. It lets you compare page load times for before and after data acceleration is enabled.
Get Embedding Settings for a Site	Returns the current embedding settings for a specific site.
Get Recently Viewed for Site	Gets the details of the views and workbooks on a site that have been most recently created, updated, or accessed by the signed in user. The 24 most recently viewed items are returned, though it may take some minutes after being viewed for an item to appear in the results.
Get User Personal Space	Gets the details of the Personal Space for the currently authenticated user.
List Authentication Configurations for Site - Not available for Tableau Server.	List all authentications configurations on the site.
Query Site	Returns information about the specified site, with the option to return information about the storage space and user count for the site.
Query Sites - Not available for Tableau Cloud.	Returns a list of the sites on the server that the caller of this method has access to. This method is not available for Tableau Cloud.
Query Views for Site	Returns all the views for the specified site, optionally including usage statistics.
Update Embedding Settings for Site	Updates the embedding settings for a site. Embedding settings can be used to restrict embedding Tableau views to only certain domains.
Update Site - Not available for Tableau Cloud.	Modifies settings for the specified site, including the content URL, administration mode, user quota, state (active or suspended), storage quota, whether flows are enabled, whether subscriptions are enabled, and whether revisions are enabled.

Subscriptions Methods

Create Subscription	Creates a new subscription to a view or workbook for a specific user on Tableau Server and Tableau Cloud. When a user is subscribed to the content, Tableau sends the content to the user in email on the schedule that you define.
Delete Subscription	Deletes the specified subscription on Tableau Server or Tableau Cloud.
Get Subscription	Returns information about the specified subscription.
List Subscriptions	Returns a list of all the subscriptions on the specified site.
Update Subscription	Modifies an existing subscription on Tableau Server. You can change the subject, server schedule, and suspension state for the subscription.

Tableau Extensions Settings Methods

List Tableau extensions server settings - Not available for Tableau Cloud.	Lists the settings for extensions of a server.
List Tableau extensions site settings	Lists the settings for extensions of a site.
Update Tableau extensions server settings - Not available for Tableau Cloud.	Updates the settings for extensions of a server.
Update Tableau extensions site settings	Updates the settings for extensions of a site.

Tableau Knowledge Graph Methods

Create a semantic context - Not available for Tableau Server	Create a semantic context node carrying one or more statements.
Delete a semantic context - Not available for Tableau Server	Delete a semantic context created and managed in Tableau Knowledge, along with its statements.
Get a node by ID - Not available for Tableau Server	Get a single node by its ID, including its semantic statements and directly connected nodes.
Get graph-health suggestions - Not available for Tableau Server	Get a report on the health of the graph, including a score and suggested improvements.
Get the downstream impact of a node - Not available for Tableau Server	Get the assets that depend on a node, to see the impact if it changes.
Get the lineage of a node - Not available for Tableau Server	Get the lineage neighborhood of a node.
List edges around a node - Not available for Tableau Server	List the edges connected to a node.
List knowledge graphs - Not available for Tableau Server	List the knowledge graphs on the caller's Tableau site, each with its ID, name, description, status, and.
List knowledge sources - Not available for Tableau Server	List the data sources and workbooks connected to the graph.
Search graph nodes - Not available for Tableau Server	Search graph nodes using natural-language semantic search.
Search semantic contexts - Not available for Tableau Server	Search semantic contexts across the graph.
Search semantic contexts attached to a node - Not available for Tableau Server	Search the semantic contexts attached to a specific node.
Update a semantic context - Not available for Tableau Server	Partially update a semantic context.

Tableau MCP Methods

Create Tableau MCP Settings for Site	Replaces the current list of Tableau MCP settings for a given site.
Get Tableau MCP Settings for Site	Gets the list of Tableau MCP settings for a specified site.
Update Tableau MCP Settings for Site	Updates the current list of Tableau MCP settings for a specified site.

Users and Groups Methods

Add Group to Group Set	Adds group to a group set.
Add User to Group	Adds a user to the specified group.
Add User to Site	Adds a user to Tableau Server or Tableau and assigns the user to the specified site.
Create Group	Creates a group on a Tableau Cloud site or Tableau Server.
Create Group Set	Creates a group set with a specified name.
Create SCIM Configuration - Not available for Tableau Server.	Creates the System for Cross-domain Identity Management Configuration (SCIM) configuration on the Tableau Cloud site.
Create SCIM Token	Generates the System for Cross-domain Identity Management (SCIM) token and secret.
Delete Group	Deletes the group on a specific site. Deleting a group does not delete the users in group, but users are no longer members of the group. Any permissions that were previously assigned to the group no longer apply.
Delete Group Set	Deletes the group set on a specific site. Deleting a group set doesn’t delete the users in the group set, but users are no longer members of the group set. Any permissions that were previously assigned to the group set no longer apply.
Delete SCIM Configuration - Not available for Tableau Server.	Permanently removes the System for Cross-domain Identity Management (SCIM) configuration from the Tableau Cloud site.
Delete SCIM Token - Not available for Tableau Server.	Permanently removes the System for Cross-domain Identity Management (SCIM) token.
Delete Users from Site with CSV	Creates a job to remove a list of users, specified in a .csv file, from a site.
Download User Credentials	Gets credentials for a user who is being migrated to another Tableau Cloud or Tableau Server site.
Get Group Set	Returns information about the specified group set including ID, name, and member groups.
Get Groups for a User	Gets a list of groups of which the specified user is a member.
Get SCIM Configuration - Not available for Tableau Server.	Gets the System for Cross-domain Identity Management (SCIM) configuration on the Tableau Cloud site.
Get Users in Group	Gets a list of users in the specified group.
Get Users on Site	Returns the users associated with the specified site.
Import Users to Site from CSV	Creates a job to import the users listed in a specified .csv file to a site, and assign their roles and authorization settings.
List Group Sets	Lists all group sets matching optional filter and ordered by optional sort expression.
List SCIM Configurations - Not available for Tableau Server.	Returns the System for Cross-domain Identity Management Configuration (SCIM) configurations on the Tableau Cloud site.
Query Groups	Returns a list of groups on the specified site, with optional parameters for specifying the paging of large results.
Query User On Site	Returns information about the specified user.
Remove Group from Group Set	Removes a group from the specified group set.
Remove User from Group	Removes a user from the specified group.
Remove User from Site	Removes a user from the specified site. The user will be deleted if they do not own any other assets other than subscriptions. If a user still owns content (assets) on Tableau Server, the user cannot be deleted unless the ownership is reassigned first.
Update Group	Updates a group on a Tableau Cloud site or Tableau Server.
Update Group Set	Updates a group set name on a Tableau Server or Tableau Cloud site.
Update SCIM Configuration - Not available for Tableau Server.	Updates the System for Cross-domain Identity Management (SCIM) configuration on the Tableau Cloud site.
Update User	Modifies information about the specified user.
Upload User Credentials	Uploads user credentials to a site on a destination Tableau Cloud or Tableau Server.

Virtual Connections Methods

Add Tags to Virtual Connection - Available only with a Data Management license.	Adds tags to a virtual connection.
Add Virtual Connection Permissions - Available only with a Data Management license.	Adds permissions to the specified virtual connection for a user or group. You can specify multiple sets of permissions using one call.
Add Virtual Connection to Server Schedule - Not available for Tableau Cloud.	Adds a task to refresh a virtual connection to an existing server schedule on Tableau Server. For Tableau Cloud, see Create Cloud Extract Refresh Task.
Create Cloud Extract Refresh Task - Not available for Tableau Server.	Creates a custom schedule for an extract refresh on Tableau Cloud. The target of the schedule can be a data source, a workbook, or a virtual connection. For Tableau Server, see Add data source to server schedule, Add workbook to server schedule, and Add virtual connection to server schedule.
Delete Extracts from Virtual Connection - Available with a Data Management, Enterprise, Server+, Cloud+, or Tableau+ Bundle license.	Deletes the extracts from a virtual connection, which changes it from extract to live mode.
Delete Tag from Virtual Connection - Available only with a Data Management license.	Deletes a tag from a virtual connection.
Delete Virtual Connection - Available only with a Data Management license.	Deletes a virtual connection.
Delete Virtual Connection Permission - Available only with a Data Management license.	Removes the specified virtual connection permission for the specified group or user.
Download Virtual Connection - Available with a Data Management, Enterprise, Server+, Cloud+, or Tableau+ Bundle license.	Downloads a virtual connection in `.tvcx` format. To download a JSON representation of a virtual connection instead, see Download Virtual Connection as JSON.
Download Virtual Connection as JSON - Available only with a Data Management license.	Downloads a JSON-representation of a virtual connection. To download a virtual connection as a `.tvcx` file, see Download Virtual Connection.
Download Virtual Connection Revision as JSON - Available only with a Data Management license.	Downloads a JSON-representation of an earlier revision of a virtual connection.
List Virtual Connection Database Connections - Available only with a Data Management license.	Returns information about database connections in the specified virtual connection.
List Virtual Connection Permissions - Available only with a Data Management license.	Returns a list of permissions for a specific virtual connection.
List Virtual Connection Revisions - Available only with a Data Management license.	Lists revisions for a virtual connection.
List Virtual Connections - Available only with a Data Management license.	Returns a list of available virtual connection names and IDs.
Publish Virtual Connection - Available only with a Data Management license.	Publishes a virtual connection on the specified site, either from a packaged virtual connection file (`.tvcx`) or from a downloaded JSON representation.
Update Virtual Connection - Available only with a Data Management license.	Updates a virtual connection's name, owner, project, or certification status.
Update Virtual Connection Database Connections - Available only with a Data Management license.	Updates the server address, port, username, or password for the specified database connection in a virtual connection.
Update Virtual Connection Now - Available with a Data Management, Enterprise, Server+, Cloud+, or Tableau+ Bundle license.	Runs an extract refresh on the specified virtual connection.

Workbooks and Views Methods

Add Tags to View	Adds one or more tags to the specified view.
Add Tags to Workbook	Adds one or more tags to the specified workbook.
Delete Custom View	Deletes the specified custom view.
Delete Tag from View	Deletes a tag from the specified view.
Delete Tag from Workbook	Deletes a tag from the specified workbook.
Delete View	Deletes a view from a workbook.
Delete Workbook	Deletes a workbook. When a workbook is deleted, all of its assets are also deleted, including associated views, data connections, and so on.
Download View Crosstab Excel	Downloads an Excel (`.xlsx`) file containing crosstab data from a view that the user has permission to access in a workbook. If a crosstab is exported from a dashboard, data from only the first view in the dashboard will appear in the `.xlsx` file. Downloads of data from story dashboards are not supported at this time.
Download Workbook	Downloads a workbook in `.twb` or `.twbx` format.
Download Workbook Encrypted Keychain	Gets an encrypted version of the embedded credentials from the workbook. These credentials can only be migrated to the linked destination Tableau Cloud or Tableau Server.
Download Workbook PDF	Downloads a `.pdf` containing images of the sheets that the user has permission to view in a workbook.
Download Workbook PowerPoint	Downloads a PowerPoint (`.pptx`) file containing slides with images of the sheets that the user has permission to view in a workbook. Download Images/PDF permissions must be enabled for the workbook (true by default). If Show sheets in tabs is not selected for the workbook, only the default tab will appear in the `.pptx` file.
Download Workbook Revision - Available only if version history is enabled for the specified site.	Downloads a specific version of a workbook in `.twb` or `.twbx` format.
Get Custom View	Gets the details of a specified custom view.
Get Custom View Data	Returns a specified custom view rendered as data in comma separated value (CSV) format.
Get Custom View Image	Downloads an image file of the specified custom view.
Get Custom View PDF	Returns a specified custom view rendered as a .pdf file.
Get Recommendations for Views - Deprecated in API 3.19	Gets a list of views that are recommended for a user.
Get View	Gets the details of a specific view.
Get View by Path	Gets the details of all views in a site with a specified name.
Get Workbook	Returns information about the specified workbook, including information about views and tags.
Get Workbook Downgrade Info	Returns a list of the features that would be impacted, and the severity of the impact, when a workbook is exported as a downgraded version (for instance, exporting a v2019.3 workbook to a v10.5 version).
Get Workbook Revisions	Returns a list of revision information (history) for the specified workbook.
Hide a Recommendation for a View - Deprecated in API 3.19	Hides a view from being recommended by the server by adding it to a list of views that are dismissed for a user.
List Custom Views	Gets a list of custom views on a site. The list includes details of each custom view.
List Users with Custom View as Default	Gets the list of users whose default view is the specified custom view.
Publish Workbook	Publishes a workbook on the specified site.
Query View Data	Returns a specified view rendered as data in comma separated value (CSV) format.
Query View Image	Downloads an image file of the specified view.
Query View PDF	Returns a specified view rendered as a .pdf file.
Query View Preview Image	Returns the thumbnail image for the specified view.
Query Views for Site	Returns all the views for the specified site, optionally including usage statistics.
Query Views for Workbook	Returns all the views for the specified workbook, optionally including usage statistics.
Query Workbook Connections	Returns a list of data connections for the specific workbook.
Query Workbook Preview Image	Returns the thumbnail image as a PNG file for the specified workbook. Usually the image that is returned is for the first sheet in the workbook.
Query Workbooks for Site	Returns the workbooks on a site.
Query Workbooks for User	Returns the workbooks that the specified user owns in addition to those that the user has Read (view) permissions for.
Set Custom View as Default for Users	Sets the specified custom for as the default view for up to 100 specified users. Success or failure for each user is reported in the response body.
Unhide a Recommendation for a View - Deprecated in API 3.19	Unhides a view from being recommended by the server by removing it from the list of views that are dimissed for a user.
Update Custom View	Changes the owner or name of an existing custom view.
Update Workbook	Modifies an existing workbook, allowing you to change the owner or project that the workbook belongs to and whether the workbook shows views in tabs. Updated workbooks can optionally be marked to appear in the recently viewed list.
Update Workbook Connection	Updates the server address, port, authentication type, username, or password for the specified workbook connection.
Update Workbook Connections	Updates the server address, port, authentication type, username, or password for one or more connections in a data source. To update all connections in a given data source with the same connection information, see Update Workbook Connection.
Update Workbook Now	Refreshes the specified workbook.
Update Workbook Thumbnail Images	Updates a workbook's thumbnail images.
Upload Workbook Encrypted Keychain	Uploads the encrypted version of the embedded credentials. This method will only work if the credentials are encrypted with the latest public key used to link the source Tableau Server with the destination Tableau Cloud or Tableau Server site.
Validate Uploaded Workbook	Validates a Tableau workbook (TWB) file that already exists in temporary storage on Tableau Cloud or Tableau Server. The TWB is validated against the TWB XSD schema and verifies that it can be loaded in Tableau.
Validate Workbook	Validates a Tableau workbook (TWB) file against the TWB XSD schema and verifies that it can be loaded in Tableau.
Validate Workbook and Upload	Validates a Tableau workbook (TWB) file against the TWB XSD schema and verifies that it can be loaded in Tableau. If validation succeeds, this method stores the TWB in a temporary location on Tableau Cloud or Tableau Server for further use.

## API Method Details The following content describes each endpoint in the Tableau REST API surface. Use the alphabetically sorted list of methods on the right, or **ctrl/cmd-f** to go directly to keywords you have in mind. ## Add analytics extension connection to site Adds a new analytics extension connection for an external service to a site. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server or site administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:analytics\_extensions:create\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) or [Server](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/settings/site/extensions/analytics/connections [view details](#) ## Add Ask Data Lens Permissions - Retired in API 3.22 > > [!WARNING] > > > > Tableau's Ask Data and Metrics features were retired in Tableau Cloud in February 2024 and in Tableau Server version 2024.2. With advances in natural language technologies, we're developing an improved interface that will make it easier to ask questions of your data and stay on top of changes. For more information, see [How Tableau AI and Tableau Pulse are reimagining the data experience](https://www.tableau.com/blog/tableau-pulse-and-tableau-ai). Adds permissions to the specified ask data lens for a user or group. You can specify multiple sets of permissions using one request. If a specified permission has already been granted or denied for a given user or group, the system ignores it. #### URI PUT /api/api-version/sites/site-luid/lenses/lens-luid/permissions #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site that contains the data source.
lens-luid	The LUID of the data source to set permissions for.

#### Request Body ` ... additional capabilities ... ... additional capabilities ... ... additional grantee capability sets ... ` #### Attribute Values

lens-luid	Required. The LUID of the ask data lens permissions are being configured for.
user-luid	Optional (at least one user or group must be specified). The LUID of the user to add permissions for.
group-luid	Optional. The LUID of the group to add permissions for.
capability-name	The capability to assign. For valid capabilities for a data source project are ChangePermissions, Delete, Move, Read, Write. For more information, see Permissions.
capability-mode	Allow to allow the capability, or Deny to deny it. This value is case sensitive.

#### Permissions Users with server or site administrator permissions, and non-administrators that have ChangePermissions permission for the lens (either explicitly or implicitly), can add ask data lens permissions. #### Response Code 200 #### Response Body ``` ``` #### Version Introduced Tableau Cloud June 2022 (API 3.16). Not currently available for Tableau Server. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400009	Invalid capability	The specified capability is invalid for a data source. Valid capabilities for a data source are ChangePermissions, Delete, Move, Read, and Write.
403	403004	No permissions to set permissions.	A user attempted to add permissions to a data source, but the caller doesn't have permission to set permissions on the data source.
404	404000	Site not found	The specified site doesn't correspond to an existing site.
404	404002	User not found	The user specified in the request body doesn't correspond to an existing user.
404	404006	Lens not found	The specified lens doesn't correspond to an existing data source.
404	404012	Group not found	The group specified in the request body doesn't correspond to an existing group.
404	404013	Capability not found	A capability specified in the request body doesn't correspond to a defined capability. This can apply to either an invalid capability name or to a capability other than Allow or Deny for any mode value.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Add Collection Permissions Adds permissions to the specified collection for a user or group. You can specify multiple sets of permissions using one call. If a specified permission has already been granted or denied for a given user or group, the system ignores it. #### URI PUT /api/api-version/sites/site-id/collections/collection-id/permissions #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the collection.
collection-id	The ID of the collection to set permissions for.

#### Request Body ``` ``` #### Attribute Values

user-id	The ID of the user to add permissions for.
group-id	The ID of the group to add permissions for.
capability-name	The capability to assign. The only valid capability for a collection is Read. For more information, see Permissions.
capability-mode	Allow to allow the capability, or Deny to deny it.

#### Permissions This method can be called by server administrators, site administrators, and collection owners. #### Required scope for JWT authorization _Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. ``` tableau:permissions:update ``` #### Response Code 200 #### Response Body ``` ``` #### Version Version 3.12 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
403	403004	No permissions to set permissions.	A user attempted to add permissions to a collection, but the caller doesn't have permission to set permissions on the collection.
404	404000	Resource not found	The site ID in the URI wasn't found.
404	404002	User not found	The user in the request body wasn't found.
404	404012	Group not found	The group in the request body wasn't found.
404	404013	Resource not found	The capability to remove the permission for. The only valid capability name for a collection is Read. The only valid capability mode is Allow or Deny.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Add Data Quality Warning Add a data quality warning to a database, table, column, published data source, flow, virtual connection, or virtual connection table. **Note:** Data quality warnings and certifications can be more generally managed through the newer **Labels** methods. Tableau recommends using them to help ensure that you can manage your assets as new features are developed. Try the [Update Labels](#update_labels_on_assets) method instead. The Add Data Quality Warning method adds a data quality warning to an asset. (An automatically-generated monitoring warning does not count towards this limit.) In Tableau Cloud February 2024 and Tableau Server 2024.2 and earlier, adding a data quality warning to an asset that already has one causes an error. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI POST api/_api-version_/sites/_site-id_/dataQualityWarnings/_content-type_/_content-luid_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
content-type	The type of asset that the data quality warning is being attached to. To specify the type, use: database table column - Available in API 3.16 and later (Tableau Cloud October 2022, Server 2022.3) datasource flow virtual connection virtual connection table These values are not case sensitive.
content-luid	The unique ID of the asset (database, table, column, published data source, flow, virtual connection, or virtual connection table). This is the same as the content ID.

#### Request Body ``` ``` #### Attribute Values Any combination of attributes inside the **** element is valid, but the data quality warning type is required. If the data quality warning type is not included, an error is thrown.

type	Type of data quality warning to apply to the asset. To specify the type, use one of the following values: DEPRECATED WARNING STALE SENSITIVE_DATA MAINTENANCE These values are case sensitive.
state	(Optional) Controls whether the data quality warning displays. Value can be "true" or "false". If the state is not specified, the data quality warning is set to "true" and is visible by default. For more information about data quality warnings, see "Set a Data Quality Warning" in the Server Help or Cloud Help.
message	(Optional. Was required in Tableau Server 2023.3 and earlier.) A custom message to accompany the data quality warning. You can format the message with italics, bold text, links, images, and more. Use HTML character entities to match the special characters in the formatting guide that's normally visible as a tooltip in the UI.
severity	(Optional) Enables high visibility for the data quality warning when set to "true". Value can be "true" or "false". For more information, see the "Visibility" section of the "Set a Data Quality Warning" topic in the Server Help or Cloud Help.

#### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to add the data quality warning: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:labels:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 201 #### Response Body **Example response:** ``` ``` #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400108	Generic add data quality warning error	The data quality warning could not be added for some other reason than those specified in this table.
400	400109	Bad request	The request body is missing the data quality warning type.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
403	403004	Unauthorized operation	Insufficient permissions to perform the operation.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404029	Content not found	The requested asset could not be found.
409	409004	Invalid parameter	One or more values in the request body are invalid.

## Add Data Source Permissions Adds permissions to the specified data source for a user or group. You can specify multiple sets of permissions using one call. If a specified permission has already been granted or denied for a given user or group, the system ignores it. If the request body includes a child workbook or element, the request is invalid. #### URI PUT /api/api-version/sites/site-id/datasources/datasource-id/permissions #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the data source.
datasource-id	The ID of the data source to set permissions for.

#### Request Body ``` ... additional capabilities ... ... additional capabilities ... ... additional grantee capability sets ... ``` #### Attribute Values

datasource-id	The <datasource> element is not required, but can be included for compatibility with earlier versions of the REST API. If the <datasource> element is included, the datasource-id value must match the data source ID in the URI. Any other attributes in the <datasource> element are ignored.
user-id	The ID (not name) of the user to add permissions for.
group-id	The ID (not name) of the group to add permissions for.
capability-name	The capability to assign. For valid capabilities for a data source project are PulseMetricDefine, ChangePermissions, Connect, Delete, ExportXml, ExtractRefresh,Read (view), Write, and SaveAs. For more information, see Permissions.
capability-mode	Allow to allow the capability, or Deny to deny it. This value is case sensitive.

#### Permissions Users who are not server administrators or site administrators can add permissions only to a data source for which they have ChangePermissions permission (either explicitly or implicitly). #### Required scope for JWT authorization _Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. ``` tableau:permissions:update ``` #### Response Code 200 #### Response Body ``` ... additional capabilities ... ... additional capabilities ... ... additional grantee capability sets ... ``` #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400009	Invalid capability	The specified capability is invalid for a data source. Valid capabilities for a data source are ChangePermissions, Connect, Delete, ExportXml, Read, and Write.
403	403004	No permissions to set permissions.	A user attempted to add permissions to a data source, but the caller doesn't have permission to set permissions on the data source.
404	404000	Site not found	The specified site doesn't correspond to an existing site.
404	404002	User not found	The user specified in the request body doesn't correspond to an existing user.
404	404004	Data source not found	The specified data source doesn't correspond to an existing data source.
404	404012	Group not found	The group specified in the request body doesn't correspond to an existing group.
404	404013	Capability not found	A capability specified in the request body doesn't correspond to a defined capability. This can apply to either an invalid capability name or to a capability other than Allow or Deny for any mode value.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Add Data Source to Favorites Adds the specified data source to the user's favorites. If the user already has the data source listed as a favorite with the same label, the operation has no effect. If the label differs, the original favorite is overwritten. #### URI PUT /api/api-version/sites/site-id/favorites/user-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the data source.
user-id	The ID of the user to add the favorite for.

#### Request Body ``` ``` #### Attribute Values

favorite-label	A label to assign to the favorite. This value is displayed when you search for favorites on the server.
datasource-id	The ID of the data source to add as a favorite.

#### Permissions Tableau Server users who are not server administrators or site administrators can call this method only if they have Read (view) permissions on the data source (either explicitly or implicitly). #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:favorites:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ... additional favorites ... ``` #### Version Version 2.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400005	Invalid label	The favorite label is empty or consists of only white space characters.
403	403004	Forbidden favorites access	A non-administrator user called this method but doesn't have permission to add a data source to the specified user's favorites. This will always be the case when the user ID in the URI represents a different user than a non-administrator user who is calling the method.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user.
404	404011	Data source not found	The data source ID in the request body doesn't correspond to an existing data source.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Add Data Source to Server Schedule Adds a task to refresh a data source to an existing server schedule on Tableau Server. _For Tableau Cloud, see [Create Cloud Extract Refresh Task](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_extract_and_encryption.htm#create_cloud_extract_refresh_task)._ #### URI PUT /api/api-version/sites/site-id/schedules/schedule-id/datasources #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the view.
schedule-id	The ID of the schedule that you are associating with the data source.

#### Request Body ``` ``` #### Attribute Values

datasource-id

The ID of the data source to add to the schedule.

#### Permissions Tableau Server users who are not server administrators or site administrators can only add a data source to a schedule if they own the data source, or are the project leader for the project that contains the data source. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:schedules:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` #### Version Version 2.8 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403032	Update Forbidden	A non-administrator user called this method, but the caller doesn't have sufficient permissions.
404	404000	Site not found	The site ID in the URI is unknown.
404	404004	Resource not found	The data source ID in the request body is unknown.
405	405000	Invalid request method	Request type was not PUT.
500	500000	Internal Server Error	The schedule ID in the URI is unknown.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/1edc53ac-e247-4870-9fd3-6fad0ce5f84d/schedules/9a4ebbab-9ec8-487a-9b48-47fa81d6077a/datasources" -X PUT -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" –d @add-to-schedule.xml` **Content of add-to-schedule.xml:** ``` ``` **Example response:** ``` ``` ## Add Database Permissions Add permissions to a database asset. To add permissions, the database asset must be associated with a published data source. **Version:** Available in API 3.5 (Tableau Cloud and Tableau Server) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** Available with [Tableau Data Management](https://help.tableau.com/current/online/en-us/dm_overview.htm). **Permissions:** Users that are granted ChangePermissions capabilities for the asset metadata and all administrators can add database permissions. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: _Not available._ #### URI PUT api/_api-version_/sites/_site-luid_/databases/_database-luid_/permissions #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site asset.
database-luid	The LUID of the database asset.

#### Request Body ``` ``` #### Attribute Values ``` { "permissions": { "database": { "id": "1d4aa9f-3d1a-4b49-8d6d-27f113cbd25e" }, "granteeCapabilities": [ { "user": { "@id": "2d4aa9f-3d1a-4b49-8d6d-27f113cbd25e" }, "capabilities": { "capability": { "name": "ChangePermissions", "mode": "allow" } } }, { "group": { "id": "3d4aa9f-3d1a-4b49-8d6d-27f113cbd25e" }, "capabilities": { "capability": { "name": "Read", "mode": "Allow" } } } ] } } ``` #### Request Attributes

`database`	The LUID of the database asset you want to add permissions to.
`user id`	The LUID of the user to add permissions for.
`capability name`	The capability to assign. If any capability has been granted or denied for a specified user or group, that capability is ignored. Valid capabilities for a database are: Read (view) Write (edit) ChangePermissions (set permissions) ChangeHierarchy (move) These values are case sensitive.
`capability mode`	Use one of the following capabilities: Allow Deny These values are case sensitive.
`group id`	The LUID of the group to add permissions for.

#### Response Code 200 #### Response Body ``` ``` ``` { "permissions": { "database": { "id": "e8d4aa9f-3d1a-4b49-8d6d-27f113cbd25e", "name": "oracle.test.tsi.lan:1521" }, "granteeCapabilities": { "user": { " id": "6265b714-7533-465d-b6db-6d0be92bfd07" }, "capabilities": { "capability": { "name": "Read", "mode": "Allow" } } } } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400120	Bad request	Permissions could not be added because support for explicit permissions is available for database assets associated with published data sources only.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
404	404000	Resource not found	The site LUID in the URI doesn't correspond to an existing site.
404	404031	Database not found	The requested database could not be found.
405	405000	Invalid request method	Request type was not PUT.
409	409045	Database error	An unknown database asset error occurred.
409	409050	Database update error	An unknown error occurred and the database asset could not be updated.
409	409051	Database update forbidden	A user without "write" permissions to the database asset attempted an update.

## Add Default Database Permissions Adds default permission capabilities to a user or group for table resources in that database. Default permissions function as a permissions template for the database's table assets. Note: If a database is in a project, default database permissions are not evaluated to determine table permissions. Use the [Add Default Permissions](#add_default_permissions) method to control default permission capabilities on tables through projects instead. How default permissions are enforced depends on whether the database is locked or unlocked. - **Locked to the database:** If the permissions on a database are locked or Locked to the database, existing child table assets and new child table assets that get indexed by Catalog will inherit the default permissions applied to the parent database asset. **Note:** If the database is locked, explicit permissions cannot be made for individual tables. - **Managed by the owner:** If the permissions on a database are unlocked or **Managed by the owner**, only new child table assets that get indexed by Catalog will inherit the default permissions applied to the parent database asset. **Note:** If the database is unlocked, explicit permissions for the table can be made in a separate request. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI PUT /api/_api-version_/sites/_site-luid_/databases/_database-luid_/default-permissions/tables #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site asset.
database-luid	The LUID of the database asset to set default permissions for.

#### Request Body ``` ``` #### Attribute Values

user-luid	The LUID of the user to add default permissions for.
group-luid	The LUID of the group to add permissions for.
capability-name	The capability to assign. If any capability has been granted or denied for a specified user or group, that capability is ignored. Valid capabilities for a databases are the following: Read (view) Write (edit) ChangePermissions (set permissions) ChangeHierarchy (move) These values are case sensitive.
capability-mode	Use one of the following capabilities: Allow Deny These values are case sensitive.

#### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following authorized users set default permissions for the database asset: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to set or "ChangePermissions" to the asset metadata #### Response Code 200 #### Response Body ``` ``` #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
403	403004	Permissions setting forbidden	A non-administrator user called this method but doesn't have permission to add permissions on the project.
403	403114	Permissions setting forbidden	Default permissions cannot be added because the database asset is locked.
404	404000	Site not found	The site LUID in the URI doesn't correspond to an existing site.
404	404003	Resource not found	The database LUID in the URI doesn't correspond to a database asset on the site.
404	404002	User not found	A user LUID in the request body as the grantee doesn't correspond to an existing user.
404	404012	Group not found	A group LUID in the request body doesn't correspond to an existing group.
404	404013	Capability not found	The capability in the request body doesn't correspond to a defined capability. This can apply to either an invalid capability name or to a capability other than Allow or Deny for any mode value.
405	405000	Invalid request method	Request type was not PUT.

## Add Default Permissions Adds default permission rules for workbook, data source, data role, lens, flow, metric, or virtual connection resources in a project for a user or group. If Tableau Catalog is enabled, also adds default permission rules for database or table resources in a project for a user or group. After adding default permission rules, new resources of the type you specify that are added to the project will have those permission rules. If permissions are [locked to the project](https://help.tableau.com/current/server/en-us/permissions.htm#LockProject), then the same is true for all existing child content of the project. For more information, see [Permissions](https://help.tableau.com/current/server/en-us/permissions.htm). Content owners can override default permissions for their content, but only if project permissions have not been locked. Project permissions can be locked for a new project when you call [Create Project](#create_project) or for an existing project by calling [Update Project](#update_project). For more information, see [Lock Content Permissions to the Project](https://help.tableau.com/current/server/en-us/permissions.htm#LockProject). #### URI Workbooks: PUT /api/api-version/sites/site-luid/projects/project-luid/default-permissions/workbooks Data sources: PUT /api/api-version/sites/site-luid/projects/project-luid/default-permissions/datasources Data roles: PUT /api/api-version/sites/site-luid/projects/project-luid/default-permissions/dataroles Lenses: PUT /api/api-version/sites/site-luid/projects/project-luid/default-permissions/lenses Metrics: PUT /api/api-version/sites/site-luid/projects/project-luid/default-permissions/metrics Flows: PUT /api/api-version/sites/site-luid/projects/project-luid/default-permissions/flows Virtual Connections _(endpoint introduced in [API version](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm#rest_and_tableau_version_table) 3.23)_: PUT /api/api-version/sites/site-luid/projects/project-luid/default-permissions/virtualconnections Databases: PUT /api/api-version/sites/site-luid/projects/project-luid/default-permissions/databases Tables: PUT /api/api-version/sites/site-luid/projects/project-luid/default-permissions/tables #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site that contains the project.
project-luid	The LUID of the project to set default permissions for.

#### Request Body ``` < !-- ... additional capabilities ... --> < !-- ... additional capabilities ... --> < !-- ... additional grantee capability sets ... --> ``` #### Attribute Values

user-luid	The LUID of the user to add default permissions for.
group-luid	The LUID of the group to add permissions for.
capability-name	The capability to assign. Valid capabilities for a workbook are AddComment ChangeHierarchy ChangePermissions Delete ExportData ExportImage ExportXml Filter Read (view) ShareView ViewComments ViewUnderlyingData WebAuthoring Write RunExplainData CreateRefreshMetrics Valid capabilities for a data source are ChangePermissions Connect Delete ExportXml SaveAs Read (view) Write Valid capabilities for a flow are ChangeHierarchy ChangePermissions Delete ExportXml (download) Execute Read (view) WebAuthoringForFlows Write For more information, see Permissions.
capability-mode	Allow to allow the capability, or Deny to deny it. This value is case sensitive.

#### Permissions Users who are not server administrators can add permissions defaults for a project only if they have the ProjectLeader permission for that project (either explicitly or implicitly). #### Required scope for JWT authorization _Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. ``` tableau:permissions:update ``` #### Response Code 200 #### Response Body ``` ``` #### Version - Version 2.1 and later. - Version 3.23 and later for the virtual connection default permissions methods. - For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400009	Invalid capability	The capability in the URI is invalid for a data source. Valid capabilities for a workbook are AddComment, ChangeHierarchy, ChangePermissions, CreateRefreshMetrics, Delete, ExportData, ExportImage, ExportXml, Filter, Read (view), RunExplainData, ShareView, ViewComments, ViewUnderlyingData, WebAuthoring, and Write. Valid capabilities for a data source are ChangePermissions, Connect, Delete, ExportXml, Read (view), and Write.
400	400042	Malformed permissions qualifier	The request body includes a <workbook> or <datasource> element.
403	403004	Permissions setting forbidden	A non-administrator user called this method but doesn't have permission to add permissions on the project.
404	404000	Site not found	The site LUID in the URI doesn't correspond to an existing site.
404	404002	User not found	A user LUID in the request body as the grantee doesn't correspond to an existing user.
404	404005	Project not found	The project LUID in the URI doesn't correspond to an existing project.
404	404009	Project ID mismatch	A project LUID specified in the URI does not match the project ID specified in the request body. (You do not have to specify a project ID in the request body.)
404	404012	Group not found	A group LUID in the request body doesn't correspond to an existing group.
404	404013	Capability not found	The capability in the request body doesn't correspond to a defined capability. This can apply to either an invalid capability name or to a capability other than Allow or Deny for any mode value.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Add Domain to Pool Associates a domain with a specific Bridge pool, allowing Bridge clients from that domain to use the pool. Each domain can only be assigned to one pool at a time. Root domains and subdomains are supported. Domain assignments are site-specific. Adding a domain already in the pool returns an error. This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:create` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI POST /api/api-version/sites/site-luid/bridge-domain-maps #### URI Parameter Values

api-version	The version of the API to use. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.

#### Request Body ``` ``` ``` { "bridgeDomain": { "existingDomainName": "example.com", "newPoolLuid": "ebae40a5-d7e4-4214-b3d5-b0715c627b71" } } ``` #### Attribute Values

existingDomainName	The domain to add to the pool. Root domains and subdomains are supported.
newPoolLuid	The UUID of the Bridge pool to add the domain to. Must be a user-created pool (not a reserved system pool).

#### Response Code 200 #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
400	409004	Invalid domain name, invalid pool ID, domain already exists, or pool not found	Domain must conform to valid format; pool ID must be valid UUID and exist; domain must not already be in this pool.
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	403000	Insufficient permissions	User does not have Site Administrator role.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500	503904	Unexpected server error	An unexpected error occurred while adding the domain.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Add Flow Permissions Adds permissions to the specified flow for a Tableau Server user or group. You can specify multiple sets of permissions using one call. #### URI PUT /api/api-version/sites/site-id/flows/flow-id/permissions #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the flow.
datasource-id	The ID of the flow.

#### Request Body ``` ... additional capabilities ... ... additional capabilities ... ... additional grantee capability sets ... ``` #### Attribute Values

flow-id	The flow-id value for the flow you want to add permissions to.
user-id	The ID (not name) of the user to add permissions for.
group-id	The ID (not name) of the group to add permissions for.
capability-name	The capability to assign. If any capability has already been granted or denied for a specified user or group, that capability is ignored. Valid capabilities for a flow are: ChangeHierarchy ChangePermissions Delete Execute ExportXml (Download) Read (view) WebAuthoringForFlows Write For more information, see Permissions.

#### Permissions Tableau Server users who are not server administrators or site administrators can call this method only if they have permission to set permissions on the flow (either explicitly or implicitly). #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:permissions:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ```                                                                                                                                                                                                             ``` #### Version Version 3.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400009	Invalid capability	The capability in the URI is invalid for a flow. Valid capabilities for a flow are ChangeHierarchy, ChangePermissions, Delete, Execute, ExportXml (Download), Read (view), and Write.
403	403004	Permissions setting forbidden	A non-administrator user called this method but doesn't have permission to set permissions on the flow.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	A user ID in the request body doesn't correspond to an existing user.
404	404027	Flow not found	The flow ID in the URI doesn't correspond to an existing flow.
404	404012	Group not found	A group ID in the request body doesn't correspond to an existing group.
404	404013	Capability not found	The specified capability doesn't correspond to a defined capability. This can apply to either an invalid capability name or a capability other than Allow or Deny for any mode value.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Add Flow Task to Server Schedule > > [!WARNING] > > > > The Add Flow Task to Schedule method is renamed and retired for Tableau Cloud in API 3.22 (Tableau Cloud March 2024). It will remain available for Tableau Server only. For Tableau Cloud in March 2024, this method will be replaced with [Create Cloud Flow Task](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_flow.htm#create_cloud_flow_task) method. Adds a task to run a flow to an existing schedule. **Note:** This method is unavailable if you do not have a Data Management license or Tableau Prep Conductor is disabled for your site. #### URI PUT /api/api-version/sites/site-id/schedules/schedule-id/flows #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the flow.
schedule-id	The ID of the schedule that you are associating with the flow. The schedule that you are adding to must have Flow as the schedule type.

#### Request Body ``` ``` #### Attribute Values

flow-id

The ID of the flow to add to the schedule. This will include all the output steps in the flow and any output steps created in the future.

parameter-id

The ID of the flow parameter. Use the List Metrics for Site - Retired in API 3.22 method to get the flow parameter ID. A parameter is a global placeholder value such as a number, text value, or boolean value that can replace a constant value in a flow.

Note: Parameters are optional and only relevant for flows that contain parameters and the parameter setting is enabled.

For more information, see Run flows with parameters.

overrideValue

The run-time value for the flow parameter. You must specify this if the parameter is required. Use the List Metrics for Site - Retired in API 3.22 method to see if the parameter is required and to get a list of allowed values if the parameter is expecting a value from an enumerated list.

Note: Parameters are options and only relevant for flows that contains parameters and the parameter setting is enabled.

For more information, see Run flows with parameters.

#### Permissions Tableau Server users who are not server administrators or site administrators can only add a flow to a schedule if they own the flow, or are the project leader for the project that contains the workbook. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:schedules:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Version Version 3.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400148	Invalid parameter override value	The run-time value provided for the flow parameter is invalid.
400	400149	Missing run-time parameter value.	The run-time value for a required flow parameters was not provided.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403098	Update Forbidden	A non-administrator user called this method, but the caller doesn't have sufficient permissions.
404	404000	Site not found	The site ID in the URI is unknown.
404	404043	Flow parameter not found	The flow parameter information was not provided.
404	404002	User not found	A user ID in the request body doesn't correspond to an existing user.
404	404027	Flow not found	The flow ID in the URI doesn't correspond to an existing flow.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/1edc53ac-e247-4870-9fd3-6fad0ce5f84d/schedules/9a4ebbab-9ec8-487a-9b48-47fa81d6077a/flows" -X PUT -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" –d @add-to-schedule.xml"` **Content of add-to-schedule.xml:** The in the request body is optional and only required in the following scenarios: - The flow has parameters and the parameter is marked as required to run the flow. - The flow has parameters but not marked as required. However, you want to specify a different value than the configured default. ``` parameterId="a2fb691b-90fa-4b6e-850e-f16c5afc1f89" overrideValue= "2"/> ``` ## Add Flow to Favorites Adds the specified flow to the user's favorites. If the user already has the flow listed as a favorite with the same label, the operation has no effect. If the label differs, the original favorite is overwritten. #### URI PUT /api/api-version/sites/site-id/favorites/user-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the data source.
user-id	The ID of the user to add the favorite for.

#### Request Body ``` ``` #### Attribute Values

favorite-label	A label to assign to the favorite. This value is displayed when you search for favorites on the server.
flow-id	The ID of the flow to add as a favorite.

#### Permissions Tableau Server users who are not server administrators or site administrators can call this method only if they have Read (view) permissions on the data source (either explicitly or implicitly). #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:favorites:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ... additional favorites ... ``` #### Version Version 3.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400005	Invalid label	The favorite label is empty or consists of only white space characters.
403	403004	Forbidden favorites access	A non-administrator user called this method but doesn't have permission to add a data source to the specified user's favorites. This will always be the case when the user ID in the URI represents a different user than a non-administrator user who is calling the method.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user.
404	404027	Flow not found	The flow ID in the URI doesn't correspond to an existing flow.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Add Group to Group Set Adds group to a group set. **Version:** Available in API 3.22 (Tableau Cloud February 2024 / Server 2024.2) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** This method can only be called by Tableau Server administrators or Tableau Cloud site admins. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** tableau:groupsets:update - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT api/api-version/sites/site-id/groupsets/group-set-id/groups/group-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
group-set-id	The unique ID of the group set you want to add the group to.
group-id	The unique ID of the group you want to add to the group set.

#### Request Body None #### Response Code 200 #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
403	403004	Unauthorized operation	Insufficient permissions to perform the operation.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404012	Group not found	The group ID in the request body doesn't correspond to an existing group.
409	409120	Group set not found	The group set ID in the request body doesn't correspond to an existing group.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Add items to a collection Adds items to a collection. **Version:** Available in API 3.28 (Cloud February 2026 / Server 2026.2) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Tableau administrators can call this method for all sites they administer. Other users can call this method for collections that they own. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:collections:update. Added in API 3.28. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/collections/{luid}/items/batchCreate [view details](#) ## Add Metric to Favorites - Retired in API 3.22 **Retired in API 3.22 (Cloud February 2024 / Server 2024.2)** Tableau's legacy metrics feature was retired in Tableau Cloud in February 2024 and in Tableau Server version 2024.2. In October 2023, Tableau retired the ability to embed legacy metrics in Tableau Cloud and in Tableau Server version 2023.3. With Tableau Pulse, we've developed an improved experience to track metrics and ask questions of your data. For more information, see [Create Metrics with Tableau Pulse](https://help.tableau.com/current/online/en-us/pulse_create_metrics.htm) to learn about the new experience and [Create and Troubleshoot Metrics (Retired)](https://help.tableau.com/current/online/en-us/metrics_create.htm) for the retired feature. Adds the specified metric to the user's favorites. If the user already has the metric listed as a favorite with the same label, the operation has no effect. If the label differs, the original favorite is overwritten. #### URI PUT /api/api-version/sites/site-id/favorites/user-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the metric.
user-id	The ID of the user to add the favorite for.

#### Request Body ` ` #### Attribute Values

favorite-label	A label to assign to the favorite. This value is displayed when you search for favorites on the server.
metric-id	The ID of the metric to add as a favorite.

#### Permissions Tableau Server users who are not server administrators or site administrators can call this method only if they have Read (view) permissions on the metric (either explicitly or implicitly). #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:favorites:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ` ... additional favorites ... ` #### Version Version 3.15 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400005	Invalid label	The favorite label is empty or consists of only white space characters.
403	403004	Forbidden favorites access	A non-administrator user called this method but doesn't have permission to add a metric to the specified user's favorites. This will always be the case when the user ID in the URI represents a different user than a non-administrator user who is calling the method.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user.
404	404028	Metric not found	The metric ID in the URI doesn't correspond to an existing metric.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Add or Update Monitoring Quality Warning on Content Create or update one or more monitoring quality warnings. You can monitor for extract refresh failures on extract data sources or flow run failures on flows. An asset can only have one instance of monitoring. Adding monitoring to an asset that already has it will update it to use the latest specified values. **Note:** An asset can have one monitoring warning in addition to other [data quality warnings](#add_dqw). This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI **Add or update a monitoring quality warning for an asset** POST api/_api-version_/sites/_site-id_/dataQualityTriggers/_content-type_/contentIds?filter=contentId:in:\[_content-luid_\] **Add or update a monitoring quality warning for multiple assets** POST api/_api-version_/sites/_site-id_/dataQualityTriggers/_content-type_/contentIds?filter=contentId:in:\[_content-luid1_,_content-luid2_,_content-luid3_,...\] **Note:** The square brackets are required around the single LUID or comma-separated list of LUIDs. #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
content-type	The type of content the monitoring is being applied to. Use one of the following values: datasource flow These values are not case sensitive.
content-luid	The LUID of the asset. This is the same as the content ID. The square brackets are required around the single LUID or comma-separated list of LUIDs.

#### Request Body ``` ``` #### Attribute Values

type	Type of monitoring quality warning. To specify the type, use one of the following values: EXTRACT_REFRESH FLOW_RUN These values are not case sensitive.
status	Monitoring status. Values can be "true" or "false". If set to "true", the data source is monitored for extract refresh failures or the flow is monitored for flow run failures). If an extract refresh or flow run failure occurs, the specified data quality warning is attached to the data source or flow (depending on type). The data quality warning is removed when the extract refresh or flow run is successful. For more information about monitoring quality warnings, see the monitoring quality warning section of the "Set a Data Quality Warning" topic in the Server Help or Cloud Help.
message	(Optional) A custom message for the data quality warning. You can format the message with italics, bold text, links, images, and more. Use HTML character entities to match the special characters in the formatting guide that's normally visible as a tooltip in the UI.
severity	High visibility status of the data quality warning. Values can be "true" or "false". For more information, see the "Visibility" section of the "Set a Data Quality Warning" topic in the Server Help or Cloud Help.

#### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to add a monitoring quality warning: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:labels:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response** ``` ``` #### Version Version 3.11 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400136	Generic quality warning trigger error	The monitoring quality warning could not be added or updated for some other reason than those specified below.
403	403004	Unauthorized operation	Insufficient permissions to perform the operation.
409	409004	Invalid parameter	One or more values in the request body are invalid.

## Add Project Permissions Adds permissions to the specified project for a user or group. You can specify multiple sets of permissions using one call. If the request body includes a child datasource or element, the request is invalid. #### URI PUT /api/api-version/sites/site-id/projects/project-id/permissions #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the project.
project-id	The ID of the project to set permissions for.

#### Request Body ``` ... additional capabilities ... ... additional capabilities ... ... additional grantee capability sets ... ``` #### Attribute Values

user-id	The ID (not name) of the user to add permissions for.
group-id	The ID (not name) of the group to add permissions for.
capability-name	The capability to assign permissions to. In Tableau Server 10.0, the valid capabilities for a project are ProjectLeader, Read (view), and Write. For more information, see Permissions.
capability-mode	Allow to allow the capability, or Deny to deny it. This value is case sensitive.

#### Permissions Users who are not server administrators or site administrators can add permissions for a project only if they have ChangePermissions (version `2.0`) or ProjectLeader (version `2.1`) permission for that project (either explicitly or implicitly). #### Required scope for JWT authorization _Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. ``` tableau:permissions:update ``` #### Response Code 200 #### Response Body ``` ... additional capabilities ... ... additional capabilities ... ... additional grantee capability sets ... ``` #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400009	Invalid capability	The capability specified in the request is not in the list of valid capability names for this method. The mode of the capability for ProjectLeader cannot be set to Deny.
403	403004	Permissions setting forbidden	A non-administrator user called this method but doesn't have permission to add permissions on the project.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	A user ID in the request body as the grantee doesn't correspond to an existing user.
404	404005	Project not found	The project ID in the URI doesn't correspond to an existing project.
404	404009	Project ID mismatch	A project ID specified in the URI does not match the project ID specified in the request body. (You do not have to specify a project ID in the request body.)
404	404012	Group not found	A group ID in the request body doesn't correspond to an existing group.
404	404013	Capability not found	The capability in the request body doesn't correspond to a defined capability. This can apply to either an invalid capability name or to a capability other than Allow or Deny for any mode value.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Add Project to Favorites Adds the specified project to a user's favorites. If the user already has the project listed as a favorite with the same label, the operation has no effect. If the label differs, the original favorite is overwritten. #### URI PUT /api/_api-version_/sites/_site-id_/favorites/_user-id_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the project.
user-id	The ID of the user to add the favorite for.

#### Request Body ``` ``` #### Attribute Values

favorite-label	A label to assign to the favorite. This value is displayed when you search for favorites on the server.
project-id	The ID (not name) of the project to add as a favorite.

#### Permissions Tableau Server users who are not server administrators or site administrators can call this method only if they have permission to add a project to a favorite list (either explicitly or implicitly). #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:favorites:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` #### Version Version 3.1 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400005	Invalid label	The favorite label is empty or consists of only white space characters.
403	403004	Access to favorites denied	A non-administrator user called this method but doesn't have permission to add a project to the specified user's favorites. This will always be the case when the user ID in the URI represents a different user than a non-administrator user who is calling the method.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user.
404	404005	Project not found	The project ID in the request body doesn't correspond to an existing project.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/1edc53ac-e247-4870-9fd3-6fad0ce5f84d/favorites/2474164d-8d37-4a4c-abc7-c2070fd25fd5" -X PUT -d @add-project-to-favorites.xml -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` **Content of add-project-to-favorites.xml:** ``` ``` **Example response:** ``` ``` ## Add Projects to Routing Rule Adds one or more project filtering conditions to an existing allow rule, narrowing the rule so it applies only to the listed projects. This method applies to allow rules only; adding projects to a block rule is rejected. Each project ID must be a valid UUID and reference a project that exists on the site, and a project already associated with the rule cannot be added again. This method is not available for Tableau Server. **Version**: Available in API 3.30 (Tableau Cloud October 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI POST /api/api-version/sites/site-luid/bridge-routing-rules/routing-rule-id/projects #### URI Parameter Values

api-version	The version of the API to use. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
routing-rule-id	The unique identifier (UUID) of the allow rule to add projects to.

#### Request Body ``` ``` ``` { "routingRuleProjects": { "mode": "add", "project": [ { "id": "11111111-2222-3333-4444-555555555555" }, { "id": "66666666-7777-8888-9999-000000000000" } ] } } ``` #### Attribute Values

mode	Required. The operation mode; must be `add` for this method.
project	Required. One or more project IDs to add. Each entry requires an `id`.

#### Response Code 200 #### Response Body Returns the updated `routingRule` with the added projects reflected in `project`. ``` ``` ``` { "routingRule": { "id": "d9e8f7a6-b5c4-3210-fedc-ba9876543210", "domain": "example.com", "isBlocked": false, "poolId": "ebae40a5-d7e4-4214-b3d5-b0715c627b71", "poolName": "WindowsPool", "project": [ { "id": "11111111-2222-3333-4444-555555555555", "name": "Finance", "isDeleted": false }, { "id": "66666666-7777-8888-9999-000000000000", "name": "Sales", "isDeleted": false } ] } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	503909	Validation failed	Missing or empty project list, invalid project or rule UUID, or projects not found on the site.
400	503910	Invariant violation	Attempted to add projects to a block rule.
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	503923	Permission denied	Caller is not a site administrator for the site.
404	503915	Routing rule not found	No routing rule exists with the given ID on this site.
409	503912	Project already present	One or more of the projects is already associated with this routing rule.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500	503921	Unexpected server error	An unexpected error occurred while adding projects.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Add Table Permissions Add permissions to a table asset. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI PUT api/_api-version_/sites/_site-luid_/tables/_table-luid_/permissions #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site asset.
table-luid	The LUID of the table asset.

#### Request Body ``` ``` #### Attribute Values

table-luid	The LUID for the table asset you want to add permissions to.
user-luid	The LUID of the user to add permissions for.
capability-name	The capability to assign. If any capability has been granted or denied for a specified user or group, that capability is ignored. Valid capabilities for a database are: Read (view) Write (edit) ChangePermissions (set permissions) ChangeHierarchy (move) These values are case sensitive.
capability-mode	Use one of the following capabilities: Allow Deny These values are case sensitive.
group-id	The LUID of the group to add permissions for.

#### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to add table asset permissions: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to set or "ChangePermissions" to the asset metadata #### Response Code 200 #### Response Body **Example response:** ``` ``` #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400120	Bad request	Permissions could not be added because support for explicit permissions is available for table assets associated with published data sources only.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
403	403117	Database locked	Permissions for the table asset cannot be deleted because the database asset is locked.
404	404000	Resource not found	The site LUID in the URI doesn't correspond to an existing site.
404	404032	Table not found	The requested table asset could not be found.
409	409052	Table error	An unknown table asset error occurred.
409	409057	Table update error	An unknown error occurred and the table asset could not be updated.
409	409058	Table update forbidden	A user without "write" permissions to the table asset attempted an update.

## Add Tags to Column Add one or more tags to a column. For more information about tags, see [Tag Items](https://help.tableau.com/current/pro/desktop/en-us/tags.htm) in the Tableau User Help. #### URI PUT api/api-version/sites/site-id/columns/column-id/tags #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
column-id	The unique ID of the column asset.

#### Request Body ``` ``` #### Attribute Values

tag-value1	Keyword text you want to add to the asset.
tag-value2	Keyword text you want to add to the asset.

#### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to add tags: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:column_tags:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response** ``` ``` #### Version Version 3.9 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
403	403004	Unauthorized operation	Insufficient permissions to perform the operation.
409	409062	Generic column tag error	The tag or tags could not be added (or deleted) for some other reason than those specified above.
409	409066	Column not found	The column asset does not exist.

## Add Tags to Data Source Adds one or more tags to the specified data source. #### URI PUT /api/api-version/sites/site-id/datasources/datasource-id/tags #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the data source.
datasource-id	The ID of the data source to add tags to.

#### Request Body ``` ... additional tags ... ``` #### Attribute Values

datasource-id	The data source to add the tag to. If the data source is already tagged with a tag that's included in the request body, those tags are ignored and the data source retains them. If the <tags> element is empty, no new tags are added to the data source.
tag	The text of the tag.

#### Permissions Tableau Server users who are not server administrators or site administrators can call this method only if they have Read permissions for the data source (either explicitly or implicitly). #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:datasource_tags:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ... additional new tags ... ... existing tags ... ``` #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400075	Error adding tags	There was a problem adding tags to the specified data source.
403	403004	Adding tags forbidden	A non-administrator user called this method but doesn't have permission to add tags. This error is raised even if the <tags> element is empty.
404	404000	Site not found	The site ID in the URI is not for an existing site.
404	404004	Data source not found	The data source ID in URI doesn't correspond to an existing data source.
404	404009	Data source ID mismatch	The request body contains a data source ID (which is optional) and it doesn't match the ID in the URI.
404	405000	Invalid request method	Request type was not PUT.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
database-id	The unique ID of the database asset.

#### Request Body ``` ``` #### Attribute Values

tag-value1	Keyword text you want to add to the asset.
tag-value2	Keyword text you want to add to the asset.

#### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to add tags: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:database_tags:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response** ``` ``` #### Version Version 3.9 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
403	403004	Unauthorized operation	Insufficient permissions to perform the operation.
404	404031	Database not found	The database asset does not exist.
409	409048	Generic database tag error	The tag or tags could not be added (or deleted) for some other reason than those specified above.

## Add Tags to Table Add one or more tags to a table. For more information about tags, see [Tag Items](https://help.tableau.com/current/pro/desktop/en-us/tags.htm) in the Tableau User Help. #### URI PUT api/api-version/sites/site-id/tables/table-id/tags #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
table-id	The unique ID of the column asset.

#### Request Body ``` ``` #### Attribute Values

tag-value1	Keyword text you want to add to the asset.
tag-value2	Keyword text you want to add to the asset.

#### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to add tags: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:table_tags:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response** ``` ``` #### Version Version 3.9 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
403	403004	Unauthorized operation	Insufficient permissions to perform the operation.
404	404032	Table not found	The table asset does not exist.
409	409055	Generic table tag error	The tag or tags could not be added (or deleted) for some other reason than those specified above.

## Add Tags to View Adds one or more tags to the specified view. #### URI PUT /api/api-version/sites/site-id/views/view-id/tags #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook.
view-id	The ID of the views to add tags to.

#### Request Body ``` ... additional tags ... ``` #### Attribute Values

view-id	The view to add the tag to. If the view is already tagged with a tag that's included in the request body, those tags are ignored and the view retains them. If the <tags> element is empty, no new tags are added to the view.
tag	The text of the tag.

#### Permissions Tableau Server users who are not server administrators or site administrators can call this method only if they have Read permissions for the view (either explicitly or implicitly). #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:view_tags:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ... additional new tags ... ... existing tags ... ``` #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400076	Error adding tags	There was a problem adding tags to the specified view.
403	403004	Adding tags forbidden	A non-administrator user called this method but doesn't have permission to add tags. This error is raised even if the <tags> element is empty.
404	404000	Site not found	The site ID in the URI is not for an existing site.
404	404011	View not found	The view ID in URI doesn't correspond to an existing view.
404	404009	Workbook ID mismatch	The request body contains a view ID (which is optional) and it doesn't match the ID in the URI.
404	405000	Invalid request method	Request type was not PUT.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID for the site.
virtualconnection-id	The LUID for the virtual connection.

#### Request Body ``` ``` #### Attribute Values

tag	The text of the tag.

#### cURL Request Example `curl --location --request PUT 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd/tags' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3' --data @data.xml` **Contents of data.xml.** ``` ``` #### Response Code 200 #### Response Body ``` ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400049	Error adding tags	There was a problem adding tags to the specified virtual connection.
403	403004	Adding tags forbidden	The user doesn't have permissions to add tags to the virtual connection.
404	404000	Site not found	The site ID in the URI is not for an existing site.
404	404006	Virtual connection not found	The virtual connection ID in URI doesn't correspond to an existing virtual connection.
404	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Add Tags to Workbook Adds one or more tags to the specified workbook. #### URI PUT /api/api-version/sites/site-id/workbooks/workbook-id/tags #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook.
workbook-id	The ID of the workbook to add tags to.

#### Request Body ``` ... additional tags ... ``` #### Attribute Values

workbook-id	The workbook to add the tag to. If the workbook is already tagged with a tag that's included in the request body, those tags are ignored and the workbook retains them. If the <tags> element is empty, no new tags are added to the workbook.
tag	The text of the tag.

#### Permissions Tableau Server users who are not server administrators or site administrators can call this method only if they have Read permissions for the workbook (either explicitly or implicitly). #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:workbook_tags:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ... additional new tags ... ... existing tags ... ``` #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400049	Error adding tags	There was a problem adding tags to the specified workbook.
403	403004	Adding tags forbidden	A non-administrator user called this method but doesn't have permission to add tags. This error is raised even if the <tags> element is empty.
404	404000	Site not found	The site ID in the URI is not for an existing site.
404	404006	Workbook not found	The workbook ID in URI doesn't correspond to an existing workbook.
404	404009	Workbook ID mismatch	The request body contains a workbook ID (which is optional) and it doesn't match the ID in the URI.
404	405000	Invalid request method	Request type was not PUT.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the specified data-driven alert.
data-alert-id	The ID of the data-driven alert. You can obtain this ID by calling Query Data-Driven Alerts.

**Version:** Available in API 3.2 (Tableau Cloud / Tableau Server 2018.3) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required.> **Permissions:** This method can only be called by server administrators and site administrators, and by users who are owners of the specified alert. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:data\_driven\_alerts:update - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Request Body ``` ``` #### Response Code 200 #### Response Body ``` ``` #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Write forbidden	A user called this method who does not have the required permissions.
403	409028	Adding recipient to data-driven alert forbidden	The user is not authorized to add the recipient to the data-driven alert.
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
404	404002	Resource Not Found	The user ID specified in the request body is invalid.
404	409023	Resource Not Found	The data-driven alert ID specified in the URI is invalid.
405	405000	Invalid request method	Request type was not POST.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/13020592-762f-4de4-a25e-f4beb005836e/dataAlerts/e5a4b73e-5cbb-412d-907e-f31cc31684f7/users" -X POST -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @add-user-to-alert.xml` **Content of add-user-to-alert.xml:** ``` ``` **Example response:** ``` ``` ## Add User to Group Adds a user to the specified group. Beginning in API 3.21, you can bulk add users to a group by specifying multiple user IDs. **Note**: After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. #### URI POST /api/api-version/sites/site-id/groups/group-id/users #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the group.
group-id	The ID of the group to add the user to.

#### Request Body **Add a single user to a group** ``` ``` **Bulk add users to a group** (beginning in API 3.21) ``` ``` #### Attribute Values

user-id

The ID (not name) of the user to add. You can get the user ID by calling Get Users on Site.

Beginning in API 3.21, you can bulk add users to a group by specifying multiple user IDs.

#### Permissions This method can only be called by server administrators and site administrators. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:groups:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Add a single user to a group** ``` ``` **Bulk add users to group** (beginning in API 3.21) ``` ``` The siteRole value is returned as one of the following values: Creator, Explorer, ExplorerCanPublish, ServerAdministrator, SiteAdministratorExplorer, SiteAdministratorCreator, Unlicensed, ReadOnly, or Viewer. #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404012	Group not found	The group name in the request body doesn't correspond to an existing group.
405	405000	Invalid request method	Request type was not POST.
409	409011	User conflict	The specified user is already a member of the group.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example ##### Add a single user to a group `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/groups/1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d/users" -X POST -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @add-user-to-group.xml` **Content of add-user-to-group.xml:** ``` ``` **Example response:** ``` ``` ##### Bulk add users to a group (beginning in API 3.21) `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/groups/1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d/users" -X POST -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @bulk-add-user-to-group.xml` **Content of bulk-add-user-to-group.xml:** ``` ``` **Example response:** ``` ``` ## Add User to Identity Pool Add a user to a specified identity pool. This enables the user to sign in to Tableau Server using the specified identity pool. This method is not available for Tableau Cloud. For more information about identity pools, see [Provision and Authenticate Users Using Identity Pools](https://help.tableau.com/current/server-linux/en-us/identity_pools.htm). #### URI POST /api/api-version/sites/site-id/users/identityPool #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that is associated with the user you want to add to the identity pool.

#### Request Body ``` ``` #### Attribute Values

user-name	The name of the user to add.
site-role	Site role of the user. You can use one of the following values: Creator Explorer ExplorerCanPublish ServerAdministrator SiteAdministratorExplorer SiteAdministratorCreator Unlicensed ReadOnly Viewer
user-id	Required. The ID (not name) of the user to add. You can get the user ID by calling Get Users on Site.
authentication-configuration	The authentication configuration instance configured for the identity pool you want to add the user to. You can get the authentication configuration instance by calling List Authentication Configurations endpoint in Tableau REST OpenAPI.
idpool-uuid	The ID of the identity pool that you wan to add the user to. You can get the identity pool ID by calling the List Identity Pools endpoint in the Tableau REST OpenAPI.
identity-uuid	The identifier for the user you want to add. Identifiers are only used for identity matching purposes. For more information about identifiers, see Usernames and Identifiers in Tableau in the Tableau Server Help.

#### Permissions This method can only be called by Tableau Server administrators. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:identity_pools_users:create ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response:** ``` ``` #### Version Version 3.19 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not POST.
429	429001	User conflict	The specified user is already a member of the identity pool.
429	429002	Can't add user	There was a problem and the user couldn't be added to the identity pool.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/users/identityPool" -X POST -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @add-user-to-idpool.xml` - `MY-SERVER` is the name or IP address of your server. - `9a8b7c6d5-e4f3-a2b1-c0d9-e8f7a6b5c4d` is the ID of the site, as returned by a previous call to [Sign In](#sign_in). - `12ab34cd56ef78ab90cd12ef34ab56cd` is the credentials token returned by a previous call to [Sign In](#sign_in). **Content of add-user-to-idpool.xml:** ``` ``` **Example response:** ``` ``` ## Add User to Site Adds a user to Tableau Server or Tableau and assigns the user to the specified site. **Tableau Server** If Tableau Server is configured to use local authentication, the information you specify is used to create a new user in Tableau Server. **Note**: After creating the user, you **must** set a full name, password, and email address for the user with the call to [Update User](#update_user). If you are using SAML with local authentication, the user information that you add is not synchronized with the SAML IdP, as it would be if you were using Active Directory. Even if it is not used by SAML, the user information must be present. If Tableau Server is configured to use Active Directory for authentication, the user you specify is imported from Active Directory into Tableau Server. **Tableau Cloud** When you add a user to Tableau Cloud, the name of the user must be the email address that is used to sign in to Tableau Cloud. After you add a user, Tableau Cloud sends the user an email invitation. The user can click the link in the invitation to sign in and update their full name and password. If you try to add a user using a specific site role but you have already reached the limit on the number of licenses for your users, the user is added as an unlicensed user. In that case, the response code is 201 (which indicates success), but the siteRole value in the response body is set to Unlicensed. **Note:** After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. #### URI POST /api/api-version/sites/site-id/users #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site to add users to.

#### Request Body _(Use the icon in the top right corner to copy the text.)_ ``` ``` _(Use the icon in the top right corner to copy the text.)_ ``` { "user": { "name":"user-name", "siteRole":"site-role", "authSetting":"auth-setting", "identityPoolName":"identity-pool-name", "idpConfigurationId":"idp-configuration-id", "email":"email-address", "language":"language", "locale": "locale" } } ``` #### Attribute Values

user-name	The name of the user. If the server uses local authentication, this can be any name. If you are using Active Directory authentication, or if you are using Tableau Cloud, there are specific requirements for the name. Tableau Server If Tableau Server uses Active Directory authentication, this must be the name of an existing user in Active Directory. If the user name is not unique across domains, you must include the domain as part of the user name (for example, example\Adam or adam@example.com). Note: Active Directory specifies a user name using two attributes: `sAMAccountName` and `userPrincipalName` (UPN) prefix. For most Active Directory users, these attributes are the same. By default, if you are adding a user from Active Directory, the name that you provide in the user-name is matched against the Active Directory `sAMAccountName` attribute, which becomes the name that the user signs in to Tableau Server with. Two exceptions are when the name that you provide: is longer than 20 characters; and includes an `@` character. In these cases, Tableau imports the user using the Active Directory UPN. For more information, see User Naming Attributes on the MSDN site. Tableau Cloud The user-name is the email address that the user will use to sign in to Tableau Cloud. When you add a user to the site, Tableau Cloud sends an email invitation. The user can click the link in the invitation to sign in and update their full name and password.
site-role	The site role to assign to the user. You can assign the following roles: Creator, Explorer, ExplorerCanPublish, SiteAdministratorExplorer, SiteAdministratorCreator, Unlicensed, or Viewer. Note: You cannot use the REST API to set a user to be a server administrator (ServerAdministrator site role).
auth-setting	(Optional) The authentication method to assign the user. Tableau Server The authSetting attribute only applies when updating users on sites with site-specific SAML-enabled settings. Tableau Cloud The ability to create and enable multiple authentication methods simultaneously was introduced in API 3.25 (January 2025). As a result of this capability, consider the following: For Tableau with MFA (or Tableau) authentication: To assign Tableau with MFA authentication (or Tableau authentication if still available for your site), you can use the authSetting or idpConfigurationId attribute, but not both. For SAML and OIDC-based authentication: For new configurations: To assign SAML or OIDC-based authentication, whose configurations were created during or after January 2025, you must use the idpConfigurationId attribute for assigning user authentication. Skip to idp-configuration-id. For existing configurations: To assign SAML and OIDC-based authentication, whose configurations that Tableau has automatically prefixed with "Initial" (such as "Initial SAML," "Initial Google," "Initial OIDC," or "Initial Salesforce"), you can continue to use the authSetting attribute for assigning user authentication. Alternatively, you can use the idpConfigurationId attribute for assigning user authentication. Do not use both. Notes: In cases where both attributes are supported, you can use the authSetting attribute or the idpConfigurationId attribute, but not both. If neither authSetting nor idpConfigurationId attribute is specified, then `TableauIdWithMFA` (or in some cases `ServerDefault` if that option is still available for your site) is the authentication assigned to the user. If you see "Unspecified" as the authentication method for the user in Tableau Cloud or if the user is unable to sign in, use the idpConfigurationId attribute instead. For more information, see When adding users to Tableau Cloud via Rest API, the user's authentication method is listed as "Unspecified" and the user gets error "Remote IdP entity descriptor is not configured" on login attempt knowledge article or skip to idp-configuration-id. You can assign the following values for the authSetting attribute: `SAML` - The user signs in using the identity provider (IdP) configured for the site. For Tableau Cloud configuration, see Enable SAML Authentication on a Site. For Tableau Server, see Configure Site-Specific SAML. `OpenID` - Tableau Cloud only: The user signs in using Google, Salesforce or OpenID Connect provider credentials. `OpenID` corresponds to Google, Salesforce, or OIDC authentication configuration in Tableau Cloud authentication settings. `TableauIDWithMFA` - Tableau Cloud only: The user signs in using a combination of TableauID credentials and a registered verification method. For more information, see About multi-factor authentication and Tableau Cloud. `ServerDefault` - The user signs in using the default authentication method that's set for the server. For Tableau Cloud, if Tableau hasn't updated your site to require Tableau with MFA yet, you can continue to use this authentication type on a temporary basis. The `ServerDefault` value corresponds to TableauID in authentication settings. For Tableau Server, the SAML Server help page describes default authentication options.
identity-pool-name	(Optional, Tableau Server only) When identity pools are configured, the name of the identity pool. Starting in API 3.19, include the identity pool name when identity pools are configured and you need to add a user to an identity pool that uses the local identity store and OIDC authentication. For more information, see Identity Pools Methods.
idp-configuration-id	(Optional, Tableau Cloud only) The configuration to assign for user authentication. Added in API 3.25 (January 2025). To find the idpConfigurationId attribute value, use the List Authentication Configurations for Site method. Notes: In cases where both attributes are supported, you can use the idpConfigurationId attribute or the authSetting attribute, but not both. If neither idpConfigurationId nor authSetting attribute is specified, then `TableauIdWithMFA` (or in some cases `ServerDefault` if that option is still available for your site) is the authentication assigned to the user.
email-address	(Optional, Tableau Cloud only) The email address where the user can receive notifications. If no value is provided, Tableau Cloud uses the `username` value to send notifications to. Starting in API 3.26 (July 2025), you can specify an email address that is different from the username.
language	(Optional, Tableau Cloud only) Language (ISO 639-1) of the user. Starting in API 3.28 (March 2026), you can set the user's default language in Tableau Cloud to a supported language (ISO 639-1). You can assign one of the following values: de, en_GB, en, es, fr_CA, fr, it, nl, pt, sv, th, ja, zh, zh_TW, or ko. Important: The language set using this attribute overrides the default site-wide invitation email language that the site admin can set.
locale	(Optional, Tableau Cloud only) Locale of the user. Starting in API 3.28 (March 2026), you can set the user's default locale to a supported locale. You can assign one of the following values: ar_SA, ar_AE, ar_BH, ar_DZ, ar_EG, ar_IQ, ar_JO, ar_KW, ar_LB, ar_LY, ar_MA, ar_OM, ar_QA, ar_SD, ar_SY, ar_TN, ar_YE, be_BY, bg_BG, ca_ES, cs_CZ, da_DK, de_DE, de_AT, de_CH, de_LU, el_GR, el_CY, en_US, en_AU, en_CA, en_GB, en_IE, en_IN, en_MT, en_NZ, en_PH, en_SG, en_ZA, es_ES, es_AR, es_BO, es_CL, es_CO, es_CR, es_DO, es_EC, es_GT, es_HN, es_MX, es_NI, es_PA, es_PE, es_PR, es_PY, es_SV, es_US, es_UY, es_VE, et_EE, fi_FI, fr_FR, fr_BE, fr_CH, fr_LU, fr_CA, ga_IE, he_IL, hi_IN, hr_HR, hu_HU, id_ID, is_IS, it_IT, it_CH, ja_JP, ko_KR, lt_LT, lv_LV, mk_MK, ms_MY, mt_MT, nl_NL, nl_BE, no_NO, pl_PL, pt_BR, pt_PT, ro_RO, ru_RU, sk_SK, sl_SI, sq_AL, sr_RS, sr_BA, sr_ME, sv_SE, th_TH, tr_TR, uk_UA, vi_VN, zh_CN, zh_HK, zh_SG, or zh_TW.

#### Permissions This method can only be called by server administrators and site administrators. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:users:create ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 201 #### Response Body ``` ``` #### Response Headers Location: /api/3.29/sites/site-id/users/new-user-id #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400003	Bad request	The user authentication setting `ServerDefault` is not supported for you site. Try again using `TableauIDWithMFA` instead.
400	400013	Invalid site role	The value of the siteRole attribute must be Explorer, ExplorerCanPublish, SiteAdministratorCreator, SiteAdministratorExplorer, Unlicensed, or Viewer.
400	400217	Unsupported language	The specified language is not valid or not supported.
400	400218	Unsupported locale	The specified locale is not valid or not supported.
403	403193	Forbidden	A non-administrator user called this method or doesn't have permissions to update language for the user.
403	403194	Forbidden	A non-administrator user called this method or doesn't have permissions to update locale for the user.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	The server is configured to use Active Directory for authentication, and the username specified in the request body doesn't match an existing user in Active Directory.
405	405000	Invalid request method	Request type was not POST.
409	409017	User conflict	The specified user already exists on the site.
409	409005	Guest user conflict	The Tableau Server API doesn't allow adding a user with the guest role to a site.
500	500109	Internal language error	The language request could not be completed.
500	500110	Internal locale error	The locale request could not be completed.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/users/" -X POST -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @add-user-to-site.xml` - `MY-SERVER` is the name or IP address of your server. - `9a8b7c6d5-e4f3-a2b1-c0d9-e8f7a6b5c4d` is the ID of the site to add the user to, as returned by a previous call to [Sign In](#sign_in). - `12ab34cd56ef78ab90cd12ef34ab56cd` is the authentication returned by a previous call to [Sign In](#sign_in). **Content of add-user-to-site.xml:** ``` ``` **Example response:** ``` ``` ## Add View Permissions Adds permissions to the specified view (also known as a sheet) for a user or group. You can specify multiple sets of permissions using one call. #### URI PUT /api/_api-version_/sites/_site-id_/views/_view-id_/permissions #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook view.
view-id	The ID of the view to set permissions for. You can obtain this ID by calling Query Views for Site.

#### Request Body ``` ... additional capabilities ... ... additional capabilities ... ... additional grantee capability sets ... ``` #### Attribute Values

view-id	The view-id value must match the view ID in the URI.
user-id	The ID (not name) of the user to add permissions for.
group-id	The ID (not name) of the group to add permissions for.
capability-name	The capability to assign. If any capability has already been granted or denied for a specified user or group, that capability is ignored. For valid capabilities for a view are AddComment, ChangePermissions, Delete, ExportData, ExportImage, ExportXml, Filter, Read (view), ShareView, ViewComments, ViewUnderlyingData, WebAuthoring, and Write. For more information, see Permissions.
capability-mode	Allow to allow the capability, or Deny to deny it. This value is case sensitive.

#### Permissions This method can only be called by server and site administrators, and user who have permission to set permissions on the workbook (either explicitly or implicitly). To use this method, the parent workbook that contains the specified view must have its **showTabs** attribute set to **Hide**. You can configure this setting by using the [Update Workbook](#update_workbook) method. #### Required scope for JWT authorization _Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. ``` tableau:permissions:update ``` #### Response Code 200 #### Response Body ``` ``` The **createdAt** and **updatedAt** values are dates and times in UTC format (YYYY-MM-DDTHH:MM:SSZ). #### Version Version 3.2 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400009	Invalid capability	The capability in the URI is invalid for a view.
403	403004	Permissions setting forbidden	A non-administrator user called this method but doesn't have permission to set permissions on the view.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404011	View not found	The view ID in the URI doesn't correspond to an existing view.
404	404012	Group not found	A group ID in the request body doesn't correspond to an existing group.
404	404013	Capability not found	The specified capability doesn't correspond to a defined capability. This can apply to either an invalid capability name or an invalid capability value (other than Allow or Deny).

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/13020592-762f-4de4-a25e-f4beb005836e/views/e5a4b73e-5cbb-412d-907e-f31cc31684f7" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @add-view-permissions.xml` **Example of add-view-permissions.xml:** ``` ``` **Example response:** ``` ``` ## Add View to Favorites Adds the specified view to a user's favorites. If the user already has the view listed as a favorite with the same label, the operation has no effect. If the label differs, the original favorite is overwritten. #### URI PUT /api/api-version/sites/site-id/favorites/user-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the view.
user-id	The ID of the user to add the favorite for.

#### Request Body ``` ``` #### Attribute Values

favorite-label	A label to assign to the favorite. This value is displayed when you search for favorites on the server.
view-id	The ID (not name) of the view to add as a favorite.

#### Permissions Tableau Server users who are not server administrators or site administrators can call this method only if they have permission to add a view to a favorite list (either explicitly or implicitly). #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:favorites:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ... additional favorites ... ``` The value of view-url-name is the name of the view in its URL. For example, if a view named `View 1` shows the URL `https://MY_SERVER/#/site/MY_SITE/views/VIEW_1` in your browser address bar, then the view-url-name would be `VIEW_1`. Modifying the name (display name) of a view will not impact the view-url-name (path element of the view's URL). #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400005	Invalid label	The favorite label is empty or consists of only white space characters.
403	403004	Forbidden Favorites access	A non-administrator user called this method but doesn't have permission to add a view to the specified user's favorites. This will always be the case when the user ID in the URI represents a different user than a non-administrator user who is calling the method.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user.
404	404011	View not found	The view ID in the request body doesn't correspond to an existing view.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/favorites/9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d" -X PUT -d @add-view-to-favorites.xml -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` **Content of add-view-to-favorite.xml:** ``` ``` **Example response:** ``` ``` ## Add Virtual Connection Permissions Adds permissions to the specified virtual connection for a user or group. You can specify multiple sets of permissions using one call. If a specified permission has already been granted or denied for a given user or group, the system ignores it. #### URI PUT /api/api-version/sites/site-id/virtualconnections/virtualconnection-id/permissions #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the virtual connection.
virtualconnection-id	The ID of the virtual connection to set permissions for.

#### Request Body ``` ``` #### Attribute Values

user-id	The LUID of the user to add permissions for. A request does not need to include both a user and a group grantee.
group-id	The LUID of the group to add permissions for. A request does not need to include both a user and a group grantee.
capability-name	The capability to assign. Valid capabilities for a virtual connection are Read, Connect, Overwrite, ChangeHierarchy, Delete, and ChangePermissions. For more information, see Permissions.
capability-mode	Allow to allow the capability, or Deny to deny it.

#### Permissions You must be an administrator or have the ChangePermissions permission for the virtual connection (either explicitly or implicitly). #### Required scope for JWT authorization _Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. ``` tableau:permissions:update ``` #### Response Code 200 #### Response Body ``` ``` #### Version Version 3.23 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400009	Invalid capability	The specified capability is invalid for a virtual connection. Valid capabilities for a virtual connection are Read, Connect, Overwrite, ChangeHierarchy, Delete, and ChangePermissions.
403	403004	Permissions setting forbidden	The user tried to change permissions for a virtual connection but doesn't have the permission to change them.
404	404000	Site not found	The specified site doesn't correspond to an existing site.
404	404002	User not found	The user specified in the request body doesn't correspond to an existing user.
404	404012	Group not found	The group specified in the request body doesn't correspond to an existing group.
404	404013	Capability not assigned	The capability in the URI is not assigned to the specified user or group with the specified mode (Allow or Deny).
404	404014	Capability not found	A capability specified in the request body doesn't correspond to a defined capability. This can apply to either an invalid capability name or to a capability other than Allow or Deny for any mode value.
405	405000	Invalid request method	Request type was not PUT.
400	409004	Invalid LUID	The virtual connection LUID in the URI was not found.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl --location --request PUT 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd/permissions' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3' --data ' '` ## Add Virtual Connection to Server Schedule Adds a task to refresh a virtual connection to an existing server schedule on Tableau Server. _For Tableau Cloud, see [Create Cloud Extract Refresh Task](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_extract_and_encryption.htm#create_cloud_extract_refresh_task)._ This method identifies and refreshes only the tables in the virtual connection that are configured as extracts; live tables are ignored. **Version**: Available in API 3.30 and later. **License**: Data Management, Enterprise, Server+, Cloud+, or Tableau+ Bundle. **Permissions**: Tableau Server users who are not server administrators or site administrators can only add a virtual connection to a schedule if they own the virtual connection, or are the project leader for the project that contains the virtual connection. **Access Scope**: `tableau:schedules:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/sites/site-id/schedules/schedule-id/virtualconnections #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID for the site.
schedule-id	The LUID for the schedule that you are associating with the virtual connection.

#### Request Body ``` starting-item-id ``` #### Attribute Values

transaction-level	Optional. DATABASE or TABLE. Default is DATABASE. If set to DATABASE: If any table extract refresh fails, none of the extracts are updated. If set to TABLE: If a table extract fails, only that table's extract isn't updated.
incremental-flag	Optional, boolean. Default is false. If set to false, do a full refresh. Fully refresh all extracts including those configured for incremental extract. If set to true, do an incremental refresh. Add new rows to incremental extracts. Full refresh other extracts.
virtualconnection-id	The LUID of the virtual connection to add to the schedule.
starting-item-id	The LUID of an extract table in the virtual connection. You may have more than one `<startingItemId>` element inside of a `<startingItemIds>` element.

#### cURL Request Example ``` curl --request PUT 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/schedules/9a4ebbab-9ec8-487a-9b48-47fa81d6077a/virtualconnections' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3' --data '' ``` #### Response Code 200 #### Response Body ``` 3577de68-2779-4962-b13d-3265ec98a4cb ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400223	Virtual connection table not found.	A LUID in `startingItemIds` is not an extract-eligible table on the virtual connection.
400	400225	Duplicate virtual connection table.	`startingItemIds` contains the same table LUID more than once.
400	404049	No virtual connection specified.	The request body must include a virtual connection in the `extractRefresh` element.
400	409004	Invalid parameter.	`startingItemIds` contains a value that is not a valid LUID.
400	409090	No extract-eligible tables.	The virtual connection has no active revision, or none of its tables are configured for extract refresh.
403	403078	Unable to create the task.	One of the following applies: The user is not a system or site administrator and does not own the virtual connection. The virtual connection already has a refresh scheduled on this schedule. The virtual connection is in a personal space. The extract refresh operation is not allowed for the virtual connection.
404	404023	Schedule not found.	Check the schedule LUID.
404	404049	Virtual connection not found.	Check the virtual connection LUID.
405	405000	Method not allowed.	Request type must be PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Add Work Copy Elements Adds field descriptions or table descriptions to a work copy. Returns HTTP 201 when every element is added. The success body omits the elements that succeeded. If any element fails, the HTTP status is the status of the first failure and the body lists only the failed elements. A `Column` entry is not added by this method. **Version**: Available in API 3.30 (Tableau Cloud October 2026 / Server 2026.3) and later. **License**: Data Management or Tableau+. **Permissions**: Users who are not server administrators or site administrators can call this method only if they have Connect, Write (save), and VizqlDataApiAccess (API Access) permissions for the data source that the work copy was created from (either explicitly or implicitly). **Access Scope**: `tableau:datasources:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI POST /api/api-version/tds/sites/site-luid/workcopy/workcopy-luid #### URI Parameter Values

api-version	The version of the API to use. These TDS Edit methods are available in API 3.30 and later. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site in the URI. This handler does not bind the path variable — the service uses the authenticated user's site LUID (`authUser.getSiteLuid()`).
workcopy-luid	The LUID of the work copy. Must be a UUID (8-4-4-4-12 hexadecimal digits), matching `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}`.

#### Request Body ``` FieldDescription Sales Total sales amount. TableDescription Orders Order line items. ``` ``` { "tdsElementList": [ { "elementType": "FieldDescription", "name": "Sales", "description": "Total sales amount." }, { "elementType": "TableDescription", "name": "Orders", "description": "Order line items." } ] } ``` #### Attribute Values

tdsElementList[]	Required. Elements to add. Must contain at least one element. An empty or missing list is HTTP 400 with error code `400008`.
tdsElementList[].elementType	Optional. Element type sent to the TDS service. For this operation, use `FieldDescription` or `TableDescription`. Any other value is forwarded and reported as a per-element failure.
tdsElementList[].name	Required. Element name.
tdsElementList[].column	Not applicable to this method. The add converter has no `Column` branch, so a `column` payload on an add element is not copied and the element is reported as a per-element failure.
tdsElementList[].description	Required for this method. Description text for a `FieldDescription` or `TableDescription` element. When `description` is null, the field is left unset so the TDS service can report a per-element failure instead of HTTP 500.

#### Response Code 201 Created #### Response Body On full success the response is an empty `tsResponse` — `tdsElementResult` is omitted entirely rather than returned as an empty list. When one or more elements fail, the HTTP status is the status of the first failure and the body carries `tdsElementResult` for the failed elements only; see the Attribute Values table below and the Errors table for the failure shape. ``` ``` ``` {} ``` #### Attribute Values

tdsElementResult[]	Failed elements only. Omitted on full success, including omitted rather than returned as an empty array.
tdsElementResult[].elementType	Required. Element type of the failed element, copied from the request.
tdsElementResult[].name	Required. Name of the failed element, copied from the request.
tdsElementResult[].status	Required. Failure status for this element.
tdsElementResult[].status.code	Required (within `status`). The translated HTTP status for this element (200, 400, 401, 403, 404, 409, 500, or 503). Not a Tableau 6-digit error sub-code.
tdsElementResult[].status.message	Optional. Error message from the TDS service.

#### Errors

HTTP status	`error` Code	Condition	Details
400	400008	Missing tdsElementList	`tdsElementList` is missing or empty. The list is required and must contain at least one element.
400		Invalid work copy LUID	The work copy LUID in the URI is not a UUID (8-4-4-4-12 hexadecimal digits).
400		Per-element invalid argument	One or more elements were rejected as invalid. The body lists only the failed elements, and each `status.code` is the HTTP status 400.
400		Unmapped per-element gRPC status	The TDS service returned a status that maps to HTTP 400. The body lists only the failed elements.
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
401		Per-element unauthenticated	The TDS service rejected an element as unauthenticated. The body lists only the failed elements.
403	403004	Data Management Bundle not licensed	On Tableau Server the TDS Edit API requires a Data Management Bundle license. The call is rejected when that license is absent.
403	403004	Unable to resolve tenant	On Tableau Cloud the subscription could not be checked because the tenant id for the site could not be retrieved.
403	403004	No cloud entitlements	On Tableau Cloud no entitlements were found for the tenant. The TDS Edit API requires a Tableau+ subscription.
403	403004	Subscription not entitled	On Tableau Cloud the site edition is not Tableau+. The TDS Edit API requires a Tableau+ subscription.
403		Per-element permission denied	The TDS service rejected an element because permission was denied. The body lists only the failed elements.
404		Per-element not found	One or more elements were not found. The body lists only the failed elements. This is not error code 404065, which the read methods return for a missing named element.
405	405000	Method not allowed	The HTTP method is not supported for this resource.
409		Per-element already exists	One or more elements already exist. The body lists only the failed elements.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500		Per-element internal error	The TDS service failed while editing an element. The body lists only the failed elements.
503		Per-element unavailable	The TDS service was unavailable while editing an element. The body lists only the failed elements.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Add Workbook Permissions Adds permissions to the specified workbook for a user or group. You can specify multiple sets of permissions using one call. #### URI PUT /api/api-version/sites/site-id/workbooks/workbook-id/permissions #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook.
workbook-id	The ID of the workbook to set permissions for.

#### Request Body ``` ... additional capabilities ... ... additional capabilities ... ... additional grantee capability sets ... ``` #### Attribute Values

workbook-id	The <workbook> element is not required, but can be included for compatibility with earlier versions of the REST API. If the <workbook> element is included, the workbook-id value must match the workbook ID in the URI. Any other attributes in the <workbook> element are ignored.
user-id	The ID (not name) of the user to add permissions for.
group-id	The ID (not name) of the group to add permissions for.
capability-name	The capability to assign. If any capability has already been granted or denied for a specified user or group, that capability is ignored. Valid capabilities for a workbook are AddComment, ChangeHierarchy, ChangePermissions, CreateRefreshMetrics, Delete, ExportData, ExportImage, ExportXml, ExtractRefresh, Filter, Read (view), RunExplainData, ShareView, ViewComments, ViewUnderlyingData, WebAuthoring, and Write. For more information, see Permissions.
capability-mode	Allow to allow the capability, or Deny to deny it. This value is case sensitive.

#### Permissions Users who are not server administrators or site administrators can call this method only if the have permission to set permissions on the workbook (either explicitly or implicitly). #### Required scope for JWT authorization _Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. ``` tableau:permissions:update ``` #### Response Code 200 #### Response Body ``` ... additional capabilities ... ... additional capabilities ... ... additional grantee capability sets ... ``` #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400009	Invalid capability	The capability in the URI is invalid for a workbook resource. Valid capabilities for a workbook are AddComment, ChangeHierarchy, ChangePermissions, CreateRefreshMetrics, Delete, ExportData, ExportImage, ExportXml, Filter, Read (view), RunExplainData, ShareView, ViewComments, ViewUnderlyingData, WebAuthoring, and Write.
403	403004	Permissions setting forbidden	A non-administrator user called this method but doesn't have permission to set permissions on the workbook.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	A user ID in the request body doesn't correspond to an existing user.
404	404006	Workbook not found	The workbook ID in the URI doesn't correspond to an existing workbook.
404	404012	Group not found	A group ID in the request body doesn't correspond to an existing group.
404	404013	Capability not found	The specified capability doesn't correspond to a defined capability. This can apply to either an invalid capability name or a capability other than Allow or Deny for any mode value.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Add Workbook to Favorites Adds the specified workbook to a user's favorites. If the user already has the workbook listed as a favorite with the same label, the operation has no effect. If the label differs, the original favorite is overwritten. #### URI PUT /api/api-version/sites/site-id/favorites/user-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook.
user-id	The ID of the user to add the favorite for.

#### Request Body ``` ``` #### Attribute Values

favorite-label	A label to assign to the favorite. This value is displayed when you search for favorites on the server. If the label is already in use for another workbook, an error is returned.
workbook-id	The ID (not name) of the workbook to add as a favorite.

#### Permissions Tableau Server users who are not administrators or site administrators can call this method only if they have permission to add a workbook to a favorites list. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:favorites:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ... additional favorites ... ``` #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400005	Invalid label	The favorite label is empty or consists of only white space characters.
403	403004	Access to Favorites forbidden	A non-administrator user called this method but doesn't have permission to add a workbook to the specified user's favorites. This will always be the case when the user references in the URI identifies a user other than the user who is calling the method.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user.
404	404006	Workbook not found	The workbook ID in the request body doesn't correspond to an existing workbook.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Add Workbook to Server Schedule Adds a task to refresh or accelerate a workbook to an existing schedule on Tableau Server. The task type must match the schedule type. For a list of schedule types, see [Create a Schedule](#create_schedule). _For Tableau Cloud, see [Create Cloud Extract Refresh Task](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_extract_and_encryption.htm#create_cloud_extract_refresh_task)._ **Note:** This method is not available for Tableau Cloud. **Important changes for Tableau View Acceleration and Data Acceleration** Tableau's View Acceleration feature and Data Acceleration APIs are retired. These features were retired in Tableau Cloud in June 2026 and in Tableau Server version 2026.2. #### URI PUT /api/api-version/sites/site-id/schedules/schedule-id/workbooks #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the view.
schedule-id	The ID of the schedule that you are associating with the workbook.

#### Request Body ``` ``` #### Attribute Values

workbook-id

The ID of the workbook to add to the schedule.

#### Permissions Only Tableau Server users who are server administrators or site administrators can add a workbook to a data acceleration schedule. Tableau Server users who are not server administrators or site administrators can only add a workbook to other types of schedules if they own the workbook, or are the project leader for the project that contains the workbook. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:schedules:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` #### Version Starting in Tableau Server 10.5 (API 2.8) you can add a task to refresh a workbook extract. In Tableau Server 2020.2 (API 3.8) through 2021.4 (API 3.15), you can add a task to add data acceleration to a workbook. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403032	Update Forbidden	A non-administrator user called this method, but the caller doesn't have sufficient permissions.
404	404000	Site not found	The site ID in the URI is unknown.
404	404006	Resource not found	The workbook ID in the request body is unknown.
405	405000	Invalid request method	Request type was not PUT.
500	500000	Internal Server Error	The schedule ID in the URI is unknown.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/ 1edc53ac-e247-4870-9fd3-6fad0ce5f84d/schedules/9a4ebbab-9ec8-487a-9b48-47fa81d6077a/workbooks" -X PUT -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" –d @add-to-schedule.xml"` **Content of add-to-schedule.xml:** ``` ``` **Example response:** ``` ``` ## Allow dashboard extension on site - Retired in API 3.21 * * * Retired in API 3.21 (Cloud October 2023 / Server 2023.3) > > [!WARNING] > > > > In October 2023 Tableau Cloud and Tableau Server version 2023.3 releases, Tableau's REST API methods for dashboard extensions settings are retired. We recommend you replace dashboard extensions methods for enabling, listing, getting details of, and updating dashboard extensions with [Tableau extensions settings methods](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_tableau_extensions_settings.htm) that have similar functionality. * * * Adds a dashboard extension to the safe list of the site you are signed into. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server or site administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/settings/site/extensions/dashboard/safeListItems [view details](#) ## Append to File Upload Uploads a block of data and appends it to the data that is already uploaded. Call this method after an upload has been initiated using [Initiate File Upload](#initiate_file_upload), as many times as needed to upload all the blocks and complete the file. (A file is limited to 10,000 blocks.) You can safely make multiple simultaneous calls to this method as long as you use the sequenceID parameter in the URI querystring. Doing so will upload the blocks in parallel and decrease the time needed to complete the file, provided there is enough available bandwidth. When the final block of data has been uploaded, you call [Publish Data Source](#publish_data_source), [Publish Flow](#publish_flow), or [Publish Workbook](#publish_workbook) to commit the file. For more information, see [Publishing Resources](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_publish.htm). #### URI PUT /api/api-version/sites/site-id/fileUploads/upload-session-id?sequenceID=sequence-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site to upload the file to.
upload-session-id	The ID of the upload session. You get this value when you start an upload session using Initiate File Upload.
sequence-id	(Optional) A long integer that you choose, indicative of the block's order in the complete sequence. After you append all the blocks and call the Publish Data Source, Publish Flow, or Publish Workbook method, the sequenceID is used to order the blocks, low sequenceID to high sequenceID, and the combined blocks are written as the file. Therefore, the sequenceID should be incremented for each block (though it doesn't have to incremented by 1). If you don't include sequenceID in the URI querystring, the uploaded blocks are processed in the order they arrive. Network conditions can cause blocks to arrive out of order, which could result in a corrupted file if sequenceID isn't used. Note: The sequenceID parameter is available starting in API version 3.27 (Tableau Cloud December 2025 / Server 2025.3). If you're using API version 3.26 (Tableau Cloud June 2025 / Server 2025.1) or earlier, the file is assembled using each block's arrival time.

#### Request Body The content of the file to be uploaded is included in a MIME multipart message. For more information, see [Publishing Resources](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_publish.htm). #### Permissions Users who are not server administrators or site administrators can call this method only if they have publishing rights on the site. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:file_uploads:create ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400016	File size too large	The attached file exceeds the configured maximum attachment size for a single append call. The maximum allowable size will be reported in the error response.
400	400019	Malformed request body	The XML content in the MIME multipart request is not empty.
400	400020	Missing file data	There is no attachment in the request with the file data to be appended to the upload.
403	403007	Not a publisher	A non-administrator user attempted to initiate a file upload, but the caller doesn't have publishing rights on the site.
403	403016	Upload failure	The file could not be uploaded for some other reason than those specified earlier.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404015	File upload not found	The file upload ID in the URI doesn't correspond to an existing file upload.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Batch Add or Update Data Quality Certifications Create or update one or more data quality certifications for different content and asset items. **Note:** Data quality warnings and certifications can be more generally managed through the newer **Labels** methods. Tableau recommends using them to help ensure that you can manage your assets as new features are developed. Try the [Update Labels](#update_labels_on_assets) method instead. A content or asset item can only have up to one data quality certification applied to it. Adding a data quality certification to an item that already has one will update the data quality certification with the latest specified values. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI POST api/api-version/sites/site-id/dataQualityCertifications #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.

#### Request Body ``` ``` #### Attribute Values Any combination of attributes inside the **** element is valid, however **type** and **message** attributes are required.

content	The type of content or asset the data quality warning is attached to. To specify type, use one of the following values: database table datasource virtualconnection virtualconnectiontable
database-id	The unique ID of the database asset.
table-id	The unique ID of the table asset.
datasource-id	The unique ID of the data source content.
virtualconnection-id	The unique ID of the virtual connection asset.
virtualconnectiontable-id	The unique ID of the virtual connection table asset.
type	Use the following value to apply a data quality certification: CERTIFIED.
message	A custom message to accompany the data quality certification. You can format the message with italics, bold text, links, images, and more. Use HTML character entities to match the special characters in the formatting guide that's normally visible as a tooltip in the UI.
state	(Optional) Controls whether the data quality certification displays. Value can be "true" or "false". If the state is not specified, the data quality certification is set to "true" and is visible by default. For more information about data quality certifications, see "Set a Data Quality Certification" in the Server Help or Cloud Help.
severity	(Optional) Enables high visibility for when the data quality certification is set to "true". Value can be "true" or "false". If the severity is not specified, the data quality certification is set to "false." This setting is available only through the REST API.

#### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to add or update data quality certifications: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:labels:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 201 #### Response Body **Example response** ``` ``` #### Version Version 3.13 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400108	Generic data quality certification error	The data quality certification could not be added for some reason other than those specified in this table.
403	403004	Unauthorized operation	Insufficient permissions to perform the operation.
404	404029	Content not found	The content does not exist.
409	409004	Invalid parameter	One or more values in the request body are invalid.

## Batch Add or Update Data Quality Warnings Add or update multiple data quality warnings on assets. **Note:** Data quality warnings and certifications can be more generally managed through the newer **Labels** methods. Tableau recommends using them to help ensure that you can manage your assets as new features are developed. Try the [Update Labels](#update_labels_on_assets) method instead. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI POST api/api-version/sites/site-id/dataQualityWarnings/createOrUpdate #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.

#### Request Body ``` ``` #### Attribute Values

content	The type of content or asset the data quality warning is attached to. To specify type, use one of the following values: database table column - Available in API 3.16 and later (Tableau Cloud October 2022, Server 2022.3) datasource flow virtualconnection virtualconnectiontable
database-id	The unique ID of the database asset.
table-id	The unique ID of the table asset.
column-id	The unique ID of the column asset.
datasource-id	The unique ID of the data source content.
flow-id	The unique ID of the flow content.
virtualconnection-id	The unique ID of the virtual connection.
virtualconnectiontable-id	The unique ID of the virtual connection table.
type	The type of data quality warning to apply to the content or asset. To specify type, use one of the following values: DEPRECATED WARNING STALE SENSITIVE_DATA MAINTENANCE
message	(Optional) A custom message to accompany the data quality warning. You can format the message with italics, bold text, links, images, and more. Use HTML character entities to match the special characters in the formatting guide that's normally visible as a tooltip in the UI.
state	(Optional) Controls whether the data quality warning displays. Value can be "true" or "false". If the state is not specified, the data quality warning is set to "true" and is visible by default. For more information about data quality warnings, see "Set a Data Quality Warning" in the Server Help or Cloud Help.
severity	(Optional) Enables high visibility for when the data quality warning is set to "true". Value can be "true" or "false". For more information, see the "Visibility" section of the "Set a Data Quality Warning" topic in the Server Help or Cloud Help.

#### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to batch add or update data quality warnings: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:labels:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response** ``` ``` #### Version Version 3.12 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400109	Bad request	The content of the request body (content type, content id, or dataQualityWarning attributes) is missing, incomplete, or contains malformed XML.
400	400108	Generic add data quality warning error	The data quality warning could not be added for some other reason than those specified in this table.
403	403004	Unauthorized operation	Insufficient permissions to perform the operation.
404	404029	Content not found	The content does not exist.
409	409004	Invalid parameter	One or more values in the request body are invalid.

## Batch Add Tags Add multiple tags to items that are different content and asset types. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. For more information about tags, see [Tag Items](https://help.tableau.com/current/pro/desktop/en-us/tags.htm) in the Tableau User Help. #### URI PUT api/api-version/sites/site-id/tags:batchCreate #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.

#### Request Body ``` ``` #### Attribute Values

tag-value1	Keyword text you want to add to item.
tag-value2	Keyword text you want to add to item.
database-id	The unique ID of the database asset.
table-id	The unique ID of the table asset.
column-id	The unique ID of the column asset.
datasource-id	The unique ID of the data source content.
workbook-id	The unique ID of the workbook content.
flow-id	The unique ID of the flow content.

#### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to add tags: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:tags:batch_create ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response** ``` ``` #### Version Version 3.9 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
403	403004	Unauthorized operation	Insufficient permissions to perform the operation.
404	404029	Content not found	The content does not exist.
404	404031	Database not found	The database asset does not exist.
404	404032	Table not found	The table asset does not exist.
409	409004	Invalid parameter	One or more values in the request body are invalid.
409	409066	Column not found	The column asset does not exist.

## Batch create Pulse subscriptions Creates multiple subscriptions to a metric for specified users and/or groups. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user that has read or connect permission to the data source used in the definition can create subscriptions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:metric\_subscriptions:create\` Access Scopes [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/subscriptions:batchCreate [view details](#) ## Batch Delete Data Quality Warnings Delete multiple data quality warnings from assets. **Note:** Data quality warnings and certifications can be more generally managed through the newer **Labels** methods. Tableau recommends using them to help ensure that you can manage your assets as new features are developed. Try the [Delete Labels](#delete_labels_on_assets) method instead. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI DELETE api/api-version/sites/site-id/dataQualityWarnings/batchDelete #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.

#### Request Body ``` ``` #### Attribute Values

content	The type of content or asset the data quality warning is attached to. To specify type, use one of the following values: database table column - Available in API 3.16 and later (Tableau Cloud October 2022, Server 2022.3) datasource flow virtualconnection virtualconnectiontable
database-id	The unique ID of the database asset.
table-id	The unique ID of the table asset.
column-id	The unique ID of the column asset.
datasource-id	The unique ID of the data source content.
flow-id	The unique ID of the flow content.
virtualconnection-id	The unique ID of the virtual connection.
virtualconnectiontable-id	The unique ID of the virtual connection table.

#### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to delete data quality warnings: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:labels:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 3.12 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
403	403004	Unauthorized operation	Insufficient permissions to perform the operation.
404	404029	Content not found	The content does not exist.
404	404031	Database not found	The database asset does not exist.
404	404032	Table not found	The table asset does not exist.
409	409004	Invalid parameter	One or more values in the request body are invalid.

## Batch Delete Tags Delete multiple tags from items that are different content and asset types. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. For more information about tags, see [Tag Items](https://help.tableau.com/current/pro/desktop/en-us/tags.htm) in the Tableau User Help. #### URI DELETE api/api-version/sites/site-id/tags:BatchDelete #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.

#### Request Body ``` ``` #### Attribute Values

tag-value1	Keyword text you want to add to item.
tag-value2	Keyword text you want to add to item.
database-id	The unique ID of the database asset.
table-id	The unique ID of the table asset.
column-id	The unique ID of the column asset.
datasource-id	The unique ID of the data source content.
workbook-id	The unique ID of the workbook content.
flow-id	The unique ID of the flow content.

#### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to delete tags: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:tags:batch_delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body **Example response** ``` ``` #### Version Version 3.9 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
403	403004	Unauthorized operation	Insufficient permissions to perform the operation.
404	404029	Content not found	The content does not exist.
404	404031	Database not found	The database asset does not exist.
404	404032	Table not found	The table asset does not exist.
409	409004	Invalid parameter	One or more values in the request body are invalid.
409	409066	Column not found	The column asset does not exist.

## Batch get Pulse subscriber counts Gets the number of unique users subscribed to a set of metrics specified in a comma separated list of metric LUIDs. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user that has read or connect permission to the data source used in the definition can create subscriptions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:metric\_subscriptions:read\` Access Scopes [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/subscriptions:batchGetMetricFollowerCounts [view details](#) ## Batch get Pulse subscriptions Gets a batch of subscriptions, specified in a comma delimited list of subscriptions LUIDs. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user that has read or connect permission to the data source used in the definition can get the details of subscriptions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:metric\_subscriptions:read\` Access Scopes [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/subscriptions:batchGet [view details](#) ## Batch list metric definitions (few) Gets the details of a batch of metric definitions and metrics on a site, specified in a brief comma delimited list of LUIDs. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Can be called by any user, but only returns definitions and metrics that the user has permissions to view. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_definitions\_metrics:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/definitions:batchGet [view details](#) ## Batch list metric definitions (many) Gets the details of a batch of definitions specified in a comma delimited list of LUIDs. This method is optimized for batches with large numbers of definitions. **Version:** Available in API 3.24 (Tableau Cloud December 2024) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can make this request but users will see results only for metrics they have permissions to view. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insights:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/definitions:batchGet [view details](#) ## Batch list metrics (few) Gets a batch of metrics from a definition, specified in a comma delimited list. **Version:** Available in API 3.26 (Tableau Cloud September 2025) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can get a batch of metrics as long as the user has read or connect access to the data source used in the definition that contains them. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_metrics:read\` Access Scopes Overview: [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/metrics:batchGet [view details](#) ## Batch list metrics (many) Gets batches of metrics available on a server. Only metrics a user has privileges to view will be visible. This endpoint uses POST as an alternative to GET, where long lists of URL parameters could be problematic. **Version:** Available in API 3.26 (Tableau Cloud September 2025) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can get a batch of metrics as long as the user has read or connect access to the data source used in the definition that contains them. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_metrics:read\` Access Scopes Overview: [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/metrics:batchGet [view details](#) ## Batch update collections Batch updates collections. **Version:** Available in API 3.28 (Cloud February 2026 / Server 2026.2) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Tableau administrators can call this method for all sites they administer. Other users can call this method for collections that they own. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:collections:update. Added in API 3.28. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/collections/batchUpdate [view details](#) ## Batch Update Schedule State Updates the state of one or more schedules. Use the `updateAll` URI parameter to update the state of all schedules in a single call. **Version**: Available in API 3.27 (Tableau Server 2025.3 and later. Not available for Tableau Cloud.) **License**: No additional license required. **Permissions**: Only server administrators. **Access Scope**: `tableau:schedules:update` - For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/schedules?state=state-enum PUT /api/api-version/schedules?state=state-enum&updateAll=update-all-flag #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
state-enum	Required, enum. Either `active` or `suspended`. The state for the schedule(s).
update-all-flag	Optional, boolean. If `true`, then the list of schedule IDs in the request body is ignored, and the operation affects all schedules on the Tableau Server.

Note: A common use case for this method is suspending all schedules before a maintenance window using the `updateAll` URI parameter. If, after the maintenance window, you use the same tactic and _activate_ all schedules using the `updateAll` URI parameter, you risk activating schedules that may have been intentionally suspended in the past, before you used `updateAll` to suspended all schedules. Instead, when suspending all schedules using the `updateAll` URI parameter, note which schedule LUIDs appear in the response body. This tells you which schedules were changed from active to suspended. Then, after the maintenance window, re-activatate only those schedules, not _all_ schedules. #### Request Body ``` schedule-id ``` { "scheduleLuids": { "scheduleLuid": \[ "schedule-id" \] } } #### Request Attributes

schedule-id

The LUID of the schedule. You can include multiple schedule-ids using additional <scheduleLuid> elements (in XML) or by comma-separating multiple schedule-ids (in JSON).

Note: If the updateAll URI parameter is included, schedule-ids in the request body are ignored.

#### cURL Request Example ``` curl "https://MY-SERVER/api/3.27/schedules?state=active&updateAll=true" -X PUT -H "X-Tableau-Auth: a1B2c3D4e5F6g7H8i9J0kL|a1B2c3D4e5F6g7H8i9J0kL1m2N3o4P5q|12345678-90ab-4cde-8f01-234567890abc" -d @data.xml ``` **Content of data.xml:** ``` 12ab34cd-56ef-78ab-90cd-12ef34ab56cd 08a7b6b5-b4ba-be3a-4d2d-1e9e59a8a7b6 ``` #### Response Code 200 #### Response Body The response body is a list of schedules that were updated with the call. ``` schedule-id ``` ``` { "scheduleLuids": { "scheduleLuid": [ "schedule-id" ] } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Generic error	An unknown error occurred. The content of the request body may be missing or incomplete, or may contain malformed XML.
403	403188	Permissions error	User calling the method isn't a server administrator.
403	403189	Invalid LUID	One or more of the schedule LUIDs isn't a valid LUID.
404	404023	LUID not found	One or more of the schedule LUIDs isn't found.
405	405000	Availability error	This method only exists on Tableau Server. Tableau Cloud isn't supported.
409	409004	Parameter error	The state parameter is absent or not recognized; or the updateAll parameter was absent or false and no schedule LUIDs were provided.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Block dashboard extension on server - Retired in API 3.21 * * * Retired in API 3.21 (Cloud October 2023 / Server 2023.3) > > [!WARNING] > > > > In October 2023 Tableau Cloud and Tableau Server version 2023.3 releases, Tableau's REST API methods for dashboard extensions settings are retired. We recommend you replace dashboard extensions methods for enabling, listing, getting details of, and updating dashboard extensions with [Tableau extensions settings methods](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_tableau_extensions_settings.htm) that have similar functionality. * * * 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](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/settings/server/extensions/dashboard/blockListItems [view details](#) ## Block Domain Blocks a domain from being used with any Bridge pool, preventing Bridge clients from that domain from connecting. Blocking is site-specific and takes precedence over pool assignments; blocked domains cannot be added to any pool. Existing connections from the domain may be terminated. This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PATCH /api/api-version/sites/site-luid/bridge-domain-maps/block-domain #### URI Parameter Values

api-version	The version of the API to use. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.

#### Request Body ``` ``` ``` { "bridgeDomain": { "existingDomainName": "example.com", "isBlocked": true } } ``` #### Attribute Values

existingDomainName	Required. The domain to block or unblock.
isBlocked	Set to `true` to block the domain; set to `false` to unblock (remove from blocked list).

#### Response Code 200 #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
400	409004	Invalid domain name or missing isBlocked	Domain must conform to valid format; isBlocked parameter is required.
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	403000	Insufficient permissions	User does not have Site Administrator role.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500	503905	Unexpected server error	An unexpected error occurred while blocking the domain.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Cancel Flow Run Cancels a flow run that is in progress. #### URI PUT /api/api-version/sites/site-id/flows/runs/flow-run-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the flow.
flow-run-id	The ID of the flow run.

#### Request Body None #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:flow_runs:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body None #### Version Version 3.10 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403135	Flow run already complete	The flow run is already complete so it could not be canceled.
403	403137	User does not have permissions to cancel flow run	In addition to server administrators and site administrators, users can cancel a flow run if they initiated the flow run or created the flow run scheduled task and have "Run Flow Now" permissions for the flow.
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
404	404036	Flow run not found	The flow run ID in the URI doesn't correspond to an existing flow run.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Cancel Job Cancels a job specified by job ID. To get a list of job IDs for jobs that are currently queued or in-progress, use the [Query Jobs](#query_jobs) method. The following jobs can be canceled using the **Cancel Job** method: - Full extract refresh - Incremental extract refresh - Subscription - Flow Run - Data Acceleration _Tableau's View Acceleration feature and Data Acceleration-related APIs were retired in Tableau Cloud in June 2026 and in Tableau Server version 2026.2._ - Bridge full extract refresh - Bridge incremental extract refresh - Queue upgrade Thumbnail (Job that puts the upgrade thumbnail job on the queue) - Upgrade Thumbnail #### URI PUT /api/_api-version_/sites/_site-id_/jobs/_job-id_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site where the job is running.
job-id	The ID of the job to cancel.

HTTP status	`error` Code	Condition	Details
403	403032	Update forbidden	A non-administrator user tried to cancel a job.
403	403091	Can not cancel job, because it's already complete.	The job ID provided is for a job that has already succeeded or failed.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/1edc53ac-e247-4870-9fd3-6fad0ce5f84d/jobs/2474164d-8d37-4a4c-abc7-c2070fd25fd5" -X PUT -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` ## Configure Identity Store Configure a new local identity store to provision users. **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/authn-service/identity-stores [view details](#) ## Create a collection Creates a new collection. **Version:** Available in API 3.28 (Cloud February 2026 / Server 2026.2) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Tableau administrators can call this method for all sites they administer. Other users can call this method for collections that they own. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:collections:create. Added in API 3.28. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/collections [view details](#) ## Create a semantic context Create a semantic context node carrying one or more statements. **Version:** Available in Tableau Cloud September 2026 and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Creator role. The user can read/write nodes allowed by content permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** Tableau Cloud+ **Access Scope:** \`tableau:knowledge:write\` [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/v1/knowledge/semantic-contexts [view details](#) ## Create a Webhook Creates a new webhook for a site. #### URI POST /api/3.6/sites//webhooks #### Parameter Values

site-id

The ID of the site in which you want to create the webhook.

#### Request Body

#### Attribute Values

webhook-name	This is required. A name for the webhook.
api-event-name \| webhook-source-api-event-name	You must specify one of these attribute values. The name of the Tableau event that triggers your webhook. The event name must be one of the supported events listed in the Trigger Events table. The event and webhook-source use different name values for the same event.  Recommended: Use the event attribute of the webhook to specify the triggering API event for the webhook. The webhook-source element serves the same purpose but is being deprecated in future versions of Tableau webhooks. If both events and webhook-source are specified, their events specified must match. If either are specified, with the other being NULL, then the specified event becomes the webhook trigger, whether the element containing the event name is event or webhook-source.
url	Required. The destination URL for the webhook. The webhook destination URL must be https and have a valid certificate.
webhook-enabled-flag	(Optional) Boolean. If true (default), the newly created webhook is enabled. If false then the webhook will be disabled.

#### Permissions This method can only be called by server and site administrators. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:webhooks:create ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 201 #### Response Body

#### Response Headers Location: /api/3.29/sites/site-id/webhooks/ ## Create an Extract for a Data Source Create an extract for a data source in a site. Optionally, encrypt the extract if the site and workbooks using it are configured to allow it. #### URI POST /api/api-version/sites/site-id/datasources/datasource-id/createExtract POST /api/api-version/sites/site-id/datasources/datasource-id/createExtract?encrypt=encryption-flag #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID of the site.
datasource-id	The LUID of the datasource.
encryption-flag	If `true`, then Tableau will attempt to encrypt the created extracts. If `false`, or no `encrypt` parameter is appended to the URI, then the extract won't be encrypted, unless encryption is enforced by site or workbook configuration. An error will be returned when `encrypt` equals `true` and encryption is disabled in the site or workbook.

#### Request Body None #### Permissions Extracts for data sources can be created by Tableau server or site administrators, and by users who own the data source or are an owner or leader of the project where the data source resides. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:extracts:create ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
404	404000	Site not found	The specified site doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not POST.
409	409070	Invalid request method	The data source cannot be extracted because it is file based or in another unsupported form.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/datasources/abcd7c6d-5e4f-3a2b-1c0d-9e8f7a6b1234/createExtract" -X POST -H "X-Tableau-Auth: oIcGYxkXSBCLLVm91mfITg|jCQSkWoIbUQVwTcH8WUTWD5nCoOf53LE"` **Response body:** ``` df410925-feae-481d-bf84-2f37bdf7ce69 ``` ## Create ask data lens - Retired in API 3.22 * * * Retired in API 3.22 (Cloud February 2024 / Server 2024.2) > > [!WARNING] > > > > **Important changes for Ask Data and Metrics** > > Tableau's Ask Data and Metrics features were retired in Tableau Cloud in February 2024 and in Tableau Server version 2024.2. With advances in natural language technologies, we're developing an improved interface that will make it easier to ask questions of your data and stay on top of changes. For more information, see [How Tableau GPT and Tableau Pulse are reimagining the data experience](https://www.tableau.com/blog/tableau-pulse-and-tableau-gpt). * * * Create an ask data lens. **Version:** Available in API 3.16 ( Tableau Cloud June 2022 / Server 2022.3) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can be called by users who have Create permissions for lenses on the site. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:lenses:create\` [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/askdata/lenses [view details](#) ## Create Authentication Configuration Create an instance of OpenID Connect (OIDC) authentication. **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/authn-service/auth-configurations [view details](#) ## Create Bridge Pool Creates a new Bridge pool with the specified name. The pool is created empty (no domain assignments or Bridge clients). The system assigns a UUID; use List Bridge Pools to get the pool ID after creation, then add domains and assign clients. This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:create` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI POST /api/api-version/sites/site-luid/bridge-pools #### URI Parameter Values

api-version	The version of the API to use. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.

#### Request Body ``` ``` ``` { "edgePool": { "pool": { "name": "Production Pool" } } } ``` #### Attribute Values

name	Required. Display name for the pool, 1–80 characters. Must be unique within the site.

#### Response Code 201 Created #### Response Body None. The pool is created with a system-generated UUID; use List Bridge Pools to get the pool ID. #### Errors

HTTP status	`error` Code	Condition	Details
400	409004 / 400929	Missing, empty, invalid, or duplicate pool name	Pool name required, 1–80 characters; must be unique on the site.
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	403000	Insufficient permissions	User does not have Site Administrator role.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500	503900	Unexpected server error	An unexpected error occurred while creating the pool.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Create Cloud Extract Refresh Task Creates a custom schedule for an extract refresh on Tableau Cloud. The target of the schedule can be a data source, a workbook, or a virtual connection. _For Tableau Server, see [Add data source to server schedule](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_jobs_tasks_and_schedules.htm#add_data_source_to_schedule), [Add workbook to server schedule](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_jobs_tasks_and_schedules.htm#add_workbook_to_schedule), and [Add virtual connection to server schedule](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_jobs_tasks_and_schedules.htm#add_virtual_connection_to_schedule)._ **Version:** Available in API 3.20 (Tableau Cloud June 2023) and later. Virtual connection support added in API 3.30. Not available for Tableau Server. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required for a data source or workbook target. A virtual connection target requires Data Management, Enterprise, Server+, Cloud+, or Tableau+ Bundle. **Permissions:** Administrators and any user with the creator role can create a custom schedule for an extract refresh. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:tasks:create - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI POST /api/api-version/sites/site-id/tasks/extractRefreshes #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID for the site.

#### Request Body ``` ``` ``` { "extractRefresh": { "type": "FullRefresh", "workbook": { "id": "54321fd-6365-44d5-925b-644e5281b605" } }, "schedule": { "frequency": "Daily", "frequencyDetails": { "start": "18:30:00", "end": "23:30:00", "intervals": { "interval": [ { "hours": "4" }, { "weekDay": "Sunday" }, { "weekDay": "Wednesday" } ] } } } ``` #### Request Attributes All request attributes are **required** to create a custom schedule for an extract refresh, except where noted below.

`extractRefresh type`	The type of extract refresh being scheduled. Valid values include: `FullRefresh` `IncrementalExtract`
`extractRefresh transactionLevel`	(Optional) : Only used with a virtual connection. Optional. DATABASE or TABLE. Default is DATABASE. If set to DATABASE: If any table extract refresh fails, none of the extracts are updated. If set to TABLE: If a table extract fails, only that table's extract isn't updated.
`workbook id` or `datasource id` or `virtualConnection id`	The LUID of the workbook, data source, or virtual connection that is the target of the custom schedule.
`startingItemId`	Only used with a virtual connection, when `extractRefresh type` is `FullRefresh` The LUID of an extract table in the virtual connection. You may have more than one `<startingItemId>` element inside of a `<startingItemIds>` element. See Virtual Connection Example.
`tableLuid`	Only used with a virtual connection, when `extractRefresh type` is `IncrementalExtract` The LUID of an extract table in the virtual connection. You may have more than one `<tableLiud>` element inside of a `<tableLiuds>` element. See Virtual Connection Example.

schedule frequency

(Required to create subscription) enumeration: The scheduled frequency for triggering the task. Valid values include:

Hourly
Daily
Weekly
Monthly

frequencyDetails start (Required to create subscription) time: If the schedule frequency is Daily, Weekly, or Monthly, then start is the time of day on which scheduled jobs should run. If the frequency is Hourly, then start is the beginning of the time range during which jobs should be started. The valid format is HH:MM:SS.

frequencyDetails end

(Required to create subscription) time: If the schedule frequency is Hourly, or Daily with an interval of hours less than 24, then end is the time of day on which scheduled jobs should stop being run. The valid format is HH:MM:SS. Time should be specified in 5 minute increments and the difference between start and end times should be increments of 60 minutes. For example, a valid frequencyDetail would be:

<frequencyDetail start="20:45:00" end="21:45:00">
  . . .
</frequencyDetail>

interval {interval type}

(Required to create subscription) string: Defines when and how often a scheduled job executes within the time parameters set in the start and end values of the frequencyDetails of the schedule. The type and valid values for an interval expression depend on the declared frequency of the schedule as follows:

Frequency	Valid interval values
`Hourly`	The value of an interval for an `Hourly` schedule can be only one of either: `hours="1"` The number of hours between jobs. `1` is the only valid value. `minutes="60"` The number of minutes between jobs. `60` is the only valid value. `weekDay="weekday"` The weekday(s) the job will be run on. Valid values are: `Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday`. For example, to schedule to run a job every hour on Sunday and Wednesday, during the time range specified in `frequencyDetails` use an interval like: `<intervals> <interval hours="1"/> <interval weekDay="Sunday"/> <interval weekDay="Wednesday"/> <intervals>`
`Daily`	The value of `Daily` can have multiple `weekday` elements, but only one `hours` declaration. An `hours` interval is required. `hours="interval"` The interval between execution of jobs on the weekday(s) specified. Valid values are `2, 4, 6, 8, 12, or 24`. Note that if the `interval` value of a daily schedule is less than `24`, a `frequencyDetail end` time must be supplied. `weekDay="weekday"` The weekday(s) the job will be run on. Valid values are: `Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday`. For example, to schedule to run a job every 4 hours on Sunday and Wednesday, during the time range specified in `frequencyDetails` use an interval like: `<intervals> <interval hours="4"/> <interval weekDay="Sunday"/> <interval weekDay="Wednesday"/> <intervals>`
`Weekly`	`weekDay="weekday"` The day of the week the schedule should run on. You can only specify a single day for a Weekly schedule. Valid values are: `Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday.`
`Monthly`	The day(s) of the month a job should be scheduled to run on. There are two ways to define a monthly interval: Specify the day(s) using the number of the day in the month; `monthDay="day"` The number of the day of the month. Valid values are the whole numbers `1` to `31` or `LastDay`. If you specify `monthDay` by day number then you can use multiple `interval` instances to choose for the job to run on multiple days in the month. If you use `LastDay` then only one instance of `interval` can be used in the schedule to specify the last day of the month. Specify the day by describing which occurrence of a weekday within the month. `monthDay="occurrence_of_weekday" Weekday="weekday"` The occurrence of the specified weekday within the month when a job should be run. Valid values for `occurrencee_of_weekday` are `First, Second, Third, Fourth, Fifth, or LastDay`. Valid values for `weekday` are `Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday`. If the value is `lastDay` then the job will run on the last occurrence of the specified weekday in the month. For example, to make a schedule that that would run a job on the third Thursday of each month, you would use: `<interval monthDay="Third" weekDay="Thursday"/>`

#### Virtual Connection Example When the target is a virtual connection, use `virtualConnection id` instead of `workbook id` or `datasource id`. The following example includes only the `` and child elements for brevity; see the primary example above for the a full request without the elements that apply only to virtual connections. _Incremental refresh of specific tables, with a table-level transaction:_ ``` b4e39d59-19c3-4380-8ea4-9bfa4ed8fb84 ``` #### cURL Request Example `curl --location --request POST "https://10ax.online.tableau.com/api/3.29/sites/a946d998-2ead-4894-bb50-1054a91dcab3/tasks/extractRefreshes" --header "Content-Type: application/xml" --data " "` 200 #### Response Body When the target is a virtual connection, the response's `extractRefresh` element includes a `transactionLevel` attribute and a `virtualConnection` element (with a sibling `startingItemIds`, if starting items were specified) in place of `datasource` or `workbook`. ``` ``` ``` { "extractRefresh": { "id": "13237fd-6365-44d5-925b-644e5281b605", "consecutiveFailedCount": "0", "type": "IncrementalRefresh", "datasource": { "id": "0057ccac-872a-11e5-bb51-f763326b1350" } }, "schedule": { "id": "cdfe8548-84c8-418e-9b33-2c0728b2398a", "createdAt": "2023-04-06T23:43:12-0700", "updatedAt": "2023-04-06T23:43:12-0700", "frequency": "Daily", "nextRunAt": "2023-04-06T23:43:12-0700", "frequencyDetails": { "start": "18:30:00", "end": "23:30:00", "intervals": { "interval": [ { "hours": "4" }, { "weekDay": "Sunday" }, { "weekDay": "Wednesday" } ] } } } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400225	Duplicate starting item	`startingItemIds` contains a duplicate table LUID.
409	409090	Extract operation not allowed	The virtual connection has no extract-configured tables; all tables are live.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
404	404026	Task not found	The task for the extract refresh could not be found.
409	409004	invalid parameter value	The request is malformed or contains an invalid or missing schedule or interval parameter value. When the difference between `start` and `end` times are not increments of one hour, this error will result.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Create Cloud Flow Task Creates a flow task on Tableau Cloud, and set its schedule. **Note:** This method is unavailable if you do not have a Data Management license or Tableau Prep Conductor is disabled for your site. **Version:** Available in API 3.22 (Tableau Cloud April 2024) and later. Not available for Tableau Server. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** Requires [Tableau Data Management](https://help.tableau.com/current/online/en-us/dm_overview.htm). **Permissions:** A user can create a cloud flow task if you are a site or server administrator, or they own the flow, or are the project leader for the project that contains the workbook. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** Not available. #### URI POST /api/api-version/sites/site-luid/tasks/flows #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.

#### Request Body ``` ``` ``` { "task": { "flowRun": { "flow": { "id": "dd3cd2e7-2ede-49c6-945f-e7b2a2f25541" } } }, "schedule": { "frequency": "Daily", "frequencyDetails": { "start": "12:30:00", "end": "23:30:00", "intervals": { "interval: [ { "hours": "4" }, { "weekDay": "Monday" }, { "weekDay": "Wednesday" } ] } } } } ``` #### Request Attributes

flow.id (Required)The LUID of the flow the task is being scheduled for.

schedule frequency

(Required to create subscription) enumeration: The scheduled frequency for triggering the task. Valid values include:

Hourly
Daily
Weekly
Monthly

frequencyDetails end

<frequencyDetail start="20:45:00" end="21:45:00">
  . . .
</frequencyDetail>

interval {interval type}

Frequency	Valid interval values
`Hourly`	The value of an interval for an `Hourly` schedule can be only one of either: `hours="1"` The number of hours between jobs. `1` is the only valid value. `minutes="60"` The number of minutes between jobs. `60` is the only valid value. `weekDay="weekday"` The weekday(s) the job will be run on. Valid values are: `Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday`. For example, to schedule to run a job every hour on Sunday and Wednesday, during the time range specified in `frequencyDetails` use an interval like: `<intervals> <interval hours="1"/> <interval weekDay="Sunday"/> <interval weekDay="Wednesday"/> <intervals>`
`Daily`	The value of `Daily` can have multiple `weekday` elements, but only one `hours` declaration. An `hours` interval is required. `hours="interval"` The interval between execution of jobs on the weekday(s) specified. Valid values are `2, 4, 6, 8, 12, or 24`. Note that if the `interval` value of a daily schedule is less than `24`, a `frequencyDetail end` time must be supplied. `weekDay="weekday"` The weekday(s) the job will be run on. Valid values are: `Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday`. For example, to schedule to run a job every 4 hours on Sunday and Wednesday, during the time range specified in `frequencyDetails` use an interval like: `<intervals> <interval hours="4"/> <interval weekDay="Sunday"/> <interval weekDay="Wednesday"/> <intervals>`
`Weekly`	`weekDay="weekday"` The day of the week the schedule should run on. You can only specify a single day for a Weekly schedule. Valid values are: `Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday.`
`Monthly`	The day(s) of the month a job should be scheduled to run on. There are two ways to define a monthly interval: Specify the day(s) using the number of the day in the month; `monthDay="day"` The number of the day of the month. Valid values are the whole numbers `1` to `31` or `LastDay`. If you specify `monthDay` by day number then you can use multiple `interval` instances to choose for the job to run on multiple days in the month. If you use `LastDay` then only one instance of `interval` can be used in the schedule to specify the last day of the month. Specify the day by describing which occurrence of a weekday within the month. `monthDay="occurrence_of_weekday" Weekday="weekday"` The occurrence of the specified weekday within the month when a job should be run. Valid values for `occurrencee_of_weekday` are `First, Second, Third, Fourth, Fifth, or LastDay`. Valid values for `weekday` are `Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday`. If the value is `lastDay` then the job will run on the last occurrence of the specified weekday in the month. For example, to make a schedule that that would run a job on the third Thursday of each month, you would use: `<interval monthDay="Third" weekDay="Thursday"/>`

#### cURL Request Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/datasources/1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d/connections" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` #### Response Code 200 #### Response Body ``` ``` ``` { "task": { "flowRun": { "id": "4d49655a-0f3a-45cc-ba61-b108a763e83a", "priority": "50", "consecutiveFailedCount": "0", "type": "RunFlowTask", "schedule": { "id": "1060dcb7-fef7-4fb1-8d3b-d0f042932d1a", "name": "SSS_e95a9d25-c616-4542-87b6-3725975bdfbd", "state": "Active", "priority": "50", "createdAt": "2024-04-09T18:54:12Z", "updatedAt": "2024-04-09T18:54:12Z", "type": "Flow", "frequency": "Daily", "nextRunAt": "2024-04-10T19:30:00Z" }, "flow": { "id": "dd3cd2e7-2ede-49c6-945f-e7b2a2f25541", "name": "olympic 1", "parameters": { "parameter": { "id": "4f22c514-5b56-4400-a48a-f69d9be217a9", "type": "integer", "name": "output_count", "description": "This is a parameter of a flow.", "value": "2", "isRequired": "true", "domain": { "xsi_type": "flowParameterAnyDomainType", "domainType": "all" } } } }, "flowRunSpec": { "flowId": "dd3cd2e7-2ede-49c6-945f-e7b2a2f25541", "flowOutputSteps": { "flowOutputStep": { "id": "485c8b5f-5647-466c-b549-e38410b7c7c8", "name": "Output" } }, "flowParameterSpecs": [] } } } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Create Connected App Create a connected app. A connected app can be used to securely authenticate your users to Tableau content embedded in a custom application or for REST API authorization (introduced to Tableau Cloud in June 2022 and Tableau Server 2023). By creating a connected app, you can establish a trusted relationship between Tableau and any custom application. For more information about connected apps, see one of the following: - For Tableau Server: [Configure Tableau Connected Apps to Enable SSO for Embedded Content](https://help.tableau.com/current/server-linux/en-us/connected_apps.htm) - For Tableau Cloud: [Configure Tableau Connected Apps with Direct Trust](https://help.tableau.com/current/online/en-us/connected_apps_direct.htm) #### URI POST api/_api-version_/sites/_site-id_/connected-apps/direct-trust **Note:** The `connected-applications` endpoint that performed this function was deprecated in API 3.17 (Tableau Cloud October 2022 / Tableau Server 2022.3), is no longer supported and may be retired in a future release. #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.

#### Request Body Tableau Cloud and Tableau Server using API 3.23 or later ``` project_id project_id project_id ``` Tableau Server (or Tableau Cloud) using API 3.21 or earlier ``` ``` #### Attribute Values Any combination of attributes inside the element is valid, however name is required.

name	Name of the connected app.
enabled	(Optional) Controls whether the connected app is enabled or not. Value can be "true" or "false". If the state is not specified, the connected app is set to "false" and not enabled by default.
project_id	(Optional, embedding workflows only) The IDs of the projects that the connected app's access level is scoped to. To get a project's project ID, see Query Projects. You can specify one project, multiple projects, all projects on a site. Single project: For Tableau Cloud (using API 3.22 or later) and Tableau Server (using API 3.23 or later), to scope the connected app's access to one project, the recommended workflow is to specify the projectIds and projectId attributes and projectId value. For Tableau Server (or Tableau Cloud) using API 3.21 or earlier, specify the projectId parameter and its value. Multiple projects: Beginning with API 3.22 (February 2024) for Tableau Cloud and API 3.23 for Tableau Server, you can specify the projectIds attribute and projectId values to scope the connected app's access to multiple projects. All projects: For Tableau Cloud (using API 3.22 or later) and Tableau Server (using API 3.23 or later), to scope the connected app's access to all projects on a site, omit the `projectIds` attribute from the request. For Tableau Server (or Tableau Cloud) using API 3.21 or earlier, to scope the connected app's access to all projects on a site, omit the `projectId` attribute from the request. Note: Specifying "all projects" in an update request for a connected app is handled differently. For more information, see update project. Note: The stand-alone projectId attribute will be retired in a future release so we recommend using projectIds attribute instead.
domainSafelist	(Optional, embedding workflows only) A list of domains the connected app is allowed to be hosted. Specify one or more URLs, separated by spaces, using a format described in Domain allowlist rules in the Tableau Server Help or Domain allowlist rules in the Tableau Cloud Help. Important: We recommend using the domain allowlist as a security best practice to ensure Tableau content is only embedded in locations that you allow. For example: `https://tableau.com https://myco.com:552 marketing.example.com`
unrestrictedEmbedding	(Optional, embedding workflows only) Controls whether the connected app can be hosted on all domains. If "true" value is specified, the connected app can be hosted on all domains. If "false" value is specified, the connected app can only be hosted on the domains specified in the `<domainSafelist>` attribute.

#### Permissions Tableau Server admins or Tableau Cloud site admins only. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:connected_apps_direct_trust:create ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 201 #### Response Body **Example response:** ``` ConnectedApp_MyCo true ac95d175-c844-4779-9d58-415e01fe7dab 1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e 1234de4e-5d6d-7c8c-9b0b-1a2a3f4f5e0e 2021-08-10T18:46:30Z true ``` **Note:** When the scope of the connected app's access is set to all projects, the request does not return the `projectId` attribute. #### Version Version 3.14 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). The resource, POST /api/_api-version_/sites/_site-id_/connected-apps/direct-trust, was added in version 3.17. The original resource, POST /api/_api-version_/sites/_site-id_/connected-applications, was deprecated in API 3.17 and will be retired in a future release. #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400109	Bad request	The request body can't be empty.
400	400143	Generic connected app error	The connected app could not be deleted for some other reason than those specified in this table.
403	403000	Admin permissions required	A non-admin user called this method and doesn't have adequate permissions to perform the action.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404041	Connected app not found	The requested connected app could not be found.

## Create Connected App Secret Generate a secret for a connected app. Secrets are tokens shared by Tableau and a custom application, and used to establish a trusted relationship. A maximum of two secrets can be associated with a connected app. These secrets do not expire and remain valid until deleted. If a connected app has already reached its two secret maximum when another one is generated, an error is thrown. #### URI POST api/_api-version_/sites/_site-id_/connected-apps/direct-trust/_client-id_/secrets **Note:** The `connected-applications` endpoint that performed this function was deprecated in API 3.17 (Tableau Cloud October 2022 / Tableau Server 2022.3), is no longer supported and may be retired in a future release. #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
client-id	The unique ID of the connected app.

#### Request Body None #### Permissions Tableau Server admins or Tableau Cloud site admins only. #### Response Code 201 #### Response Body The request returns details about the generated secret, including the secret value ``. **Example response:** ``` TO7/wkW+45U001IBtyNbtyIMYQ/GBM0XlRXqsgYqPlY= 7ecc5c7c-d923-4ffd-917b-cab1bd89f03b 2021-08-10T18:48:40Z ``` #### Version Version 3.14 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). The resource, POST /api/_api-version_/sites/_site-id_/connected-apps/direct-trust/_client-id_/secrets, was added in version 3.17. The original resource, POST /api/_api-version_/sites/_site-id_/connected-applications/_client-id_/secrets, was deprecated in version 3.17 and will be retired in a future release. #### Errors

HTTP status	`error` Code	Condition	Details
400	400143	Generic connected app error	The connected app could not be deleted for some other reason than those specified in this table.
400	400144	Secret limit exceeded	The connected app has already reached its two secret maximum.
403	403000	Admin permissions required	A non-admin user called this method and doesn't have adequate permissions to perform the action.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404041	Connected app not found	The requested connected app could not be found.
404	404042	Secret not found	The requested secret for the connected app could not be found.

## Create custom domain settings Starts the process of custom domain setup for a Tableau site. **Version:** Available in API 3.26 (Tableau Cloud June 2025) and later. Not available for Tableau Server. [Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Only users with administrator permissions can create a custom domain for a site. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:custom\_domains:create\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/customdomains/settings/site/{site\_luid} [view details](#) ## Create Data Driven Alert Create a data driven alert (DDA) for a view with a single data axis. **Version:** Available in API 3.20 (Tableau Cloud June 2023) and later. Not available for Tableau Server. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Users with the Administrator, Creator, or Explorer role can add DDAs to views they have permissions to. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:data\_driven\_alerts:create - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI POST /api/api-version/sites/site-luid/dataAlerts #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.

#### Request Body Copy ``` --> /> ``` Copy ``` { "dataAlertCreateAlert": { "alertCondition": "above", "alertThreshold": "14000", "subject": "Data Driven Alert for Forecast", "frequency": "daily", "visibility": "public", "device": "desktop", "worksheetName": "one_measure_no_dimension", "viewId": "my-view-id" // can be "customViewId" instead }} ``` #### Request Attributes

`dataAlertCreateAlert alertCondition`	(Required) Enumeration: The condition that triggers the DDA. Used in conjunction with the threshold to determine when to trigger an alert. For example, an alert can be triggered if on the condition that data is above or equal to a threshold of 1000 orders. The value can be: `above` `above-equal` `below` `below-equal` `equal`
`dataAlertCreateAlert alertThreshold`	(Required) Int: The data value where an alert should be triggered when that value drops below or rises above the alert threshold value.
`dataAlertCreateAlert subject`	(Required) String: The name of the data driven alert.
`dataAlertCreateAlert frequency`	(Required) Enumeration: The time period between attempts by Tableau to assess whether the alert threshold has been crossed. The value can be one of: `once` Sends the alert only the first time the alert threshold is crossed. `freguently` As frequently as possible given server conditions. `hourly` `daily` `weekly`
`dataAlertCreateAlert visibility`	(Required) Enumeration: Determines whether the alert can be seen by only its creator (`private`), or by any user with permissions to the worksheet where the alert resides (`public`) . The value can be one of: `private` `public`
`dataAlertCreateAlert device`	(Optional) Enumeration: The type of device the alert is formatted for. If no `device` is provided then the default device setting of the underlying view is used. Values can be one of: `desktop` `phone` `tablet`
`dataAlertCreateAlert worksheetName`	(Required) String: The name of the worksheet that the DDA will be created on. For dashboards, this is the name of the underlying sheet that contains the data whose value can trigger the alert, not the name of the dashboard that presents that sheet. For custom views, the name of the original view that was used to form the custom view.
`dataAlertCreateAlert viewId` OR `dataAlertCreateAlert customViewId`	(Required) LUID: The LUID of either the `viewId` or `customViewId` that contains the data that can trigger an alert.

#### cURL Request Example `curl http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/datasources/1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d/connections" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` #### Response Code 200 #### Response Body Copy ``` --> /> ``` Copy ``` { "dataAlertCreateAlert": { "alertCondition": "above", "alertThreshold": "14000", "subject": "Data Driven Alert for Forecast", "frequency": "daily", "visibility": "public", "device": "desktop", "worksheetName": "one_measure_no_dimension", "viewId": "my-view-id" // can be "customViewId" instead }} ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
400	403165	DDA creation failed	A data driven alert could not be created because there is a missing value in the request body.
401	401002	Unauthorized Access	The user does not have permissions to create a data driven alert. Causes may include: authentication token provided in the request header was invalid or has expired; the user does not have administrator, creator, or explorer permissions; the user does not have permissions to view the sheet.
403	403164	DDA not enabled	Data driven alerts are not enabled for the site, or the user visibility site setting is configured as `limited`.
404	404011	View not found	The view specified in the request could not be found.
404	409004	Request is malformed	A data driven alert could not be created because there is an unexpected value in the request body.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Create Extracts for Embedded Data Sources in a Workbook Create extracts for all embedded data sources of a workbook. Optionally, encrypt the extracts if the site and workbook using them are configured to allow it. When you create an extract for a data source in a workbook, the extract is available only to the workbook and may have configuration specific to the workbook, such as hiding of unused fields. You can create workbook extracts for both embedded and published data sources used by the workbook. When you create a workbook data source for a published data source, then refreshing the workbook extract will retrieve any changes to data from the published datasource, or from the published data source's extract if it is using one. **Note:** This method will fail and result in an error if your Server Administrator has disabled the **RunNow** setting for the site. For more information, see [Tableau Server Settings](https://help.tableau.com/current/server/en-us/maintenance_set.htm). #### URI POST /api/api-version/sites/site-id/workbooks/workbook-id/createExtract POST /api/api-version/sites/site-id/workbooks/workbook-id/createExtract?encrypt=encryption-flag #### Path Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID of the site.
workbook-id	The LUID of the workbook.
encryption-flag	If `true`, then Tableau will attempt to encrypt the created extracts. If `false`, or no `encrypt` parameter is appended to the URI, then the extract won't be encrypted, unless encryption is enforced by site or workbook configuration. An error will be returned when `encrypt` equals `true` and encryption is disabled in the site or workbook.

#### Request Body ``` ``` #### Request Parameter Values

datasource-id	LUID of the embedded data source to be extracted.
extract-all-datasources-flag	Boolean. If `true`, then all data sources in the workbook will have an extract created for them. If `false`, then a data source must be supplied in the request.

#### Permissions Extracts for data sources embedded in a workbook can be created by Tableau server or site administrators, and users who own the workbook, or are an owner or leader of the project where the workbook resides. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:extracts:create ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code `200` #### Response Body ``` ``` #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
404	404000	Site not found	The specified site doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not POST.
409	409070	Invalid request method	The data source cannot be extracted because it is file based or in another unsupported form.

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.

site-id The ID of the site to create the group in.

asJob-value

A Boolean value that is used if you are importing from Active Directory. If you set this to false (the default), the import process runs as a synchronous process. If the Active Directory group contains many users, the process might time out before it finishes.

If you set this to true, the process runs asynchronously. In that case, Tableau Server starts a job to perform the import and returns the job ID in the Location header. You can check the status of the import job by calling Query Job.

Note: This parameter has no effect if the server is configured to use local authentication.

This attribute is available for Tableau Server only.

#### Request Body **Creating a local group** ``` ``` **Notes:** - When the request is to create a local group and minimumSiteRole is specified, users are granted a license using the grant license on-login mode by default. **Importing a group from Active Directory** (Tableau Server only) ``` ``` **Notes:** - When the request is to create a group with grantLicenseMode, a siteRole value should also be supplied. - When the request body contains an element, a Tableau Server configured to authenticate via Active Directory will create the group and modify the set of users in the group to be the same as those in Active Directory. The source attribute of the element must be set to `ActiveDirectory`. If Tableau Server or Tableau Cloud site is configured to use local authentication, including an element has no effect. - When a group is created by importing from Active Directory, Tableau Server uses the value of the Active Directory `sAMAccountName` attribute as the user name. #### Attribute Values

new-tableau-server-group-name	The name for the new group.
active-directory-group-name	The name of the Active Directory group to import. This attribute is available for Tableau Server only.
active-directory-domain-name	The domain of the Active Directory group to import. This attribute is available for Tableau Server only.
minimum-site-role	Required if an import element or grantLicenseMode attribute are present in the request. For Tableau Server, the site role assigned to users who are imported from Active Directory or granted a license automatically using the grant license on-sync or on-login mode. If the requested user name matches an existing user in the group, the user either retains their existing role or are granted the one specified in the request, based on the role that enables the most capabilities. This is true whether the group the user belongs to is imported from Active Directory (Tableau Server only) or local. Site roles that can be assigned, listed from the one enabling the least capabilities to the most, are as follows. Unlicensed Viewer Explorer ExplorerCanPublish Creator SiteAdministratorExplorer SiteAdministratorCreator Note: You cannot use the REST API to set a user to be a Tableau Server administrator (ServerAdministrator site role).
license-mode	The mode for automatically applying licenses for group members. When the mode is onLogin, a license is granted for each group member when they log in to a site. For local groups, the mode can be either onLogin or unset. If the attribute is omitted, the default mode is unset, which results in no licenses being granted automatically to group members. For groups that import an Active Directory domain, the mode can be either onSync or onLogin. The minimum role granted to users through grantLicenseMode is specified in the siteRole attribute. If that role has less permissions than an existing role assigned to the user, then the user's permissions remain unchanged.
on-demand-access	Optional. A boolean value that is used to enable on-demand access for embedded Tableau content when the Tableau Cloud site is licensed with Embedded Analytics usage-based model or capacity-based model with Cloud+ or Tableau+ edition. Set to true to enable the capability for the group or set to false to disable the capability for the group. For more information about on-demand access, see On-demand access for users in the Tableau Embedding API v3 Help. This attribute is available for Tableau Cloud only starting from API version 3.21 (October 2023).

#### Permissions This method can only be called by Tableau Server administrators or Tableau Cloud site admins. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:groups:create ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 201, for creating a local group and for importing immediately 202, for importing using a background process #### Response Headers Location: /api/3.29/sites/site-id/groups/new-group-id #### Response Body **Creating a local group:** ``` ``` **Creating a group and importing from Active Directory immediately (Tableau Server only):** ``` ``` **Importing as a background process:** ``` ``` #### Version Version 3.9 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400013	Invalid site role	The value of the minimumSiteRole or siteRole attribute must be Creator, Explorer, ExplorerCanPublish, SiteAdministratorCreator, SiteAdministratorExplorer, Unlicensed, or Viewer.
400	400019	Malformed import element	When the <import> element is present in the request body, the following attributes must be specified: source with the value ActiveDirectory; domainName; and siteRole If any of these is missing, the element is malformed.
400	400984	Not licensed	On-demand access can't be enabled if your site is not licensed with the usage-based model or capacity-based usage model with Tableau+ or Cloud+.
403	403011	Active Directory is not configured	The <import> element is present, but Tableau Server is configured for local authentication.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404016	Domain not found	The request body includes an <import> element, but the specified domain name doesn't exist in Active Directory.
404	404017	Active Directory group not found	The request body includes an <import> element, but no group exists in Active Directory that matches the specified group name.
405	405000	Invalid request method	Request type was not POST.
409	409009	Group name conflict	The group name in the request already belongs to the specified site. For the purpose of uniqueness checks, group names are case-insensitive.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example: Local Group `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/groups/" -X POST -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @create-local-group.xml` **Content of create-local-group.xml:** ``` ``` **Response header:** `Location: /api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/groups/1a2b3c4d5-e6f7-a8b9-c0d1-e2f3a4b5c6d` **Response body:** ``` ``` #### Example: Active Directory Group `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/groups/" -X POST -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @create-ad-group.xml` **Content of create-ad-group.xml:** ``` ``` **Response header:** `Location: /api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/groups/1a2b3c4d5-e6f7-a8b9-c0d1-e2f3a4b5c6d` **Response body:** ``` ``` ## Create Group Set Creates a group set with a specified name. **Note**: You can't use this method to populate the group set with groups. After you create a group set and its ID is available, you can add a group to the group set by calling [Add Group to Group Set](#add_group_to_groupset). **Version:** Available in API 3.22 (Tableau Cloud February 2024 / Server 2024.2) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** This method can only be called by Tableau Server administrators or Tableau Cloud site admins. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** tableau:groupsets:create - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI POST /api/api-version/sites/site-id/groupsets #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site to create the group in.

#### Request Body Copy ``` name

(Required) Name of the new group set.

#### cURL Request Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/groupsets/" --header "Content-Type: application/xml" --header "X-Tableau-Auth: YqB9_MHoTHO26HGsFBFEBg|bQDOIH4MsqFGvUDYTrRYh633vrZHBt6d|a946d998-2ead-4894-bb50-1054a91dcab3" --data " "` #### Response Code 201, for creating a group set. #### Response Body Copy ``` ``` Copy ``` { "groupSet": { "id": "4123e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6234", "name": "marketing-group", "groupCount": "0" }} ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400013	Invalid site role	The value of the minimumSiteRole or siteRole attribute must be SiteAdministratorCreator or SiteAdministratorExplorer.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	The request type wasn’t POST.
409	409121	Group set name conflict	The group set name in the request already belongs to another group set. For the purpose of uniqueness checks, group set names are case-insensitive.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Create Identity Pool Create an identity pool. **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/authn-service/identity-pools [view details](#) ## Create Label Category Creates a data label category. Note that category is one property of a label value (labelValue), which is itself a property of a label on an asset. Other properties of a labelValue include name and description. These properties determine label behavior and options that users see in label dialogs. For more information on data label objects and properties, see the [Data Labels in the REST API](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_data_labels.htm) topic. A Data Management license is not required to create, update, or delete label categories, but one is required to create, update, delete, and see labels on assets. #### URI POST api/api-version/sites/site-luid/labelCategories #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The unique LUID of the site asset.

#### Request Body ``` ``` #### Attribute Values

label-category-name

The label category name.

Required. Must be 1-128 characters long. (In Tableau Server 2023.3 and earlier, must be 1-24 characters long.)

label-category-description

The label category description.

Required. Must be 1-500 characters in length.

#### Permissions - Only a site or server administrator can create, update, or delete label categories. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:label_categories:create ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Version Introduced in Tableau Cloud October 2023 (API 3.21) / Server 2023.3 (API 3.21). #### Response Body ``` ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400189	Generic create label categories error	An unknown error occurred.
403	403004	Operation on resource unauthorized	You must be an administrator to create, update, or delete label values.
409	409004	Invalid parameter	The category name must be 1-128 characters long. (In Tableau Server 2023.3 and earlier, the category name must be 1-24 characters long.) The category name, when stripped of spaces, dashes, and underscores, must not case insensitively match one of Tableau's built-in label categories names. The category description must be 1-500 characters in length.

## Create metric Creates a metric. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric in a definition as long as the user has read or connect access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_metrics:create\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/metrics [view details](#) ## Create metric definition Creates a metric definition. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric definition as long as the user has write and publish access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_definitions:create\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/definitions [view details](#) ## Create metric tag for user Creates a tag for the specified metric, for the signed in user. **Version:** Available in API 3.25 (Tableau Cloud March 2025) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Anyone can make this request but users will see results only for metrics they have permissions to view. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_metrics:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/metrics/{metric\_id}/tag [view details](#) ## Create OpenID Connect Configuration Create the Tableau Cloud site's OpenID Connect (OIDC) configuration. After you've configured OIDC authentication, you can use the Tableau Cloud's UI to [test the configuration](https://help.tableau.com/current/online/en-us/openid_auth_server_config.htm#test) and [add users](https://help.tableau.com/current/online/en-us/openid_auth_server_config.htm#test). For more information about OIDC authentication in Tableau Cloud, see [OpenID Connect](https://help.tableau.com/current/online/en-us/openid_auth.htm) in the Tableau Cloud Help. **Version:** Available in API 3.22 (Tableau Cloud February 2024) and later. Not available for Tableau Server._[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Tableau Cloud site admins only. **JWT Access Scope:** Not available. #### URI PUT /api/api-version/sites/site-luid/site-oidc-configuration #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.

#### Request Body Copy ``` ``` Copy ``` { "siteOIDCConfiguration": { "idpConfigurationName": "idpConfigurationName", "enabled": "enabled", "clientId": "clientId", "clientSecret": "clientSecret", "authorizationEndpoint": "authorizationEndpoint", "tokenEndpoint": "tokenEndpoint", "userinfoEndpoint": "userinfoEndpoint", "jwksUri": "jwksUri", "endSessionEndpoint": "endSessionEndpoint", "allowEmbeddedAuthentication": "allowEmbeddedAuthentication", "prompt":"prompt", "customScope":"customScope", "clientAuthentication": "clientAuthentication", "essentialAcrValues": "essentialAcrValues", "voluntaryAcrValues": "voluntaryAcrValues", "emailMapping": "emailMapping", "firstNameMapping": "firstNameMapping", "lastNameMapping": "lastNameMapping", "fullNameMapping": "fullNameMapping", "useFullName": "useFullName" }} ``` #### Request Attributes

`idpConfigurationName`	(Required) The name of the configuration. Starting in API 3.24, you can create and enable multiple authentication configurations. For more information, see Authentication in the Tableau Cloud Help.
`enabled`	(Required) Controls whether the configuration is enabled or not. Value can be "true" or "false". For example "true".
`clientId`	(Required) The client ID from your IdP. For example, "0oa111usf1gpUkVUt0h1".
`clientSecret`	(Required) The client secret from your IdP.
`authorizationEndpoint`	(Required) Use the authorization endpoint from your IdP. To find the value, enter the configuration URL in a browser and obtain the user information endpoint (`authorization_endpoint`) from the details that are returned. For example, "https://myidp.com/oauth2/v1/authorize".
`tokenEndpoint`	(Required) Use the token endpoint from your IdP. To find the value, enter the configuration URL in a browser and obtain the token endpoint (`token_endpoint`) from the details that are returned. For example, "https://myidp.com/oauth2/v1/token".
`userinfoEndpoint`	(Required) Use the user information endpoint from your IdP. To find the value, enter the configuration URL in a browser and obtain the user information endpoint (`userinfo_endpoint`) from the details that are returned. For example, "https://myidp.com/oauth2/v1/userinfo".
`jwksUri`	(Required) Use the JWK set URI from your IdP. To find the value, enter the configuration URL in a browser and obtain the JWK set URI endpoint (`jwks_uri`) from the details that are returned. For example, "https://myidp.com/oauth2/v1/keys".
`endSessionEndpoint`	(Optional) If single logout (SLO) is enabled for the site, which is done through Tableau Cloud site UI, you can specify the configuration URL or the end session endpoint from your IdP. For example, "https://myidp.com/oauth2/v1/logout".
`allowEmbeddedAuthentication`	(Optional) Controls how users authenticate when accessing embedded views. Value can be "true" or "false". Default value is "false", which authenticates users in a separate pop-up window. When set to "true", users authenticate using an inline frame (IFrame), which is less secure.
`customScope`	(Optional) Specifies a custom scope user-related value that you can use to query the IdP. For example, "openid, email, profile".
`prompt`	(Optional) Specifies whether the user is prompted for re-authentication and consent. For example, "login, consent".
`clientAuthentication`	(Optional) Token endpoint authentication method. Value can be "client_secret_basic" or "client_secret_post". Default value is "client_secret_basic".
`essentialAcrValues`	(Optional) List of essential Authentication Context Reference Class values used for authentication. For example, "phr".
`voluntaryAcrValues`	(Optional) List of voluntary Authentication Context Reference Class values used for authentication.
`emailMapping`	(Optional) Claim for retrieving email from the OIDC token. Default value is "email".
`firstNameMapping`	(Optional) Claim for retrieving first name from the OIDC token. Default value is "given_name". You can use this attribute to retrieve the user’s display name when `useFullName` attribute is set to "false".
`lastNameMapping`	(Optional) Claim for retrieving last name from the OIDC token. Default value is "family_name". You can use this attribute to retrieve the user’s display name when `useFullName` attribute is set to "false".
`fullNameMapping`	(Optional) Claim for retrieving name from the OIDC token. Default value is "name". You can use this attribute to retrieve the user’s display name when `useFullName` attribute is set to "true".
`useFullName`	(Optional) Controls what is used as the display name. Value can be "true" or "false". Default value is "false", which uses first name `(firstNameMapping` attribute) and last name (`lastNameMapping` attribute) as the user display name. When set to "true", full name (`fullNameMapping` attribute) is used as the user display name.

#### cURL Request Example `curl "https://us-west-2a.online.tableau.com/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/site-oidc-configuration" -X PUT -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @create-update-oidc-config.xml` **Content of create-update-oidc-config.xml:** Copy ``` ``` #### Response Code 200 #### Response Body Copy ``` " authorizationEndpoint="https://myidp.com/oauth2/v1/authorize" tokenEndpoint="https://myidp.com/oauth2/v1/token" userinfoEndpoint="https://myidp.com/oauth2/v1/userinfo" jwksUri="https://myidp.com/oauth2/v1/keys" endSessionEndpoint="https://myidp.com/oauth2/v1/logout" customScope="openid, email, profile" prompt="login,consent" clientAuthentication="client_secret_basic" essentialAcrValues="phr" emailMapping="email" firstNameMapping="given_name" lastNameMapping="family_name" fullNameMapping="name" useFullName="false" /> ``` Copy ``` {"siteOIDCConfiguration": { "idpConfigurationName":"Auth_External_OIDC", "enabled":"true", "testLoginUrl":"https://sso.online.tableau.com/public/testLogin?alias=080bca2d-578b-49cc-b40d-3781b36b30ee&authSetting=OIDC", "allowEmbeddedAuthentication":"false", "clientId":"0oa111usf1gpUkVUt0h1", "clientSecret":"<omit>", "authorizationEndpoint":"https://myidp.com/oauth2/v1/authorize", "tokenEndpoint":"https://myidp.com/oauth2/v1/token", "userinfoEndpoint":"https://myidp.com/oauth2/v1/userinfo", "jwksUri":"https://myidp.com/oauth2/v1/keys", "endSessionEndpoint":"https://myidp.com/oauth2/v1/logout", "customScope":"openid, email, profile", "prompt":"login,consent", "clientAuthentication":"client_secret_basic", "essentialAcrValues":"phr", "emailMapping":"email", "firstNameMapping":"given_name", "lastNameMapping":"family_name", "fullNameMapping":"name", "useFullName":"false" }} ``` **Notes:** - The response hides the client secret and replaces it with `<omit>`. - You can use the testloginURL attribute to validate the OIDC configuration. When you enter the URL in a browser, details about the configuration displays. #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Create or Update labelValue Creates a label value with the specified name if it doesn't exist, or updates the existing label value if the label value name already exists. Note: You can update an existing label value using either this method or the [Update labelValue](#ref_update_labelvalue) method. If you want to change the name on an existing label value, use the [Update labelValue](#ref_update_labelvalue) method. Note that a label value (labelValue) is one property of a label. A label value has its own properties like name, category, and description that determine label behavior and options that users see in label dialogs. For more information on data label objects and properties, see the [Data Labels in the REST API](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_data_labels.htm) topic. A Data Management license is not required to create, update, or delete label values, but one is required to create, update, delete, and see labels on assets. #### URI PUT api/api-version/sites/site-luid/labelValues #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The unique LUID of the site asset.

#### Request Body ``` ``` #### Attribute Values

label-value-name

The label value name.

Required. If you specify an existing label value name, this method will update the label value. If you specify a label value name that's different than existing label value names, this method will create the label value.

Required. Must be 1-128 characters long. (In Tableau Server 2023.3 and earlier, must be 1-24 characters long.)

label-value-category

The label value category.

Required. If you're updating an existing label value, this must match the existing category for that label value.

label-value-description

The label value description.

Required, but does not need to be different than the existing description. Must be 1-500 characters in length.

#### Permissions - Only a site or server administrator can create, update, or delete label values. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:label_values:create ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Version Introduced in Tableau Cloud June 2023 (API 3.20) and Tableau Server 2023.3 (API 3.21). #### Response Body ``` ``` #### Errors

HTTP status	`error` Code	Condition	Details
401	4000173	Generic create label values error	An unknown error occurred.
403	403004	Operation on resource unauthorized	You must be a site or server administrator to create or update label values.
403	403157	Bad request	You may see this error if you try to create or update a label in the certification category.
409	409004	Invalid parameter	The label value name must be 1-128 characters long in Tableau Cloud. (In Tableau Server 2023.3 and earlier, must be 1-24 characters long.) The name, when stripped of spaces, dashes, and underscores, must not case insensitively match one of Tableau's built-in label value names. The category must match an existing category. You can't change the category on an existing label value. The description can't be empty or over 500 characters.

## Create Project Creates a project on the specified site. You can also create project hierarchies by creating a project under the specified parent project on the site. To make changes to an existing project, call [Update Project](#update_project). **Note**: After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. **Version:** Available in API 1.0 and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Only Tableau Administrators can update a project. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** tableau:projects:create - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI POST /api/api-version/sites/site-id/projects POST /api/api-version/sites/site-id/projects?publishSamples=publish-value #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site to create the project in.
publish-value	(Optional) A Boolean value that specifies whether to publish the sample workbooks provided by Tableau to the project. When the publish-value is not specified in the request, or the `publishSamples` parameter is missing, no samples will be published. To publish the sample workbooks, set `publishSamples` parameter to `true`. This option is equivalent to the tabcmd command-line utility option, `publishsamples`. For more information, see tabcmd.

#### Request Body Copy ```

``` Copy ``` { "project": { "parentProjectId": "afe6f0b8-cb10-11e7-9fd4-db8b61369aa5", "name": "Update-Project-Name", "description": "This is the new description after the project update", "contentPermissions": "ManagedByOwner", "owner": { "id": "abc12e4e-5d6d-7c8c-9b0b-1a2a3f4f5e90" } }} ``` #### Attribute Values

`project name`	(Required) The new name for the project.
`project description`	(Optional) The new description for the project.
`project parentProjectId`	(Optional) The new identifier of the parent project. Use this option to create or change project hierarchies. To create a project as a stand alone or at the top of a project hierarchy, omit the parentProjectId attribute. For information about how permissions are evaluated in project hierarchies, see Project Permissions States and Defaults.
`project contentPermissions`	(Optional) This value controls user permissions in a project, however, if the project is nested within a project with more restrictive policies, it will inherit those permissions and these settings will have no effect. The functional permissions of a project, including those it inherits, are available in value of contentPermission in the response body from a request to create, update, or query a project. LockedToProject to lock permissions so that users cannot overwrite the default permissions set for the project ManagedByOwner to allow users to manage permissions for content that they own LockedToProjectWithoutNested to lock the permissions of a parent project, but not those of its child projects. The default is ManagedByOwner. For more information, see Lock Content Permissions.
`owner id`	The LUID of the user that owns the project.

#### cURL Example `curl --request PUT "https://myServer/api/3.21/sites/1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e/projects/xz2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e3w" --header "Content-Type: application/xml" --header "X-Tableau-Auth;" --data " "` #### Response Code 201 #### Response Body Copy ``` ``` Copy ``` { "project": { "id": "1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e", "parentProjectId": "afe6f0b8-cb10-11e7-9fd4-db8b61369aa5", "name": "Update-Project-Name", "description": "This is the new description after the project update", "contentPermissions": "ManagedByOwner", "controllingPermissionsProjectId": "1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e", "owner": { "id": "abc12e4e-5d6d-7c8c-9b0b-1a2a3f4f5e90" } }} ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400008	Bad request	The request cannot set content permissions to LockedToProjectWithoutNested for a REST API version lower than 3.8.
403	403008	Insufficient storage on site	The samples could not be published because there is not enough storage space remaining on the server to accommodate the samples.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not POST.
409	409006	Project name conflict	The project name in the request already belongs to the specified site. For the purpose of uniqueness checks, project names are case-insensitive.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Create Routing Rule Creates a Bridge routing rule for a site. A routing rule controls how Bridge queries for a domain are routed. An allow rule (`isBlocked=false`) routes the domain to a designated pool, optionally scoped to specific projects; a block rule (`isBlocked=true`) prevents the domain from being routed through Bridge. All routing-rule methods require Tableau Cloud site admin privileges and Bridge feature enablement for the site. This method is not available for Tableau Server. **Version**: Available in API 3.30 (Tableau Cloud October 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:create` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI POST /api/api-version/sites/site-luid/bridge-routing-rules #### URI Parameter Values

api-version	The version of the API to use. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.

#### Request Body ``` ``` ``` { "routingRule": { "domain": "example.com", "isBlocked": false, "poolId": "ebae40a5-d7e4-4214-b3d5-b0715c627b71", "project": [ { "id": "11111111-2222-3333-4444-555555555555" }, { "id": "66666666-7777-8888-9999-000000000000" } ] } } ``` #### Attribute Values

domain	Required. The domain the rule matches, for example `example.com`. Both root domains and subdomains are supported.
isBlocked	Required. `true` creates a block rule; `false` creates an allow rule. The request is rejected if this attribute is omitted.
poolId	Required for allow rules (`isBlocked=false`). The UUID of the target Bridge pool. Must be omitted for block rules.
project	Optional. One or more project IDs that scope an allow rule to specific projects. Each entry requires an `id`. Must be omitted for block rules.

#### Response Code 201 Created #### Response Body Returns the created routing rule. The request accepts only the project `id`; the response returns `id`, `name`, and `isDeleted` for each project, populated by the server. Unset fields are omitted from the response. ``` ``` ``` { "routingRule": { "id": "d9e8f7a6-b5c4-3210-fedc-ba9876543210", "domain": "example.com", "isBlocked": false, "poolId": "ebae40a5-d7e4-4214-b3d5-b0715c627b71", "poolName": "WindowsPool", "project": [ { "id": "11111111-2222-3333-4444-555555555555", "name": "Finance", "isDeleted": false } ] } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	503909	Validation failed	Missing `routingRule`, missing `isBlocked`, blank or invalid domain, blank or invalid `poolId`, `poolId` missing for an allow rule, invalid UUID, or invalid, empty, or not-found projects.
400	503910	Invariant violation	`poolId` or `project` supplied for a block rule.
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	503923	Permission denied	Caller is not a site administrator for the site.
409	503911	Duplicate routing rule	A routing rule already exists for this domain and project scope.
409	503931	Domain already blocked	The domain is already blocked by an existing block rule.
409	503932	Domain-only rule exists	A domain-only (unscoped) allow rule already exists for this domain; at most one is allowed.
409	503933	Blocked domain has allow rules	The domain being blocked still has allow rules; remove them before blocking the domain.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500	503916	Unexpected server error	An unexpected error occurred while creating the rule.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Create SCIM Configuration Creates the System for Cross-domain Identity Management Configuration (SCIM) configuration on the Tableau Cloud site. The SCIM capability requires that you configure authentication for your Tableau Cloud site and associate the SCIM configuration with the authentication configuration. For more information about the SCIM capability in Tableau, see [SCIM](https://help.tableau.com/current/online/en-us/scim_config_online.htm) in the Tableau Cloud Help. **Version**: Available in API 3.26 (Tableau Cloud August 2025) and later. **License**: No additional license required. **Permissions**: Tableau Cloud site admins only. **Access Scope**: `tableau:scim_configurations:create` - Scope added in API 3.27 (Tableau Cloud December 2025) _For more information, see_ [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_,_ [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_, [access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps:_ [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm)_._ #### URI POST /api/api-version/sites/site-luid/scimConfigurations #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.

#### Request Body ``` SCIM Contractors d3b782da-0787-44ca-8585-6fd48dbfc658d3b782da-0787-44ca-8585-6fd48dbfc658 ``` ``` { "scimConfiguration": { "name": "SCIM Contractors", "idpConfigurationId": "d3b782da-0787-44ca-8585-6fd48dbfc658d3b782da-0787-44ca-8585-6fd48dbfc658" } } ``` #### cURL Request Example ``` POST request: curl --location 'https://prod-ca-a.online.tableau.com/api/3.29/sites/0f04ea64-0d72-424a-afd8-ee7d758dc9b8/scimConfigurations \ --data '{ "scimConfiguration":{ "name": "SCIM Contractors","idpConfigurationId": "d3b782da-0787-44ca-8585-6fd48dbfc658d3b782da-0787-44ca-8585-6fd48dbfc658" } }' ``` #### Attribute Values

name

(Required) Name of the SCIM configuration.

idpConfigurationId

(Required) Authentication configuration to associate with the SCIM configuration.

Starting in API 3.26, you can have multiple SCIM configurations. Include the idpConfigurationId to identify which SAML authentication configuration to associate with this SCIM configuration. To get the idpConfigurationId, see List Authentication Configurations for Site.

Starting in API 3.28, you can associate OIDC or Google authentication with SCIM.

#### Response Code 201 #### Response Body ``` 065693d8-436a-4738-a8f1-375953a2a888 95dcdf3b-30eb-42ae-b938-7ffca3e11fdc false true SCIM Contractors Tue Apr 01 06:31:47 UTC 2025 ``` ``` { "scimConfiguration": { "id": "065693d8-436a-4738-a8f1-375953a2a888", "idpConfigurationId": "95dcdf3b-30eb-42ae-b938-7ffca3e11fdc", "isApiTokenActive": false, "isOwner": true, "name": "SCIM Contractors", "createdAt": "Tue Apr 01 06:31:47 UTC 2025" } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, contains malformed XML, or the `idpConfigurationId` is not valid.
400	400008	Bad Request	The content of the request body is missing the SCIM configuration name, contains unsupported attributes, or the `idpConfigurationId` is missing.
400	400802	Bad Request	The maximum number of 20 SCIM configurations for the site has been reached.
401	401002	Unauthorized Access	The authentication token provided in the request header is invalid or has expired.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Create SCIM Token Generates the System for Cross-domain Identity Management (SCIM) token and secret. You must be the user who created the SCIM configuration to generate the associated SCIM token. After the SCIM token is generated, ensure the SCIM token's secret is added to the identity provider's (IdP's) SCIM settings. **Version**: Available in API 3.26 (Tableau Cloud August 2025) and later. **License**: No additional license required. **Permissions**: Tableau Cloud site admins only. **Access Scope**: Not available _For more information, see_ [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_,_ [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_, and access scopes for_ [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm)_._ #### URI POST /api/api-version/sites/site-luid/scimConfigurations/scim-configuration-id/apiToken #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
scim-configuration-id	The UUID of the SCIM configuration. To get the SCIM configuration UUID, see List SCIM Configurations.

#### Request Body None #### cURL Request Example ``` POST request: curl --location 'https://prod-ca-a.online.tableau.com/api/3.29/sites/0f04ea64-0d72-424a-afd8-ee7d758dc9b8/scimConfigurations/065693d8-436a-4738-a8f1-375953a2a888/apiToken' ``` #### Response Code 201 #### Response Body ``` 065693d8-436a-4738-a8f1-375953a2a888 SCIM_CLIENT_API_TOKEN:d3b782da-0787-44ca-8585-6fd48dbfc658 hqh8YEoYQ1enO9t9Z3h1xA==:X_jndRxNXuWKIXIUbvSGEvysnnSK6B7pt62GiWd8Vuw= ``` ``` { "apiToken": { "id": "065693d8-436a-4738-a8f1-375953a2a888", "clientName": "SCIM_CLIENT_API_TOKEN:d3b782da-0787-44ca-8585-6fd48dbfc658", "secret": "hqh8YEoYQ1enO9t9Z3h1xA==:X_jndRxNXuWKIXIUbvSGEvysnnSK6B7pt62GiWd8Vuw=" } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400802	Bad Request	The SCIM configuration is already associated with a SCIM token. To generate a new token for the SCIM configuration, first delete the associated SCIM token and try again.
401	401002	Unauthorized Access	The authentication token provided in the request header is invalid or has expired.
403	403182	Forbidden	A SCIM token can only be generated by the user who created the SCIM configuration.
404	404057	Resource Not Found	The SCIM configuration ID is not valid.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Create Server Schedule Creates a new server schedule on Tableau Server. _For Tableau Cloud, see [Create Cloud Extract Refresh Task](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_extract_and_encryption.htm#create_cloud_extract_refresh_task) and [Create subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_subscriptions.htm#create_subscription_cloud)._ Schedules are not specific to sites. For more information, see [Creating a Flow Schedule](https://help.tableau.com/current/server/en-us/prep_conductor_create_schedule_definitions.htm), [Extracts and Refresh Schedules](https://help.tableau.com/current/server/en-us/publish.htm) and [Create or Modify a Schedule](https://help.tableau.com/current/server/en-us/help.htm#schedule_manage_create.htm) in the Tableau Server documentation. Scheduling flows requires Tableau Prep Conductor to be enabled on your Tableau Server. For more information, see [Enable Tableau Prep Conductor](https://help.tableau.com/current/prep/en-us/prep_conductor_config_server_overview.htm). **Note**: After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. #### URI POST /api/api-version/schedules #### Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.

#### Request Body ``` ``` #### Attribute Values

schedule-name	The name to give to the schedule. This name identifies the schedule in the server environment when users select a schedule and manage schedule information.
schedule-priority	An integer value between 1 and 100 that determines the default priority of the schedule if multiple tasks are pending in the queue. Lower numbers have higher priority.
schedule-type	`Flow` to create a flow schedule, `Extract` to create an extract refresh schedule, `Subscription` to create a subscription schedule, or `DataAcceleration` to create a data acceleration schedule. Tableau's View Acceleration feature and Data Acceleration-related APIs were retired in Tableau Cloud in June 2026 and in Tableau Server version 2026.2.
schedule-execution-order	`Parallel` to allow jobs associated with this schedule to run at the same time, or `Serial` to require the jobs to run one after the other.
schedule-frequency	This represents the granularity of the schedule. `Hourly`. Jobs can be scheduled to run at intervals specified in run one or more times per day at intervals specified in minutes or hours. Valid intervals are 15 and 30 minutes and 2, 4, 6, 8, and 12 hours. `Daily`. Jobs can be scheduled to run once per day. `Weekly`. Jobs can be scheduled to run one or more times per week. `Monthly`. Jobs can be scheduled to run once per month on a specific day. The value you provide for schedule-frequency determines whether you must include an end-time value, and what is required in the contents of the <intervals> element.
start-time	The time of day on which scheduled jobs should run (or if the frequency is hourly, on which they should start being run), in the format `HH:MM:SS` (for example, `18:30:00`). This value is required for all schedule frequencies. The entered time will be applied based on the time zone of your server.
end-time	If the schedule frequency is `Hourly`, the time of day on which scheduled jobs should stop being run, in the format `HH:MM:SS` (for example, `23:30:00`). Hourly jobs will occur at the specified intervals between the start time and the end time. For other schedule frequencies, this value is not required; if the attribute is included, it is ignored. The entered time will be applied based on the time zone of your server.
interval-expression	A value that specifies the interval between jobs associated with the schedule. The value you specify here depends on the value specified in schedule-frequency. `Hourly` The interval expression is only one of the following: `hours="interval"` where interval is `1`, `2`, `4`, `6`, `8`, or `12`, representing how many hours between jobs. `minutes="interval"` where interval is `15` or `30`, representing how many minutes between jobs. You can specify an interval in hours or minutes, but not both. `Daily` If the schedule frequency is `Daily`, no interval is specified. Any information specified in the <intervals> element is ignored. `Weekly` The interval expression is `weekDay="weekday"`, where weekday is `Sunday`, `Monday`, `Tuesday`, `Wednesday`, `Thursday`, `Friday`, or `Saturday`. You can specify multiple <interval> elements to indicate that scheduled jobs should run on multiple days during the week. `Monthly` The interval expression is `monthDay="day"`, where day is either the day of the month (`1`, `2`, etc.) or `LastDay`. Note: If you want to specify multiple days in the month, you can do this using the web interface. You cannot create or update such a monthly schedule using REST API.

#### Permissions This method can only be called by server administrators. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:schedules:create ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 201 #### Response Body ``` ``` #### Version Version 2.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400064	Error creating schedule	An unspecified error occurred while trying to create the schedule.
400	409004	Bad request	The content of the request body is missing or incomplete. For hourly, daily, or monthly schedules, this often means that the content of the <intervals> element does not match the expected format. The <detail> element of the error provides detail about the expected format.
405	405000	Invalid request method	Request type was not POST.
409	409021	Schedule name conflict	The schedule name in the request already belongs to an existing schedule.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/schedules/" -X POST -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @create-schedule.xml` **Content of create-schedule.xml for an hourly schedule** ``` ``` **Response body** ``` ``` **Content of create-schedule.xml for a daily schedule** For a daily schedule, frequencyDetails is set to `Daily`. The start attribute is required. No intervals element is required. **Daily schedules on any recurrence must have the same start and end minute. The hour can be different. However, if the daily schedule is set to only happen once a day, then it needs only a start time and not an end time.** ``` ``` **Response body** ``` ``` **Content of create-schedule.xml for a weekly schedule** For a weekly schedule, frequencyDetails is set to `Weekly`. A start attribute is required. The intervals element is required, and must include between 1 and 7 interval subelements that contain a weekDay attribute. Valid values for the weekDay attribute are `Sunday`, `Monday`, `Tuesday`, `Wednesday`, `Thursday`, `Friday`, or `Saturday`. ``` ``` **Response body** ``` ``` **Content of create-schedule.xml for a monthly schedule** For a monthly schedule, frequencyDetails is set to `Monthly`. A start attribute is required. The intervals element is required, and must include 1 interval subelement that contains a monthDay attribute. Valid values for the monthDay attribute are integers between 1 and 31 and the string `LastDay`. ``` ``` **Response body** ``` ``` ## Create Site Creates a site on Tableau Server. To make changes to an existing site, call [Update Site](#update_site). This method isn’t available for Tableau Cloud. For more information, see [Work with Sites](https://help.tableau.com/current/server/en-us/help.htm#sites_intro.htm) and [Add or Edit Sites](https://help.tableau.com/current/server/en-us/help.htm#sites_add.htm) in the Tableau Server documentation. **Note**: After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. #### URI POST /api/api-version/sites #### Request Body ``` ``` #### Attribute Values

site-name	The name of the site.
content-url	The subdomain name of the site's URL. This value can contain only characters that are upper or lower case alphabetic characters, numbers, hyphens (-), or underscores (_). If you provide unsupported special characters, Tableau creates the site content URL by omitting those characters from the string. For example, if you provide the site URL as "test.site", Tableau converts it to "testsite" and returns this new URL in the response.
admin-mode	(Optional) Specify ContentAndUsers to allow site administrators to use the server interface and `tabcmd` commands to add and remove users. (Specifying this option doesn’t give site administrators permissions to manage users using the REST API.) Specify ContentOnly to prevent site administrators from adding or removing users. (Server administrators can always add or remove users.) Note: You can’t set adminMode to ContentOnly and also set userQuota. The default value is ContentAndUsers.
storage-quota	(Optional) The maximum amount of space for the new site, in megabytes. If you set a quota and the site exceeds it, publishers will be prevented from uploading new content until the site is under the limit again.
disable-subscriptions	(Optional) Specify true to prevent users from being able to subscribe to workbooks on the specified site. The default is false.
editing-flows-enabled-flag	(Optional) Specify true to enable and false to disable editing flows for a site. For more information on flows, see Enable and Configure Tableau Prep Conductor. The default is set to true, which means editing flows is enabled by default. For more information, see Implication of disabling Tableau Prep Conductor.
scheduling-flows-enabled-flag	(Optional) Specify true to enable and false to disable scheduling flows for a site. For more information on flows, see Enable and Configure Tableau Prep Conductor. The default is set to true which means scheduling flows is enabled by default. For more information, see Implication of disabling Tableau Prep Conductor.
flows-enabled-flag	The flowsEnabled attribute is deprecated as of API version 3.10.
allow-subscription-attachments-flag	(Optional) If true, and subscription to attachments is enabled on the server, then users can create subscriptions that send an email with images of a workbook or view in a PDF attachment. The default value is true. If subscription to attachments is disabled in the server settings, then making this value true will have no effect. Default is true.
guest-access-enabled-flag	(Optional) Specify true to enable and false to disable the ability for guests, users without specific site access permission, to access the site. Default is false.
cache-warmup-enabled-flag	This attribute is removed in API 3.19 and later (Tableau Cloud September 2021). For current methods to improve Tableau performance see, View Acceleration. (Optional) Set this value to true to enable cache warm up to improve workbook load time. Set the value to false to disable cache warmup. Default is true.
commenting-enabled-flag	(Optional) Specify true to enable and false to disable the ability for user comments on views in the site. Default is true.
revision-history-enabled	(Optional) true if the site maintains revisions for changes to workbooks and data sources; otherwise, false. The default is false.
num-revision-limit	(Optional) An integer between 2 and 10000 to indicate a limited number of revisions for content. Setting this value to -1 removes any value that was set previously, and effectively removes any limit to the number of revisions that are maintained.
subscribe-others-enabled-flag	(Optional) Specify true to enable and false to disable the ability for view owners to subscribe other users to a view. Default is true.
extractEncryptionMode	(Optional) Specify enforced, enabled, or disabled. Default is disabled. For more information, see Extract and Encryption Methods.
requestAccessEnabled	(Optional) Specify true to allow users send access request emails to content or project owners. Specify false if you don’t want users to be able to request access. The default is false.
runNowEnabled	(Optional) Specify true to allow users to run flows, extract refreshes, and schedules manually. Specify false if you don’t want users to be able to run flows, extract refreshes, and subscriptions manually. The default is true. If this attribute is set to false, the following methods will fail and will return an error message. Run Flow Now Run Flow Task Update Data Source Now Run Extract Refresh Task
Licensing attributes For user-based license types, the maximum number of users is set by the licenses activated on that server. For core-based licensing, there’s no limit to the number of users; if you specify a maximum value, only licensed users are counted, and server administrators are excluded. The REST API enables administrators to set licensing limits below the purchased maximum with two types of license-related attributes: - User Quota - The total maximum number of licenses currently configured for a site. - Tiered Capacities - If set, the configured maximum license count for each license type (role). Online administrators can get these attributes. An on-premises server administrator can both get and set them but if license maximums are set using one attribute kind then the value(s) of the other kind must be null. Setting values for both kinds of attributes will result in an error. For more information, see Licensing Overview.
User quota all-license-limit-total	(Optional) The maximum total number of users with Creator, Explorer, or Viewer licenses currently allowed on a site. On-premises server administrators can set `userQuota` with the following rules: The number can't exceed the number of licenses activated for the site; and if tiered capacity attributes are set, then `userQuota` will equal the sum of the tiered capacity values, and attempting to set `userQuota` will cause an error. An administrator can revert the license limit to number of activated licenses on the site, or shift control of license limits to tiered capacities values, by omitting `userQuota` from a Create Site or Update Site request, or making its value -1.
Tiered capacity attributes creator-license-limit explorer-license-limit viewer-license-limit	(Optional) The maximum number of licenses for users with the Creator, Explorer, or Viewer role, respectively, allowed on a site. On-premises server administrators can set tiered capacity attributes with the following rules: the number can't exceed the number of licenses of a given type that are activated for the site; a value must be supplied for every tiered capacity license type every time any one or more of them is set. A value of -1 removes the administrator-applied limit for a license type, and reverts the limit to the number of activated licenses configured for the role. Setting the value of a tiered capacity to -1 will not automatically increase the limit if more licenses are purchased and activated for the role in the future. To use role-specific license limits, the `userQuota` must be set to null by omitting the attribute from Create Site or Update Site request, or setting its value to -1. Attempting to set values for both tiered capacities and `userQuota` will result in an error.
data-alerts-enabled-flag	(Optional, boolean) If `true`, data alerts are enabled on the site. Default value is `true`.
commenting-mentions-enabled-flag	(Optional, boolean) If `true`, mentions for commenting are enabled. Default value is `true`.
catalog-obfuscation-enabled-flag	(Optional, boolean) If `true`, catalog obfuscation is enabled on the site. Default value is `true`.
flow-auto-save-enabled-flag	(Optional, boolean) If `true`, flow auto save is enabled on the site. Default value is `true`.
run-now-enabled-flag	(Optional, boolean) If `true`, run now for schedules is enabled which allows non-administrators to run schedules manually. Default value is `true`.
metrics-content-type-enabled-flag	(Optional, boolean) If `true`, the metrics content type is enabled on the server. Default value is `true`.
notify-site-admins-on-throttle-flag	(Optional, boolean) If `true`, site admins will be notified if their background jobs are being throttled. Default value is `false`.
authoring-enabled-flag	(Optional, boolean) If `true`, web authoring is enabled. Default value is `true`.
custom-subscription-email-enabled-flag	(Optional, boolean) If `true`, sending custom subscription email is enabled. If set to false after being set true, the current custom subscription email is voided. Default value is `false`.
custom-subscription-email	A valid custom email that will be sent if customSubscriptionEmailEnabled is set to true. Default value is `false`.
custom-subscription-footer-enabled-flag	(Optional, boolean) If `true`, a custom footer will be included on subscription and data alert emails. If set to false after being set true, the current custom subscription footer is voided. Default value is `false`.
custom-subscription-footer	A custom subscription footer that will be added to subscription and data alerts if customSubscriptionFooterEnabled is set to true. Default value is `false`.
ask-data-mode	The mode of the ask data feature on the site. Can be set to one of two values: `DisabledByDefault` - Enables creation of Ask Data lenses for all published data sources. Data sources do not have lenses created automatically. `DisabledAlways` - Disables Ask Data lenses and related content throughout the site. Preserves information about lenses and data source indexes, which are restored if Ask Data is re-enabled. Default value is `DisabledByDefault`. For more information, see Disable or Enable Ask Data for a Site.
named-sharing-enabled-flag	(Optional, boolean) If `true`, named sharing is enabled. Default value is `true`.
cataloging-enabled-flag	(Optional, boolean) If `true`, data catalog is enabled for the site. Default value is `true`.
derived-permissions-enabled-flag	(Optional, boolean) If `true`, derived permissions are enabled for the site. Default value is `false`.
user-visibility-mode	(Optional, string) When the value is `FULL` users can see the user of other site users. If the value is `LIMITED` User information on the site is not visible to other users. Default value is FULL. For more information, see User Visibility.
use-default-time-zone	Optional, boolean) Set this to `true`, if you want the time-zone attribute use the Server time Zone at run time. This attribute is set to the official IANA name. If this is set to `false`, the time-zone value must be specified.
time-zone	(Optional, string) Use this attribute to specify a time zone other than the Server time zone at run time. Only canonical names in the official IANA database are supported. You can find the list of the canonical time zone names on Wikipedia.
autoSuspendRefreshEnabled	(Optional) Tableau can automatically suspend extract refresh tasks for inactive workbooks to save resources. Specify true to enable or false to disable. Default is true.
autoSuspendRefreshInactivityWindow	(Optional) An integer from 7 through 100 to indicate the number of days to wait before automatically suspending extract refresh tasks for inactive workbooks. The default is 30.
explainDataEnabled	(Optional, boolean) Set this attribute to `false` to disable Explain Data capabilities for a site. By default, this attribute is set to `true`. For more information about this site setting, see one of the following topics: For Tableau Cloud, see Disable or Enable Explain Data for a Site. For Tableau Server, see Disable or Enable Explain Data for a Site.
dqwSubscriptionsEnabled	(Optional, boolean) Set this attribute to `false` to exclude data quality warnings (DQWs) from subscription emails. By default, this attribute is set to `true`. For more information about this site setting, see one of the following topics: For Tableau Cloud, see Disable or Enable Explain Data for a Site. For Tableau Server, see Disable or Enable Explain Data for a Site.
groupAssertionsEnabled	(Optional, boolean) Set to `true` to allow assertions into group membership using session info. Set to `false` if you do not want users to be able to be asserted in to groups. The default is `false`. If this attribute is set to false, it will disable group assertions for the entire site, including the following settings: groupAssertionsSAMLEnabled groupAssertionsOIDCEnabled groupAssertionsConnectedAppsEnabled
groupAssertionsSAMLEnabled	(Optional, boolean) Set to `true` to allow assertions into group membership using SAML session info. Set to `false` if you don’t want users to be able to be asserted in to groups. The default is `false`. If this attribute is set to false, it will disable group assertions for SAML sessions.
groupAssertionsOIDCEnabled	(Optional, boolean) Set to `true` to allow assertions into group membership using OIDC session info. Set to `false` if you don’t want users to be able to be asserted in to groups. The default is `false`. If this attribute is set to false, it will disable group assertions for OIDC sessions. Note: This parameter only applies to Tableau Cloud.
groupAssertionsConnectedAppsEnabled	(Optional, boolean) Set to `true` to allow assertions into group membership using Connected App JWT tokens. Set to `false` if you don’t want users to be able to be asserted in to groups via connected apps. The default is `false`. If this attribute is set to false, it will disable group assertions for JWT connected app connections.
groupSetsEnabled	(Optional, boolean) Set to `true` to allow groups sets. Set to `false` if you don’t want group sets support for the site. The default is `false`. If this attribute is set to false, it will disable group sets for the site.
recycleBinEnabled	(Optional, boolean) Set to `true` to enable the Recycle Bin. Set to `false` to disable it. The default is `true`.

#### Permissions This method can only be called by server administrators. #### Required scope for JWT authorization Introduced in Tableau Server 2022.3 (API 3.17). ``` tableau:sites:create ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 201 #### Response Body ``` ``` Response Body Details: - userQuota, storageQuota, and tiered capacity (tierCreatorCapacity, tierExplorerCapacity, tierViewerCapacity) attributes are only present in the response body if those quotas have been set for the site being queried. #### Response Headers Location: /api/3.29/sites/new-site-id #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing, incomplete, or contains malformed XML.
400	400000	Invalid storage quota	The storage quota value wasn’t a positive number.
400	400000	Invalid user quota	The user quota value wasn’t a positive number.
400	400013	Invalid administrator mode	The user provided an administrator mode that isn’t ContentOnly or ContentAndUsers. Note: An empty string or all whitespace is invalid.
405	405000	Invalid request method	Request type was not POST.
409	409001	Site name conflict	The site name in the request already belongs to an existing site.
409	409002	Site URL conflict	The content URI in the request already belongs to an existing site.
409	409004	User quota and tiered capacity conflict	The request cannot set both tiered capacity attributes and userQuota. One or the other must be null.
409	409004	License limit exceeded	The request cannot set tiered capacity attributes or userQuota values that are larger than the number of active licenses configured for the site.
409	409004	Administrator mode or user quota conflict	The request cannot set adminMode to ContentOnly and also specify a userQuota value.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/" -X POST -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @create-site.xml` **Content of create-site.xml:** ``` ``` **Response body:** ``` ``` ## Create Subscription Creates a new subscription to a view or workbook for a specific user on Tableau Server and Tableau Cloud. When a user is subscribed to the content, Tableau sends the content to the user in email on the schedule that you define. For more information, see [Subscribe to Views](https://help.tableau.com/current/server/en-us/subscribe_user.htm) in the Tableau Server documentation. Tableau Server and Tableau Cloud each have a different model for schedules and tasks. On Tableau Server, you create a schedule and add a task to it. On Tableau Cloud you create a task and define it's frequency. While the Create Subscription endpoint path and parameters are the same for both Server and Cloud, because the models are different, the request and response bodies are different. - [Tableau Server Request](#create_subscription_server) - [Tableau Cloud Request](#create_subscription_cloud) **Note**: After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. #### URI POST /api/api-version/sites/site-id/subscriptions #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site to create the subscription in.

#### JWT Access Scope `tableau:tasks:create` _(this scope is included in the scope: `tableau:tasks`)_ This scope can be used to enable this REST method to be called from a unified access token (UAT) or connected app. For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Tableau Cloud connected app scopes](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) or [Tableau Server connected apps scopes](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm). _Available in API 3.20 (Tableau Cloud June 2023) / Tableau Server 2023.3._ ### Tableau Server Request Create a subscription task and add it to a server schedule on Tableau Server. _For Tableau Cloud, see [Tableau Cloud Request](#create_subscription_cloud)._ #### Request Body ``` ``` ``` { "subscription": { "subject": "subscription-subject", "attachImage": "attach-image-flag", "attachPdf": "attach-pdf-flag", "pageOrientation": "page-orientation", "pageSizeOption": "page-size-option", "message": "message", "suspended": "suspended-flag", "content": { "id": "content-id", "type": "content-type", "sendIfViewEmpty": "send-view-if-empty-flag", "customViewId": "custom-view-id" }, "schedule": { "id": "schedule-id" }, "user": { "id": "user-id" } } } ```

subscription-subject	A description for the subscription. This description is displayed when users list subscriptions for a site in the server environment. A description is required.
attach-image-flag	(Optional) Setting this `true` will cause the subscriber to receive mail with .png images of workbooks or views attached to it. This is the default behavior if neither `attachImage` or `attachPdf` are specified. If subscriptions to attachments are disabled in Tableau server or site settings, then making a request that sets `attachImage` to `false` will cause an error.
attach-pdf-flag	(Optional) Setting this `true` will cause the subscriber to receive mail with a .pdf file containing images of workbooks or views attached to it. If subscriptions to attachments are disabled in Tableau server or site settings, then making a request that sets `attachPdf` to `true` will cause an error.
page-orientation	(Optional) The orientation of the pages produced when attach-pdf-flag is `true`. The value can be `Portrait` or `Landscape`. If this parameter is not present the page orientation will default to `Portrait`.
page-size-option	(Optional) The type of page produced, which determines the page dimensions when attach-pdf-flag is `true`. The value can be: `A3`, `A4`, `A5`, `B5`, `Executive`, `Folio`, `Ledger`, `Legal`, `Letter`, `Note`, `Quarto`, or `Tabloid`. If this parameter is not present the page type will default to `Letter`.
message	The text body of the subscription email message.
suspended-flag	(Optional) If `true`, the subscription is created in a disabled state, meaning it won't run until it's enabled using the Update Subscription method or Resume Subscription in the web UI. The default value is `false`.
content-type	`Workbook` to create a subscription for a workbook, or `View` to create a subscription for a view.
send-view-if-empty-flag	(Optional) Applies to views only. If `true`, an image is sent even if the view specified in a subscription is empty. If `false`, nothing is sent if the view is empty. The default value is true.
custom-view-id	(Optional) Applies to views only. The LUID of a custom view to use instead of the default view.
content-id	The ID of the workbook or view to subscribe to.
schedule-id	The ID of a schedule to associate the subscription with. To determine what schedules are available, call List Server Schedules. The type of the schedule must be `Subscription`.
user-id	The ID of the user to create the subscription for. Note: The user must have an email address defined in Tableau Server.

#### Permissions The following list summarizes the permissions required to subscribe a user to specific content: - Tableau Server users who are server administrators can subscribe any user to any content. - Site administrators can subscribe any user on the site to any content on that site. - Project leaders can subscribe users to any content that they are project leaders for. - Content owners can subscribe users to any content they own. - Non-owners can subscribe themselves to any content that they have Read (view) permissions for. #### Response Code 201 #### Response Body ``` ``` ``` { "subscription": { "id": "subscription-id", "subject": "subscription-subject", "suspended": "suspended-flag", "pageOrientation": "page-orientation", "pageSizeOption": "page-size-option", "message": "message", "content": { "id": "content-id", "type": "content-type", "sendIfViewEmpty": "send-view-if-empty-flag" }, "schedule": { "id": "schedule-id", "name": "schedule-name" }, "user": { "id": "user-id", "name": "user-name" } } } ``` #### Response Headers ``` Location: /api/3.29/sites/site-id/subscriptions/new-subscription-id ``` #### Version Available in API 2.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400067	Invalid subscription subject	The subscription subject is null or empty.
400	400068	Invalid subscription target	The content type specified in the request body is not a workbook or view.
400	400069	Invalid subscription type	The subscription type is not `Workbook` or `View`.
400	400069	Invalid schedule type	The schedule type is not `Subscription`.
403	403060	No permissions to create subscription.	The user does not have permission to create a subscription for the specified content.
403	403063	No user permissions for content.	The user specified in the request body does not have Read (view) permissions for the specified content.
403	403064	No user email address.	The user does not have an email address.
404	404000	Site not found	The specified site doesn't correspond to an existing site.
404	404002	User not found	The user specified in the request body doesn't correspond to an existing user.
400	404006	Workbook not found	The workbook ID in the request body doesn't correspond to an existing workbook.
404	404011	View not found	The view ID in the request body doesn't correspond to an existing view.
404	404023	Schedule not found	The schedule ID in the request body doesn't correspond to an existing schedule.
405	405000	Invalid request method	Request type was not POST.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ### Tableau Cloud Request Create a subscription task and define its frequency on Tableau Cloud. _For Tableau Server, see [Tableau Server Request](#create_subscription_server)._ **Version:** Available in API 3.20 (Tableau Cloud June 2023) and later. Not available for Tableau Server. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Administrators and any user with the creator or explorer role can create a custom schedule for a subscription task. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:tasks:create Access Scopes Overview: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) #### URI POST /api/api-version/sites/site-luid/subscriptions #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.

#### Request Body ``` ``` ``` { "subscription": { "subject": "finance report", "attachImage": "true", "attachPdf": "true", "pageOrientation": "true", "pageSizeOption": "Folio", "message": "daily finance report", "suspended": "false", "content": { "id": "13237fd-6365-44d5-925b-644e5281b605", "type": "Workbook", "sendIfViewEmpty": "false", "customViewId": "12ab34cd-56ef-78ab-90cd-12ef34ab56cd" }, "user": { "id": "456" } }, "schedule": { "frequency": "Daily", "frequencyDetails": { "start": "18:30:00", "end": "23:30:00", "intervals": { "interval": [ { "hours": "4" }, { "weekDay": "Sunday" }, { "weekDay": "Wednesday" } ] } } } } ``` #### Request Attributes `subject, contentId, and userId` are **required** to create a custom schedule for a subscription, other attributes are optional with defaults. All attributes are optional when updating a custom schedule for a subscription.

`subscription subject`	(Required to create subscription) string: A description for the subscription. This description is displayed when users list subscriptions for a site in the server environment.
`subscription attachImage`	boolean: Setting this `true` will cause the subscriber to receive mail with .png images of workbooks or views attached to it. This is the default behavior if neither `attachImage` or `attachPdf` are specified. Default is `false`. If subscriptions to attachments are disabled in Tableau server or site settings, then making a request that sets `attachImage` to `false` will cause an error.
`subscription attachPdf`	boolean: Setting this `true` will cause the subscriber to receive mail with a .pdf file containing images of workbooks or views attached to it. Default is `false`. If subscriptions to attachments are disabled in Tableau server or site settings, then making a request that sets `attachPdf` to `true` will cause an error.
`subscription pageOrientation`	enumeration: The orientation of the pages produced when attach-pdf-flag is `true`. The value can be `Portrait` or `Landscape`. If this parameter is not present the page orientation will default to `Portrait`.
`subscription pageSizeOption`	enumeration: The type of page produced, which determines the page dimensions when attach-pdf-flag is `true`. The value can be: `A3`, `A4`, `A5`, `B5`, `Executive`, `Folio`, `Ledger`, `Legal`, `Letter`, `Note`, `Quarto`, or `Tabloid`. If this parameter is not present the page type will default to `Letter`.
`subscription message`	string: The text body of the subscription email message.
`subscription suspended`	boolean: If `true`, the subscription is created in a disabled state, meaning it won't run until it's enabled using the Update Subscription method or Resume Subscription in the web UI. The default value is `false`.
`content id`	(Required to create subscription) LUID: The LUID of the workbook or view the user should be subscribed to.
`content type`	(Required to create subscription) enumeration: `Workbook` to create a subscription for a workbook, or `View` to create a subscription for a view.
`content sendIfViewEmpty`	boolean: Applies to views only. If `true`, an image is sent even if the view specified in a subscription is empty. If `false`, nothing is sent if the view is empty. The default value is true.
`content customViewID`	string: Applies to views only. The LUID of a custom view to use instead of the default view.
`userId`	(Required to create subscription) LUID: The LUID of the user to create the subscription for. Note: The user must have an email address defined in Tableau Server.

schedule frequency

(Required to create subscription) enumeration: The scheduled frequency for triggering the task. Valid values include:

Hourly
Daily
Weekly
Monthly

frequencyDetails end

<frequencyDetail start="20:45:00" end="21:45:00">
  . . .
</frequencyDetail>

interval {interval type}

Frequency	Valid interval values
`Hourly`	The value of an interval for an `Hourly` schedule can be only one of either: `hours="1"` The number of hours between jobs. `1` is the only valid value. `minutes="60"` The number of minutes between jobs. `60` is the only valid value. `weekDay="weekday"` The weekday(s) the job will be run on. Valid values are: `Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday`. For example, to schedule to run a job every hour on Sunday and Wednesday, during the time range specified in `frequencyDetails` use an interval like: `<intervals> <interval hours="1"/> <interval weekDay="Sunday"/> <interval weekDay="Wednesday"/> <intervals>`
`Daily`	The value of `Daily` can have multiple `weekday` elements, but only one `hours` declaration. An `hours` interval is required. `hours="interval"` The interval between execution of jobs on the weekday(s) specified. Valid values are `2, 4, 6, 8, 12, or 24`. Note that if the `interval` value of a daily schedule is less than `24`, a `frequencyDetail end` time must be supplied. `weekDay="weekday"` The weekday(s) the job will be run on. Valid values are: `Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday`. For example, to schedule to run a job every 4 hours on Sunday and Wednesday, during the time range specified in `frequencyDetails` use an interval like: `<intervals> <interval hours="4"/> <interval weekDay="Sunday"/> <interval weekDay="Wednesday"/> <intervals>`
`Weekly`	`weekDay="weekday"` The day of the week the schedule should run on. You can only specify a single day for a Weekly schedule. Valid values are: `Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday.`
`Monthly`	The day(s) of the month a job should be scheduled to run on. There are two ways to define a monthly interval: Specify the day(s) using the number of the day in the month; `monthDay="day"` The number of the day of the month. Valid values are the whole numbers `1` to `31` or `LastDay`. If you specify `monthDay` by day number then you can use multiple `interval` instances to choose for the job to run on multiple days in the month. If you use `LastDay` then only one instance of `interval` can be used in the schedule to specify the last day of the month. Specify the day by describing which occurrence of a weekday within the month. `monthDay="occurrence_of_weekday" Weekday="weekday"` The occurrence of the specified weekday within the month when a job should be run. Valid values for `occurrencee_of_weekday` are `First, Second, Third, Fourth, Fifth, or LastDay`. Valid values for `weekday` are `Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday`. If the value is `lastDay` then the job will run on the last occurrence of the specified weekday in the month. For example, to make a schedule that that would run a job on the third Thursday of each month, you would use: `<interval monthDay="Third" weekDay="Thursday"/>`

#### cURL Request Example `curl -X POST "https://prod-ca-a.online.tableau.com/api/3.29/sites/a946d998-2ead-4894-bb50-1054a91dcab3/subscriptions" -H "Content-Type: application/xml" --data " "` #### Response Code 200 #### Response Body ``` ``` ``` { "subscription": { "id": "789", "subject": "finance report", "attachImage": "true", "attachPdf": "true", "pageOrientation": "true", "pageSizeOption": "Folio", "message": "Daily finance report", "content": { "id": "13237fd-6365-44d5-925b-644e5281b605", "type": "Workbook", "sendIfViewEmpty": "false" }, "user": { "id": "09876fd-6365-44d5-925b-644e528d5678" } }, "schedule": { "id": "54321fd-6365-44d5-925b-644e52812345", "createdAt": "2023-04-06T23:43:12-0700", "updatedAt": "2023-04-06T23:43:12-0700", "frequency": "Daily", "nextRunAt": "2023-04-06T23:43:12-0700", "frequencyDetails": { "start": "18:30:00", "end": "23:30:00", "intervals": { "interval": [ { "hours": "4" }, { "weekDay": "Sunday" }, { "weekDay": "Wednesday" } ] } } } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403004	Unauthorized Access	The user is not authorized to make this request..
404	404002	User not found	The user specified in the request could not be found.
404	404025	Subscription not found	The task for the subscription could not be found.
409	409004	invalid parameter value	The request is malformed or contains an invalid or missing schedule or interval parameter value. When the difference between `start` and `end` times are not increments of one hour, this error will result.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Create subscription Creates a subscription to a specified metric for a specified user or group. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user that has read or connect permission to the data source used in the definition can create subscriptions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:metric\_subscriptions:create\` Access Scopes [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/subscriptions [view details](#) ## Create Tableau MCP Settings for Site Replaces the current list of Tableau MCP settings for a given site. **Version**: Available in API 3.29 (Tableau Cloud June 2026 / Server 2026.2) and later. **License**: No additional license required. **Permissions**: Server administrators and site administrators. **Access Scope**: `tableau:mcp_site_settings:create` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). For more information about configuring the Tableau MCP settings for a site, see [Site settings for Tableau MCP](https://tableau.github.io/tableau-mcp/docs/configuration/mcp-config/site-settings). #### URI POST /api/api-version/sites/site-id/settings/mcp #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site.

#### Request Body ``` mcp-setting-key mcp-setting-value ``` ``` { "mcpSiteSettings": { "settings": [ { "key": "mcp-setting-key", "value": "mcp-setting-value" } ] } } ``` #### Attribute Values

mcp-setting-key	(Required) String. Specifies the setting to assign a value to.
mcp-setting-value	(Required) String. Provides the value for the associated key.

#### Response Code 200 #### Response Body ``` EXCLUDE_TOOLS search-content ``` ``` { "mcpSiteSettings": { "settings": [ { "key": "EXCLUDE_TOOLS", "value": "search-content" } ] } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	409004	Invalid parameter	The mcpSiteSettings entity is empty; the settings key is null, missing, or invalid; or site LUID format is invalid.
401	401002	Invalid authentication credentials	Missing or invalid authentication credentials.
401	403001	Missing authentication token	Authentication token not provided.
403	403000	Insufficient permissions	User isn't an administrator.
403	403010	Site mismatch	Authenticated user's site does not match the site LUID in the request.
403	403157	Feature disabled	Feature not enabled.
403	N/A	Insufficient OAuth scope	The user lacks the required OAuth scope.
404	404000	Site not found	A site with the specified LUID does not exist.
500	500000	Internal server error	Unknown server error.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Create Work Copy Creates a work copy of a published data source and returns the work copy LUID. Composable data sources and Semantic Data Model (SDM) data sources are not supported. The call is rejected when the caller already has the maximum number of open work copies. **Version**: Available in API 3.30 (Tableau Cloud October 2026 / Server 2026.3) and later. **License**: Data Management or Tableau+. **Permissions**: Users who are not server administrators or site administrators can call this method only if they have Connect, Write (save), and VizqlDataApiAccess (API Access) permissions for the data source (either explicitly or implicitly). **Access Scope**: `tableau:datasources:create` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI POST /api/api-version/tds/sites/site-luid/datasource/datasource-luid/workcopy #### URI Parameter Values

api-version	The version of the API to use. These TDS Edit methods are available in API 3.30 and later. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site in the URI. This handler does not bind the path variable — the service uses the authenticated user's site LUID (`authUser.getSiteLuid()`).
datasource-luid	The LUID of the data source. Must be a UUID (8-4-4-4-12 hexadecimal digits), matching `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}`.

#### Response Code 201 Created #### Response Body Returns the created work copy's identifiers in `tdsWorkCopy`. The response includes `workCopyLuid` but not `datasourceLuid`, which only Publish Work Copy returns. ``` d9e8f7a6-b5c4-3210-fedc-ba9876543210 ``` ``` { "tdsWorkCopy": { "workCopyLuid": "d9e8f7a6-b5c4-3210-fedc-ba9876543210" } } ``` #### Attribute Values

tdsWorkCopy	Required. Work copy identifiers.
tdsWorkCopy.workCopyLuid	LUID of the new work copy.
tdsWorkCopy.datasourceLuid	Optional. LUID of the published data source. Not returned by this method; returned by Publish Work Copy.

#### Errors

HTTP status	`error` Code	Condition	Details
400		Invalid data source LUID	The data source LUID in the URI is not a UUID (8-4-4-4-12 hexadecimal digits).
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	403004	Data Management Bundle not licensed	On Tableau Server the TDS Edit API requires a Data Management Bundle license. The call is rejected when that license is absent.
403	403004	Unable to resolve tenant	On Tableau Cloud the subscription could not be checked because the tenant id for the site could not be retrieved.
403	403004	No cloud entitlements	On Tableau Cloud no entitlements were found for the tenant. The TDS Edit API requires a Tableau+ subscription.
403	403004	Subscription not entitled	On Tableau Cloud the site edition is not Tableau+. The TDS Edit API requires a Tableau+ subscription.
404		Data source not found or not visible to the caller	The data source LUID in the URI doesn't correspond to an existing data source in the site, or the caller doesn't have permission to access it.
405	405000	Method not allowed	The HTTP method is not supported for this resource.
405	405003	Composable data source	Creating a work copy is not supported for composable data sources (data sources that have one or more immediate parent published data sources).
405	405004	Semantic Data Model (SDM) data source	Creating a work copy is not supported for Semantic Data Model (SDM) data sources.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
429		Work copy limit exceeded	The maximum number of open work copies is reached. Publish an existing work copy before creating a new one.
500		Unknown error	There was an internal server error.
503		Service unavailable	Service unavailable.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Decrypt Extracts in a Site Extract encryption at rest is a data security feature that allows you to encrypt .hyper extracts while they are stored on Tableau Server. For more information, see [Extract Encryption at Rest](https://help.tableau.com/current/server/en-us/security_ear.htm). Decrypts all extracts on a site. **Note:** Depending on the number and size of extracts, this operation may consume significant server resources. Consider running this command outside of normal business hours. #### URI POST /api/api-version/sites/site-id/decrypt-extracts #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site.

#### Request Body None #### Permissions Tableau Server administrators can call this method. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:extract_encryption:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body None #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
404	404000	Site not found	The specified site doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not POST.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete a semantic context Delete a semantic context created and managed in Tableau Knowledge, along with its statements. **Version:** Available in Tableau Cloud September 2026 and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Creator role. The user can read/write nodes allowed by content permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** Tableau Cloud+ **Access Scope:** \`tableau:knowledge:write\` [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/v1/knowledge/semantic-contexts/{ctx\_id} [view details](#) ## Delete a Webhook Deletes the specified webhook. #### URI DELETE /api/3.6/sites//webhooks/ #### Parameter Values

site-id	The ID of the site that contains the workbook to be deleted.
webhook-id	The ID of the webhook.

#### Request Body None. #### Permissions This method can only be called by server and site administrators. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:webhooks:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None. ## Delete All Recycle Bin Contents Permanently deletes all content in a site's Recycle Bin . **Version**: Available in API 3.29 (Tableau Cloud June 2026 / Server 2026.2). **License**: No additional license required. **Permissions**: Server administrators, site administrators, or other users. **Access Scope**: `tableau:recyclebin_content:delete` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). Administrators delete all content in the site's Recycle Bin. Other users only delete content they own. For information about how content properties change when it's deleted or restored. See [Recycle Bin](https://help.tableau.com/current/pro/desktop/en-us/recycle_bin.htm). #### URI DELETE /api/api-version/sites/site-id/recyclebin DELETE /api/api-version/sites/site-id/recyclebin?asJob=asJob-value #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the Recycle Bin.
as-job-value	(Optional) If `true`, runs as an asynchronous job. Returns job information instead of executing synchronously. Default is `false`. Check the status of the job by calling Query Job.

#### Request Body None #### Response Code 204 with synchronous execution (when query parameter asJob is false) 202 with asynchronous execution (when query parameter asJob is true and an `EmptyRecycleBin` job is created) #### Response Body No response body with synchronous execution(when query parameter asJob is false) Returns a job object with asynchronous execution (when query parameter asJob is true and an `EmptyRecycleBin` job is created): Datetime fields are returned in UTC format (YYYY-MM-DDTHH:MM:SSZ). ``` ``` ``` { "job":{ "id":"12ab34cd-56ef-78ab-90cd-12ef34ab56cd", "mode":"Asynchronous", "type":"EmptyRecycleBin", "progress":"0", "createdAt":"2026-05-22T02:37:30Z", "finishCode":"1" } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	Check the request body and query string parameters.
401	401000	No auth credentials	Check the authorization header.
401	401002	Unauthorized	Session expired or invalid.
403	403004	Operation on resource unauthorized	Check user permission.
403	403157	Feature disabled	Recycle Bin disabled.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Method not allowed	Request type unrecognized for this method.
406	406000	Unacceptable media type	Bad Accept: header.
409	409004	Invalid parameter	Parameter type-mismatched, unknown content type, or malformed LUID.
429	429000	Too many requests	Request throttled.
500	500000	Internal server error	Unknown error.
503	500001	Internal service error	Internal service error.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete analytics extension connection from site Deletes a specific analytics extension connection for an external service from a site. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Can only be called by users with site or server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/settings/site/extensions/analytics/connections/{connection\_luid} [view details](#) ## Delete ask data lens - Retired in API 3.22 * * * Retired in API 3.22 (Cloud February 2024 / Server 2024.2) > > [!WARNING] > > > > **Important changes for Ask Data and Metrics** > > Tableau's Ask Data and Metrics features were retired in Tableau Cloud in February 2024 and in Tableau Server version 2024.2. With advances in natural language technologies, we're developing an improved interface that will make it easier to ask questions of your data and stay on top of changes. For more information, see [How Tableau GPT and Tableau Pulse are reimagining the data experience](https://www.tableau.com/blog/tableau-pulse-and-tableau-gpt). * * * Delete an ask data lens. **Version:** Available in API 3.16 ( Tableau Cloud June 2022 / Server 2022.3) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can be called by users with administrator and lens owner permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:lenses:delete\` [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/askdata/lenses/{lens\_id} [view details](#) ## Delete Ask Data Lens Permission - Retired in API 3.22 > > [!WARNING] > > > > Tableau's Ask Data and Metrics features were retired in Tableau Cloud in February 2024 and in Tableau Server version 2024.2. With advances in natural language technologies, we're developing an improved interface that will make it easier to ask questions of your data and stay on top of changes. For more information, see [How Tableau AI and Tableau Pulse are reimagining the data experience](https://www.tableau.com/blog/tableau-pulse-and-tableau-ai). Deletes the specified permissions to the specified ask data lens for a user or group. #### URI DELETE /api/api-version/sites/site-luid/lenses/lens-luid/permissions/groups/group-luid/capability-name/capability-mode DELETE /api/api-version/sites/site-luid/lenses/lens-luid/permissions/users/user-luid/capability-name/capability-mode #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	Required. The LUID of the site that contains the view.
lens-luid	Required. The LUID of the lens to delete permissions for.
group-luid	Optional (one user or group must be specified). The LUID of the group to remove the permission for.
user-luid	Optional. The LUID of the user to remove the permission for.
capability-name	The capability to remove the permission for. The valid capabilities for a view are ChangePermissions, Delete, Move, Read, Write. For more information, see Permissions.
capability-mode	Allow to remove the allow permission, or Deny to remove the deny permission.

#### Request Body None #### Permissions Users with server or site administrator permissions, and non-administrators that have Delete or ChangePermissions permission (either explicitly or implicitly) for the lens, can delete ask data lens permissions. #### Response Code 204 #### Response Body None #### Version Introduced Tableau Cloud June 2022 (API 3.16). Not currently available for Tableau Server. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400009	Invalid capability	The capability in the URI is invalid for an ask data lense. Valid capabilities for a lens are ChangePermissions, Delete, Move, Read, and Write.
403	403004	Permissions setting forbidden	A non-administrator user called this method but doesn't have permission to delete permissions on the view.
403	403039	Project permissions locked	The parent project that contains the specified ask data lens has its permissions locked.
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn’t correspond to an existing user.
404	404046	Lens not found	The ask data lens LUID in the URI doesn't correspond to an existing view.
404	404012	Group not found	A group LUID in the request body doesn't correspond to an existing group.
404	404013	Capability not found	The specified capability doesn't correspond to a defined capability. This can apply to either an invalid capability name or an invalid capability value (other than Allow or Deny).
404	404014	Capability not assigned	The capability in the URI is not assigned to the specified user or group with the specified mode (Allow or Deny).
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Authentication Configuration Delete an authentication instance. **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/authn-service/auth-configurations/{id} [view details](#) ## Delete Bridge Client Permanently removes a Bridge client from the site. This operation is irreversible; the Bridge client cannot be recovered through the API. Pool assignments are revoked and the client must be re-registered to reconnect. Data sources and scheduled refreshes using this client will be affected; consider moving to unassigned status for temporary deactivation instead of deleting. This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:delete` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI DELETE /api/api-version/sites/site-luid/bridge-clients/bridge-client-id #### URI Parameter Values

api-version	The version of the API to use. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
bridge-client-id	The unique identifier for the Bridge client to delete.

#### Request Body None #### Response Code 204 No Content #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	403000	Insufficient permissions	User does not have Site Administrator role.
404	503001	Bridge client not found	Bridge client with the specified ID does not exist on this site.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500	503003	Unexpected server error	An unexpected error occurred while deleting the Bridge client.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Bridge Pool Permanently deletes a Bridge pool and all its associated domain mappings. The pool must have no Bridge clients assigned (move clients first). Cannot delete reserved system pools. The operation is irreversible; domain mappings are removed and the pool ID becomes invalid. This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:delete` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI DELETE /api/api-version/sites/site-luid/bridge-pools/pool-id #### URI Parameter Values

api-version	The version of the API to use. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
pool-id	The unique identifier (UUID) of the pool to delete.

#### Request Body None #### Response Code 204 No Content #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
400	409004	Invalid pool ID or pool not found	Pool ID must be valid UUID and exist on the site.
400	503902	System pool	Cannot delete reserved system pools.
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	403000	Insufficient permissions	User does not have Site Administrator role.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500	503902	Unexpected server error	An unexpected error occurred while deleting the pool.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Collection Permission Removes the specified collection permission for the specified group or user. #### URI DELETE /api/api-version/sites/site-id/collections/collection-id/permissions/groups/group-id/capability-name/capability-mode DELETE /api/api-version/sites/site-id/collections/collection-id/permissions/users/user-id/capability-name/capability-mode #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the collection.
collection-id	The ID of the collection to remove the permission for.
group-id	The ID of the group to remove the permission for.
user-id	The ID of the user to remove the permission for.
capability-name	The capability to remove the permission for. The only valid capability for a collection is Read. The only valid capability mode is Allow or Deny. For more information, see Permissions.
capability-mode	Allow to delete an allow permission, or Deny to delete a deny permission. This value is case sensitive.

#### Request Body None #### Permissions This method can be called by server administrators, site administrators, and collection owners. #### Required scope for JWT authorization _Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. ``` tableau:permissions:delete ``` #### Response Code 204 #### Response Body None #### Version Version 3.12 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400009	Invalid capability	The capability in the URI is invalid for a collection. The only valid capability for a collection is Read.
403	403004	Permissions setting forbidden	A non-administrator user called this method but doesn't have permission to set permissions on the collection.
404	404000	Resource not found	The site ID in the URI wasn't found.
404	404002	Resource not found	The user ID in the URI wasn't found.
404	404012	Resource not found	The group ID in the URI wasn't found.
404	404013	Resource not found	The capability in the URI isn't recognized.
404	404014	Resource not found	The user or group permission wasn't found on the collection. Check the permissions on the collection that you're trying to remove and try again.
404	404038	Resource not found	The collection ID in the URI wasn't found.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete collections Deletes collections. **Version:** Available in API 3.28 (Cloud February 2026 / Server 2026.2) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Tableau administrators can call this method for all sites they administer. Other users can call this method for collections that they own. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:collections:delete. Added in API 3.28. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/collections [view details](#) ## Delete collections Deletes collections. **Version:** Available in API 3.28 (Cloud February 2026 / Server 2026.2) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Tableau administrators can call this method for all sites they administer. Other users can call this method for collections that they own. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:collections:delete. Added in API 3.28. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/collections/{luid} [view details](#) ## Delete Connected App Permanently remove a connected app. Deleting the connected app also deletes the secrets associated with the connected app. For more information about deleting a connected app, see one of the following: - For Tableau Server: [Effects of deleting a connected app](https://help.tableau.com/current/server-linux/en-us/connected_apps.htm#effects) - For Tableau Cloud: [Effects of deleting a connected app](https://help.tableau.com/current/online/en-us/connected_apps_direct.htm#effects) #### URI DELETE api/_api-version_/sites/_site-id_/connected-apps/direct-trust/_client-id_ **Note:** The `connected-applications` endpoint that performed this function was deprecated in API 3.17 (Tableau Cloud October 2022 / Tableau Server 2022.3), is no longer supported and may be retired in a future release. #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
client-id	The unique ID of the connected app.

HTTP status	`error` Code	Condition	Details
400	400143	Generic connected app error	The connected app could not be deleted for some other reason than those specified in this table.
403	403000	Admin permissions required	A non-admin user called this method and doesn't have adequate permissions to perform the action.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404041	Connected app not found	The requested connected app could not be found.

## Delete Connected App Secret Permanently remove a secret associated with a connected app. For more information about deleting a connected app, see one of the following: - For Tableau Server: [Effects of deleting a secret](https://help.tableau.com/current/server-linux/en-us/connected_apps.htm#effects) - For Tableau Cloud: [Effects of deleting a secret](https://help.tableau.com/current/online/en-us/connected_apps_direct.htm#effects) #### URI DELETE api/_api-version_/sites/_site-id_/connected-apps/direct-trust/_client-id_/secrets/_secret-id_ **Note:** The `connected-applications` endpoint that performed this function was deprecated in API 3.17 (Tableau Cloud October 2022 / Tableau Server 2022.3), is no longer supported and may be retired in a future release. #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
client-id	The unique ID of the connected app.
secret-id	The unique ID of the connected app secret.

#### Permissions Tableau Server admins or Tableau Cloud site admins only. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:connected_app_direct_trust_secrets:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 3.14 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). The resource, DELETE api/_api-version_/sites/_site-id_/connected-apps/direct-trust/_client-id_/secrets/_secret-id_, was added in version 3.17. The original resource, DELETE api/_api-version_/sites/_site-id_/connected-applications/_client-id_/secrets/_secret-id_, was deprecated in version 3.17 and will be retired in a future release. #### Errors

HTTP status	`error` Code	Condition	Details
400	400143	Generic connected app error	The connected app could not be deleted for some other reason than those specified in this table.
403	403000	Admin permissions required	A non-admin user called this method and doesn't have adequate permissions to perform the action.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404041	Connected app not found	The requested connected app could not be found.
404	404042	Secret not found	The requested secret for the connected app could not be found.

## Delete custom domain settings Deletes the custom domain setup for a Tableau site. **Version:** Available in API 3.26 (Tableau Cloud June 2025) and later. Not available for Tableau Server. [Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Only users with administrator permissions can view a site's custom domain settings. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:custom\_domains:delete\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/customdomains/settings/site/{site\_luid} [view details](#) ## Delete Custom View Deletes the specified custom view. **Version:** Available in API 3.18 (Tableau Cloud December 2022 / Server 2023.1). _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Tableau administrators can delete a custom view. Other users can delete any custom view that they own. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:views:update - Scope added in API 3.18 (Tableau Cloud December 2022 / Tableau Server 2023.1). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI DELETE /api/api-version/sites/site-luid/customviews/custom-view-luid #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
custom-view-luid	The LUID for the custom view being updated.

#### Request Body None. #### Required scope for JWT authorization _Introduced in Tableau Cloud December 2022 (API 3.18) ._ Authorize use of this method in your connected app by including this scope in its JSON Web Token (JWT). For more information, see [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help. ``` tableau:views:update ``` #### cURL Request Example `curl -L -X DELETE "https://qa-near/api/3.18/sites/a946d998-2ead-4894-bb50-1054a91dcab3/customviews/37d015c6-bc28-4c88-989c-72c0a171f7aa" -H "X-Tableau-Auth: njR9EGn0QSCpbDrUOh0IKg|wamRRyVFFUHTVwFL6OWEyOggxCwWYXuq|a946d998-2ead-4894-bb50-1054a91dcab3"` #### Response Code 201 #### Response Body None. #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403162	Unauthorized Access	The user does not have adminstrator permissions or Read permissions for the custom view..
404	404008	Resource Not Found	A custom view with the requested LUID could not be found.
405	405000	Invalid Request Method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Data Acceleration Task Deletes a data acceleration task. This method is not available for Tableau Cloud. **Important changes for Tableau View Acceleration and Data Acceleration** Tableau's View Acceleration feature and Data Acceleration APIs are retired. These features were retired in Tableau Cloud in June 2026 and in Tableau Server version 2026.2. #### URI DELETE /api/api-version/sites/site-id/tasks/dataAcceleration/dataAcceleration-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the task.
dataAcceleration-id	The ID of the task to remove.

#### Request Body None #### Permissions This method can only be called by server administrators and site administrators. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:data_acceleration_tasks:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body None #### Version In Tableau Server 2020.2 (API 3.8) through 2021.4 (API 3.15) data acceleration is supported. **Important changes for Tableau View Acceleration and Data Acceleration** Tableau's View Acceleration feature and Data Acceleration APIs are retired. These features were retired in Tableau Cloud in June 2026 and in Tableau Server version 2026.2. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	409087	Permission denied	The user isn't authorized to view data acceleration tasks.
403	409087	Permission denied	The user isn't authorized to access the workbook.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404026	Task not found	The task id in the URI doesn't correspond to an existing task.
405	405000	Invalid request method	Request type was not DELETE.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
certification-luid	The unique ID of the data quality certification.

#### Request body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to delete a data quality certification: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:labels:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Version Version 3.13 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400105	Generic data quality certification error	The data quality certification could not be deleted for some reason other than those specified in this table.
403	403004	Unauthorized operation	Insufficient permissions to perform the operation.
409	409004	Invalid parameter	One or more values in the request body are invalid.

## Delete Data Quality Certifications by Content Delete multiple data quality certifications from assets. **Note:** Data quality warnings and certifications can be more generally managed through the newer **Labels** methods. Tableau recommends using them to help ensure that you can manage your assets as new features are developed. Try the [Delete Labels](#delete_labels_on_assets) method instead. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI DELETE api/_api-version_/sites/_site-id_/dataQualityCertifications #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
indicator-id	The unique ID of the data quality certification.

#### Request body ``` ``` #### Attribute Values

content	The type of content or asset the data quality warning is attached to. To specify type, use one of the following values: database table datasource virtualconnection virtualconnectiontable
database-id	The unique ID of the database asset.
table-id	The unique ID of the table asset.
datasource-id	The unique ID of the data source content.
virtualconnection-id	The unique ID of the virtual connection.
virtualconnectiontable-id	The unique ID of the virtual connection table.

#### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to delete data quality certifications: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:labels:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Version Version 3.13 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400106	Generic data quality certification error	The data quality certifications could not be deleted for some reason other than those specified in this table.
404	404029	Content not found	The content does not exist.
403	403004	Unauthorized operation	Insufficient permissions to perform the operation.
409	409004	Invalid parameter	One or more values in the request body are invalid.

## Delete Data Quality Warning by Content Delete the data quality warnings from an asset. **Note:** Data quality warnings and certifications can be more generally managed through the newer **Labels** methods. Tableau recommends using them to help ensure that you can manage your assets as new features are developed. Try the [Delete Labels](#delete_labels_on_assets) method instead. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI DELETE api/api-version/sites/site-id/dataQualityWarnings/content-type/content-luid #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
content-type	The type of asset that the data quality warning is being attached to. To specify the type, use: database table column - Available in API 3.16 and later (Tableau Cloud October 2022, Server 2022.3) datasource flow virtualconnection virtualconnectiontable Types are not case sensitive.
content-luid	The LUID of the content (database, table, column, published data source, flow, virtual connection, or virtual connection table).

#### Request Body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to delete the data quality warning: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:labels:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
409	400106	Data quality warning delete error	An unknown error occurred and the data quality warning could not be deleted.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404029	Content not found	The requested asset could not be found.
404	404030	Data quality warning not found	The data quality warning for the requested asset could not be found.

## Delete Data Quality Warning by ID Delete a data quality warning from an asset using the data quality warning ID. **Note:** Data quality warnings and certifications can be more generally managed through the newer **Labels** methods. Tableau recommends using them to help ensure that you can manage your assets as new features are developed. Try the [Delete Label](#delete_label) method instead. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI DELETE api/_api-version_/sites/_site-id_/dataQualityWarnings/_dataqualitywarning-id_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
dataqualitywarning-id	The unique ID of the data quality warning.

#### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to delete the data quality warning: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:labels:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400105	Data quality warning delete error	An unknown error occurred and the data quality warning could not be deleted.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404029	Content not found	The requested asset could not be found.
404	404030	Data quality warning not found	The data quality warning for the requested asset could not be found.

## Delete Data Source Deletes the specified data source from a site. When a data source is deleted, its associated data connection is also deleted. Workbooks that use the data source are not deleted, but they will no longer work properly. #### URI DELETE /api/api-version/sites/site-id/datasources/datasource-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the data source.
datasource-id	The ID of the data source to delete.

#### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can delete a data source for which they have Read (view) and Delete permissions (either explicitly or implicitly). #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:datasources:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Deletion forbidden	A non-administrator user called this method but doesn't have Read (view) and Delete permission for the data source.
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
404	404004	Data source not found	The data source ID in the URI doesn't correspond to an existing data source in the site.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Data Source from Favorites Deletes the specified data source from the user's favorites. If the specified data source is not a favorite, the operation has no effect. #### URI DELETE /api/api-version/sites/site-id/favorites/user-id/datasources/datasource-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the data source.
user-id	The ID of the user to remove the favorite from.
datasource-id	The ID of the data source to remove from the user's favorites.

#### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can call this method only if they have Read (view) permissions on the data source (either explicitly or implicitly). #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:favorites:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 2.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Forbidden favorites access	A non-administrator user attempted to delete a data source from a different user's favorites.
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user
404	404010	Data source not a favorite	The data source ID in the URI exists but is not a favorite of the specified user.
404	404011	Data source not found	The data source ID in the URI doesn't correspond to an existing data source
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Data Source Permission Removes the specified data source permission for the specified group or user. #### URI DELETE /api/api-version/sites/site-id/datasources/datasource-id/permissions/groups/group-id/capability-name/capability-mode DELETE /api/api-version/sites/site-id/datasources/datasource-id/permissions/users/user-id/capability-name/capability-mode #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the data source.
datasource-id	The ID of the data source to remove the permission for.
group-id	The ID of the group to remove the permission for.
user-id	The ID of the user to remove the permission for.
capability-name	The capability to remove the permission for. Valid capabilities for a data source are ChangePermissions, Connect, Delete, ExportXml, ExtractRefresh, Read (view), Write, and SaveAs. For more information, see Permissions.
capability-mode	Allow to remove the allow permission, or Deny to remove the deny permission. This value is case sensitive.

#### Request Body None #### Permissions Users who are not server administrators or site administrators can call this method only if they have permission to delete permissions from the data source (either explicitly or implicitly). #### Required scope for JWT authorization _Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. ``` tableau:permissions:delete ``` #### Response Code 204 #### Response Body None #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400009	Invalid capability	The capability in the URI is invalid for a data source. Valid capabilities for a data source are ChangePermissions, Connect, Delete, ExportXml, Read, and Write.
403	403004	Permissions setting forbidden	A non-administrator user called this method but doesn't have permission to set permissions on the data source.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user.
404	404004	Data source not found	The data source ID in the URI doesn't correspond to an existing data source.
404	404012	Group not found	The group ID in the URI doesn't correspond to an existing group.
404	404013	Capability not assigned	The capability in the URI is not assigned to the specified user or group with the specified mode (Allow or Deny).
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Data-Driven Alert Deletes the specified data-driven alert from the specified site. #### URI DELETE /api/_api-version_/sites/_site-id_/dataAlerts/_data-alert-id_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the specified data-driven alert.
data-alert-id	The ID of the data-driven alert. You can obtain this ID by calling Query Data-Driven Alerts.

**Version:** Available in API 3.2 (Tableau Cloud / Tableau Server 2018.3) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required.> **Permissions:** This method can be called by server and site administrators, and by users who are owners or recipients of the specified data-driven alert. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:data\_driven\_alerts:delete - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Request Body None #### Response Code 204 #### Response Body None #### Version #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Delete forbidden	A user called this method who does not have the required permissions
404	409023	Resource Not Found	The data-driven alert ID specified in the URI is invalid.
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/13020592-762f-4de4-a25e-f4beb005836e/dataAlerts/e5a4b73e-5cbb-412d-907e-f31cc31684f7" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` ## Delete Database Permissions Permanently remove the permissions applied to a database asset. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI DELETE api/api-version/sites/site-luid/databases/database-luid/permissions/users/user-luid/capability-name/capability-mode DELETE api/api-version/sites/site-luid/databases/database-luid/permissions/groups/group-luid/capability-name/capability-mode #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site.
database-luid	The LUID of the database asset.
user-luid	The LUID of the user to remove the permissions for.
group-luid	The LUID of the group to remove the permissions for.
capability-name	The explicit permissions capability to remove. Capabilities that can be removed are Read, Write, ChangePermissions, or ChangeHierarchy.
capability-mode	The permissions mode to remove. Modes that can be removed are Allow or Deny.

#### Request Body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following authorized users have permissions to delete the permissions on the database asset: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to set or "ChangePermissions" to the asset metadata #### Response Code 200 #### Response Body None #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400120	Bad request	Permissions could not be deleted because support for explicit permissions is available for database assets associated with published data sources only.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
403	403117	Database locked	Permissions for the database asset cannot be deleted because the database asset is locked.
404	404000	Resource not found	The site LUID in the URI doesn't correspond to an existing site.
404	404031	Database not found	The requested database could not be found.
409	409045	Database error	An unknown database asset error occurred.
409	409051	Database update forbidden	A user without "write" permissions to the database asset attempted an update.

## Delete Default Database Permissions Permanently remove the default permissions on a database asset. Removing the default permissions from the database asset means that any new child table assets that are indexed by Catalog won't have any default permissions set. Note: If a database is in a project, default database permissions are not evaluated to determine table permissions. Use the [Delete Default Permissions](#delete_default_permissions) method to control default permission capabilities on tables through projects instead. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI DELETE api/_api-version_/sites/_site-luid_/databases/_database-luid_/default-permissions/tables/users/user-luid/capability-name/capability-mode DELETE api/_api-version_/sites/_site-luid_/databases/_database-luid_/default-permissions/tables/groups/group-luid/capability-name/capability-mode #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site asset.
database-luid	The LUID of the database asset.
user-luid	The LUID of the user to remove the default permission for.
group-id	The LUID of the group to remove the default permission for.
capability-name	The capability to remove the permissions for. Valid capabilities for databases are the following: Read (view) Write (edit) ChangePermissions (set permissions) ChangeHierarchy (move) For more information, see Permissions.
capability-mode	Allow to remove the allow permission, or Deny to remove the deny permission.

#### Request Body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following authorized users have permissions to delete the permissions on the database asset: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Response Code 200 #### Response Body None #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400120	Bad request	Permissions could not be deleted because support for explicit permissions is available for database assets associated with published data sources only.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
403	403117	Database locked	Default permissions cannot be deleted because the database asset is locked.
404	404000	Resource not found	The site LUID in the URI doesn't correspond to an existing site.
404	404031	Database not found	The requested database could not be found.
409	409045	Database error	An unknown database asset error occurred.
409	409051	Database update forbidden	A user without "write" permissions to the database asset attempted an update.

## Delete Default Permission Removes default permission rules for workbook, data source, data role, lens, flow, metric, or virtual connection resources in a project for a user or group. If Tableau Catalog is enabled, also removes default permission rules for database or table resources in a project for a user or group. After removing default permission rules, new resources of the type you specify that are added to the project will no longer have those permission rules. If permissions are [locked to the project](https://help.tableau.com/current/server/en-us/permissions.htm#LockProject), then the same is true for all existing child content of the project. #### URI Workbooks: DELETE /api/api-version/sites/site-luid/projects/project-luid/default-permissions/workbooks/users/user-luid/capability-name/capability-mode DELETE /api/api-version/sites/site-luid/projects/project-luid/default-permissions/workbooks/groups/group-luid/capability-name/capability-mode Data sources: DELETE /api/api-version/sites/site-luid/projects/project-luid/default-permissions/datasources/users/user-luid/capability-name/capability-mode DELETE /api/api-version/sites/site-luid/projects/project-luid/default-permissions/datasources/groups/group-luid/capability-name/capability-mode Data roles: DELETE /api/api-version/sites/site-luid/projects/project-luid/default-permissions/dataroles/users/user-luid/capability-name/capability-mode DELETE /api/api-version/sites/site-luid/projects/project-luid/default-permissions/dataroles/groups/group-luid/capability-name/capability-mode Lenses: DELETE /api/api-version/sites/site-luid/projects/project-luid/default-permissions/lenses/users/user-luid/capability-name/capability-mode DELETE /api/api-version/sites/site-luid/projects/project-luid/default-permissions/lenses/groups/group-luid/capability-name/capability-mode Metrics: DELETE /api/api-version/sites/site-luid/projects/project-luid/default-permissions/metrics/users/user-luid/capability-name/capability-mode DELETE /api/api-version/sites/site-luid/projects/project-luid/default-permissions/metrics/groups/group-luid/capability-name/capability-mode Flows: DELETE /api/api-version/sites/site-luid/projects/project-luid/default-permissions/flows/users/user-luid/capability-name/capability-mode DELETE /api/api-version/sites/site-luid/projects/project-luid/default-permissions/flows/groups/group-luid/capability-name/capability-mode Virtual Connections _(endpoints introduced in [API version](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm#rest_and_tableau_version_table) 3.23)_: DELETE /api/api-version/sites/site-luid/projects/project-luid/default-permissions/virtualconnections/users/user-luid/capability-name/capability-mode DELETE /api/api-version/sites/site-luid/projects/project-luid/default-permissions/virtualconnections/groups/group-luid/capability-name/capability-mode Databases: DELETE /api/api-version/sites/site-luid/projects/project-luid/default-permissions/databases/users/user-luid/capability-name/capability-mode DELETE /api/api-version/sites/site-luid/projects/project-luid/default-permissions/databases/groups/group-luid/capability-name/capability-mode Tables: DELETE /api/api-version/sites/site-luid/projects/project-luid/default-permissions/tables/users/user-luid/capability-name/capability-mode DELETE /api/api-version/sites/site-luid/projects/project-luid/default-permissions/tables/groups/group-luid/capability-name/capability-mode #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID of the site that contains the project.
project-id	The LUID of the project to remove the default permission for.
group-id	The LUID of the group to remove the default permission for.
user-id	The LUID of the user to remove default permission for.
capability-name	The capability to remove the permissions for. Valid capabilities for a workbook are AddComment ChangeHierarchy ChangePermissions Delete ExportData ExportImage ExportXml Filter Read (view) ShareView ViewComments ViewUnderlyingData WebAuthoring Write RunExplainData CreateRefreshMetrics Valid capabilities for a data source are ChangePermissions Connect Delete ExportXml SaveAs Read (view) Write Valid capabilities for a flow are ChangeHierarchy ChangePermissions Delete ExportXml (download) Execute Read (view) WebAuthoringForFlows Write For more information, see Permissions.
capability-mode	Allow to remove the allow permission, or Deny to remove the deny permission. This value is case sensitive.

#### Request Body None #### Permissions Users who are not server administrators can remove permissions for a project only if they have ProjectLeader permissions for that project (either explicitly or implicitly). #### Required scope for JWT authorization _Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. ``` tableau:permissions:delete ``` #### Response Code 204 #### Response Body None #### Version - Version 2.1 and later. - Version 3.23 and later for the virtual connection default permissions methods. - For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400009	Invalid capability	The capability in the URI is invalid.
403	403004	Permissions setting forbidden	A non-administrator user called this method but doesn't have permissions to remove permissions for the project.
403	403095	Delete permissions for flows forbidden	A non-administrator user called this method but doesn't have permissions to remove permissions for the project where the flow is located.
404	404000	Site not found	The site LUID in the URI doesn't correspond to an existing site.
404	404002	User not found	A user LUID in the URI doesn't correspond to an existing user.
404	404005	Project not found	The project LUID in the URI doesn't correspond to an existing project.
404	404012	Group not found	A group LUID in the URI doesn't correspond to an existing group.
404	404013	Capability not assigned	The capability in the URI isn't assigned to the specified user or group.
404	404013	Capability not found	The capability in the URI doesn't correspond to a defined capability. This can apply to either an invalid capability name or a capability other than Allow or Deny for any mode value.
404	404027	Flow not found	The flow LUID in the URI doesn't correspond to an existing flow.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Domain Removes a domain mapping from the system. The domain is no longer associated with any pool and can be re-added later if needed. For blocked domains, deletion unblocks the domain. Deletion is immediate; existing connections may be terminated and Bridge clients from that domain lose access until the domain is re-added to a pool. This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:delete` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PATCH /api/api-version/sites/site-luid/bridge-domain-maps/remove-domain #### URI Parameter Values

api-version	The version of the API to use. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.

#### Request Body ``` ``` ``` { "bridgeDomain": { "existingDomainName": "example.com" } } ``` #### Attribute Values

existingDomainName

Required. The domain name to remove from the system.

#### Response Code 200 #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
400	409004	Invalid domain name or domain not found	Domain must conform to valid format and must exist in the system.
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	403000	Insufficient permissions	User does not have Site Administrator role.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500	503907	Unexpected server error	An unexpected error occurred while deleting the domain.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete EAS Delete a registered external authorization server (EAS). #### URI DELETE api/_api-version_/sites/_site-id_/connected-apps/external-authorization-servers/_eas-id_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
eas-id	The unique ID of the registered EAS.

HTTP status	`error` Code	Condition	Details
400	400143	Generic connected app error	The connected app could not be deleted for some other reason than those specified in this table.
403	403000	Admin permissions required	A non-admin user called this method and doesn't have adequate permissions to perform the action.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404047	EAS not found	The requested EAS could not be found.

## Delete Extract from Data Source Delete the extract from a data source. #### URI POST /api/api-version/sites/site-id/datasources/datasource-id/deleteExtract #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID of the site.
datasource-id	The LUID of the datasource whose extract is to be deleted.

#### Permissions Extracts for data sources can be deleted by Tableau server or site administrators, and by users who own the data source or are an owner or leader of the project where the data source resides. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:extracts:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code `204 No Content` #### Response Body None. #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
404	404000	Site not found	The specified site doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not POST.
409	409070	Invalid request method	The data source cannot be extracted because it is file based or in another unsupported form.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID of the site that contains the extract refresh task.
task-id	The LUID of the extract refresh task to remove.

#### JWT Access Scope Available in API 3.20 (Tableau Cloud June 2023). Not available for Tableau Server. `tableau:tasks:delete` (this scope is included in the scope: `tableau:tasks`) For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Request Body None #### Permissions Tableau Server or Cloud users who are not server administrators or site administrators can delete an extract refresh task for which they have Read (view) and Delete permissions (either explicitly or implicitly). #### Response Code 204 #### Response Body None #### Version Version 3.6 and later. Virtual connection support added in 3.30. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404026	Task not found	The task id in the URI doesn't correspond to an existing extract refresh task.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Extracts from Virtual Connection Deletes the extracts from a virtual connection, which changes it from extract to live mode. This operation applies to the entire virtual connection. You can't target individual tables. **Version**: Available in API 3.30. **License**: Data Management, Enterprise, Server+, Cloud+, or Tableau+ Bundle. **Permissions**: Extracts for virtual connections can be deleted by Tableau server or site administrators, and by users who own the virtual connection or are an owner or leader of the project where the virtual connection resides. **Access Scope**: `tableau:extracts:delete` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI POST /api/api-version/sites/site-id/virtualconnections/virtualconnection-id/deleteExtract #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID for the site.
virtualconnection-id	The LUID for the virtual connection whose extract is to be deleted.

#### Request Body The request body is an empty tsRequest element. `` ``` {} ``` #### cURL Request Example ``` curl --request POST 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd/deleteExtract' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3' --data '' ``` #### Response Code 204 No Content #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
400	409128	No extract to delete.	The virtual connection has no extract. Neither the active revision nor any of its tables has extracts enabled.
400	409099	Unable to delete the extract.	A generic error occurred while converting the virtual connection to live and deleting its extract.
403	409098	User not authorized to delete the extract.	The user must be able to see the virtual connection and must have permission to convert its extract to live.
404	404049	Virtual connection not found.	Check the virtual connection LUID. This error also occurs if the virtual connection has no active revision.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Extracts of Embedded Data Sources from a Workbook Delete all extracts of embedded data sources in a workbook. **Note:** Depending on the number and size of extracts, this operation may consume significant server resources. Consider running this command outside of normal business hours. #### URI POST /api/api-version/sites/site-id/workbooks/workbook-id/deleteExtract #### Path Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID of the site.
datasource-id	The LUID of the workbook containing the extract to be deleted.

#### Permissions Extracts for data sources can be deleted by Tableau server or site administrators, and by users who own the data source or are an owner or leader of the project where the data source resides. #### Request Body ``` ``` #### Request Parameter Values None. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:extracts:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code `200` #### Response Body None. #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
404	404000	Site not found	The specified site doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not POST.
409	409070	Invalid request method	The data source cannot be extracted because it is file based or in another unsupported form.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the flow.
flow-id	The ID of the flow to delete.

#### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can delete a flow for which they have Read (view) and Delete permissions (either explicitly or implicitly). #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:flows:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 3.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Deletion forbidden	A non-administrator user called this method but doesn't have Read (view) and Delete permission for the flow.
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
404	404027	Flow not found	The flow ID in the URI doesn't correspond to an existing flow.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Flow from Favorites Deletes the specified flow from the user's favorites. If the specified flow is not a favorite, the operation has no effect. #### URI DELETE /api/api-version/sites/site-id/favorites/user-id/datasources/datasource-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the data source.
user-id	The ID of the user to remove the favorite from.
datasource-id	The ID of the data source to remove from the user's favorites.

#### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can call this method only if they have Read (view) permissions on the data source (either explicitly or implicitly). #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:favorites:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 3.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Forbidden favorites access	A non-administrator user attempted to delete a data source from a different user's favorites.
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user
404	404010	Flow not a favorite	The flow ID in the URI exists but is not a favorite of the specified user.
404	404027	Data source not found	The flow ID in the URI doesn't correspond to an existing flow.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Flow Permission Deletes the specified permission from the specified flow for a group or user. #### URI DELETE /api/api-version/sites/site-id/flows/flow-id/permissions/groups/group-id/capability-name/capability-mode DELETE /api/api-version/sites/site-id/flows/flow-id/permissions/users/user-id/capability-name/capability-mode #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the flow.
flow-id	The ID of the flow to remove the permission for.
group-id	The ID of the group to remove the permission for.
user-id	The ID of the user to remove the permission for.
capability-name	The capability to remove the permission for. Valid capabilities for a flow are: ChangeHierarchy ChangePermissions Delete Execute ExportXml (Download) Read (view) WebAuthoringForFlows Write For more information, see Permissions.
capability-mode	Allow to remove the allow permission, or Deny to remove the deny permission. This value is case sensitive.

#### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can delete permissions from a flow only if they have ChangePermissions permission for flow (either explicitly or implicitly). #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:permissions:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 3.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400009	Invalid capability	The capability in the URI is invalid for a flow. Valid capabilities for a flow are ChangeHierarchy, ChangePermissions, Delete, Execute, ExportXml (Download), Read (view), and Write.
403	403004	Permissions setting forbidden	A non-administrator user called this method but doesn't have permission to set permissions on the flow.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user.
404	404027	Flow not found	The flow ID in the URI doesn't correspond to an existing flow.
404	404012	Group not found	The group ID in the URI doesn't correspond to an existing group.
404	404013	Capability not found	The capability in the URI doesn't correspond to a defined capability. This can apply to either an invalid capability name or a capability other than Allowor Denyat the end of the URI.
404	404013	Capability not assigned	The capability in the URI is not assigned to the specified user or group with the specified mode (Allowor Deny).
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Group Deletes the group on a specific site. Deleting a group does not delete the users in group, but users are no longer members of the group. Any permissions that were previously assigned to the group no longer apply. **Note**: You cannot delete the All Users group. #### URI DELETE /api/api-version/sites/site-id/groups/group-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the project.
group-id	The ID of the group to delete.

#### Request Body None #### Permissions This method can be called by site administrators. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:groups:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 2.1 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
404	404012	Group not found	The group ID in the URI doesn't correspond to an existing group or the group is not part of the specified site.
405	405000	Invalid request method	Request type was not DELETE.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the project.
group-set-id	The ID of the group set to delete.

#### Request Body None #### cURL Request Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/groupsets/1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` The response contains no body (data) for a successful delete operation. The HTTP response code is 204 if the delete operation succeeded. #### Response Code 204 #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type wasn’t DELETE.
409	409120	Group set not found	The group set ID in the URI doesn't correspond to an existing group set or the group set isn’t part of the specified site.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Identity Pool Delete an identity pool. **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/authn-service/identity-pools/{uuid} [view details](#) ## Delete Identity Store Delete an identity store. **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/authn-service/identity-stores/{id} [view details](#) ## Delete Label Deletes a data label by its LUID. You can't delete extract refresh or flow run monitoring warnings (the extract\_refresh\_failure and flow\_run\_failure label values) using this method because those warnings are set and cleared automatically, depending on their triggers. See also "How to set a monitoring quality warning" in the [Tableau Server](https://help.tableau.com/current/server/en-us/dm_dqw.htm#how-to-set-a-monitoring-quality-warning) and [Tableau Cloud](https://help.tableau.com/current/online/en-us/dm_dqw.htm#how-to-set-a-monitoring-quality-warning) Help and the quality warning trigger methods in [Metadata Methods](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_metadata.htm). For more information on data label objects and properties, see the [Data Labels in the REST API](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_data_labels.htm) topic. All label operations except those related to the certification of data sources require Catalog to be enabled. Catalog requires a Data Management license. #### URI DELETE api/api-version/sites/site-luid/labels/label-luid #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The unique LUID of the site asset.
label-luid	The unique LUID of the label asset.

#### Request Body None #### Permissions - To delete a data label other than a certification label, you must have write permission on the associated asset. - To delete a certification label, you must be an administrator, or else you must be a project leader or product owner for the project the asset is in. - To delete a certification label for an external asset _not_ in a project, you must have the change permissions permission on the associated asset. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2024 and Tableau Server 2024.2 (API 3.23). ``` tableau:labels:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Version Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
401	400105	Generic delete label error	An unknown error occurred. Confirm that the LUID in the URI is correct.
403	403004	Operation on resource unauthorized	Insufficient permissions to perform the operation.
409	409004	Invalid parameter	The URI does not contain a properly-formatted LUID.

## Delete Label Category Deletes a label category. Note that category is one property of a label value (labelValue), which is itself a property of a label on an asset. Other properties of a labelValue include name and description. These properties determine label behavior and options that users see in label dialogs. For more information on data label objects and properties, see the [Data Labels in the REST API](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_data_labels.htm) topic. A Data Management license is not required to create, update, or delete label categories, but one is required to create, update, delete, and see labels on assets. #### URI DELETE api/api-version/sites/site-luid/labelCategories/label-category-name #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The unique LUID of the site asset.
label-category-name	The label category name. URL encode the label category name (as it appears in the Tableau web interface) if it has spaces or non-alphanumeric characters in it.

#### Request Body None #### Permissions Only a site or server administrator can create, update, or delete label categories. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:label_categories:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Version Introduced in Tableau Cloud October 2023 (API 3.21) / Server 2023.3 (API 3.21). #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
400	400191	Generic delete label category error	An unknown error occurred.
403	403004	Operation on resource unauthorized	You must be an administrator to create, update, or delete label values.
409	409004	Invalid parameter	The category name in the URI must exist. The category name can't be one of the built-in categories.

## Delete Labels Deletes the data labels on one or more assets. You can optionally limit the data labels to delete by category using a query string. You can't delete extract refresh or flow run monitoring warnings (the extract\_refresh\_failure and flow\_run\_failure label values) using this method because those warnings are set and cleared automatically, depending on their triggers. See also "How to set a monitoring quality warning" in the [Tableau Server](https://help.tableau.com/current/server/en-us/dm_dqw.htm#how-to-set-a-monitoring-quality-warning) and [Tableau Cloud](https://help.tableau.com/current/online/en-us/dm_dqw.htm#how-to-set-a-monitoring-quality-warning) Help and the quality warning trigger methods in [Metadata Methods](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_metadata.htm). For more information on data label objects and properties, see the [Data Labels in the REST API](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_data_labels.htm) topic. All label operations except those related to the certification of data sources require Catalog to be enabled. Catalog requires a Data Management license. #### URI DELETE api/api-version/sites/site-luid/labels DELETE api/api-version/sites/site-luid/labels?categories=category-list #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The unique LUID of the site.
category-list	(Optional) A comma-separated list of label value categories used to limit the label deletions to only the listed categories. See Data Labels in the REST API for information on label values and categories.

#### Request Body ``` ``` #### Attribute Values

asset-type

The type of asset. Valid asset types are:

database
table
column - Available in API 3.16 and later (Tableau Cloud October 2022, Server 2022.3)
datasource
flow
virtualconnection
virtualconnectiontable

asset-luid

The asset LUID.

#### Permissions - To delete a data label other than a certification label, you must have write permission on the associated asset. - To delete a certification label, you must be an administrator, or else you must be a project leader or product owner for the project the asset is in. - To delete a certification label for an external asset _not_ in a project, you must have the change permissions permission on the associated asset. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2024 and Tableau Server 2024.2 (API 3.23). ``` tableau:labels:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Version Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
401	400106	Generic delete labels error	An unknown error occurred.
403	403004	Operation on resource unauthorized	Insufficient permissions to perform the operation.
404	404029	Resource not found	The contentType and contentID attribute combination does not correspond to an asset on the server. This can be caused by an incorrect contentType, an incorrect contentID, or both.
409	409004	Invalid parameter	One or more values in the request body are invalid.

## Delete labelValue Deletes a label value. If you use this method on a built-in label value that was customized, this method reverts the label to its built-in defaults instead of deleting it. (Afterwards, assets with the label that you reverted will reflect the built-in default.) Note that a label value (labelValue) is one property of a label. A label value has its own properties like name, category, and description that determine label behavior and options that users see in label dialogs. For more information on data label objects and properties, see the [Data Labels in the REST API](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_data_labels.htm) topic. A Data Management license is not required to create, update, or delete label values, but one is required to create, update, delete, and see labels on assets. #### URI DELETE api/api-version/sites/site-luid/labelValues/label-value-name #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The unique LUID of the site asset.
label-value-name	The label value name. URL encode the label value name if it has spaces or non-alphanumeric characters in it.

#### Request Body None #### Permissions Only a site or server administrator can create, update, or delete label values. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:label_values:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Version Introduced in Tableau Cloud June 2023 (API 3.20) and Tableau Server 2023.3 (API 3.21). #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Operation on resource unauthorized	You must be a site or server administrator to create or update label values.
409	409004	Invalid parameter	The label value name in the URI must exist. The label value name can't be one of the built-in labels, unless that label has a customized description (in which case, this method reverts the description to the built-in default).
401	4000173	Generic add labels to content error	An unknown error occurred.

## Delete metric Deletes a metric. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can delete a metric from a definition as long as the user has write and publish access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_metrics:delete\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/pulse/metrics/{metric\_id} [view details](#) ## Delete Metric - Retired in API 3.22 **Retired in API 3.22 (Cloud February 2024 / Server 2024.2)** Tableau's legacy metrics feature was retired in Tableau Cloud in February 2024 and in Tableau Server version 2024.2. In October 2023, Tableau retired the ability to embed legacy metrics in Tableau Cloud and in Tableau Server version 2023.3. With Tableau Pulse, we've developed an improved experience to track metrics and ask questions of your data. For more information, see [Create Metrics with Tableau Pulse](https://help.tableau.com/current/online/en-us/pulse_create_metrics.htm) to learn about the new experience and [Create and Troubleshoot Metrics (Retired)](https://help.tableau.com/current/online/en-us/metrics_create.htm) for the retired feature. Deletes a specified metric from a site. #### URI DELETE /api/api-version/sites/site-id/metrics/metric-luid #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the metric.
metric-luid	The unique ID of the metric to remove.

#### Request Body None #### Permissions Users who are not administrators can delete a metric for which they have explicit or implicit Read (view) and Delete permission. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:metrics:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 3.9 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404006	Metric not found	The metric ID in the URI doesn't correspond to an existing metric.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.9/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/metrics/6561daa3-20e8-407f-ba09-709b178c0b4a" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` The response contains no body (data) for a successful delete operation. The HTTP response code is 204 if the delete operation succeeded. ## Delete metric definition Deletes a metric definition. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can delete a metric definition as long as the user has write and publish access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_definitions:delete\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/pulse/definitions/{definition\_id} [view details](#) ## Delete metric tag Deletes the specified metric tag. **Version:** Available in API 3.25 (Tableau Cloud March 2025) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Anyone can make this request but users will see results only for metrics they have permissions to view. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_metrics:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/pulse/metrics/{metric\_id}/tag/{tag\_id} [view details](#) ## Delete Project Deletes the specified project on a specific site. When a project is deleted, all Tableau assets inside of it are also deleted, including assets like associated workbooks, data sources, project view options, and rights. External assets, such as databases and tables, are not deleted. Starting in Tableau Cloud December 2022 / Server 2023.1, external assets from deleted projects are moved to the External Assets Default Project, and can also be found in External Assets. In Tableau Cloud October 2022 / Server 2022.3 and earlier, external assets are not moved to any other project, but can be found in External Assets. Use this method with caution. #### URI DELETE /api/api-version/sites/site-luid/projects/project-luid #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site that contains the project.
project-luid	The LUID of the project to delete.

#### Request Body None #### Permissions Only server administrators and site administrators can call this method. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:projects:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403003	Deletion forbidden	You attempted to delete a default project that cannot be deleted.
404	404000	Site not found	The site LUID or URL namespace in the URI doesn't correspond to an existing site.
404	404005	Project not found	The project LUID in the URI doesn't correspond to an existing project or the project is not found on this site.
405	405000	Invalid request method	Request type was not DELETE.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the project.
user-id	The ID of the user to remove the favorite from.
project-id	The ID of the project to remove from the user's favorites.

#### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can delete a project only from their own favorites. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:favorites:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 3.1 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Forbidden favorites access	A non-administrator user attempted to delete a project from a different user's favorites.
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user.
404	404005	Project not found	The project ID in the URI doesn't correspond to an existing project.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/1edc53ac-e247-4870-9fd3-6fad0ce5f84d/favorites/9a4ebbab-9ec8-487a-9b48-47fa81d6077a/projects/89a82d78-664f-45a1-8256-d4d2961a070b" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` ## Delete Project Permission Removes the specified project permission for the specified group or user. #### URI DELETE /api/api-version/sites/site-id/projects/project-id/permissions/groups/group-id/capability-name/capability-mode DELETE /api/api-version/sites/site-id/projects/project-id/permissions/users/user-id/capability-name/capability-mode #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the project.
project-id	The ID of the project to remove the permission for.
group-id	The ID of the group to remove the permission for.
user-id	The ID of the user to remove project the permission for.
capability-name	The capability to remove the permission for. In Tableau Server 10.0, valid capabilities for a project are ProjectLeader, Read (view), and Write. For more information, see Permissions.
capability-mode	Allow to remove the allow permission, or Deny to remove the deny permission. This value is case sensitive.

#### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can remove permissions for a project only if they have ChangePermissions (version `2.0`) or ProjectLeader (version `2.1`) permissions for that project (either explicitly or implicitly). #### Required scope for JWT authorization _Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. ``` tableau:permissions:delete ``` #### Response Code 204 #### Response Body None #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400009	Invalid capability	The capability in the URI is invalid for a project. For a list of valid capabilities, see the capability-name attribute earlier.
403	403004	Permissions setting forbidden	A non-administrator user called this method but doesn't have permissions to remove default permissions for the project.
403	403004	Delete forbidden	A non-administrative user tried to update the project, but does not have permissions to the project.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	A user ID in the URI doesn't correspond to an existing user.
404	404005	Project not found	The project ID in the URI doesn't correspond to an existing project.
404	404012	Group not found	A group ID in the URI doesn't correspond to an existing group.
404	404013	Capability not assigned	The capability in the URI isn't assigned to the specified user or group.
404	404013	Capability not found	The capability in the URI doesn't correspond to a defined capability. This can apply to either an invalid capability name or a capability other than Allow or Deny for any mode value.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Pulse subscription Deletes a specified subscription to a metric. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user that has read or connect permission to the data source used in the definition can delete subscriptions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:metric\_subscriptions:delete\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/pulse/subscriptions/{id} [view details](#) ## Delete Quality Warning Trigger by ID Permanently remove a quality warning trigger using the quality warning trigger ID. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI DELETE api/_api-version_/sites/_site-id_/dataQualityTriggers/_trigger-id_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
trigger-id	The unique ID of the quality warning trigger.

#### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to delete a quality warning trigger: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:labels:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body None #### Version Version 3.11 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400138	Generic quality warning trigger error	The quality warning trigger could not be deleted for some other reason than those specified below.
403	403004	Unauthorized operation	Insufficient permissions to perform the operation.
404	404037	Quality warning not found	The requested quality warning trigger was not found.
409	409004	Invalid parameter	One or more values in the request body are invalid.

## Delete Quality Warning Triggers by Content Permanently remove all quality warning triggers for one or more data sources or flows, or both. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI **Delete one quality warning trigger** DELETE api/_api-version_/sites/_site-id_/dataQualityTriggers/_content-type_/contentIds?filter=contentId:in:\[_content-luid_\] **Delete multiple quality warning triggers** DELETE api/_api-version_/sites/_site-id_/dataQualityTriggers/_content-type_/contentIds?filter=contentId:in:\[_content-luid1_,_content-luid2_,_content-luid3_,...\] #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
content-type	The type of content the quality warning trigger has been applied to. In this case, use one of the following values: datasource flow These values are not case sensitive.
content-luid	The unique ID of the asset. This is the same as the content ID.

#### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to delete quality warning triggers: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:labels:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body None #### Version Version 3.10 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400138	Generic quality warning trigger error	The quality warning trigger could not be deleted for some other reason than those specified below.
403	403004	Unauthorized operation	Insufficient permissions to perform the operation.
404	404037	Quality warning not found	The requested quality warning trigger was not found.
409	409004	Invalid parameter	One or more values in the request body are invalid.

## Delete Recycle Bin Content Item Permanently deletes the specified Recycle Bin content item. **Version**: Available in API 3.29 (Tableau Cloud June 2026 / Server 2026.2). **License**: No additional license required. **Permissions**: Server administrators, site administrators, or other users. **Access Scope**: `tableau:recyclebin_content:delete` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). Administrators can delete any content in the site's Recycle Bin. Other users can only delete content they own. For information about how content properties change when it's deleted or restored. See [Recycle Bin](https://help.tableau.com/current/pro/desktop/en-us/recycle_bin.htm). #### URI DELETE /api/api-version/sites/site-id/recyclebin/content-type/content-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the Recycle Bin.
content-type	Content type in plural form: `workbooks`, `datasources`, `flows`, or `projects`.
content-id	The LUID of the Recycle Bin content item to delete.

#### Request Body None #### Response Code 204 #### Response Body None #### Version Version 3.29 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	Check the request body and query string parameters.
401	401000	No auth credentials	Check the authorization header.
401	401002	Invalid auth credentials	Session expired or invalid.
403	403004	Operation on resource unauthorized	Check user permission.
403	403157	Feature disabled	Recycle Bin disabled.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404003	Unknown resource	Requested content item not found.
405	405000	Method not allowed	Request type unrecognized for this method.
406	406000	Unacceptable media type	Bad Accept: header.
409	409004	Invalid parameter	Parameter type-mismatched, unknown content type, or malformed LUID.
429	429000	Too many requests	Request throttled.
500	500000	Internal server error	Unknown error.
503	500001	Internal service error	Internal service error.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Routing Rule Permanently deletes a Bridge routing rule identified by its ID. This method applies to both allow rules and block rules. Deletion is immediate; the domain is no longer routed (or blocked) by the removed rule. If no rule matches the ID, a 404 error is returned. This method is not available for Tableau Server. **Version**: Available in API 3.30 (Tableau Cloud October 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:delete` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI DELETE /api/api-version/sites/site-luid/bridge-routing-rules/routing-rule-id #### URI Parameter Values

api-version	The version of the API to use. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
routing-rule-id	The unique identifier (UUID) of the routing rule to delete.

#### Request Body None #### Response Code 204 No Content #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
400	503909	Validation failed	The routing-rule-id is not a valid UUID.
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	503923	Permission denied	Caller is not a site administrator for the site.
404	503915	Routing rule not found	No routing rule exists with the given ID on this site.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500	503920	Unexpected server error	An unexpected error occurred while deleting the rule.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete SCIM Configuration Permanently removes the System for Cross-domain Identity Management (SCIM) configuration from the Tableau Cloud site. Deleting the SCIM configuration deletes the associated SCIM token. You must be the user who created the SCIM configuration to delete the SCIM configuration unless the creator of the SCIM configuration is no longer a member of the site. After the SCIM configuration is deleted, ensure the SCIM token's secret is also removed from the identity provider's (IdP's) SCIM settings. **Version**: Available in API 3.26 (Tableau Cloud August 2025) and later. **License**: No additional license required. **Permissions**: Tableau Cloud site admins only. **Access Scope**: `tableau:scim_configurations:delete` - Scope added in API 3.27 (Tableau Cloud December 2025) _For more information, see_ [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_,_ [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_, [access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps:_[Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm)_._ #### URI DELETE /api/api-version/sites/site-luid/scimConfigurations/scim-configuration-id #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
scim-configuration-id	The UUID of the SCIM configuration. To get the SCIM configuration UUID, see List SCIM Configurations.

#### Request Body None #### cURL Request Example ``` DELETE request: curl --location --request DELETE 'https://prod-ca-a.online.tableau.com/api/3.29/sites/0f04ea64-0d72-424a-afd8-ee7d758dc9b8/scimConfigurations/065693d8-436a-4738-a8f1-375953a2a888' ``` #### Response Code 204 #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
401	401002	Unauthorized Access	The authentication token provided in the request header is invalid or has expired.
403	403182	Forbidden	The SCIM configuration can only be deleted by the user who created the SCIM configuration.
404	404057	Resource Not Found	The SCIM configuration cannot be deleted because it does not exist on this site.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete SCIM Token Permanently removes the System for Cross-domain Identity Management (SCIM) token. You must be the user that created the SCIM configuration to delete the associated SCIM token unless the creator of the SCIM configuration is no longer a member of the site. After the SCIM token is deleted, ensure the SCIM token's secret is also removed from the identity provider's (IdP's) SCIM settings. **Version**: Available in API 3.26 (Tableau Cloud August 2025) and later. **License**: No additional license required. **Permissions**: Tableau Cloud site admins only. **Access Scope**: `tableau:scim_api_tokens:delete` - Scope added in API 3.27 (Tableau Cloud December 2025) _For more information, see_ [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_,_ [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_, [access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps:_[Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm)_._ #### URI DELETE /api/api-version/sites/site-luid/scimConfigurations/scim-configuration-id/apiToken #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
scim-configuration-id	The UUID of the SCIM configuration. To get the SCIM configuration UUID, see List SCIM Configurations.

#### Request Body None #### cURL Request Example ``` DELETE request: curl --location --request DELETE 'https://prod-ca-a.online.tableau.com/api/3.29/sites/0f04ea64-0d72-424a-afd8-ee7d758dc9b8/scimConfigurations/065693d8-436a-4738-a8f1-375953a2a888/apiToken' ``` #### Response Code 204 #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
401	401002	Unauthorized Access	The authentication token provided in the request header is invalid or has expired.
404	404050	Resource Not Found	The SCIM configuration does not have an associated SCIM token.
404	404057	Resource Not Found	The SCIM configuration ID is not valid.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Server Schedule Deletes the specified schedule on Tableau Server. _For Tableau Cloud, see [Delete Extract Refresh Task](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_extract_and_encryption.htm#delete_extract_refresh_task) and [Delete Subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_subscriptions.htm#delete_subscription)._ #### URI DELETE /api/api-version/schedules/schedule-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
schedule-id	The ID of the schedule to delete. To determine what schedules are available, call List Server Schedules.

HTTP status	`error` Code	Condition	Details
400	400059	Error deleting the schedule.	An unspecified error occurred during the deletion operation.
404	404023	Schedule not found	The specified schedule doesn't correspond to an existing schedule on the site.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Server Session Deletes a specified session. This method is not available for Tableau Cloud and is typically used in programmatic management of the life cycles of embedded Tableau sessions. #### URI DELETE api/_api-version_/sessions/_session-id_ #### Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.

session-id

The unique ID of the session to be deleted. A session's ID and other metadata can be queried from the Tableau Server Postgres repository.

Reading the Postgres repository excessively can impact performance and that writing directly to the repository is not supported in any form. For more information, see Collect Data with the Tableau Server Repository and Tableau Server Postgres Data Dictionary.

#### Request Body None. #### Permissions This method can only be called by server administrators. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:sessions:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 3.9 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400105	Session delete error	An unknown error occurred and the session could not be deleted.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404029	Content not found	The requested asset could not be found.

## Delete Site Deletes the specified site. You can specify the site to delete by using the site ID, the site name, or the content URL. You use the key query string parameter to indicate how you are specifying the site, as shown in the URIs. Beginning in API version 3.18, you can delete a site asynchronously, which allows you to track the site deletion progress. This method is not available for Tableau Cloud. **Note**: You must have previously called the [Sign In](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_authentication.htm#sign_in) method and signed in to a site in order to delete the site. When you call this method, you must include the authentication token that you got back when you signed into the site. #### URI **Delete site** DELETE /api/api-version/sites/site-id DELETE /api/api-version/sites/site-name?key=name DELETE /api/api-version/sites/content-url?key=contentUrl **Delete site asynchronously** (beginning in API 3.18) DELETE /api/api-version/sites/async-delete/site-id DELETE /api/api-version/sites/async-delete/site-name?key=name DELETE /api/api-version/sites/async-delete/content-url?key=contentUrl #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site to delete.
site-name	The name of the site to delete. If you specify a site name, you must also include the parameter `key=name`.
content-url	The permanent name of the site to sign in to. The content URL appears in the URL path of Tableau content in your browser address bar after the Tableau Server URL. `mySite` is the content URL in the following example: `http://<server or cloud URL>/#/site/mySite/explore`

#### Request Body None #### Permissions This method can only be called by server administrators. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:sites:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code **Delete site** 204 **Delete site asynchronously** (beginning in API 3.18) 201 #### Response Body **Delete site** None **Delete site asynchronously** (beginning in API 3.18) ``` ``` The `` element returns the following attributes: - job-id is a unique identifier for the job. You can use the value of this attribute to check the status of the delete job by passing it to the [Query Job](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_jobs_tasks_and_schedules.htm#query_job) method. - mode has the value of `Asynchronous`. - type has the value of `SiteDelete`. - progress is set to `0` when the asynchronous delete job is created, and then changes to `100` when the job is complete. This value indicates percentage of job progress. - createdAt provides a complete date and time that indicates when asynchronous delete was initiated. - finishCode is set to `1` when the asynchronous delete job is created, and then changes to `0` when the job is complete. #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403002	Deletion not allowed.	An attempt was made to delete the default Tableau Server site.
404	404000	Site not found	The specified site doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### cURL Request Example **Delete site** `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d5-e4f3-a2b1-c0d9-e8f7a6b5c4d" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` `curl "http://MY-SERVER/api/3.29/sites/marketing-site?key=contentUrl" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` The response contains no body (data) for a successful delete operation. The HTTP response code is 204 if the delete operation succeeded. **Delete site asynchronously** (beginning in API 3.18) `curl "http://MY-SERVER/api/3.29/sites/async-delete/9a8b7c6d5-e4f3-a2b1-c0d9-e8f7a6b5c4d" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` `curl "http://MY-SERVER/api/3.29/sites/async-delete/marketing-site?key=contentUrl" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` `curl "http://MY-SERVER/api/3.29/sites/async-delete/marketing-site-name?key=name" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` The responses above will return the job ID for a successful delete operation. You can use the value to check the status of the delete job by passing it to the [Query Job](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_jobs_tasks_and_schedules.htm#query_job) method. ## Delete Subscription Deletes the specified subscription on Tableau Server or Tableau Cloud. #### URI DELETE /api/api-version/sites/site-id/subscriptions/subscription-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the subscription.
subscription-id	The ID of the subscription to delete. To determine what subscriptions are available, call Query Subscriptions.

#### JWT Access Scope Available in API 3.20 (Tableau Cloud June 2023). Not available for Tableau Server. `tableau:tasks:delete` (this scope is included in the scope: `tableau:tasks`) For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Request Body None #### Permissions Tableau Server users can call this method to delete any subscription that they had permission to create. For details, see [Create Subscription](#create_subscription). #### Response Code 204 #### Response Body None #### Version Version 2.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400062	Error deleting the subscription.	An unspecified error occurred during the deletion operation.
401	401002	User not authenticated.	The user making the request has not been authenticated for this site.
403	403059	Delete forbidden.	A non-administrator user called this method but doesn't have permission to delete the subscription.
404	404000	Site not found	The specified site doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Table Permissions Permanently remove the permissions applied to a table asset. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI DELETE api/api-version/sites/site-luid/tables/table-luid/permissions/users/user-luid/capability-name/capability-mode DELETE api/api-version/sites/site-luid/tables/table-luid/permissions/groups/group-luid/capability-name/capability-mode #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site asset.
table-luid	The LUID of the table asset.
user-luid	The LUID of the user to remove the permissions for.
group-luid	The LUID of the group to remove the permissions for.
capability-name	The explicit permissions capability to remove. Capabilities that can be removed are Read, Write, ChangePermissions, or ChangeHierarchy.
capability-mode	The permissions mode to remove. Modes that can be removed are Allow or Deny.

#### Request Body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to delete the permissions on a table asset: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to set or "ChangePermissions" to the asset metadata #### Response Code 204 #### Response Body None #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400120	Bad request	Permissions could not be deleted because support for explicit permissions is available for table assets associated with published data sources only.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
403	403117	Database locked	Permissions for the table asset cannot be deleted because the database asset is locked.
404	404000	Resource not found	The site LUID in the URI doesn't correspond to an existing site.
409	409051	Database update forbidden	A user without "write" permissions to the database asset attempted an update.

## Delete Tag from Column Delete a tag from a column. For more information about tags, see [Tag Items](https://help.tableau.com/current/pro/desktop/en-us/tags.htm) in the Tableau User Help. #### URI DELETE api/api-version/sites/site-id/columns/column-id/tags/tag-name #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
column-id	The unique ID of the column asset.
tag-name	The keyword text of the tag.

#### Request Body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to delete tags: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:column_tags:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 3.9 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Unauthorized operation	Insufficient permissions to perform the operation.
404	404007	Tag not found	The tag does not exist.
409	409062	Generic database tag error	The tag or tags could not be deleted (or added) for some other reason than those specified in this table.
409	409066	Column not found	The column asset does not exist.

## Delete Tag from Data Source Deletes a tag from the specified data source. #### URI DELETE /api/api-version/sites/site-id/datasources/datasource-id/tags/tag-name #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the data source.
datasource-id	The ID of the data source to remove the tag from.
tag-name	The name of the tag to remove from the data source.

#### Request Body None #### Permissions Tableau Server users who are not server administrators, site administrators, or data source owners can delete a tag from a data source only if they are project leaders or if they originally added the tag. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:datasource_tags:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400077	Error deleting tag	There was a problem deleting the tag from the specified data source.
403	403004	Deleting tags forbidden	A non-administrator user called this method but doesn't have permission to delete a tag from the specified data source.
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
404	404004	Data source not found	The data source ID in the URI doesn't correspond to an existing data source.
404	404007	Tag not found	The tag in the URI doesn't exist for the specified data source.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Tag from Database Delete a tag from a database. For more information about tags, see [Tag Items](https://help.tableau.com/current/pro/desktop/en-us/tags.htm) in the Tableau User Help. #### URI DELETE api/api-version/sites/site-id/databases/database-id/tags/tag-name #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
database-id	The unique ID of the database asset.
tag-name	The keyword text of the tag.

#### Request Body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to delete tags: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:database_tags:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 3.9 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Unauthorized operation	Insufficient permissions to perform the operation.
404	404007	Tag not found	The tag does not exist.
404	404031	Database not found	The database asset does not exist.
409	409048	Generic database tag error	The tag or tags could not be deleted (or added) for some other reason than those specified above.

## Delete Tag from Table Delete a tag from a table. For more information about tags, see [Tag Items](https://help.tableau.com/current/pro/desktop/en-us/tags.htm) in the Tableau User Help. #### URI DELETE api/api-version/sites/site-id/tables/table-id/tags/tag-name #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
table-id	The unique ID of the table asset.
tag-name	The keyword text of the tag.

#### Request Body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to delete tags: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:table_tags:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 3.9 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Unauthorized operation	Insufficient permissions to perform the operation.
404	404007	Tag not found	The tag does not exist.
404	404032	Table not found	The table asset does not exist.
409	409055	Generic database tag error	The tag or tags could not be deleted (or added) for some other reason than those specified above.

## Delete Tag from View Deletes a tag from the specified view. #### URI DELETE /api/api-version/sites/site-id/views/view-id/tags/tag-name #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook.
view-id	The ID of the view to remove the tag from.
tag-name	The name of the tag to remove from the view.

#### Request Body None #### Permissions Tableau Server users who are not server administrators, site administrators, or workbook owners can delete a tag from a workbook only if they are project leaders or if they originally added the tag. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:view_tags:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400078	Error deleting tag	There was a problem deleting the tag from the specified view.
403	403004	Deleting tags forbidden	A non-administrator user called this method but doesn't have permission to delete a tag from the specified workbook.
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
404	404006	Workbook not found	The workbook ID in the URI doesn't correspond to an existing workbook.
404	404007	Tag not found	The tag in the URI doesn't exist for the specified workbook.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Tag from Virtual Connection Deletes a tag from a virtual connection. **Version:** Available in API 3.23 (Tableau Cloud June 2024 / Tableau Server 2024.2) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** Requires [Tableau Data Management](https://help.tableau.com/current/online/en-us/dm_overview.htm). **Permissions:** You must have the View permission for the virtual connection and your site role must be at least Explorer. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:virtual\_connection\_tags:delete - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI DELETE /api/api-version/sites/site-id/virtualconnections/virtualconnection-id/tags/tag-name #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID for the site.
virtualconnection-id	The LUID for the virtual connection.
tag-name	The text of the tag.

#### Request Body None #### cURL Request Example `curl --location --request DELETE 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd/tags/office' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3'` #### Response Code 204 #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
400	400077	Error deleting tag	There was a problem deleting the tag from the specified virtual connection.
403	403004	Deleting tags forbidden	The user doesn't have permissions to add delete tags from the virtual connection.
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
404	404004	Virtual connection not found	The virtual connection ID in the URI doesn't correspond to an existing virtual connection.
404	404007	Tag not found	The tag in the URI doesn't exist for the specified virtual connection.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Tag from Workbook Deletes a tag from the specified workbook. #### URI DELETE /api/api-version/sites/site-id/workbooks/workbook-id/tags/tag-name #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook.
workbook-id	The ID of the workbook to remove the tag from.
tag-name	The name of the tag to remove from the workbook.

#### Request Body None #### Permissions Tableau Server users who are not server administrators, site administrators, or workbook owners can delete a tag from a workbook only if they are project leaders or if they originally added the tag. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:workbook_tags:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400051	Error deleting tag	There was a problem deleting the tag from the specified workbook.
403	403004	Deleting tags forbidden	A non-administrator user called this method but doesn't have permission to delete a tag from the specified workbook.
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
404	404006	Workbook not found	The workbook ID in the URI doesn't correspond to an existing workbook.
404	404007	Tag not found	The tag in the URI doesn't exist for the specified workbook.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete User from Data-Driven Alert Removes a specified user from the recipients list for a data-driven alert. #### URI DELETE /api/_api-version_/sites/_site-id_/dataAlerts/_data-alert-id_/users/_user-id_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the specified data-driven alert.
data-alert-id	The ID of the data-driven alert. You can obtain this ID by calling Query Data-Driven Alerts.
user-id	The ID (not name) of the user to remove from the data-driven alert.

**Version:** Available in API 3.2 (Tableau Cloud / Tableau Server 2018.3) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required.> **Permissions:** This method can only be called by server administrators and site administrators, and by users who are owners of the specified alert. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:data\_driven\_alerts:update - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Request Body None #### Response Code 204 #### Response Body None #### Version #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Delete forbidden	A user called this method who does not have the required permissions.
403	409029	Deleting recipient from data-driven alert forbidden	The user is not authorized to remove the recipient from the data-driven alert.
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
404	404002	Resource Not Found	The user ID specified in the request body is invalid.
404	409023	Resource Not Found	The data-driven alert ID specified in the URI is invalid.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/13020592-762f-4de4-a25e-f4beb005836e/dataAlerts/e5a4b73e-5cbb-412d-907e-f31cc31684f7/users/ff43cb47-f208-4d2f-9a22-0fbb6d29f7f1" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` ## Delete Users from Site with CSV Creates a job to remove a list of users, specified in a .csv file, from a site. The .csv file should comply with the rules described in one of the following topics: - For Tableau Cloud - [CSV Import File Guidelines](https://help.tableau.com/current/online/en-us/csvguidelines.htm) - For Tableau Server - [CSV Import File Guidelines](https://help.tableau.com/current/server/en-us/csvguidelines.htm) #### URI POST /api/_api-version_/sites/_site-id_/users/delete #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that users are being deleted from.

#### Request Body Because this method involves a file that is external to Tableau a multi-part request is required. For more information on multi-part requests, See [Importing CSV files with Multipart Requests](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_fundamentals.htm#multipart_requests). ``` --boundary-string Content-Disposition: form-data; name=\"tableau_user_delete\"; filename=\"users.csv\" Content-Type: text/csv --boundary-string-- ``` #### Permissions This method can only be called by server and site administrators. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:users:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 3.15 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request payload is missing or incomplete, or contains malformed XML.
500	500000	Internal Server Error	The request could not be completed.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the view.
view-id	The ID of the view to remove.

#### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can delete a view for which they have Read (view) and Delete permissions (either explicitly or implicitly). #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:views:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Introduced in Tableau Cloud December 2025 / Server 2025.3 (API 3.27). For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400212	Generic error	An unknown error occurred. Try again.
403	403004	Operation on resource unauthorized	Insufficient permissions to perform the operation. Confirm you have Read and Delete permissions for the view.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site. Confirm the site ID.
404	404011	View not found	The view ID in the URI doesn't correspond to an existing view. Confirm the view ID.
405	405000	Invalid request method	The HTTP request method was wrong. Confirm you're using the HTTP DELETE method.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete View from Favorites Deletes the specified view from user's favorites. If the specified view is not a favorite, the operation has no effect. #### URI DELETE /api/api-version/sites/site-id/favorites/user-id/views/view-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the view.
user-id	The ID of the user to remove the favorite from.
view-id	The ID of the view to remove from the user's favorites.

#### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can delete a view only from their own favorites. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:favorites:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Forbidden Favorites access	A non-administrator user attempted to delete a view from a different user's favorites.
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user
404	404010	View not a favorite	The view ID in the URI exists but is not a favorite of the specified user.
404	404011	View not found	The view ID in the URI doesn't correspond to an existing view
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete View Permission Deletes permission to the specified view (also known as a sheet) for a Tableau Server user or group. #### URI DELETE /api/api-version/sites/site-id/views/view-id/permissions/groups/group-id/capability-name/capability-mode DELETE /api/api-version/sites/site-id/views/view-id/permissions/users/user-id/capability-name/capability-mode #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the view.
view-id	The ID of the view to delete permissions for. You can obtain this ID by calling Query Views for Site.
group-id	The ID of the group to remove the permission for.
user-id	The ID of the user to remove the permission for.
capability-name	The capability to remove the permission for. The valid capabilities for a view are AddComment, ChangePermissions, Delete, ExportData, ExportImage, ExportXml, Filter, Read (view), ShareView, ViewComments, ViewUnderlyingData, WebAuthoring, and Write. For more information, see Permissions.
capability-mode	Allow to remove the allow permission, or Deny to remove the deny permission.

#### Request Body None #### Permissions Users who are not server administrators or site administrators can delete permissions from a view only if they have ChangePermissions permissions on the view (either explicitly or implicitly). #### Required scope for JWT authorization _Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. ``` tableau:permissions:delete ``` #### Response Code 204 #### Response Body None #### Version Version 3.2 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400009	Invalid capability	The capability in the URI is invalid for a view.
403	403004	Permissions setting forbidden	A non-administrator user called this method but doesn't have permission to delete permissions on the view.
403	403039	Project permissions locked	The parent project that contains the specified view has its permissions locked.
403	403096	Parent workbook tabs enabled	The specified view currently has permissions inherited from its parent workbook. View permission can be deleted if the parent workbook has its tabs disabled.
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn’t correspond to an existing user.
404	404011	View not found	The view ID in the URI doesn't correspond to an existing view.
404	404012	Group not found	A group ID in the request body doesn't correspond to an existing group.
404	404013	Capability not found	The specified capability doesn't correspond to a defined capability. This can apply to either an invalid capability name or an invalid capability value (other than Allow or Deny).
404	404014	Capability not assigned	The capability in the URI is not assigned to the specified user or group with the specified mode (Allow or Deny).
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/fbfa6f03-982c-4930-8ec1-d5949a19125d/views/0524c7ce-250b-45b1-adf2-d08f1648643c/permissions/users/ff43cb47-f208-4d2f-9a22-0fbb6d29f7f1/AddComment/Allow" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` ## Delete Virtual Connection Deletes a virtual connection. **Version:** Available in API 3.23 (Tableau Cloud June 2024 / Tableau Server 2024.2) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** Requires [Tableau Data Management](https://help.tableau.com/current/online/en-us/dm_overview.htm). **Permissions:** You must have the Delete permission for the virtual connection and your site role must be at least Creator. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:virtual\_connections:delete - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI DELETE /api/api-version/sites/site-id/virtualconnections/virtualconnection-id #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID for the site.
virtualconnection-id	The LUID for the virtual connection.

#### Request Body None #### cURL Request Example _(Use the icon in the top right corner to copy the text.)_ ``` curl --request DELETE 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3' ``` #### Response Code 204 #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	User not authorized.	Check to make sure the user has the required permissions.
404	404049	Virtual connection not found	Check the virtual connection LUID.
409	409122	Generic error	An unknown error occurred.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Virtual Connection Permission Removes the specified virtual connection permission for the specified group or user. #### URI DELETE /api/api-version/sites/site-id/virtualconnections/virtualconnection-id/permissions/groups/group-id/capability-name/capability-mode DELETE /api/api-version/sites/site-id/virtualconnections/virtualconnection-id/permissions/users/user-id/capability-name/capability-mode #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the virtual connection.
virtualconnection-id	The ID of the virtual connection to remove the permission for.
group-id	The LUID of the group to remove the permission for. A request does not need to include both a user and a group grantee.
user-id	The LUID of the user to remove the permission for. A request does not need to include both a user and a group grantee.
capability-name	The capability to remove the permission for. Valid capabilities for a virtual connection are Read, Connect, Overwrite, ChangeHierarchy, Delete, and ChangePermissions. For more information, see Permissions.
capability-mode	Allow to remove the allow permission, or Deny to remove the deny permission.

#### Request Body None #### Permissions You must be an administrator or have the Delete permission for the virtual connection (either explicitly or implicitly). #### Required scope for JWT authorization _Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. ``` tableau:permissions:delete ``` #### Response Code 204 #### Response Body None #### Version Version 3.23 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400009	Invalid capability	The specified capability is invalid for a virtual connection. Valid capabilities for a virtual connection are Read, Connect, Overwrite, ChangeHierarchy, Delete, and ChangePermissions.
403	403004	Permissions setting forbidden	The user tried to change permissions for a virtual connection but doesn't have the permission to change them.
404	404000	Site not found	The specified site doesn't correspond to an existing site.
404	404002	User not found	The user specified in the request body doesn't correspond to an existing user.
404	404012	Group not found	The group ID in the URI doesn't correspond to an existing group.
404	404013	Capability not assigned	The capability in the URI is not assigned to the specified user or group with the specified mode (Allow or Deny).
404	404014	Capability not found	A capability specified in the request body doesn't correspond to a defined capability. This can apply to either an invalid capability name or to a capability other than Allow or Deny for any mode value.
405	405000	Invalid request method	Request type was not DELETE.
400	409004	Invalid LUID	The virtual connection LUID in the URI was not found.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl --location --request DELETE 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd/permissions/users/9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d/read/allow' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3'` ## Delete Work Copy Elements Deletes elements from a work copy. Send `elementType` and `name` for each element. Other content is ignored. Returns HTTP 200 when every element is deleted. The success body omits the elements that succeeded. If any element fails, the HTTP status is the status of the first failure and the body lists only the failed elements. **Version**: Available in API 3.30 (Tableau Cloud October 2026 / Server 2026.3) and later. **License**: Data Management or Tableau+. **Permissions**: Users who are not server administrators or site administrators can call this method only if they have Connect, Write (save), and VizqlDataApiAccess (API Access) permissions for the data source that the work copy was created from (either explicitly or implicitly). **Access Scope**: `tableau:datasources:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI DELETE /api/api-version/tds/sites/site-luid/workcopy/workcopy-luid #### URI Parameter Values

api-version	The version of the API to use. These TDS Edit methods are available in API 3.30 and later. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site in the URI. This handler does not bind the path variable — the service uses the authenticated user's site LUID (`authUser.getSiteLuid()`).
workcopy-luid	The LUID of the work copy. Must be a UUID (8-4-4-4-12 hexadecimal digits), matching `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}`.

#### Request Body ``` FieldDescription Sales TableDescription Orders ``` ``` { "tdsElementList": [ { "elementType": "FieldDescription", "name": "Sales" }, { "elementType": "TableDescription", "name": "Orders" } ] } ``` #### Attribute Values

tdsElementList[]	Required. Elements to delete. Must contain at least one element. An empty or missing list is HTTP 400 with error code `400008`.
tdsElementList[].elementType	Required for this method. Element type of the element to delete (`Column`, `FieldDescription`, or `TableDescription`). Any other value is forwarded and reported as a per-element failure.
tdsElementList[].name	Required. Name of the element to delete.
tdsElementList[].column	Not applicable to this method. Delete uses `elementType` and `name` only; other content is ignored.
tdsElementList[].description	Not applicable to this method. Delete uses `elementType` and `name` only; other content is ignored.

#### Response Code 200 OK #### Response Body On full success the response is an empty `tsResponse` — `tdsElementResult` is omitted entirely rather than returned as an empty list. When one or more elements fail, the HTTP status is the status of the first failure and the body carries `tdsElementResult` for the failed elements only; see the Attribute Values table below and the Errors table for the failure shape. ``` ``` ``` {} ``` #### Attribute Values

tdsElementResult[]	Failed elements only. Omitted on full success, including omitted rather than returned as an empty array.
tdsElementResult[].elementType	Required. Element type of the failed element, copied from the request.
tdsElementResult[].name	Required. Name of the failed element, copied from the request.
tdsElementResult[].status	Required. Failure status for this element.
tdsElementResult[].status.code	Required (within `status`). The translated HTTP status for this element (200, 400, 401, 403, 404, 500, or 503). Not a Tableau 6-digit error sub-code.
tdsElementResult[].status.message	Optional. Error message from the TDS service.

#### Errors

HTTP status	`error` Code	Condition	Details
400	400008	Missing tdsElementList	`tdsElementList` is missing or empty. The list is required and must contain at least one element.
400		Invalid work copy LUID	The work copy LUID in the URI is not a UUID (8-4-4-4-12 hexadecimal digits).
400		Per-element invalid argument	One or more elements were rejected as invalid. The body lists only the failed elements, and each `status.code` is the HTTP status 400.
400		Unmapped per-element gRPC status	The TDS service returned a status that maps to HTTP 400. The body lists only the failed elements.
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
401		Per-element unauthenticated	The TDS service rejected an element as unauthenticated. The body lists only the failed elements.
403	403004	Data Management Bundle not licensed	On Tableau Server the TDS Edit API requires a Data Management Bundle license. The call is rejected when that license is absent.
403	403004	Unable to resolve tenant	On Tableau Cloud the subscription could not be checked because the tenant id for the site could not be retrieved.
403	403004	No cloud entitlements	On Tableau Cloud no entitlements were found for the tenant. The TDS Edit API requires a Tableau+ subscription.
403	403004	Subscription not entitled	On Tableau Cloud the site edition is not Tableau+. The TDS Edit API requires a Tableau+ subscription.
403		Per-element permission denied	The TDS service rejected an element because permission was denied. The body lists only the failed elements.
404		Per-element not found	One or more elements were not found. The body lists only the failed elements. This is not error code 404065, which the read methods return for a missing named element.
405	405000	Method not allowed	The HTTP method is not supported for this resource.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500		Per-element internal error	The TDS service failed while editing an element. The body lists only the failed elements.
503		Per-element unavailable	The TDS service was unavailable while editing an element. The body lists only the failed elements.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Workbook Deletes a workbook. When a workbook is deleted, all of its assets are also deleted, including associated views, data connections, and so on. #### URI DELETE /api/api-version/sites/site-id/workbooks/workbook-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook.
workbook-id	The ID of the workbook to remove.

#### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can delete a workbook for which they have Read (view) and Delete permissions (either explicitly or implicitly). #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:workbooks:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404006	Workbook not found	The workbook ID in the URI doesn't correspond to an existing workbook.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Workbook from Favorites Deletes a workbook from a user's favorites. If the specified workbook is not a favorite of the specified user, this call has no effect. #### URI DELETE /api/api-version/sites/site-id/favorites/user-id/workbooks/workbook-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the user.
user-id	The ID of the user to remove the favorite from.
workbook-id	The ID of the workbook to remove from the user's favorites.

#### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can remove a workbook only from their own favorites. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:favorites:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Access to Favorites forbidden	A non-administrator user attempted to delete a workbook from a different user's favorites.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user.
404	404006	Workbook not found	The workbook ID in the URI doesn't correspond to an existing workbook.
404	404010	Workbook not a favorite	The workbook ID in the URI exists but belongs to a different user.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Delete Workbook Permission Deletes the specified permission from the specified workbook for a group or user. #### URI DELETE /api/api-version/sites/site-id/workbooks/workbook-id/permissions/groups/group-id/capability-name/capability-mode DELETE /api/api-version/sites/site-id/workbooks/workbook-id/permissions/users/user-id/capability-name/capability-mode #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook.
workbook-id	The ID of the workbook to remove the permission for.
group-id	The ID of the group to remove the permission for.
user-id	The ID of the user to remove the permission for.
capability-name	The capability to remove the permission for. Valid capabilities for a workbook are AddComment, ChangeHierarchy, ChangePermissions, Delete, ExportData, ExportImage, ExportXml, ExtractRefresh, Filter, Read (view), ShareView, ViewComments, ViewUnderlyingData, WebAuthoring, Write, RunExplainData, and CreateRefreshMetrics. For more information, see Permissions.
capability-mode	Allow to remove the allow permission, or Deny to remove the deny permission. This value is case sensitive.

#### Request Body None #### Permissions Users who are not server administrators or site administrators can delete permissions from a workbook only if they have ChangePermissions permission for workbook (either explicitly or implicitly). #### Required scope for JWT authorization _Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. ``` tableau:permissions:delete ``` #### Response Code 204 #### Response Body None #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400009	Invalid capability	The capability in the URI is invalid for a workbook resource. Valid capabilities for a workbook are AddComment, ChangeHierarchy, ChangePermissions, Delete, ExportData, ExportImage, ExportXml, Filter, Read, Share_view, ViewComments, ViewUnderlyingData, WebAuthoring, and Write.
403	403004	Permissions setting forbidden	A non-administrator user called this method but doesn't have permission to delete permissions from the workbook.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user.
404	404006	Workbook not found	The workbook ID in the URI doesn't correspond to an existing workbook.
404	404012	Group not found	The group ID in the URI doesn't correspond to an existing group.
404	404013	Capability not found	The capability in the URI doesn't correspond to a defined capability. This can apply to either an invalid capability name or a capability other than Allow or Deny at the end of the URI.
404	404013	Capability not assigned	The capability in the URI is not assigned to the specified user or group with the specified mode (Allow or Deny).
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Disallow dashboard extension on site - Retired in API 3.21 * * * Retired in API 3.21 (Cloud October 2023 / Server 2023.3) > > [!WARNING] > > > > In October 2023 Tableau Cloud and Tableau Server version 2023.3 releases, Tableau's REST API methods for dashboard extensions settings are retired. We recommend you replace dashboard extensions methods for enabling, listing, getting details of, and updating dashboard extensions with [Tableau extensions settings methods](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_tableau_extensions_settings.htm) that have similar functionality. * * * Deletes a specific dashboard extension from the safe list of the site you are signed into. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Can only be called by users with site or server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/settings/site/extensions/dashboard/safeListItems/{safe\_list\_item\_luid} [view details](#) ## Download Data Source Downloads a data source in `.tdsx` format. #### URI GET /api/api-version/sites/site-id/datasources/datasource-id/content GET /api/api-version/sites/site-id/datasources/datasource-id/content?includeExtract=extract-value #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the data source.
datasource-id	The ID of the data source to download.
extract-value	(Optional) The extract-value is a Boolean value (`False` or `True`). When the data source specified for download has an extract, if you add the parameter `?includeExtract=False`, the extract is not included when you download the data source. You can use this parameter to improve performance if you are downloading workbooks or data sources that have large extracts.

#### Request Body None #### Permissions Users who are not server administrators or site administrators can download a data source only if they have ExportXml permission for the data source (either explicitly or implicitly). #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:datasources:download ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body The data source content in `.tdsx` format (`Content-Type: application/octet-stream`). The response will have the following content disposition header: `Content-Disposition: name="tableau_datasource"; filename="datasource-filename"` #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403028	Read forbidden	A non-administrator user attempted to download a data source, but the caller doesn't have Read permission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404004	Data source not found	The data source ID in the URI doesn't correspond to an existing data source.
405	405000	Invalid request method	Request type was not GET.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
datasource-luid	The LUID of the data source to download the encrypted keychain from.

#### Request Body ``` site1 d56023b5-8f8b-4241-aa74-8974ced85827 http://example.com ``` ``` { "destinationSiteUrlNamespace": "site1", "destinationSiteLuid": "d56023b5-8f8b-4241-aa74-8974ced85827", "destinationServerUrl": "http://localhost" } ``` #### Request Attributes

`destinationSiteUrlNamespace`	(Required) The site name on Tableau Cloud.
`destinationSiteLuid`	(Required) The site ID on Tableau Cloud.
`destinationServerUrl`	(Required) The destination Tableau Cloud URL.

#### cURL Request Example ``` curl --location "https://example.org/api/3.24/sites/7a2f773d-4a9f-496e-afc6-a60517cb1b86/datasources/1a2a3b4b-5c6c-7d8d-9e0e-1f2f3a4a5b6b/retrieveKeychain" -X POST --header "Content-Type: application/xml" --header "X-Tableau-Auth: nbQAstTxTHuBlcMlXZ3QKg|LXn5aiYcffck999kgpOPrQft5JkvRsYg|7a2f773d-4a9f-496e-afc6-a60517cb1b86" --data " site19a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4dhttp://example.com" ``` #### Response Code 200 #### Response Body ``` BADsJ5lBKho2Tdqqbo7txS8IyKgNw5FnJud0etCHJLhBUurgIRHk3g5AeMQg6KHBw+6nwNIDEd65MKi76DLd5aIMhQC5aLCR4NE7R2gp7JbxLo+nOMGnfDQm5XekJVpLQGfY53GIX52ED2iTfOQ0yRNbnPV4djT0z23rosG0gpmqXV/py5okFzVW4wx8RisnZdvv+SAlv222jVhksX1w5A6HB3Bs45BeWfpwrOnHwnNoWUGwHuu4iGlyE7m65RlATZN+fvDGOFN1zU2lXaSZyWqRKiWkD+oCS5wRNtJ6lGz7RnesKvH6QEL9sT8cXA1ZOEA531xNAv9rjazEP5BssIdA1GcJ5J7zar5xxC68qm3cz3MkndyqWXZrf0vWPgwysUHEpWn60oDG/8/xG6c0Eigh4gwE+dA+NF1L2q9VyhVr8+AzJ7vatf95LDwAuRT43G3Q+WApx9qBPXco15pKjwy00rHPgn4cRtu+unwh6d3gIh6AbK6X++U/vV/Ktpe31lSZmV8eHPeTNfdCrGOT9ozZhF5oKhsBZyFrVY7Wtf1YcXawh3bvtZxg9d8a2mKNXDeaF+uJrpI43aFa4KrJKdfvDpq2k0aJhL1QNxWSFBYw0tPJX/rhKAeOHHY2K44Wh5JNWwL+x1uYap93IK303sJ13hV0jXW7nXUhfIW7o5iUtbYWrpCvVwubZLf4U5Y= ``` ``` { "associatedUserLuidList": [], "encryptedKeychainList": { "encryptedKeychain": "BADsJ5lBKho2Tdqqbo7txS8IyKgNw5FnJud0etCHJLhBUurgIRHk3g5AeMQg6KHBw+6nwNIDEd65MKi76DLd5aIMhQC5aLCR4NE7R2gp7JbxLo+nOMGnfDQm5XekJVpLQGfY53GIX52ED2iTfOQ0yRNbnPV4djT0z23rosG0gpmqXV/py5okFzVW4wx8RisnZdvv+SAlv222jVhksX1w5A6HB3Bs45BeWfpwrOnHwnNoWUGwHuu4iGlyE7m65RlATZN+fvDGOFN1zU2lXaSZyWqRKiWkD+oCS5wRNtJ6lGz7RnesKvH6QEL9sT8cXA1ZOEA531xNAv9rjazEP5BssIdA1GcJ5J7zar5xxC68qm3cz3MkndyqWXZrf0vWPgwysUHEpWn60oDG/8/xG6c0Eigh4gwE+dA+NF1L2q9VyhVr8+AzJ7vatf95LDwAuRT43G3Q+WApx9qBPXco15pKjwy00rHPgn4cRtu+unwh6d3gIh6AbK6X++U/vV/Ktpe31lSZmV8eHPeTNfdCrGOT9ozZhF5oKhsBZyFrVY7Wtf1YcXawh3bvtZxg9d8a2mKNXDeaF+uJrpI43aFa4KrJKdfvDpq2k0aJhL1QNxWSFBYw0tPJX/rhKAeOHHY2K44Wh5JNWwL+x1uYap93IK303sJ13hV0jXW7nXUhfIW7o5iUtbYWrpCvVwubZLf4U5Y=" } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403054	Unauthorized Access	A non-administrator user attempted to get data source revision information, but the caller doesn't have sufficient permissions.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404004	Data source not found	The data source ID in the URI doesn't correspond to an existing data source.
405	405000	Invalid request method	Request type was not POST.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Download Data Source Revision Downloads a specific version of a data source prior to the current one in `.tdsx` format. To down load the current version of a data source use the [Download Data Source](#download_data_source) method. **Note:** This method is available only if version history is enabled for the specified site. For more information, see [Maintain a History of Revisions](https://help.tableau.com/current/server/en-us/help.htm#revision_history_maintain.htm) in the Tableau Server Help. #### URI GET /api/api-version/sites/site-id/datasources/datasource-id/revisions/revision-number/content #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the data source.
datasource-id	The ID of the data source to download.
revision-number	The revision number of the data source to download. To determine what versions are available, call Get Data Source Revisions.

#### Request Body None #### Permissions Tableau Server users who are site administrators can download data source revisions on the site that they are administrators for. Users who are not server administrators or site administrators can get data source revisions if they have all of the following: - A site role of ExplorerCanPublish. - Read (view), Write (save), and Download (save as) permissions for the specified data source. - Save (write) permissions for the project that contains the data source. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:content:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body The data source content in `.tdsx` format (`Content-Type: application/octet-stream`). The response will have the following content disposition header: `Content-Disposition: name="tableau_datasource"; filename="datasource-filename"` #### Version Version 2.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403028	Read forbidden	A non-administrator user attempted to download a data source, but the caller doesn't have required permissions.
403	403053	Version history not enabled	version history is not enabled for the specified site.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404004	Data source not found	The data source ID in the URI doesn't correspond to an existing data source.
404	404024	Data source revision not found	The revision number in the URI doesn't correspond to an existing data source revision.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Download Flow Downloads a flow in .tfl or .tflx format. #### URI GET /api/api-version/sites/site-id/flows/flow-id/content #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the flow.
flow-id	The ID of the flow to download.

#### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can download a flow only if they have download permission for the flow (either explicitly or implicitly). #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:flows:download ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body None #### Version Version 3.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403097	Read forbidden	A non-administrator user attempted to download a flow, but the caller doesn't have Read permission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404027	Flow not found	The flow ID in the URI doesn't correspond to an existing flow.
405	405000	Invalid request method	Request type was not GET.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
flow-luid	The LUID of the flow to download the encrypted keychain from.

#### Request Body ``` site1 d56023b5-8f8b-4241-aa74-8974ced85827 http://localhost ``` ``` { "destinationSiteUrlNamespace": "site1", "destinationSiteLuid": "d56023b5-8f8b-4241-aa74-8974ced85827", "destinationServerUrl": "http://localhost" } ``` #### Request Attributes

`destinationSiteUrlNamespace`	(Required) The site name on the destination site.
`destinationSiteLuid`	(Required) The site LUID of the destination site.
`destinationServerUrl`	(Required) The destination Tableau Server or Tableau Cloud URL.

#### cURL Request Example ``` curl --location "https://myserver/api/3.25/sites/7a2f773d-4a9f-496e-afc6-a60517cb1b86/flows/1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d/retrievekeychain" -X POST --header "Content-Type: application/xml" --header "X-Tableau-Auth: nbQAstTxTHuBlcMlXZ3QKg|LXn5aiYcffck999kgpOPrQft5JkvRsYg|7a2f773d-4a9f-496e-afc6-a60517cb1b86" --data "site1 9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4dhttp://localhost" ``` #### Response Code 200 #### Response Body ``` BADsJ5lBKho2Tdqqbo7txS8IyKgNw5FnJud0etCHJLhBUurgIRHk3g5AeMQg6KHBw+6nwNIDEd65MKi76DLd5aIMhQC5aLCR4NE7R2gp7JbxLo+nOMGnfDQm5XekJVpLQGfY53GIX52ED2iTfOQ0yRNbnPV4djT0z23rosG0gpmqXV/py5okFzVW4wx8RisnZdvv+SAlv222jVhksX1w5A6HB3Bs45BeWfpwrOnHwnNoWUGwHuu4iGlyE7m65RlATZN+fvDGOFN1zU2lXaSZyWqRKiWkD+oCS5wRNtJ6lGz7RnesKvH6QEL9sT8cXA1ZOEA531xNAv9rjazEP5BssIdA1GcJ5J7zar5xxC68qm3cz3MkndyqWXZrf0vWPgwysUHEpWn60oDG/8/xG6c0Eigh4gwE+dA+NF1L2q9VyhVr8+AzJ7vatf95LDwAuRT43G3Q+WApx9qBPXco15pKjwy00rHPgn4cRtu+unwh6d3gIh6AbK6X++U/vV/Ktpe31lSZmV8eHPeTNfdCrGOT9ozZhF5oKhsBZyFrVY7Wtf1YcXawh3bvtZxg9d8a2mKNXDeaF+uJrpI43aFa4KrJKdfvDpq2k0aJhL1QNxWSFBYw0tPJX/rhKAeOHHY2K44Wh5JNWwL+x1uYap93IK303sJ13hV0jXW7nXUhfIW7o5iUtbYWrpCvVwubZLf4U5Y= ``` ``` { "associatedUserLuidList": [], "encryptedKeychainList": { "encryptedKeychain": "BADsJ5lBKho2Tdqqbo7txS8IyKgNw5FnJud0etCHJLhBUurgIRHk3g5AeMQg6KHBw+6nwNIDEd65MKi76DLd5aIMhQC5aLCR4NE7R2gp7JbxLo+nOMGnfDQm5XekJVpLQGfY53GIX52ED2iTfOQ0yRNbnPV4djT0z23rosG0gpmqXV/py5okFzVW4wx8RisnZdvv+SAlv222jVhksX1w5A6HB3Bs45BeWfpwrOnHwnNoWUGwHuu4iGlyE7m65RlATZN+fvDGOFN1zU2lXaSZyWqRKiWkD+oCS5wRNtJ6lGz7RnesKvH6QEL9sT8cXA1ZOEA531xNAv9rjazEP5BssIdA1GcJ5J7zar5xxC68qm3cz3MkndyqWXZrf0vWPgwysUHEpWn60oDG/8/xG6c0Eigh4gwE+dA+NF1L2q9VyhVr8+AzJ7vatf95LDwAuRT43G3Q+WApx9qBPXco15pKjwy00rHPgn4cRtu+unwh6d3gIh6AbK6X++U/vV/Ktpe31lSZmV8eHPeTNfdCrGOT9ozZhF5oKhsBZyFrVY7Wtf1YcXawh3bvtZxg9d8a2mKNXDeaF+uJrpI43aFa4KrJKdfvDpq2k0aJhL1QNxWSFBYw0tPJX/rhKAeOHHY2K44Wh5JNWwL+x1uYap93IK303sJ13hV0jXW7nXUhfIW7o5iUtbYWrpCvVwubZLf4U5Y=" } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403054	Unauthorized Access	A non-administrator user attempted to get data source revision information, but the caller doesn't have sufficient permissions.
404	404000	Site not found	The site LUID in the URI doesn't correspond to an existing site.
404	404004	Flow not found	The flow LUID in the URI doesn't correspond to an existing flow.
405	405000	Invalid request method	Request type was not POST.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Download User Credentials Gets credentials for a user who is being migrated to another Tableau Cloud or Tableau Server site. Before you use this method, you must create public and private keys for resources with embedded credentials. For more information, see [Migrate Workbooks and Data Sources with Embedded Credentials](https://help.tableau.com/current/server/en-us/cmt-migration_embedded_credentials.htm). **Version:** Available in API 3.23 (Tableau Cloud June 2024/ Tableau Server 2024.2) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** This method can only be called by Tableau Cloud and Tableau Server admins. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** tableau:oauth\_credentials:download - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI POST /api/api-version/sites/site-luid/users/user-luid/retrieveSavedCreds #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
user-luid	The LUID of the user whole credentials you want to download.

`destinationSiteUrlNamespace`	(Required) The site name on Tableau Cloud.
`destinationSiteLuid`	(Required) The site ID on Tableau Cloud.
`destinationServerUrl`	(Required) The destination Tableau Cloud URL.

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403054	Unauthorized Access	A non-administrator user attempted to get data source revision information, but the caller doesn't have sufficient permissions.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user.
405	405000	Invalid request method	Request type was not POST.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Download View Crosstab Excel Downloads an Excel (`.xlsx`) file containing crosstab data from a view that the user has permission to access in a workbook. If a crosstab is exported from a dashboard, data from only the first view in the dashboard will appear in the `.xlsx` file. Downloads of data from story dashboards are not supported at this time. If you make multiple requests for an `.xlsx`, subsequent calls return a cached version of the file. This means that the returned `.xlsx` might not include the latest changes to the workbook. To decrease the amount of time that a workbook is cached, use the maxAge parameter. Note the data exported is at a summary level only. Detail level data is only available as a download option in the user interface. This method includes the ability to filter a view using fields in the underlying workbook data. To learn more about filtering query views, see [Filtering and Sorting in the REST API](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm#Filter-query-views). #### URI GET /api/api-version/sites/site-id/views/view-id/crosstab/excel GET /api/api-version/sites/site-id/views/view-id/crosstab/excel?maxAge=max-age-minutes GET /api/api-version/sites/site-id/views/view-id/crosstab/excel?vf\_=_filter-value_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook.
view-id	The ID of the view to use as the source of the crosstab to be downloaded as an `.xlsx` file.
max-age-minutes	(Optional) The maximum number of minutes an `.xlsx` file will be cached on the server before being refreshed. To prevent multiple `.xlsx` requests from overloading the server, the shortest interval you can set is one minute. There is no maximum value, but the server job enacting the caching action may expire before a long cache period is reached.
filter-value	The value of the field that you want to use to filter the workbook view. For example, a workbook with the filter `/excel?vf_year=2017` would only display data from the year 2017. To learn more, see View filter queries.

#### Request Body None #### Permissions To export a crosstab to an `.xlsx` of a view, users who are not server administrators or site administrators need Read and ExportData permissions for the workbook containing the view and for the view itself. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:views:download ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body This method has no response body. The response is in the form of a downloaded `.xlsx` file. The response header content will have Content-Type: `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`. #### Version Version 3.9 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400101	Unknown error	There was a problem downloading or querying this file.
400	400130	Unknown error	The view ID in the URI doesn't correspond to a view available on the specified site.
401	4001XX	Unauthorized	The authentication token for the request is missing, invalid, or expired.
403	4031XX	Unauthorized	A user attempted to download a .xlsx file without Read and/or ExportData permissions for the workbook or view, and is not an administrator.
404	404xxx	Site or view not found	The site or view specified in the request could not be found.
405	405000	Invalid request method	Request type was not GET.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID of the site that contains the virtual connection.
virtualconnection-id	The LUID of the virtual connection to download. To get the LUID, use List Virtual Connections.

Unlike [Download Data Source](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_data_sources.htm#download_data_source), this method has no `includeExtract` parameter. If the virtual connection uses extracts, the download always includes them. Encrypted extracts are decrypted before packaging, so the downloaded `.tvcx` file can be published to any site. #### Request Body None #### cURL Request Example _(Use the icon in the top right corner to copy the text.)_ ``` curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd/content" -X GET -H "X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3" -o my-virtualconnection.tvcx ``` The response is a file that contains the virtual connection. #### Response Code 200 #### Response Headers `Content-Type: application/octet-stream` `Content-Disposition: name="tableau_virtual_connection_content"; filename="virtualconnection-filename.tvcx"` #### Response Body The virtual connection in `.tvcx` format, a binary ZIP archive with the following contents: ``` virtualconnection-name.tvcx (ZIP) virtualconnection-name.tvc The virtual connection schema (tables, columns, connections, and policy collection) Data/Extracts/*.hyper Hyper extracts. Present only if the virtual connection uses extracts. ``` A `.tvcx` file for a virtual connection that has only live tables contains just the `.tvc` schema file. #### Errors

HTTP status	`error` Code	Condition	Details
400	400200	Download virtual connection error	The virtual connection ID is not a valid ID, or the .tvcx file could not be built.
403	403174	Download virtual connection forbidden	The user does not have permission to download the virtual connection.
404	404000	Site not found	The site LUID in the URI doesn't correspond to an existing site.
404	404049	Virtual connection not found	The virtual connection does not exist.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Download Virtual Connection as JSON Downloads a JSON-representation of a virtual connection. _To download a virtual connection as a `.tvcx` file, see [Download Virtual Connection](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_virtual_connections.htm#download_virtual_connection)._ **Version:** Available in API 3.23 (Tableau Cloud June 2024 / Tableau Server 2024.2) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** Requires [Tableau Data Management](https://help.tableau.com/current/online/en-us/dm_overview.htm). **Permissions:** You must have the Overwrite permission for the virtual connection and your site role must be at least Creator. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:virtual\_connections:read - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-id/virtualconnections/virtualconnection-id #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID for the site.
virtualconnection-id	The LUID for the virtual connection.

#### Request Body None #### cURL Request Example _(Use the icon in the top right corner to copy the text.)_ ``` curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd" -X GET -H "Content-Type: application/xml" -H "X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3" ``` #### Response Code 200 #### Response Body ``` virtualconnection-as-json ``` ``` { "virtualConnection": { "project": { "id": "1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e" }, "owner": { "id": "9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d" }, "content": "virtualconnection-as-json", "name": "virtualconnection-name" } } ``` The response body contains the project LUID, owner LUID, and a content element (for XML output) or content property (for JSON output) containing the virtual connection schema rendered as JSON. If the response is XML, the content element is unescaped JSON. If the response is JSON, the content property is escaped JSON. #### Errors

HTTP status	`error` Code	Condition	Details
400	400200	Generic error	An unknown error occurred.
403	403174	User not authorized.	Check to make sure the user has the required permissions.
404	404049	Virtual connection not found	Check the virtual connection LUID.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Download Virtual Connection Revision as JSON Downloads a JSON-representation of an earlier revision of a virtual connection. **Version:** Available in API 3.23 (Tableau Cloud June 2024 / Tableau Server 2024.2) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** Requires [Tableau Data Management](https://help.tableau.com/current/online/en-us/dm_overview.htm). **Permissions:** You must have the Overwrite permission for the virtual connection and your site role must be at least Creator. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:virtual\_connections:read - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-id/virtualconnections/virtualconnection-id/revisions/revision-number #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID for the site.
virtualconnection-id	The LUID for the virtual connection.
revision-number	The revision number (revisionNumber) of the virtual connection, as returned by the Get Virtual Connection Revisions method. This is an integer, not a LUID.

#### Request Body None #### cURL Request Example _(Use the icon in the top right corner to copy the text.)_ ``` curl 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd/revisions' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3' ``` #### Response Code 200 #### Response Body ``` virtualconnection-as-json ``` ``` { "virtualConnection": { "project": { "id": "project-id" }, "owner": { "id": "owner-id" }, "content": "virtualconnection-as-json", "name": "virtualconnection-name" } } ``` The response body contains the project LUID, owner LUID, and a content element (for XML output) or content property (for JSON output) containing the virtual connection schema rendered as JSON. If the response is XML, the content element is unescaped JSON. If the response is JSON, the content property is escaped JSON. #### Errors

HTTP status	`error` Code	Condition	Details
400	400200	Generic error	An unknown error occurred. Check to make sure the revision number is a revision and not the active virtual connection.
403	403174	User not authorized.	Check to make sure the user has the required permissions.
404	404049	Virtual connection not found	Check the virtual connection LUID. Check that the revision number exists.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Download Workbook Downloads a workbook in `.twb` or `.twbx` format. **Security note:** Content in .twb or .twbx files downloaded using this method is stored in plain text. All data, including filter values that may give semantic clues to the data, will be readable by anyone who opens the files. #### URI GET /api/api-version/sites/site-id/workbooks/workbook-id/content GET /api/api-version/sites/site-id/workbooks/workbook-id/content?includeExtract=extract-value #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook.
workbook-id	The ID of the workbook to download.
extract-value	(Optional) The extract-value is a Boolean value (`False` or `True`). When the workbook specified for download has an extract, if you add the parameter `?includeExtract=False`, the extract is not included when you download the workbook. You can use this option to improve performance if you are downloading workbooks or data sources that have large extracts.

#### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can download a workbook only if they have ExportXml permission for the workbook (either explicitly or implicitly). #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:workbooks:download ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body One of the following, depending on the format of the workbook: - The workbook's content in `.twb` format (`Content-Type: application/xml`) - The workbook's content in `.twbx` format (`Content-Type: application/octet-stream`) In both cases, the response will have the following content disposition header: `Content-Disposition: name="tableau_workbook"; filename="workbook-filename"` #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403019	Read forbidden	A non-administrator user attempted to download a workbook, but the caller doesn't have ExportXml permission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404006	Workbook not found	The workbook ID in the URI doesn't correspond to an existing workbook.
405	405000	Invalid request method	Request type was not GET.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
workbook-luid	The LUID of the workbook to download the encrypted keychain from.

`destinationSiteUrlNamespace`	(Required) The site name on Tableau Cloud.
`destinationSiteLuid`	(Required) The site ID on Tableau Cloud.
`destinationServerUrl`	(Required) The destination Tableau Cloud URL.

#### cURL Request Example ``` curl --location "https://example.org/api/3.24/sites/7a2f773d-4a9f-496e-afc6-a60517cb1b86/workbooks/1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d/retrieveKeychain" -X POST --header "Content-Type: application/xml" --header "X-Tableau-Auth: nbQAstTxTHuBlcMlXZ3QKg|LXn5aiYcffck999kgpOPrQft5JkvRsYg|7a2f773d-4a9f-496e-afc6-a60517cb1b86" --data " site1 9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d http://example.com " ``` #### Response Code 200 #### Response Body ``` BADsJ5lBKho2Tdqqbo7txS8IyKgNw5FnJud0etCHJLhBUurgIRHk3g5AeMQg6KHBw+6nwNIDEd65MKi76DLd5aIMhQC5aLCR4NE7R2gp7JbxLo+nOMGnfDQm5XekJVpLQGfY53GIX52ED2iTfOQ0yRNbnPV4djT0z23rosG0gpmqXV/py5okFzVW4wx8RisnZdvv+SAlv222jVhksX1w5A6HB3Bs45BeWfpwrOnHwnNoWUGwHuu4iGlyE7m65RlATZN+fvDGOFN1zU2lXaSZyWqRKiWkD+oCS5wRNtJ6lGz7RnesKvH6QEL9sT8cXA1ZOEA531xNAv9rjazEP5BssIdA1GcJ5J7zar5xxC68qm3cz3MkndyqWXZrf0vWPgwysUHEpWn60oDG/8/xG6c0Eigh4gwE+dA+NF1L2q9VyhVr8+AzJ7vatf95LDwAuRT43G3Q+WApx9qBPXco15pKjwy00rHPgn4cRtu+unwh6d3gIh6AbK6X++U/vV/Ktpe31lSZmV8eHPeTNfdCrGOT9ozZhF5oKhsBZyFrVY7Wtf1YcXawh3bvtZxg9d8a2mKNXDeaF+uJrpI43aFa4KrJKdfvDpq2k0aJhL1QNxWSFBYw0tPJX/rhKAeOHHY2K44Wh5JNWwL+x1uYap93IK303sJ13hV0jXW7nXUhfIW7o5iUtbYWrpCvVwubZLf4U5Y= ``` ``` { "associatedUserLuidList": [], "encryptedKeychainList": { "encryptedKeychain": "BADsJ5lBKho2Tdqqbo7txS8IyKgNw5FnJud0etCHJLhBUurgIRHk3g5AeMQg6KHBw+6nwNIDEd65MKi76DLd5aIMhQC5aLCR4NE7R2gp7JbxLo+nOMGnfDQm5XekJVpLQGfY53GIX52ED2iTfOQ0yRNbnPV4djT0z23rosG0gpmqXV/py5okFzVW4wx8RisnZdvv+SAlv222jVhksX1w5A6HB3Bs45BeWfpwrOnHwnNoWUGwHuu4iGlyE7m65RlATZN+fvDGOFN1zU2lXaSZyWqRKiWkD+oCS5wRNtJ6lGz7RnesKvH6QEL9sT8cXA1ZOEA531xNAv9rjazEP5BssIdA1GcJ5J7zar5xxC68qm3cz3MkndyqWXZrf0vWPgwysUHEpWn60oDG/8/xG6c0Eigh4gwE+dA+NF1L2q9VyhVr8+AzJ7vatf95LDwAuRT43G3Q+WApx9qBPXco15pKjwy00rHPgn4cRtu+unwh6d3gIh6AbK6X++U/vV/Ktpe31lSZmV8eHPeTNfdCrGOT9ozZhF5oKhsBZyFrVY7Wtf1YcXawh3bvtZxg9d8a2mKNXDeaF+uJrpI43aFa4KrJKdfvDpq2k0aJhL1QNxWSFBYw0tPJX/rhKAeOHHY2K44Wh5JNWwL+x1uYap93IK303sJ13hV0jXW7nXUhfIW7o5iUtbYWrpCvVwubZLf4U5Y=" } } ``` ## Download Workbook PDF Downloads a `.pdf` containing images of the sheets that the user has permission to view in a workbook. Download Images/PDF permissions must be enabled for the workbook (true by default). If Show sheets in tabs is not selected for the workbook, only the default tab will appear in the `.pdf` file. If you make multiple requests for a PDF, subsequent calls return a cached version of the file. This means that the returned PDF might not include the latest changes to the workbook. To decrease the amount of time that a workbook is cached, use the maxAge parameter. **Version**: Available in API 3.4 and later. **License**: No additional license required. **Permissions**: To download a `.pdf` of a workbook, Tableau Server users who are not server administrators or site administrators need Read and ExportImage permissions for the workbook. The user needs Read and ExportImage permissions for a view in a workbook in order for that view to appear in the `.pdf`. **Access Scope**: `tableau:workbooks:download` - For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-id/workbooks/workbook-id/pdf?type=page-type&orientation=orientation GET /api/api-version/sites/site-id/workbooks/workbook-id/pdf?maxAge=max-age-minutes Available in API 3.23 (Tableau Cloud December 2024 / Tableau Server 2024.3) and later: GET /api/api-version/sites/site-id/workbooks/workbook-id/pdf?vf\_fieldname\=filter-value Available in API 3.26 (Tableau Cloud June 2025/ Tableau Server 2025.3) and later: GET /api/api-version/sites/site-id/workbooks/workbook-id/pdf?vizHeight=viz-height&vizWidth=viz-width #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook.
workbook-id	The ID of the workbook to use as the source of the .pdf file to be downloaded.
max-age-minutes	(Optional) The maximum number of minutes a workbook PDF will be cached before being refreshed. To prevent multiple PDF requests from overloading the server, the shortest interval you can set is one minute. There is no maximum value, but the server job enacting the caching action may expire before a long cache period is reached.
orientation	(Optional) The orientation of the pages in the .pdf file produced. The value can be `Portrait` or `Landscape`. If this parameter is not present the page orientation will default to `Portrait`.
page-type	(Optional) The type of page, which determines the page dimensions of the .pdf file returned. The value can be: `A3`, `A4`, `A5`, `B5`, `Executive`, `Folio`, `Ledger`, `Legal`, `Letter`, `Note`, `Quarto`, or `Tabloid`. If this parameter is not present the page type will default to `Legal`.
fieldname=filter-value	Available in API 3.23 (Tableau Cloud December 2024 / Server 2024.3) and later: (Optional) An expression that applies a granular filter to the request. Returns will be based on the value (filtervalue) of the dimension or measure (fieldname) of your view data you specify. For more information, see View filter queries.
viz-height	(Optional) The height of the rendered pdf image in pixels that, along with the value of `vizWidth`, determines its resolution and aspect ratio.
viz-width	(Optional) The width of the rendered pdf image in pixels that, along with the value of `vizHeight`, determines its resolution and aspect ratio.

HTTP status	`error` Code	Condition	Details
400	400101	Unknown error	There was a problem downloading or querying this workbook.
403	403004	Unauthorized	A non-administrator user attempted to download a pdf, but they don't have Read and/or ExportImage permissions for the workbook or user does not have Read permissions for the views of the workbook.
403	403105	Unauthorized	The PDF export feature is disabled on the server or the server is not configured to allow PDF exports using the REST API.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404006	Workbook not found	The workbook ID in the URI doesn't correspond to an existing workbook.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### cURL Request Example ``` curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/workbooks/1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d/pdf?maxAge=60" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -o "response.pdf" ``` The response is a file that contains the workbook, whose data is no older than 60 minutes, is saved as a pdf. ## Download Workbook PowerPoint Downloads a PowerPoint (`.pptx`) file containing slides with images of the sheets that the user has permission to view in a workbook. Download Images/PDF permissions must be enabled for the workbook (true by default). If Show sheets in tabs is not selected for the workbook, only the default tab will appear in the `.pptx` file. If you make multiple requests for a `.pptx`, subsequent calls return a cached version of the file. This means that the returned `.pptx` might not include the latest changes to the workbook. To decrease the amount of time that a workbook is cached, use the maxAge parameter. #### URI GET /api/api-version/sites/site-id/workbooks/workbook-id/powerpoint GET /api/api-version/sites/site-id/workbooks/workbook-id/powerpoint?maxAge=max-age-minutes #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook.
workbook-id	The ID of the workbook to use as the source of the `.pptx` file to be downloaded.
max-age-minutes	(Optional) The maximum number of minutes a workbook `.pptx` will be cached before being refreshed. To prevent multiple `.pptx` requests from overloading the server, the shortest interval you can set is one minute. There is no maximum value, but the server job enacting the caching action may expire before a long cache period is reached.

#### Request Body None #### Permissions To download a `.pptx` of a workbook, Tableau Server users who are not server administrators or site administrators need Read and ExportImage permissions for the workbook. The user needs Read and ExportImage permissions for a view in a workbook in order for that view to appear in the `.pptx`. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:workbooks:download ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body This method has no response body. The response is in the form of a downloaded `.pptx` file. The response header content will have Content-Type: `application/vnd.openxmlformats-officedocument.presentationml.presentation`. #### Version Version 3.8 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400101	Unknown error	There was a problem downloading or querying this workbook.
401	4001XX	Unknown error	There was a problem downloading or querying this workbook.
403	4031XX	Unauthorized	A non-administrator user attempted to download a .pptx file, but they don't have Read and/or ExportImage permissions for the workbook or user does not have Read permissions for the views of the workbook.
403	403105	Unauthorized	The PowerPoint export feature is disabled on the server or the server is not configured to allow PowerPoint exports using the REST API.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404006	Workbook not found	The workbook ID in the URI doesn't correspond to an existing workbook.
405	405000	Invalid request method	Request type was not GET.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook.
workbook-id	The ID of the workbook to download.
revision-number	The revision number of the workbook to download. To determine what versions are available, call Get Workbook Revisions. Note that the current revision of a workbook cannot be accessed by this call; use Download Workbook instead.
extract-value	(Optional) The extract-value is a Boolean value (`False` or `True`). When the workbook specified for download has an extract, if you add the parameter `?includeExtract=False`, the extract is not included when you download the workbook. You can use this option to improve performance if you are downloading workbooks or data sources that have large extracts.

#### Request Body None #### Permissions Users who are site administrators can download workbook revisions on the site that they are administrators for. Users who are not server administrators or site administrators can download workbook revisions if they have all of the following: - A site role of ExplorerCanPublish. - Read (view), Write (save), and Download (save as) permissions for the specified workbook. - Save (write) permissions for the project that contains the workbook. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:workbooks:download ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body One of the following, depending on the format of the workbook: - The workbook's content in `.twb` format (`Content-Type: application/xml`) - The workbook's content in `.twbx` format (`Content-Type: application/octet-stream`) In both cases, the response will have the following content disposition header: `Content-Disposition: name="tableau_workbook"; filename="workbook-filename"` #### Version Version 2.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403053	Version history not enabled	version history is not enabled for the specified site.
403	403019	Read forbidden	A non-administrator user attempted to download a workbook, but the caller doesn't have required permissions.
404	404024	Workbook revision not found	The revision number in the URI doesn't correspond to an existing data source revision.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404006	Workbook not found	The workbook ID in the URI doesn't correspond to an existing workbook.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Enable or disable analytics extensions on server Enables or disables analytics extensions on a server. **Version:** Available in API 3.11 ( Tableau Server 2021.1) and later. Not available for Tableau Cloud. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:extensions\_server\_settings:update\`. Added in API 3.28. Access Scopes Overview: [Access scopes for connected apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) PUT {server}/api/-/settings/server/extensions/analytics [view details](#) ## Encrypt Extracts in a Site Extract encryption at rest is a data security feature that allows you to encrypt .hyper extracts while they are stored on Tableau Server. For more information, see [Extract Encryption at Rest](https://help.tableau.com/current/server/en-us/security_ear.htm). Encrypts all extracts on a site. **Note:** Depending on the number and size of extracts, this operation may consume significant server resources. Consider running this command outside of normal business hours. #### URI POST /api/api-version/sites/site-id/encrypt-extracts #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site.

#### Request Body None #### Permissions Tableau Server administrators can call this method. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:extract_encryption:create ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body None #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
404	404000	Site not found	The specified site doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not POST.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Generate basic insight bundle Generates a basic insight bundle. **Version:** Available in API 3.24 (Tableau Cloud December 2024) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric in a definition as long as the user has read or connect access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insights:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/insights/basic [view details](#) ## Generate breakdown insight bundle Generates a breakdown insight bundle. This provides the BAN and breakdown groups of insights. **Version:** Available in API 3.26 (Tableau Cloud September 2025) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric in a definition as long as the user has read or connect access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insights:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/insights/breakdown [view details](#) ## Generate current metric value insight bundle Generates a bundle the current aggregated value for each metric. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric in a definition as long as the user has read or connect access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insights:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/insights/ban [view details](#) ## Generate detail insight bundle Generates a detail insight bundle. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric in a definition as long as the user has read or connect access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. For the [usage-based licensing model](https://help.tableau.com/current/online/en-us/license_product_keys.htm#usagebased-license-model), each call to this method counts as an analytical impression. **Access Scope:** \`tableau:insights:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/insights/detail [view details](#) ## Generate exploration insight bundle Generates an exploration insight bundle. This provides the BAN, anchor, and followup groups of insights. **Version:** Available in API 3.26 (Tableau Cloud September 2025) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric in a definition as long as the user has read or connect access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insights:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/insights/exploration [view details](#) ## Generate insight brief Generates an insight brief based on a user utterance by gathering insights for the specified metrics. For supplemental information, see **Version:** Available in API 3.26 (Tableau Cloud September 2025) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric in a definition as long as the user has read or connect access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_brief:create\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/insights/brief [view details](#) ## Generate metric card image Generates a PNG image of a Pulse metric card with full visual parity to the web UI homepage. **Version:** Available in API 3.29 (Tableau Cloud June 2026) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Can be called by any user. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insights:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/images/metricCard [view details](#) ## Generate springboard insight bundle Generates a springboard insight bundle. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric in a definition as long as the user has read or connect access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insights:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/insights/springboard [view details](#) ## Get a node by ID Get a single node by its ID, including its semantic statements and directly connected nodes. **Version:** Available in Tableau Cloud September 2026 and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any authenticated user. The user can read nodes allowed by content permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** Tableau Cloud+ **Access Scope:** \`tableau:knowledge:read\` [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/v1/knowledge/nodes/{node\_id} [view details](#) ## Get a Webhook Returns information about the specified webhook. #### URI GET /api/3.6/sites//webhooks/ #### Parameter Values

site-id	The ID of the site that contains the webhook.
webhook-id	The ID of the webhook.

## Get allowed dashboard extension on site - Retired in API 3.21 * * * Retired in API 3.21 (Cloud October 2023 / Server 2023.3) > > [!WARNING] > > > > In October 2023 Tableau Cloud and Tableau Server version 2023.3 releases, Tableau's REST API methods for dashboard extensions settings are retired. We recommend you replace dashboard extensions methods for enabling, listing, getting details of, and updating dashboard extensions with [Tableau extensions settings methods](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_tableau_extensions_settings.htm) that have similar functionality. * * * 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 Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Can only be called by users with site or server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/settings/site/extensions/dashboard/safeListItems/{safe\_list\_item\_luid} [view details](#) ## Get analytics extension details Get the details of a specified analytics extension connection to an external service. **Version:** Available in API 3.11 (Tableau Cloud March 2021/ Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Can only be called by users with site or server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:analytics\_extensions:read\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) or [Server](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/settings/site/extensions/analytics/connections/{connection\_luid} [view details](#) ## Get ask data lens - Retired in API 3.22 * * * Retired in API 3.22 (Cloud February 2024 / Server 2024.2) > > [!WARNING] > > > > **Important changes for Ask Data and Metrics** > > Tableau's Ask Data and Metrics features were retired in Tableau Cloud in February 2024 and in Tableau Server version 2024.2. With advances in natural language technologies, we're developing an improved interface that will make it easier to ask questions of your data and stay on top of changes. For more information, see [How Tableau GPT and Tableau Pulse are reimagining the data experience](https://www.tableau.com/blog/tableau-pulse-and-tableau-gpt). * * * Get the details of the specified ask data lens. **Version:** Available in API 3.16 ( Tableau Cloud June 2022 / Server 2022.3) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can be called by users who have Read access to the lens. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:lenses:read\` [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/askdata/lenses/{lens\_id} [view details](#) ## Get batch content usage statistics Gets usage statistics for multiple content items. The batch of can include multiple content types. **Version:** Available in API 3.17 ( Tableau Cloud December 2022) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Tableau administrators can get statistics for all content they administer. Other users can get statistics for any content they own or have at least Read permissions for. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:content:read\`. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/content/usage-stats [view details](#) ## Get blocked dashboard extension on server - Retired in API 3.21 * * * Retired in API 3.21 (Cloud October 2023 / Server 2023.3) > > [!WARNING] > > > > In October 2023 Tableau Cloud and Tableau Server version 2023.3 releases, Tableau's REST API methods for dashboard extensions settings are retired. We recommend you replace dashboard extensions methods for enabling, listing, getting details of, and updating dashboard extensions with [Tableau extensions settings methods](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_tableau_extensions_settings.htm) that have similar functionality. * * * 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](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/settings/server/extensions/dashboard/blockListItems/{block\_list\_item\_luid} [view details](#) ## Get Bridge Client Retrieves detailed information about a single Bridge client. Lookup is site-scoped. The response includes connection status, pool assignment (poolId, assignedToDefaultPool, unassigned), version, and ownership; lastStatusConnectedTime indicates when the client last connected (empty if never connected). This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:read` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-luid/bridge-clients/bridge-client-id #### URI Parameter Values

api-version	The version of the API to use. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
bridge-client-id	The unique identifier for the Bridge client to retrieve.

#### Request Body None #### Response Code 200 #### Response Body ``` ``` ``` { "bridgeClient": { "id": "12345", "name": "Bridge-Client-1", "status": "ONLINE", "version": "2024.1.0", "poolId": "abc-123-def-456", "assignedToDefaultPool": false, "unassigned": false, "lastStatusConnectedTime": "2024-10-30T10:30:00Z", "ownerName": "John Doe", "ownerEmail": "john.doe@example.com" } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	403000	Insufficient permissions	User does not have Site Administrator role.
404	503001	Bridge client not found	Bridge client with the specified ID does not exist on this site.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500	503002	Unexpected server error	An unexpected error occurred while retrieving the Bridge client.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get Connected App Query a connected app by its ID. #### URI GET api/_api-version_/sites/_site-id_/connected-apps/direct-trust/_client-id_ **Note:** The `connected-applications` endpoint that performed this function was deprecated in API 3.17 (Tableau Cloud October 2022 / Tableau Server 2022.3), is no longer supported and may be retired in a future release. #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
client-id	The unique ID of the connected app.

#### Request Body None #### Permissions Tableau Server admins or Tableau Cloud site admins only. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:connected_apps_direct_trust:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body The request returns details about the connected app, including the following: - ``: Information related to the secret only if it has been previously generated. To create a secret for a connected app, see [Create Connected App Secret](#create_connectedapp_secret). To get the secret value, see [Query Connected App Secret](#get_connectedapp_secret). - ``: Name of the connected app. - ``: Whether the connected app is enabled or not. - ``: The ID of the connected app. - `:` The project that the connected app's access level is scoped to. - `:` If specified, one or more domains that the connected app is allowed to be hosted on. - ``: Whether the connected app can be hosted on all domains. If `false` is returned, the `` attribute determines the domain access. **Example response:** ``` 7ecc5c7c-d923-4ffd-917b-cab1bd89f03b 2021-08-10T18:48:40Z ConnectedApp_MyCo true ac95d175-c844-4779-9d58-415e01fe7dab 1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e 1234de4e-5d6d-7c8c-9b0b-1a2a3f4f5e0e 2021-08-10T18:46:30Z false ``` #### Version Version 3.14 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). The resource, GET api/_api-version_/sites/_site-id_/connected-apps/direct-trust/_client-id_, was added in version 3.17. The original resource, GET api/_api-version_/sites/_site-id_/connected-applications/_client-id_, was deprecated in version 3.17 and will be retired in a future release. #### Errors

HTTP status	`error` Code	Condition	Details
400	400143	Generic connected app error	The connected app could not be deleted for some other reason than those specified in this table.
403	403000	Admin permissions required	A non-admin user called this method and doesn't have adequate permissions to perform the action.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404041	Connected app not found	The requested connected app could not be found.

## Get Connected App Secret Query a connected app secret and the token value using the connected app's ID. Secrets are tokens shared by Tableau and a custom application, and used to establish a trusted relationship. A maximum of two secrets can be associated with a connected app. These secrets do not expire and remain valid until deleted. #### URI GET api/_api-version_/sites/_site-id_/connected-apps/direct-trust/_client-id_/secrets/_secret-id_ **Note:** The `connected-applications` endpoint that performed this function was deprecated in API 3.17 (Tableau Cloud October 2022 / Tableau Server 2022.3), is no longer supported and may be retired in a future release. #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
client-id	The unique ID of the connected app.
secret-id	The unique ID of the connected app secret.

#### Request Body None #### Permissions Tableau Server admins or Tableau Cloud site admins only. #### Response Code 200 #### Response Body The request returns details about the secret associated with the connected app, including the following: - ``: The token value of the secret. - `:` The ID of the secret. **Example response:** ``` TO7/wkW+45U001IBtyNbtyIMYQ/GBM0XlRXqsgYqPlY= 7ecc5c7c-d923-4ffd-917b-cab1bd89f03b 2021-08-10T18:48:40Z ``` #### Version Version 3.14 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). The resource, GET api/_api-version_/sites/_site-id_/connected-apps/direct-trust/_client-id_/secrets/_secret-id_, was added in version 3.17. The original resource, GET api/_api-version_/sites/_site-id_/connected-applications/_client-id_/secrets/_secret-id_, was deprecated in version 3.17 and will be retired in a future release. #### Errors

HTTP status	`error` Code	Condition	Details
400	400143	Generic connected app error	The connected app could not be deleted for some other reason than those specified in this table.
403	403000	Admin permissions required	A non-admin user called this method and doesn't have adequate permissions to perform the action.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404041	Connected app not found	The requested connected app could not be found.
404	404042	Secret not found	The requested secret for the connected app could not be found.

## Get content search results Searches across all supported content types for objects relevant to the search expression specified in the querystring of the request URI. **Version:** Available in API 3.16 ( Tableau Cloud June 2022 / Server 2022.3) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Search results will be limited to those objects that the user has permissions to access. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:content:read\`. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/search [view details](#) ## Get Content Suggestions Returns a specified number of suggestions for auto-completion of user input as they type. You can specify content types of suggestions and prioritize recently viewed content. **Version:** Available in API 3.19 ( Tableau Cloud March 2023 / Server 2023.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Suggestions will be limited to those objects that the user has permissions to access. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:content:read\`. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/suggestions [view details](#) ## Get current analytics extension for workbook Gets basic details, including connection type and name, of the analytics extension connection to an external service that the specified workbook is currently using. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can be called by users that have permissions to the specified workbook. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:analytics\_extensions:read\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) or [Server](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/settings/site/extensions/analytics/workbooks/{workbook\_luid}/selected\_connection [view details](#) ## Get Current Server Session Returns details of the current session of Tableau Server. #### URI GET /api/api-version/sessions/current #### Parameter Values

api-version

The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.

#### Request Body None #### Permissions This method can be called by all authenticated users. #### Response Code 200 #### Response Body ``` ``` The response for users without administrator permissions contains only the site user, id, name, and content-url attributes. #### Version Version 3.1 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example Response ``` ``` ## Get Custom Domain Name Gets the custom domain for a Tableau site, if one is provisioned. For more information about how, see **Version:** Available in API 3.26 (Tableau Cloud June 2025) and later. Not available for Tableau Server. [Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Can be called by any user that is a member of the site associated with the custom domain. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:custom\_domains:read\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/customdomains/site/{site\_luid} [view details](#) ## Get custom domain settings Gets the custom domain settings for a Tableau site. **Version:** Available in API 3.26 (Tableau Cloud June 2025) and later. Not available for Tableau Server. [Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Only users with administrator permissions can view a site's custom domain settings. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:custom\_domains:read\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/customdomains/settings/site/{site\_luid} [view details](#) ## Get Custom View Gets the details of a specified custom view. **Version:** Available in API 3.18 (Tableau Cloud December 2022 / Server 2023.1). _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Tableau administrators can get the details of a custom view. Other users can get the details of any custom view that they have **Read** permissions for. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:content:read - Scope added in API 3.18 (Tableau Cloud December 2022 / Tableau Server 2023.1). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-luid/customviews/custom-view-luid #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
custom-view-luid	The LUID for the custom view being updated.

#### Request Body None. #### cURL Request Example `curl -L -X GET "https://qa-near/api/3.18/sites/a946d998-2ead-4894-bb50-1054a91dcab3/customviews/37d015c6-bc28-4c88-989c-72c0a171f7aa" -H "X-Tableau-Auth: njR9EGn0QSCpbDrUOh0IKg"wamRRyVFFUHTVwFL6OWEyOggxCwWYXuq"a946d998-2ead-4894-bb50-1054a91dcab3"` #### Response Code 200 #### Response Body ``` ``` ``` { "pagination": { "pageNumber": "1", "pageSize": "100", "totalAvailable": "1673" }, "customView": { "id": "37d015c6-bc28-4c88-989c-72c0a171f7aa", "name": "New name 2", "createdAt": "2016-02-03T23:35:09Z", "updatedAt": "2022-09-28T23:56:01Z", "lastAccessedAt": "2022-09-28T23:57:12Z", "shared": "false", "view": { "id": "8e33ff19-a7a4-4aa5-9dd8-a171e2b9c29f", "name": "circle" }, "workbook": { "id": "2fbe87c9-a7d8-45bf-b2b3-877a26ec9af5", "name": "marks and viz types 2" }, "owner": { "id": "cdfe8548-84c8-418e-9b33-2c0728b2398a", "name": "workgroupuser" } } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403162	Unauthorized Access	The user does not have adminstrator permissions or Read permissions for the custom view..
404	404008	Resource Not Found	A custom view with the requested LUID could not be found.
405	405000	Invalid Request Method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get Custom View Data Returns a specified custom view rendered as data in comma separated value (CSV) format. **Version**: Available in API 3.23 (Tableau Cloud December 2024 / Server 2024.3) and later. **License**: No additional license required. **Permissions**: Tableau Server users who are not server administrators or site administrators can query workbook views only if they have Read (view) and Export data permissions for the underlying view (either explicitly or implicitly). **Access Scope**: `tableau:views:download` - For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). CSV data is provided in the response body, rather than as a download. If the request is for a dashboard, only data for the dashboard's first view is returned. If you make multiple requests for a custom view's data, subsequent calls return a cached version of the data. This means that the returned data might not include the latest changes to the custom view. To decrease the amount of time that data of a custom view is cached, use the maxAge parameter. Default age of data is 60 minutes. For Tableau Cloud, concurrent requests to endpoints that start long-running jobs, including this one, are limited to 20 at a time. A 429 HTML response means that a request exceeded the limit and should be retried at a later time. (introduced September 2021). Note the data exported is at a summary level only. Detail level data is only available as a download option in the user interface. This method includes the ability to filter a view using fields in the underlying workbook data. To learn more about filtering query views, see [Filtering and Sorting in the REST API](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm#Filter-query-views). #### URI GET /api/api-version/sites/site-id/customviews/custom-view\_luid/data GET /api/api-version/sites/site-id/customviews/custom-view\_luid/data?maxAge=max-age-minutes GET /api/api-version/sites/site-id/customviews/custom-view\_luid/data?vf\__fieldname_\>=_filter-value_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the view.
custom-view-luid	The ID of the view to render as data.
max-age-minutes	(Optional) The maximum number of minutes view data will be cached before being refreshed. To prevent multiple view data requests from overloading the server, the shortest interval you can set is one minute. There is no maximum value, but the server job enacting the caching action may expire before a long cache period is reached.
fieldname=filter-value	(Optional) An expression that applies a granular filter to the request. Returns will be based on the value (filtervalue) of the dimension or measure (fieldname) of your view data you specify. For more information, see View filter queries.

#### Request Body None #### cURL Request `curl "http://MY-SERVER/api/3.29/sites/1edc53ac-e247-4870-9fd3-6fad0ce5f84d/customviews/2474164d-8d37-4a4c-abc7-c2070fd25fd5/data?maxAge=60" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` #### Response Code 200 #### Response Body The response body contains view data in CSV format no more than 60 minutes old. ``` Month of Date,Year of Date,Above Median?,Avg. Median January,1893,below median,-1.0 January,1864,below median,-0.9 January,1861,below median,-0.9 December,1862,below median,-0.9 March,1917,below median,-0.8 December,1892,below median,-0.8 February,1862,below median,-0.8 February,1911,below median,-0.8 February,1917,below median,-0.8 May,1861,below median,-0.8 November,1862,below median,-0.8 March,1898,below median,-0.8 December,1860,below median,-0.8 January,1862,below median,-0.7 March,1850,below median,-0.7 February,1893,below median,-0.7 December,1870,below median,-0.7 ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400080	Bad Request	The view ID in the URI doesn't correspond to a view available on the specified site.
401	401002	Unauthorized	The authentication token provided in the request header was invalid or has expired.
403	403032	Read forbidden	A non-administrator user attempted to get custok views, but the caller doesn't have Read or Expot imagepermission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.
429	429000	Concurrent request limit exceeded	For Tableau Cloud, the cumulative number of concurrent requests has exceeded the limit of 20. This limit applies to long-running jobs such as exports and downloads for view data, images, .pdf or .pptx files, datasources, and crosstabs, Retry this request at a later time. Introduced September 2021.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get Custom View Image Downloads an image file of the specified custom view. **Version:** Available in API 3.18 (Tableau Cloud December 2022 / Server 2023.1). _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Tableau administrators download the image of a custom view. Other users candownload the image of any custom view that they have **Publish** permissions for. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:views:download - Scope added in API 3.18 (Tableau Cloud December 2022 / Tableau Server 2023.1). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-id/customviews/view-id/image GET /api/api-version/sites/site-id/customviews/view-id/image?resolution=image-resolution GET /api/api-version/sites/site-id/customviews/view-id/image?maxAge=max-age-minutes GET /api/api-version/sites/site-id/customviews/view-id/image?vf\_=_filter-value_ Available in API 3.29 (Tableau Cloud June 2026 / Server 2026.2 and later: GET /api/api-version/sites/site-id/customviews/view-id/image?format=image-format #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID for the site.
view-id	The LUID for the custom view being updated.
image-resolution	(Optional) The resolution of the image. Image width and actual pixel density are determined by the display context of the image. Aspect ratio is always preserved. Set the value to `high` to ensure maximum pixel density.
max-age-minutes	(Optional) The maximum number of minutes a view image will be cached before being refreshed. To prevent multiple image requests from overloading the server, the shortest interval you can set is one minute. There is no maximum value, but the server job enacting the caching action may expire before a long cache period is reached.
filter-value	The value of the field that you want to use to filter the workbook view. For example, a workbook with the filter `/data?vf_year=2017` would only display data from the year 2017. To learn more, see View filter queries.
image-format	(Optional) The format of the returned image. Valid values are `png` (default) or `svg`. Available in API 3.29 and later.

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403162	Unauthorized Access	The user does not have adminstrator permissions or Read permissions for the custom view..
404	404008	Resource Not Found	A custom view with the requested LUID could not be found.
405	405000	Invalid Request Method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get Custom View PDF Returns a specified custom view rendered as a .pdf file. **Version**: Available in API 3.23 (Tableau Cloud December 2024 / Server 2024.3) and later. **License**: No additional license required. **Permissions**: Tableau Serverand site administrators can get custom views as PDFs. Other users can do this only if they have Read (view) and Export image permissions for the views (either explicitly or implicitly). **Access Scope**: `tableau:views:download` - For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). If you make multiple requests for a PDF, subsequent calls return a cached version of the file. This means that the returned PDF might not include the latest changes to the custom view. To decrease the amount of time that an PDF is cached, use the maxAge parameter. This method includes the ability to filter a view using fields in the underlying workbook data. To learn more about filtering query views, see [Filtering and Sorting in the REST API](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm#Filter-query-views). #### URI GET /api/api-version/sites/site-luid/customviews/custom-view-luid/pdf GET /api/api-version/sites/site-luid/customviews/custom-view-luid/pdf?vizHeight=viz-height&vizWidth=viz-width GET /api/api-version/sites/site-luid/customviews/custom-view-luid/pdf?maxAge=max-age-minutes GET /api/api-version/sites/site-luid/customviews/custom-view-luid/pdf?type=page-type&orientation=orientation GET /api/api-version/sites/site-luidcustomviews/custom-view-luid/pdf?vf\_fieldname\=filter-value #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The ID of the site that contains the view.
custom-view-luid	The ID of the view to render as a .pdf file.
viz-height	(Optional) The height of the rendered pdf image in pixels that, along with the value of `vizWidth`, determines its resolution and aspect ratio.
viz-width	(Optional) The width of the rendered pdf image in pixels that, along with the value of `vizHeight`, determines its resolution and aspect ratio.
max-age-minutes	(Optional) The maximum number of minutes a view PDF will be cached before being refreshed. To prevent multiple PDF requests from overloading the server, the shortest interval you can set is one minute. There is no maximum value, but the server job enacting the caching action may expire before a long cache period is reached.
orientation	(Optional) The orientation of the pages in the .pdf file produced. The value can be `Portrait` or `Landscape`. If this parameter is not present the page orientation will default to `Portrait`.
page-type	(Optional) The type of page, which determines the page dimensions of the .pdf file returned. The value can be: `A3`, `A4`, `A5`, `B5`, `Executive`, `Folio`, `Ledger`, `Legal`, `Letter`, `Note`, `Quarto`, or `Tabloid`. If this parameter is not present the page type will default to `Legal`.
fieldname=filter-value	(Optional) An expression that applies a granular filter to the request. Returns will be based on the value (filtervalue) of the dimension or measure (fieldname) of your view data you specify. For more information, see View filter queries.

#### Request Body None #### Response Code 200 #### Response Body This method has no response body. The response is in the form of a downloaded `.pdf` file. The response header content will have `Content-Type:application/pdf`. #### cURL Example ``` curl "http://MY-SERVER/api/3.29/sites/1edc53ac-e247-4870-9fd3-6fad0ce5f84dcustomviews/2474164d-8d37-4a4c-abc7-c2070fd25fd5/pdf/maxAge=60" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" ``` The response is a file that contains the view, whose data is no older than 60 minutes, saved as a pdf. #### Errors

HTTP status	`error` Code	Condition	Details
400	400080	Bad Request	The view ID in the URI doesn't correspond to a view available on the specified site.
401	401002	Unauthorized	The authentication token provided in the request header was invalid or has expired.
403	403032	Read forbidden	A non-administrator user attempted to query workbook views, but the caller doesn't have Read permission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get Data Acceleration Report for a Site Returns a report about data acceleration for the site. It lets you compare page load times for before and after data acceleration is enabled. This method is not available for Tableau Cloud. **Important changes for Tableau View Acceleration and Data Acceleration** Tableau's View Acceleration feature and Data Acceleration APIs are retired. These features were retired in Tableau Cloud in June 2026 and in Tableau Server version 2026.2. #### URI GET /api/api-version/sites/site-id/dataAccelerationReport #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the task.

sheetURI	The URI of the sheet in the workbook.
unacceleratedSessionCount	The number of sessions that were created to load the workbook sheet before it was accelerated. For example, if you loaded it 7 times in a row, the session is reused so the count will still be 1. Generally, the more data you compare, the better the comparison is. Note: If sheets were loaded but never accelerated, they are not shown.
averageUnAcceleratedPLT	The average page load time for the sheet before it was accelerated.
acceleratedSessionCount	The number of sessions that were created to load the workbook sheet after it was accelerated.
averageAcceleratedPLT	The average page load time for the sheet after it was accelerated.

#### Version In Tableau Server 2020.2 (API 3.8) through 2021.4 (API 3.15) data acceleration is supported. **Important changes for Tableau View Acceleration and Data Acceleration** Tableau's View Acceleration feature and Data Acceleration APIs are retired. These features were retired in Tableau Cloud in June 2026 and in Tableau Server version 2026.2. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	40500	Invalid requests method	Request type was not GET

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/dataAccelerationReport" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` **Example response:** ``` ... ``` ## Get Data Acceleration Tasks in a Site Returns a list of data acceleration tasks for the site. This method is not available for Tableau Cloud. **Important changes for Tableau View Acceleration and Data Acceleration** Tableau's View Acceleration feature and Data Acceleration APIs are retired. These features were retired in Tableau Cloud in June 2026 and in Tableau Server version 2026.2. #### URI GET /api/api-version/sites/site-id/tasks/dataAcceleration #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the task.

... additional tasks ... ``` #### Version In Tableau Server 2020.2 (API 3.8) through 2021.4 (API 3.15) data acceleration is supported. **Important changes for Tableau View Acceleration and Data Acceleration** Tableau's View Acceleration feature and Data Acceleration APIs are retired. These features were retired in Tableau Cloud in June 2026 and in Tableau Server version 2026.2. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

403	409087	Permission denied	The user isn't authorized to view data acceleration tasks.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	40500	Invalid requests method	Request type was not GET

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/tasks/dataAcceleration" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` **Example response:** ```

``` ## Get Data Source Revisions Returns a list of revision information (history) for the specified data source. **Note:** This method is available only if version history is enabled for the specified site. For more information, see [Maintain a History of Revisions](https://help.tableau.com/current/server/en-us/help.htm#revision_history_maintain.htm) in the Tableau Server Help. To get a specific version of the data source from revision history, use the [Download Data Source Revision](#download_data_source_revision) method. #### URI GET /api/api-version/sites/site-id/datasources/datasource-id/revisions GET /api/api-version/sites/site-id/datasources/datasource-id/revisions?pageSize\=page-size&pageNumber\=page-number #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the data source to get revisions for.
datasource-id	The ID of the data source to get revisions for.
page-size	(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number	(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.

#### Request Body None #### Permissions Tableau Server users who are site administrators can get data source revisions on the site that they are administrators for. Users who are not server administrators or site administrators can get data source revisions if they have all of the following: - A site role of ExplorerCanPublish. - Read (view), Write (save), and Download (save as) permissions for the specified data source. - Save (write) permissions for the project that contains the data source. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:content:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` If the revision element includes the attribute `deleted="true"`, the data source has been deleted and cannot be downloaded using the [Download Data Source Revision](#download_data_source_revision) method. If a user has been deleted from the site, no `` element is included in the `` element. #### Version Version 2.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400006	Invalid page number	The page number parameter is not an integer, is less than one, or is greater than the final page number for data sources at the requested page size.
400	400007	Invalid page size	The page size parameter is not an integer, or is less than one.
403	403014	Page size limit exceeded	The specified page size is larger than the maximum page size.
403	403053	Version history not enabled	version history is not enabled for the specified site.
403	403054	A non-administrator user attempted to get data source revision information, but the caller doesn't have sufficient permissions.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404		Data source not found	The data source ID in the URI doesn't correspond to an existing data source.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get Data-Driven Alert Returns details on a specified data-driven alert, including the recipients of the alert. #### URI GET /api/_api-version_/sites/_site-id_/dataAlerts/_data-alert-id_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the specified data-driven alert.
data-alert-id	The ID of the data-driven alert. You can obtain this ID by calling Query Data-Driven Alerts.

**Version:** Available in API 3.20 (Tableau Cloud June 2023) and later. Not available for Tableau Server. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Users with the Administrator, Creator, or Explorer role can add DDAs to views they have permissions to. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:data\_driven\_alerts:read - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Request Body None #### Response Code 200 #### Response Body ``` ``` The **createdAt** and **updatedAt** values are dates and times in UTC format (YYYY-MM-DDTHH:MM:SSZ). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Read forbidden	A user queried this method who does not have the required permissions
404	409023	Resource Not Found	The data-driven alert ID specified in the URI is invalid.
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/13020592-762f-4de4-a25e-f4beb005836e/dataAlerts/e5a4b73e-5cbb-412d-907e-f31cc31684f7" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` **Example response:** ``` ``` ## Get Databases and Tables from Connection Query databases and tables from the connection information in the data source (.tds or .tdsx) or workbook (.tws or .twbx) file's XML. **Note:** This method can't be used to query databases and tables when the database is an embedded asset. For more information about embedded assets see one of the following: - For Tableau Cloud, see [Embedded asset appears in External Assets](https://help.tableau.com/current/online/en-us/dm_lineage.htm#embedded-asset-appears-in-external-assets). - For Tableau Server, see [Embedded asset appears in External Assets](https://help.tableau.com/current/server/en-us/dm_lineage.htm#embedded-asset-appears-in-external-assets). #### URI POST api/_api-version_/sites/_site-id_/databaseAndTables/lookup #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.

#### Request Body ``` encoded_xml ``` #### Attribute Values

embedded	(Optional) Indicates whether the database is embedded or not. Use "false" if the database is not embedded and "true" if the database is embedded. For more information about embedded databases (and tables), see one of the following topics: For Tableau Cloud, see Embedded asset appears in External Assets. For Tableau Server, see Embedded asset appears in External Assets.
datasource-name	(Optional) The data source name that can be found in the XML of the data source (.tds or .tdsx) or workbook (.tws or .twbx) file.
datasource-format	(Optional) The format of the data source that can be found in the XML of the data source (.tds or .tdsx) or workbook (.tws or .twbx) file.
encoded_xml	This is the encoded version of the connection element (`<connection>...</connection>`) in the XML of the data source (.tds or .tdsx) or workbook (.tws or .twbx) file. Before you begin, make a copy of the data source or workbook file to ensure you have a backup. To encode the `connection` element, you can use a free online base64 encoding tool or write a simple script. Note: Make sure there are no extra spaces between the `connection` element's start and end tags. For example, after encoding the connection element, the generated encoding should look like `<base64xml>...</base64xml>`. If the generated encoding looks like `<base64xml> ... </base64xml>`, you might see an invalid parameter (409097) error.

#### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to query databases and tables from the connection: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have "derived permissions" (if enabled) or have been granted explicit "Read" (view) permissions to the asset Otherwise, authorized users who have "derived permissions" (if enabled), and Tableau Server admins or Tableau Cloud site admins. #### Response Code 200 #### Response Body **Example response** ``` ``` **Note:** Both `databaseAnchor` and `tableAnchor` IDs returned from this request correspond to `database` and `table` IDs that you can use to retrieve additional information about databases and tables endpoints using other REST endpoints, including [Query Database](#query_database) and [Query Table](#query_table). #### Version Version 3.13 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
409	409095	Generic asset retrieval error	The database and table information could not be queried for some reason other than those specified in this table.
409	409096	Unauthorized operation	Insufficient permissions to perform the operation.
409	409097	Invalid parameter	One or more values in the request body are invalid.

## Get details of a collection Gets the details of a collection. **Version:** Available in API 3.28 (Cloud February 2026 / Server 2026.2) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Tableau administrators can call this method for all sites they administer. Other users can call this method for collections that they own. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:collections:read. Added in API 3.28. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/collections/{luid} [view details](#) ## Get Domain Mapping Retrieves information about all domain mappings for the site, including pool assignment and status (ALLOWED or BLOCKED). When status is ALLOWED, poolId is the pool UUID; when BLOCKED, poolId is the string "BLOCKED". URL-encode special characters in domain names in the request. This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:read` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-luid/bridge-domain-maps #### URI Parameter Values

api-version	The version of the API to use. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.

#### Request Body None #### Response Code 200 #### Response Body ``` ``` ``` { "bridgeDomain": { "domain": [ { "name": "abc.test.com", "status": "BLOCKED", "poolId": "BLOCKED" }, { "name": "*.myco.lan", "status": "ALLOWED", "poolId": "185da21c-1598-4b2f-9137-fa632e935bf1" } ] } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	403000	Insufficient permissions	User does not have Site Administrator role.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500	503908	Unexpected server error	An unexpected error occurred while retrieving the domain.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get Embedding Settings for a Site Returns the current embedding settings for a specific site. Embedding settings can be used to restrict embedding Tableau views to only certain domains. This setting impacts all embedding scenarios including, Tableau Javascript API v2, Embedding API v3, and the embed code from the share dialog. For more information, see the [Tableau Site Settings for Embedding](https://help.tableau.com/current/api/embedding_api/en-us/docs/embedding_api_site.html) topic in the Tableau Embedding v3 Help. Beginning in version 2023.2 (June 2023) for Tableau Cloud and in version 2023.3 for Tableau Server, this setting might impact embedding scenarios that use Tableau connected apps. For more information, see the “[Control where content can be embedded](https://help.tableau.com/current/online/en-us/connected_apps_eas.htm#allowlist)” section in the connected apps topic in the Tableau Cloud Help. #### URI GET /api/api-version/sites/site-id/settings/embedding #### Path Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the views.

#### Request Body None #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:embedding_site_settings:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Permissions Any Tableau Cloud or Tableau Server user can call this method. #### Response Body ```

``` ##### Example Response ``` ``` #### Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/settings/embedding" -X GET -H "X-Tableau-Auth:1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d"` #### Version API version 3.16 and later. #### Errors

HTTP status	`error` Code	Condition	Details
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get enabled state of analytics extensions on server Gets the enabled/disabled state of analytics extensions on a server. **Version:** Available in API 3.11 ( Tableau Server 2021.1) and later. Not available for Tableau Cloud. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:extensions\_server\_settings:read\`. Added in API 3.28. Access Scopes Overview: [Access scopes for connected apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/settings/server/extensions/analytics [view details](#) ## Get enabled state of analytics extensions on site Gets the enabled/disabled state of analytics extensions on a site. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server or site administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:analytics\_extensions:read\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) or [Server](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/settings/site/extensions/analytics [view details](#) ## Get Extract Refresh Task Returns information about a site's scheduled extract refresh task for a data source, workbook, or virtual connection. #### URI GET /api/api-version/sites/site-id/tasks/extractRefreshes/task-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that the user is a member of.
task-id	The ID of the extract refresh that you want information about.

#### JWT Access Scope Available in API 3.20 (Tableau Cloud June 2023). `tableau:tasks:read` (this scope is included in the scope: `tableau:tasks`) For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can only access the list of extract refresh tasks that they own. #### Response Code 200 #### Response Body Tableau Server and Tableau Cloud return different payloads in response to this request. Output for virtual connections includes `transactionLevel` and table ids in addition to the output that's standard for data sources and workbooks. ### Tableau Server Response For Tableau Server an extract refresh task with a server schedule is returned. ``` ``` ``` [ { "extractRefresh": { "id": "refresh_task_id", "priority": "nn", "consecutiveFailedCount": "n", "type": "REFRESH_EXTRACT", "schedule": { "id": "schedule_id", "name": "schedule_name", "state": "state", "priority": "nn", "createdAt": "DATE_TIME", "updatedAt": "DATE_TIME", "type": "Extract", "frequency": "frequency", "nextRunAt": "DATE_TIME" }, "datasource": { "id": "datasource_id" } } }, [] ] ``` ### Tableau Cloud Response For Tableau Cloud an extract refresh task with its frequency is returned. ``` ``` ``` { "task": { "extractRefresh": { "id": "0ece2369-c4eb-4382-be0f-961039d708a0", "priority": "50", "consecutiveFailedCount": "5", "type": "RefreshExtractTask", "schedule": { "frequency": "Weekly", "nextRunAt": "2023-06-08T04:50:00Z", "frequencyDetails": { "start": "21:50:00", "intervals": { "interval": [ { "weekDay": "Thursday" } ] } } }, "workbook": { "id": "7e766949-7166-4b3d-90ba-784f7575743b" } } } } ``` #### Version Version 2.6 and later. Virtual connection support added in 3.30. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

403	403004	Operation unauthorized	The user is not authorized to get the task.
404	404026	Task not found	The task ID in the URI doesn't correspond to an existing task.
405	405000	Invalid requests method	Request type was not GET

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get Favorites for User Returns a list of favorite projects, data sources, views, workbooks, and flows for a user. #### URI GET /api/api-version/sites/site-id/favorites/user-id GET /api/api-version/sites/site-id/favorites/user-id?pageSize=page-size&pageNumber=page-number #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that the user is a member of.
user-id	The ID of the user for which you want to get a list favorites.
page-size	(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number	(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.

#### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can call this method only if they are the user for which they want to get a list of favorites. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:content:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` The value of view-url-name is the name of the view in its URL. For example, if a view named `View 1` shows the URL `https://MY_SERVER/#/site/MY_SITE/views/VIEW_1` in your browser address bar, then the view-url-name would be `VIEW_1`. Modifying the name (display name) of a view will not impact the view-url-name (path element of the view's URL). #### Response when favorite items have been deleted In the case where an item selected as a favorite has been deleted the response body will contain only the label of the favorite. ``` ``` #### Version Version 2.5 and later. Support for favorite projects added in version 3.1. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

403	403004	Forbidden Favorites access	A non-administrator user called this method but doesn't have permission to view the specified user's favorites.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the flow.
flow-run-id	The ID of the flow run.

#### Request Body None #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:flow_runs:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` The status attribute can be: Pending, InProgress, Success, Cancelled, or Failed. #### Version Version 3.10 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Get forbidden	User does not have permissions to get the flow run. A user can view a flow run if they have permission to view the flow.
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
404	404036	Flow run not found	The flow run ID in the URI doesn't correspond to an existing flow run.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get Flow Run Task Returns information about the specified flow run task. This method shows you information about the scheduled task for the flow. #### URI GET /api/api-version/sites/site-id/tasks/runFlow/task-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that the user is a member of.
task-id	The ID of the scheduled flow run task that you want information about.

#### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can only access the list of scheduled flow run tasks that they own. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:flow_tasks:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` #### Version Version 3.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Operation unauthorized	The user is not authorized to get the task.
404	404026	Task not found	The task ID in the URI doesn't correspond to an existing task.
405	405000	Invalid request method	Request type was not GET.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that the user is a member of.

#### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can only access the list of scheduled flow tasks for the flows that they own. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:flow_tasks:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ... additional tasks ... ``` #### Version Version 3.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/tasks/runFlow" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` **Example response:** ``` ``` ## Get Flow Runs Get flow runs. #### URI GET /api/api-version/sites/site-id/flows/runs GET /api/api-version/sites/site-id/flows/runs?filter=filter-expression #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site.
filter-expression	(Optional) An expression that lets you specify a subset to return. You can filter on predefined fields such as the `userId` of the user who started the flow run, `flowId`, `progress`, `startedAt`, and `completedAt`. You can include multiple filter expressions. For more information, see Filtering and Sorting.

#### Request Body None #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:flow_runs:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ... additional flow runs.... ``` The status attribute can be: Pending, InProgress, Success, Cancelled, or Failed. #### Version Version 3.10 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Get forbidden	User does not have permissions to get the flow run.
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the filter doesn't correspond to an existing user.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get graph-health suggestions Get a report on the health of the graph, including a score and suggested improvements. **Version:** Available in Tableau Cloud September 2026 and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any authenticated user. The user can read nodes allowed by content permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** Tableau Cloud+ **Access Scope:** \`tableau:knowledge:read\` [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/v1/knowledge/suggestions/search [view details](#) ## Get Group Set Returns information about the specified group set including ID, name, and member groups. **Version:** Available in API 3.22 (Tableau Cloud February 2024 / Server 2024.2) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** This method can only be called by Tableau Server administrators or Tableau Cloud site admins. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** tableau:groupsets:read - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-id/groupsets/group-set-id #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the group.
group-set-id	The ID of the group set you want information for.

#### Request Body None #### cURL Request Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/groupsets/8cf3b6c1-839f-4eae-b41f-2144165193f2" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` #### Response Code 200 #### Response Body Copy ``` ``` Copy ``` { "groupSet": { "id": "8cf3b6c1-839f-4eae-b41f-2144165193f2", "name": "All Users", "groupCount": "2", "group": [ { "id": "9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d", "name": "All Users" }, { "id": "4123e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6234", "name": "Researchers" } ] }} ``` #### Version Version 3.22 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	The request type wasn’t GET.
409	409120	Group set not found	The group set ID in the request body doesn't correspond to an existing group set.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get Groups for a User Gets a list of groups of which the specified user is a member. #### URI GET /api/api-version/sites/site-id/users/user-id/groups GET /api/api-version/sites/site-id/users/user-id/groups?pageSize=page-size&pageNumber=page-number #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the group.
user-id	The ID of the user whose group memberships are listed.
page-size	(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number	(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.

#### Request Body None #### Permissions This method can only be called by server administrators and site administrators. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:users:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` **Notes:** - Starting in July 2026 (version 3.29), the externalUserEnabled attribute (Tableau Cloud only) is omitted from the element in the response if the site isn't licensed for on-demand access. #### Version Version 3.7 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400006	Invalid page number	The page number parameter is not an integer, is less than one, or is greater than the final page number for data sources at the requested page size.
400	400007	Invalid page size	The page size parameter is not an integer, or is less than one.
403	403014	Page size limit exceeded	The specified page size is larger than the maximum page size.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404012	User not found	The group ID in the URI doesn't correspond to an existing user.
405	405000	Invalid request method	Request type was not GET.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The unique LUID of the site asset.
label-luid	The unique LUID of the label asset.

#### Request Body None #### Permissions To view a data label, you must have read permissions on the associated asset. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2024 and Tableau Server 2024.2 (API 3.23). ``` tableau:labels:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` #### Version Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
401	400103	Generic query label error	An unknown error occurred.
403	403004	Operation on resource unauthorized	Insufficient permissions to perform the operation.
404	404030	Label not found	The label LUID doesn't correspond to an existing project.
409	409004	Invalid parameter	One or more values in the request body are invalid.

## Get Labels Displays information about the data labels on one or more assets. You can optionally limit the data labels to show by category using a query string. For more information on data label objects and properties, see the [Data Labels in the REST API](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_data_labels.htm) topic. All label operations except those related to the certification of data sources require Catalog to be enabled. Catalog requires a Data Management license. #### URI POST api/api-version/sites/site-luid/labels POST api/api-version/sites/site-luid/labels?categories=category-list #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The unique LUID of the site asset.
category-list	(Optional) A comma-separated list of label value categories used to limit the labels shown to only the listed categories. See Data Labels in the REST API for information on label values and categories.

#### Request Body ``` ``` #### Attribute Values

asset-type

The type of asset. Valid asset types are:

database
table
column - Available in API 3.16 and later (Tableau Cloud October 2022, Server 2022.3)
datasource
flow
virtualconnection
virtualconnectiontable

asset-luid

The asset LUID.

#### Permissions To view a data label, you must have read permissions on the associated asset. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2024 and Tableau Server 2024.2 (API 3.23). ``` tableau:labels:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ` #### Version Version 3.9 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
403	403004	Permissions issue	The user does not have permissions to read the specified metric.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404004	Metric not found	The metric ID in the URI doesn't correspond to an existing metric.

#### Example `curl "http://MY-SERVER/api/3.9/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/metrics/6561daa3-20e8-407f-ba09-709b178c0b4a" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` **Response Body** ` ` ## Get Metric Data - Retired in API 3.22 **Retired in API 3.22 (Cloud February 2024 / Server 2024.2)** Tableau's legacy metrics feature was retired in Tableau Cloud in February 2024 and in Tableau Server version 2024.2. In October 2023, Tableau retired the ability to embed legacy metrics in Tableau Cloud and in Tableau Server version 2023.3. With Tableau Pulse, we've developed an improved experience to track metrics and ask questions of your data. For more information, see [Create Metrics with Tableau Pulse](https://help.tableau.com/current/online/en-us/pulse_create_metrics.htm) to learn about the new experience and [Create and Troubleshoot Metrics (Retired)](https://help.tableau.com/current/online/en-us/metrics_create.htm) for the retired feature. Returns the data for the specified metric as comma separated (CSV) format. The maximum number of rows returned is 10,000. #### URI GET /api/api-version/sites/site-luid/metrics/metric-luid/data #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site that contains the data source to get revisions for.
metric-luid	The LUID of the metric whose data should be returned.

#### Request Body None #### Permissions Tableau administrators, and non-administrator and users with Read capability for a metric, will be able to get its data. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:metrics:download ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` your_timestamp_column_name,your_measure_column_nametimestamp_1,measure_1timestamp_2,measure_1 ``` #### Version Introduced Tableau Cloud June 2022 (API 3.16). Not currently available for Tableau Server. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	40000	Bad request	The LUID of the site or metric was malformed.
401	40100	Not authorized	The authentication token provided in the request header was invalid or has expired.
403	403054	Not authorized	A non-administrator user attempted to get metric data, but does not have sufficient permissions.
404	404000	Site not found	The site LUIID in the URI doesn't correspond to an existing site.
404		Metric not found	The metric LUID in the URI doesn't correspond to an existing data source.
405	405000	Invalid request method	Request type was not GET.
429	405000	Too many requests	The concurrent request limit for the site was exceeded. Retry after a pause.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example Request command line: `curl "http://MY-SERVER/api/3.16/sites/1edc53ac-e247-4870-9fd3-6fad0ce5f84d/metrics/2474164d-8d37-4a4c-abc7-c2070fd25fd5/data" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` Response: ``` Timestamp,Measure 2021-12-31:11:59:57-0800,3 2021-12-31:11:59:58-0800,2 2021-12-31:11:59:59-0800,1 ``` ## Get metric definition Gets a metric definition and optionally metrics it contains. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Can be called by any user, but only returns definitions and metrics that the user has permissions to view. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_definitions\_metrics:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/definitions/{definition\_id} [view details](#) ## Get Mobile Security Settings for Server Gets the mobile security settings for the server. **Version:** Available in API 3.19 (Tableau Cloud December 2022 / Server 2023.1) and later.. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Only Tableau server and site administrators can get mobile security settings for the server. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:mobile\_security\_site\_settings:read - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/settings/mobilesecuritysettings #### URI Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.

#### cURL Request Example `curl -L -X GET "https://qa-server.tsi.lan/api/3.18/settings/mobilesecuritysettings" -H "Accept: application/json" -H "X-Tableau-Auth: ejET2rVmS2e81XiZ9G4lzQ|Iz71DR2lu3r0zHpcOAH2OoRQZlPfxACC|a905dbfd-6550-4546-908b-3e055fcc026d" --data-raw ""` #### Response Code 200 #### Response Body Copy ``` true false 14 14 true ``` Copy ``` { "mobileSecuritySettingsList": { "mobileSecuritySettings": [ { "name": "mobile.security.jailbroken_device", "enabled": true, "iosConfig": { "valueList": [ "true" ], "enabled": true, "severity": "warn" }, "androidConfig": { "valueList": [ "false" ], "enabled": true, "severity": "critical" } }, { "name": "mobile.security.max_offline", "enabled": true "iosConfig": { "valueList": [ "14" ], "enabled": true, "severity": "critical" }, "androidConfig": { "valueList": [ "14" ], "enabled": true, "severity": "critical" }, }, { "name": "mobile.security.screenshot", "enabled": false, "androidConfig": { "valueList": [ "true" ], "enabled": true, "severity": "warn" } } ] }} ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The request is incomplete is malformed.
400	400174	Mobile security settings error	An uknown mobile security settings error has occurred.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403004	Unauthorized Access	The user does not have the required administrtor permissions.
403	403157	Forbidden	Mobile security settings are not enabled on the server.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get Mobile Security Settings for Site Gets the mobile security settings for the specified site. **Version:** Available in API 3.18 (Tableau Cloud December 2022) and later. Not available for Tableau Server. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Only Tableauserver and site administrators can get mobile security settings. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:mobile\_security\_site\_settings:read - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-luid/settings/mobilesecuritysettings #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.

#### cURL Request Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/datasources/1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d/connections" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` #### Response Code 200 #### Response Body Copy ``` true false 14 14 true ``` Copy ``` { "mobileSecuritySettingsList": { "mobileSecuritySettings": [ { "name": "mobile.security.jailbroken_device", "enabled": true, "iosConfig": { "valueList": [ "true" ], "enabled": true, "severity": "warn" }, "androidConfig": { "valueList": [ "false" ], "enabled": true, "severity": "critical" } }, { "name": "mobile.security.max_offline", "enabled": true "iosConfig": { "valueList": [ "14" ], "enabled": true, "severity": "critical" }, "androidConfig": { "valueList": [ "14" ], "enabled": true, "severity": "critical" }, }, { "name": "mobile.security.screenshot", "enabled": false, "androidConfig": { "valueList": [ "true" ], "enabled": true, "severity": "warn" } } ] }} ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The request is incomplete is malformed.
400	400174	Mobile security settings error	An uknown mobile security settings error has occurred.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403004	Unauthorized Access	The user does not have the required administrtor permissions.
403	403157	Forbidden	Mobile security settings are not enabled on the server.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get OpenID Connect Configuration Get details about the Tableau Cloud site's OpenID Connect (OIDC) configuration. **Version:** Available in API 3.22 (Tableau Cloud February 2024) and later. Not available for Tableau Server. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Tableau Cloud site admins only. **JWT Access Scope:** Not available. #### URI GET /api/api-version/sites/site-luid/site-oidc-configuration?idpConfigurationId=idp-configuration-id **Note:** The resource, GET /api/api-version/sites/site-luid/site-oidc-configuration?idpConfigurationId=idpConfigurationId, was added in version 3.24. The original resource, PUT /api/api-version/sites/site-luid/site-oidc-configuration, continues to be a supported resource if your site is configured with only one OIDC authentication configuration. If you don’t specify an `idpConfigurationId` value starting in API 3.24, the initial OIDC configuration on the site is removed. If there is no initial OIDC configuration on the site, then no OIDC configuration is removed. #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
idp-configuration-id	The ID of the configuration. To get the idpConfigurationId value, use the List Authentication Configurations for Site method.

#### Request Body None #### cURL Request Example `curl "https://us-west-2a.online.tableau.com/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/site-oidc-configuration?idpConfigurationId=00000000-0000-0000-0000-0000000000" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` #### Response Code 200 #### Response Body Copy ``` " authorizationEndpoint="https://myidp.com/oauth2/v1/authorize" tokenEndpoint="https://myidp.com/oauth2/v1/token" userinfoEndpoint="https://myidp.com/oauth2/v1/userinfo" jwksUri="https://myidp.com/oauth2/v1/keys" idpConfigurationName="Initial OIDC" endSessionEndpoint="https://myidp.com/oauth2/v1/logout" customScope="openid, email, profile" prompt="login,consent" clientAuthentication="client_secret_basic" essentialAcrValues="phr" emailMapping="email" firstNameMapping="given_name" lastNameMapping="family_name" fullNameMapping="name" useFullName="false" idpConfigurationId="00000000-0000-0000-0000-000000000000" /> ``` Copy ``` { "siteOIDCConfiguration": { "enabled":"true", "testLoginUrl":"https://sso.online.tableau.com/public/testLogin?alias=080bca2d-578b-49cc-b40d-3781b36b30ee&authSetting=OIDC", "allowEmbeddedAuthentication":"false", "clientId":"0oa111usf1gpUkVUt0h1", "clientSecret":"<omit>", "authorizationEndpoint":"https://myidp.com/oauth2/v1/authorize", "tokenEndpoint":"https://myidp.com/oauth2/v1/token", "userinfoEndpoint":"https://myidp.com/oauth2/v1/userinfo", "jwksUri":"https://myidp.com/oauth2/v1/keys", "idpConfigurationName":"Initial OIDC" "endSessionEndpoint":"https://myidp.com/oauth2/v1/logout", "customScope":"openid, email, profile", "prompt":"login,consent", "clientAuthentication":"client_secret_basic", "essentialAcrValues":"phr", "emailMapping":"email", "firstNameMapping":"given_name", "lastNameMapping":"family_name", "fullNameMapping":"name", "useFullName":"false", "idpConfigurationId":"00000000-0000-0000-0000-000000000000" }} ``` **Notes:** - The response hides the client secret and replaces it with `<omit>`. - You can use the `testloginURL` to validate the OIDC configuration. When you enter the URL in a browser, details about the configuration displays. - You can use the `idpConfigurationId` to assign the authentication method to a user using the [Add User to Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_users_and_groups.htm#add_user_to_site) and [Update User](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_users_and_groups.htm#update_user) methods. #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get or create metric Returns the details of a metric in a definition if it exists, or creates a new metric if it does not. Also returns 'true' if a new metric was created, or 'false' if it already existed. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric in a definition as long as the user has read or connect access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_metrics:create\` Access Scopes Overview: [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/pulse/metrics:getOrCreate [view details](#) ## Get Pulse subscription Gets a specified subscription to a metric. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user that has read or connect permission to the data source used in the definition can get the details of a subscription. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:metric\_subscriptions:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/subscriptions/{id} [view details](#) ## Get Recently Viewed for Site Gets the details of the views and workbooks on a site that have been most recently created, updated, or accessed by the signed in user. The 24 most recently viewed items are returned, though it may take some minutes after being viewed for an item to appear in the results. #### URI GET /api/api-version/sites/site-id/content/recent #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the views and workbooks.

#### Request Body None #### Permissions Users who are not server administrators or site administrators, the method returns only the views and workbooks that the user owns or has **Read** permissions for (either explicitly or implicitly). #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:content:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` The value of view-url-name is the name of the view in its URL. For example, if a view named `View 1` shows the URL `https://MY_SERVER/#/site/MY_SITE/views/VIEW_1` in your browser address bar, then the the view-url-name would be `VIEW_1`. Modifying the name (display name) of a view will not impact the view-url-name (path element of the view's URL). #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl -X GET "https://qa-windows/api/3.5/sites/cd24a433-b66c-46cd-a4af-6cde73db9ee1/content/recent" -H "X-Tableau-Auth: pI8NzKb-S5-Jqiatds8jrQ|GKUYlgHjuHSPSVfS38plFpH31UkHGtNl"` **Example response:** ``` ``` #### Version Version 3.15 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	409109	Invalid request	Invalid notification type.
400	409100	Invalid request	Invalid channel.
403	403004	Invalid permissions	Invalid permission to update site user notification settings.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	The request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example **Example response:** ``` ``` ## Get User Personal Space Gets the details of the Personal Space for the currently authenticated user. Personal Space must be enabled for the site in order to be returned by this method. For more information see, [Create and Edit Private Content in Personal Space](https://help.tableau.com/current/pro/desktop/en-us/personal_space.htm) **Version**: Available in API 3.13 and later. **License**: No additional license required. **Permissions**: Only the user that owns a Personal Space can get its details. **Access scope**:`tableau:projects:read` - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-id/personalSpace #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the user.

#### Request Body none #### cURL Example `curl "http://MY-SERVER/api/3.29/sites/7bfb590b-cfa7-4576-8bea-e9cc035/personalSpace -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` #### Response Code 200 #### Response Body ``` ``` ``` { "personalSpace": { "luid": "b76c9984-c7a8-4ae4-826d-e08372ad7d61", "ownerLuid": "39e76bc4-737f-40c0-bca7-e635fe0e9fd9", "readOnly": false } } ``` `readOnly` is `true` only if Personal Space is disabled in site settings or the user's role for the site does not allow writing to a Personal Space. #### Errors

404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get Users in Group Gets a list of users in the specified group. #### URI GET /api/api-version/sites/site-id/groups/group-id/users GET /api/api-version/sites/site-id/groups/group-id/users?pageSize=page-size&pageNumber=page-number #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the group.
group-id	The ID of the group to get the users for.
page-size	(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number	(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.

#### Request Body None #### Permissions This method can only be called by server administrators and site administrators. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:groups:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ... additional user information ... ``` The siteRole value is returned as one of the following values: Creator, Explorer, ExplorerCanPublish, ServerAdministrator, SiteAdministratorExplorer, SiteAdministratorCreator, Unlicensed, ReadOnly, or Viewer. The externalAuthUserId value is returned for Tableau Cloud; it represents ID stored in Tableau's single sign-on (SSO) system. For other server configurations, this field contains null, and the value of lastLogin is an empty string. #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400006	Invalid page number	The page number parameter is not an integer, is less than one, or is greater than the final page number for data sources at the requested page size.
400	400007	Invalid page size	The page size parameter is not an integer, or is less than one.
403	403014	Page size limit exceeded	The specified page size is larger than the maximum page size.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404012	Group not found	The group ID in the URI doesn't correspond to an existing group.
405	405000	Invalid request method	Request type was not GET.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the users.
filter-expression	(Optional) An expression that lets you specify a subset of users to return. You can filter on predefined fields such as `name` and `lastLogin`. You can include multiple filter expressions. For more information, see Filtering and Sorting.
sort-expression	(Optional) An expression that lets you specify the order in which user information is returned. If you do not specify a sort expression, the sort order of the information that's returned is undefined. For more information, see Filtering and Sorting.
page-size	(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number	(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.
field-expression	(Optional) An expression that lets you specify the set of available fields to return. You can qualify the return values based upon predefined keywords such as `_all_` or `_default_`, and you can specify individual fields for the views or other supported resources. You can include multiple field expressions in a request. For more information, see Using Fields in the REST API.

**Note**: The filter and sort parameters can be combined with each other and with paging parameters and fields parameters using an ampersand **`&`**. #### Request Body None #### Permissions This method can only be called by server administrators and site administrators. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:users:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` **Notes:** - The siteRole value is returned as one of the following values: Creator, Explorer, ExplorerCanPublish, ServerAdministrator, SiteAdministratorExplorer, SiteAdministratorCreator, Unlicensed, ReadOnly, or Viewer. - The externalAuthUserId value is returned for Tableau Cloud only; it represents ID stored in Tableau's single sign-on (SSO) system. For other server configurations, this field contains null, and the value of lastLogin is an empty string. - The authSetting attribute is only returned if you are using Tableau Server with site-specific SAML enabled, or Tableau Cloud with either SAML or OpenID Connect enabled. - Starting in API 3.24, **idpConfigurationId** indicates the authentication method assigned to the user in Tableau Cloud only. - When Tableau Cloud returns domain name, it indicates the authentication type of the user. When Tableau Server returns domain name, it indicates the domain of the user. #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400006	Invalid page number	The page number is not an integer, is less than one, or is greater than the final page number for users at the requested page size.
400	400007	Invalid page size	The page size parameter is not an integer, or is less than one.
403	403014	Page size limit exceeded	The specified page size is larger than the maximum page size.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/users" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` **Example response:** ``` ... more users ... ``` `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/users?filter=siteRole:eq:Unlicensed&sort=name:asc" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` This example includes a filter to return the users whose site role is Unlicensed and specifies that the results should be sorted by the name value. ## Get View Gets the details of a specific view. **Version**: Available in API 3.0 and later. **License**: No additional license required. **Permissions**: For users who are not server administrators or site administrators, the method returns only the views that the user owns or has **Read** permissions for (either explicitly or implicitly). **Access Scope**: `tableau:content:read` - For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-id/views/view-id?includeUsageStatistics=get-usage-information #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the group.
view-id	The ID of the view whose details are requested.
(Optional) get-usage-information	true to return usage statistics. The default is false.

404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404006	Resource not found	The view ID in the URI doesn't correspond to an existing view.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### cURL Example ``` curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/views/1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6ds" -X GET -H "X-Tableau-Auth:RDEj_zqgQtGGcCiD3BXnSA|abXWv8thv5ocrXLNU7axCicQu3UdfgeX" ``` **Example response:** ``` ``` ## Get View by Path Gets the details of all views in a site with a specified name. **Version**: Available in API 3.6 and later. **License**: No additional license required. **Permissions**: For users who are not server administrators or site administrators, the method returns only the views that the user owns or has **Read** permissions for (either explicitly or implicitly). **Access Scope**: `tableau:content:read` - For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-id/views?filter=viewUrlName:eq:view-name #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the group.
view-name	The name of the view as it appears in the URL to the view. For `https://MY_SERVER/#/MY_SITE/views/workbook-name/Sheet1?:iid=1`, the name would be `Sheet1`.

#### Request Body None #### Response Code 200 #### Response Body ``` ``` ``` { "view": { "id": "view-id", "name": "view-name", "contentUrl": "path-to-view", "createdAt": "created-date", "updatedAt": "updated-date", "viewUrlName": "view-name", "workbook": { "id": "workbook-id" }, "owner": { "id": "owner-id" }, "project": { "id": "product-id" }, "tags": [] } } ``` The value of view-url-name is the name of the view in its URL. For example, if a view named `View 1` shows the URL `https://MY_SERVER/#/site/MY_SITE/views/VIEW_1` in your browser address bar, then the view-url-name would be `VIEW_1`. Modifying the name (display name) of a view will not impact the view-url-name (path element of the view's URL). #### Errors

404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404006	Resource not found	The view ID in the URI doesn't correspond to an existing view.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### cURL Example ``` curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/views?filter=viewUrlName:eq:Sheet1" -X GET -H "X-Tableau-Auth:RDEj_zqgQtGGcCiD3BXnSA|abXWv8thv5ocrXLNU7axCicQu3UdfgeX" ``` **Example response:** ``` viewUrlName="Sheet1" > ``` ## Get Workbook Returns information about the specified workbook, including information about views and tags. **Note**: After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. **Version:** Available in API 2.0 and later. Data acceleration and data freshness policy setting update are added in API 3.22 (Tableau Cloud February 2024 / Server 2024.2)._[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** You can get workbok details if you are a user with implicit or explicit Read permissions for the workbook, or are a Tableau Administrator. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:content:read - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-id/workbooks/workbook-id GET /api/api-version/sites/site-id/workbooks/content-url?key=contentUrl #### URI Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.

site-id The ID of the site that contains the workbook.

content-url

The permanent name of the site to sign in to. The content URL appears in the URL path of Tableau content in your browser address bar after the Tableau Server URL.

mySite is the content URL in the following example:

http://<server or cloud URL>/#/site/mySite/explore

#### Request Body None #### Response Code 200 #### cURL Request Example `curl -L -X GET "http://qa-near/api/3.17/sites/a946d998-2ead-4894-bb50-1054a91dcab3/workbooks/simple-highlight?key=contentUrl" -H "X-Tableau-Auth:HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3"` #### Response Body Copy ``` ``` Copy ``` { "workbook": { "id": "0828bd63-dea5-454f-8f54-30f9a92760ff", "name": "WB_Election_live", "description": "", "contentUrl": "WB_Election_live", "webpageUrl": "http://MyServer/#/workbooks/4", "showTabs": "false", "size": "1", "createdAt": "2024-01-25T23:42:57Z", "updatedAt": "2024-01-25T23:42:57Z", "encryptExtracts": "false", "defaultViewId": "10f6d099-fe90-41a1-a77b-1512b818d23c", "project": { "id": "7eb51f54-bbca-11ee-9262-638afb01250c", "name": "Default" }, "location": { "id": "7eb51f54-bbca-11ee-9262-638afb01250c", "type": "Project", "name": "Default" }, "owner": { "id": "09d032b6-d17d-444c-afbe-d71c22f7ee31", "name": "test" }, "tags": [], "views": { "view": { "id": "fcc36499-fd2d-42af-8e2c-29d1c7893edd", "name": "Votes", "contentUrl": "WB_Election_live/sheets/Votes", "createdAt": "2024-01-25T23:42:57Z", "updatedAt": "2024-01-25T23:42:57Z", "viewUrlName": "Votes", "tags": [], "dataAccelerationConfig": { "accelerationEnabled": "true", "accelerationStatus": "Pending" } } }, "dataFreshnessPolicy": { "option": "FreshAt", "freshAtSchedule": { "time": "08:15:00", "frequency": "Week", "timezone": "America/Los_Angeles", "intervals": { "interval": { "weekDay": "MONDAY" } } } } }} ``` The datetime-created and datetime-updated attribute values are returned in UTC format (YYYY-MM-DDTHH:MM:SSZ). #### Errors

HTTP status	`error` Code	Condition	Details
403	403018	Read forbidden	A non-administrator user attempted to query the workbook, but the caller doesn't have Read permission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404006	Workbook not found	The workbook LUID or contentUrl in the URI doesn't correspond to an existing workbook, or the querystring `?key=contentUrl` is not capitalized correctly.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get Workbook Downgrade Info Returns a list of the features that would be impacted, and the severity of the impact, when a workbook is exported as a downgraded version (for instance, exporting a v2019.3 workbook to a v10.5 version). #### URI GET /api/api-version/sites/site-id/workbooks/workbook-id/downGradeInfo?productVersion=downgrade-target-version #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook that downgrade info is being shown for.
workbook-id	The ID of the workbook being downgraded.
downgrade-target-version	The Tableau release version number the workbook is being downgraded to.

#### Request Body None #### Permissions Tableau Server users who are site administrators can get downgrade information for workbooks on the site that they are administrators for. Users who are not server administrators or site administrators can get downgrade information for workbooks they have permissions to. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:workbook_downgrade_info:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400114	Unknown downgrade error	The workbook cannot be exported to a downgraded version due to an unknown error.
400	400115	Invalid downgrade version	The downgrade version specified is not a valid Tableau version number.
400	400116	Downgrade version not supported	The downgrade version specified refers to a Tableau version that is not supported.
403	40310	Access to downgrade info denied	The caller does not have permissions required to access download info for this workbook.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get Workbook Revisions Returns a list of revision information (history) for the specified workbook. **Note:** This method is available only if version history is enabled for the specified site. To get a specific version of the workbook from revision history, use the [Download Workbook Revision](#download_workbook_revision) method. For more information, see [Maintain a History of Revisions](https://help.tableau.com/current/server/en-us/help.htm#revision_history_maintain.htm) in the Tableau Server Help. #### URI GET /api/api-version/sites/site-id/workbooks/workbook-id/revisions GET /api/api-version/sites/site-id/workbooks/workbook-id/revisions?pageSize\=page-size&pageNumber\=page-number #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook to get revisions for.
workbook-id	The ID of the workbook to get revisions for.
page-size	(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number	(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.

#### Request Body None #### Permissions Tableau Server users who are site administrators can get workbook revisions on the site that they are administrators for. Users who are not server administrators or site administrators can get workbook revisions if they have all of the following: - A site role of ExplorerCanPublish. - Read (view), Write (save), and Download (save as) permissions for the specified workbook. - Save (write) permissions for the project that contains the workbook. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:content:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` If the revision element includes the attribute `isDeleted="true"`, the workbook has been deleted and cannot be downloaded using the [Download Workbook Revision](#download_workbook_revision) method. If a user has been deleted from the site, no `` element is included in the `` element. #### Version Version 2.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400006	Invalid page number	The page number parameter is not an integer, is less than one, or is greater than the final page number for data sources at the requested page size.
400	400007	Invalid page size	The page size parameter is not an integer, or is less than one.
403	403014	Page size limit exceeded	The specified page size is larger than the maximum page size.
403	403053	Version history not enabled	version history is not enabled for the specified site.
403	403056	A non-administrator user attempted to get workbook revision information, but the caller doesn't have sufficient permissions.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404006	Workbook not found	The workbook ID in the URI doesn't correspond to an existing workbook.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Gets recommended metrics Gets personalized groups of metrics to recommend to a user. Only metric that the user has privileges to view will be returned. **Version:** Available in API 3.26 (Tableau Cloud September 2025) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can get a batch of metrics as long as the user has read or connect access to the data source used in the definition that contains them. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_metrics:read\` Access Scopes Overview: [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/metrics:recommended [view details](#) ## Hide a Recommendation for a View - Deprecated in API 3.19 Hides a view from being recommended by the server by adding it to a list of views that are dismissed for a user. > [!WARNING] > > Starting in API version 3.19 (Tableau Server 2023.1 / Cloud March 2023), this method is deprecated, will no longer be supported, and may be retired in future releases. If hidden, a view will not be displayed on the server Home or Recommendation pages. #### URI PUT /api/api-version/sites/site-id/recommendations/dismissals #### Path Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the group.

#### Request Body ``` ``` #### Request Parameters

view-luid

The LUID of the view to be added to the list of views hidden from recommendation for a user.

#### Permissions This method can only be called by server administrators and site administrators. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:recommendation_dismissals:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body None #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404029	Content not found	The content ID in the URI doesn't correspond to an existing content of the requested type.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example ``` curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/dismissals -X PUT \ -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" \ -d "@hide-view.xml" ``` **Content of** hide-view.xml ``` ``` **Example response:** No response body. Response code is `204`. ## Import ask data lens - Retired in API 3.22 * * * Retired in API 3.22 (Cloud February 2024 / Server 2024.2) > > [!WARNING] > > > > **Important changes for Ask Data and Metrics** > > Tableau's Ask Data and Metrics features were retired in Tableau Cloud in February 2024 and in Tableau Server version 2024.2. With advances in natural language technologies, we're developing an improved interface that will make it easier to ask questions of your data and stay on top of changes. For more information, see [How Tableau GPT and Tableau Pulse are reimagining the data experience](https://www.tableau.com/blog/tableau-pulse-and-tableau-gpt). * * * Import an existing ask data lens on a server to a site, and optionally transform the metadata of the lens in the process. **Version:** Available in API 3.16 ( Tableau Cloud June 2022 / Server 2022.3) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by server administrators or site administrators. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:lenses:create\` [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/askdata/lenses/import [view details](#) ## Import Users to Site from CSV Creates a job to import the users listed in a specified .csv file to a site, and assign their roles and authorization settings. The .csv file should comply with the rules described in one of the following topics: - For Tableau Cloud - [CSV Import File Guidelines](https://help.tableau.com/current/online/en-us/csvguidelines.htm) - For Tableau Server - [CSV Import File Guidelines](https://help.tableau.com/current/server/en-us/csvguidelines.htm) #### URI POST api/_api-version_/sites/_site-id_/users/import #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.

path-to-csv	The file path to the .csv list users to be imported.
user-name	(Optional) The name of the user. If the server uses local authentication, this can be any name. If you are using Active Directory authentication, or if you are using Tableau Cloud, there are specific requirements for the name. Tableau Server If Tableau Server uses Active Directory authentication, this must be the name of an existing user in Active Directory. If the user name is not unique across domains, you must include the domain as part of the user name (for example, example\Adam or adam@example.com). Note: Active Directory specifies a user name using two attributes: `sAMAccountName` and `userPrincipalName` (UPN) prefix. For most Active Directory users, these attributes are the same. By default, if you are adding a user from Active Directory, the name that you provide in the user-name is matched against the Active Directory `sAMAccountName` attribute, which becomes the name that the user signs in to Tableau Server with. Two exceptions are when the name that you provide: is longer than 20 characters; and includes an `@` character. In these cases, Tableau imports the user using the Active Directory UPN. For more information, see User Naming Attributes on the MSDN site. Tableau Cloud The user-name is the email address that the user will use to sign in to Tableau Cloud. When you add a user to the site, Tableau Cloud sends an email invitation. The user can click the link in the invitation to sign in and update their full name and password.
auth-setting	Tableau Server The authSetting attribute only applies when updating users on sites with site-specific SAML-enabled settings. Tableau Cloud The ability to create and enable multiple authentication methods simultaneously was introduced in API 3.25 (January 2025). As a result of this capability, consider the following: For Tableau with MFA (or Tableau) authentication: To assign Tableau with MFA authentication (or Tableau authentication if still available for your site), you can use the authSetting or idpConfigurationId attribute, but not both. For SAML and OIDC-based authentication: For new configurations: To assign SAML or OIDC-based authentication, whose configurations were created during or after January 2025, you must use the idpConfigurationId attribute for assigning user authentication. Skip to idp-configuration-id. For existing configurations: To assign SAML and OIDC-based authentication, whose configurations that Tableau has automatically prefixed with "Initial" (such as "Initial SAML," "Initial Google," "Initial OIDC," or "Initial Salesforce"), you can continue to use the authSetting attribute for assigning user authentication. Alternatively, you can use the idpConfigurationId attribute for assigning user authentication. Do not use both. Notes: In cases where both attributes are supported, you can use the authSetting attribute or the idpConfigurationId attribute, but not both. If neither authSetting nor idpConfigurationId attribute is specified, then `TableauIdWithMFA` (or in some cases `ServerDefault` if that option is still available for your site) is the authentication assigned to the user. If you see "Unspecified" as the authentication method for the user in Tableau Cloud or if the user is unable to sign in, use the idpConfigurationId attribute instead. For more information, see When adding users to Tableau Cloud via Rest API, the user's authentication method is listed as "Unspecified" and the user gets error "Remote IdP entity descriptor is not configured" on login attempt knowledge article or skip to idp-configuration-id. You can assign the following values for the authSetting attribute: `SAML` - The user signs in using the identity provider (IdP) configured for the site. For Tableau Cloud configuration, see Enable SAML Authentication on a Site. For Tableau Server, see Configure Site-Specific SAML. `OpenID` - Tableau Cloud only: The user signs in using Google, Salesforce or OpenID Connect provider credentials. `OpenID` corresponds to Google, Salesforce, or OIDC authentication configuration in Tableau Cloud authentication settings. `TableauIDWithMFA` - Tableau Cloud only: The user signs in using a combination of TableauID credentials and a registered verification method. For more information, see About multi-factor authentication and Tableau Cloud. `ServerDefault` - The user signs in using the default authentication method that's set for the server. For Tableau Cloud, if Tableau hasn't updated your site to require Tableau with MFA yet, you can continue to use this authentication type on a temporary basis. The `ServerDefault` value corresponds to TableauID in authentication settings. For Tableau Server, the SAML Server help page describes default authentication options. Assigning user auth settings with this method The request payload enables you to set auth settings for individual users, or all users in the .csv file. To prevent the payload from having any impact on auth settings, omit the `name` and `authSetting` attributes of the `user` object: `<tsrequest><user /></tsrequest>`. To set the default auth settings for all users being imported, omit the `name` attribute and specify the `authSetting` attribute of the `user` object: `<tsRequest><user authSetting="OpenID"/><tsRequest>` If the auth setting for a user is defined in both the imported .csv and in a request payload, the setting in the .csv will take precedence. If no auth setting is defined for a user in either the .csv and the request payload, then the default setting of the site is assigned.
idp-configuration-id	(Optional, Tableau Cloud only) The configuration to assign for user authentication. Added in API 3.25 (January 2025). To find the idpConfigurationId attribute value, use the List Authentication Configurations for Site method. Notes: In cases where both attributes are supported, you can use the idpConfigurationId attribute or the authSetting attribute, but not both. If neither idpConfigurationId nor authSetting attribute is specified, then `TableauIdWithMFA` (or in some cases `ServerDefault` if that option is still available for your site) is the authentication assigned to the user.
isVerbose	Tableau Cloud only When set to `false`, this method only returns the top three errors in a batch of users. When set to `true`, the method displays a full list of errors during CSV upload. Available in REST API 3.22 (Tableau Cloud February 2024)

#### Permissions Tableau Server admins or Tableau Cloud site admins only. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:users:create ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 201 #### Version REST API version 3.15 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Response Body ``` ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request payload is missing or incomplete, or contains malformed XML.
500	500000	Internal Server Error	The request could not be completed.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example ``` curl -X POST \ http://10.108.21.238//api/3.15/sites/8aa3291f-1b5a-4f52-a3be-6512661f574d/users/import \ -H 'cache-control: no-cache' \ -H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \ -H 'x-tableau-auth: AVjAKZb3SQimzoqyMmQXEg|9OSHQrwCXF83SIR2XCuDEK91AM7v3FZr' \ -F tableau_user_import=@users.csv \ -F 'request_payload=' ``` #### Response ``` ``` ## Initiate File Upload Initiates the upload process for a file. After the upload has been initiated, you call [Append to File Upload](#append_to_file_upload) to send individual blocks of the file to the server. When the complete file has been sent to the server, you call [Publish Data Source](#publish_data_source), [Publish Flow](#publish_flow), or [Publish Workbook](#publish_workbook) to commit the upload. Initiate File Upload returns an upload session ID that you pass to [Append to File Upload](#append_to_file_upload) or one of the publishing methods in order to identify the upload session. The file size that is returned in the response is initialized to zero (0) megabytes, because no data has yet been loaded. Subsequent calls to [Append to File Upload](#append_to_file_upload) or the publishing APIs update this value. For more information, see [Publishing Resources](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_publish.htm). #### URI POST /api/api-version/sites/site-id/fileUploads #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site to upload the file to.

#### Request Body None #### Permissions Users who are not server administrators or site administrators can initiate a file upload only if they have publishing rights on the site. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:file_uploads:create ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 201 #### Response Body ``` ``` #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
403	403015	Access to Favorites forbidden	A non-administrator user attempted to initiate a file upload, but the caller doesn't have publishing rights on the site.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not POST.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## List All Registered EAS Get all external authorization servers (EASs) registered to a site. #### URI GET api/_api-version_/sites/_site-id_/connected-apps/external-authorization-servers #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.

HTTP status	`error` Code	Condition	Details
403	403000	Admin permissions required	A non-admin user called this method and doesn't have adequate permissions to perform the action.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.

## List allowed dashboard extensions on site - Retired in API 3.21 * * * Retired in API 3.21 (Cloud October 2023 / Server 2023.3) > > [!WARNING] > > > > In October 2023 Tableau Cloud and Tableau Server version 2023.3 releases, Tableau's REST API methods for dashboard extensions settings are retired. We recommend you replace dashboard extensions methods for enabling, listing, getting details of, and updating dashboard extensions with [Tableau extensions settings methods](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_tableau_extensions_settings.htm) that have similar functionality. * * * Lists the dashboard extensions on the safe list of the site you are signed into. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server or site administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/settings/site/extensions/dashboard/safeListItems [view details](#) ## List analytics extension connections of workbook Lists basic details of each analytics extension connection available for a specified workbook, including connection type and name. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can be called by users that have permissions to the specified workbook. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:analytics\_extensions:read\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) or [Server](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/settings/site/extensions/analytics/workbooks/{workbook\_luid}/connections [view details](#) ## List analytics extension connections on site Lists a site's analytics extension connections for external services. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server or site administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:analytics\_extensions:read\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) or [Server](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/settings/site/extensions/analytics/connections [view details](#) ## List Ask Data Lens Permissions > > [!WARNING] > > > > Tableau's Ask Data and Metrics features were retired in Tableau Cloud in February 2024 and in Tableau Server version 2024.2. With advances in natural language technologies, we're developing an improved interface that will make it easier to ask questions of your data and stay on top of changes. For more information, see [How Tableau AI and Tableau Pulse are reimagining the data experience](https://www.tableau.com/blog/tableau-pulse-and-tableau-ai). List all permissions configured for the specified ask data lens that the user has read capability for. #### URI GET /api/api-version/sites/site-luid/lens/lens-Luid/permissions #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site that contains the metrics.
lens-luid	The LUID of the ask data lens whose permissions are being listed.

#### Request Body None #### Permissions Users with server or site administrator permissions, and non-administrators that have **Read** permission (either explicitly or implicitly), can list permissions for an ask data lens. lu #### Response Code 200 #### Response Body ``` <-- ... additional capabilities ... --> <-- ... additional capabilities ... --> <-- ... additional grantee capability sets ... --> ``` **Note:** The parent element is included in the response only if the lens' permissions are determined by project-level default permissions and project permissions are locked. Project permissions can be locked for a new project when you call Create Project or for an existing project by calling Update Project. For more information, see Lock Content Permissions to the Project. #### Version Introduced Tableau Cloud June 2022 (API 3.16). Not currently available for Tableau Server. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403018	Read forbidden	A non-administrator user attempted to query metrics for the site, but the caller doesn't have Read permission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404046	Lens not found	A lens with the requested LUID could be found.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## List ask data lenses in site - Retired in API 3.22 * * * Retired in API 3.22 (Cloud February 2024 / Server 2024.2) > > [!WARNING] > > > > **Important changes for Ask Data and Metrics** > > Tableau's Ask Data and Metrics features were retired in Tableau Cloud in February 2024 and in Tableau Server version 2024.2. With advances in natural language technologies, we're developing an improved interface that will make it easier to ask questions of your data and stay on top of changes. For more information, see [How Tableau GPT and Tableau Pulse are reimagining the data experience](https://www.tableau.com/blog/tableau-pulse-and-tableau-gpt). * * * Returns a list of ask data lenses in a site. **Version:** Available in API 3.16 ( Tableau Cloud June 2022 / Server 2022.3) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can be called by any user. Responses will include only the lenses to the user has access to. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:lenses:read\` [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/askdata/lenses [view details](#) ## List Authentication Configurations for Site List all authentications configurations on the site. For more information, see [Authentication](https://help.tableau.com/current/online/en-us/security_auth.htm#multiple_idp) in the Tableau Cloud Help. **Version:** Available in API 3.24 (Tableau Cloud November 2024) and later. Not available for Tableau Server._[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Tableau Cloud site admins only. **JWT Access Scope:** Not available. #### URI GET /api/api-version/sites/site-luid/site-auth-configurations #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.

#### Request Body None #### cURL Request Example `curl "https://us-west-2a.online.tableau.com/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/site-auth-configurations" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` #### Response Code 200 #### Response Body Copy ``` authSetting="OIDC" enabled="true" idpConfigurationId="00000000-0000-0000-0000-000000000000" idpConfigurationName="Initial Salesforce" knownProviderAlias="Salesforce" authSetting="SAML" enabled="true" idpConfigurationId="11111111-1111-1111-1111-111111111111" idpConfigurationName="Initial SAML" ``` Copy ``` {"siteAuthConfigurations": [ { "authSetting":"OIDC", "enabled":"true", "idPConfigurationId":"00000000-0000-0000-0000-000000000000", "idPConfigurationName":"Initial Salesforce", "knownProviderAlias":"Salesforce" }, { "authSetting":"SAML", "enabled":"true", "idPConfigurationId":"11111111-1111-1111-1111-111111111111", "idPConfigurationName":"Initial SAML" } ]} ``` **Notes:** - Use the idpConfigurationId to specify the authentication method for a user in [Add User to Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_users_and_groups.htm#add_user_to_site) and [Update User](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_users_and_groups.htm#update_user) methods. - The knownProviderAlias is returned when the authentication type is either Google or Salesforce. #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## List Authentication Configurations on Server List information about all authentication instances associated with identity pools. **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/authn-service/auth-configurations [view details](#) ## List blocked dashboard extensions on server - Retired in API 3.21 * * * Retired in API 3.21 (Cloud October 2023 / Server 2023.3) > > [!WARNING] > > > > In October 2023 Tableau Cloud and Tableau Server version 2023.3 releases, Tableau's REST API methods for dashboard extensions settings are retired. We recommend you replace dashboard extensions methods for enabling, listing, getting details of, and updating dashboard extensions with [Tableau extensions settings methods](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_tableau_extensions_settings.htm) that have similar functionality. * * * 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](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/settings/server/extensions/dashboard/blockListItems [view details](#) ## List Bridge Clients Retrieves a list of all Bridge clients for a specific site, with optional filtering by pool. Only one filter (poolId, onlyDefaultPool, or onlyUnassigned) can be specified at a time. Each client is in one of three states: assigned to a named pool, assigned to the default pool, or unassigned. The response includes status, pool assignment, and ownership; filtering is mutually exclusive (multiple filters return 400). This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:read` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI All clients: GET /api/api-version/sites/site-luid/bridge-clients Filter by pool: GET /api/api-version/sites/site-luid/bridge-clients?poolId=poolId Filter by default pool: GET /api/api-version/sites/site-luid/bridge-clients?onlyDefaultPool=boolean Filter by unassigned: GET /api/api-version/sites/site-luid/bridge-clients?onlyUnassigned=boolean Only one filter can be specified at a time. Specifying multiple filters returns 400 Bad Request. #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
poolId	Optional. Filter by specific pool; returns only Bridge clients assigned to this pool. Mutually exclusive with `onlyDefaultPool` and `onlyUnassigned`.
onlyDefaultPool	Optional. If true, returns only Bridge clients in the default pool. Mutually exclusive with `poolId` and `onlyUnassigned`.
onlyUnassigned	Optional. If true, returns only Bridge clients not assigned to any pool. Mutually exclusive with `poolId` and `onlyDefaultPool`.

#### Request Body None #### cURL Request Example `curl "https://myco/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/bridge-clients" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` #### Response Code 200 #### Response Body ``` ``` ``` { "bridgeClients": { "bridgeClient": [ { "id": "12345", "name": "Bridge-Client-1", "status": "ONLINE", "version": "2024.1.0", "poolId": "abc-123-def-456", "assignedToDefaultPool": false, "unassigned": false, "lastStatusConnectedTime": "2024-10-30T10:30:00Z", "ownerName": "John Doe", "ownerEmail": "john.doe@example.com" }, { "id": "67890", "name": "Bridge-Client-2", "status": "OFFLINE", "version": "2024.1.0", "poolId": null, "assignedToDefaultPool": true, "unassigned": false, "lastStatusConnectedTime": "2024-10-29T15:45:00Z", "ownerName": "Jane Smith", "ownerEmail": "jane.smith@example.com" } ] } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	BAD_REQUEST	Multiple filters specified	Only one filter parameter can be specified at a time (poolId, onlyDefaultPool, or onlyUnassigned).
400	BAD_REQUEST	Invalid poolId	The poolId specified is reserved and cannot be used as a filter.
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	403000	Insufficient permissions	User does not have Site Administrator role.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500	503002	Unexpected server error	An unexpected error occurred while retrieving Bridge clients.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## List Bridge Pools Retrieves a list of all Bridge pools for the specified site, including pool details and associated domain mappings. Each pool includes its ID, display name, and domains with status ALLOWED or BLOCKED. There is no pagination; consider caching results for 5–15 minutes for large deployments. This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:read` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-luid/bridge-pools #### URI Parameter Values

api-version	The version of the API to use. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.

#### Request Body None #### Response Code 200 #### Response Body ``` ``` ``` { "edgePool": { "poolList": [ { "pool": { "id": "abc-123-def-456", "name": "Production Pool" }, "domains": { "domain": [ { "name": "example.com", "status": "ALLOWED" }, { "name": "subdomain.example.com", "status": "ALLOWED" } ] } }, { "pool": { "id": "ghi-789-jkl-012", "name": "Development Pool" }, "domains": { "domain": [ { "name": "dev.example.com", "status": "ALLOWED" } ] } } ] } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	403000	Insufficient permissions	User does not have Site Administrator role.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500	503903	Unexpected server error	An unexpected error occurred while retrieving pools.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## List Collection Permissions Returns a list of permissions for a specific collection. #### URI GET /api/api-version/sites/site-id/collections/collection-luid/permissions #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the collection.
collection-id	The ID of the collection to get permissions for.

#### Request Body None #### Permissions This method can be called by server administrators, site administrators, and collection owners. #### Required scope for JWT authorization _Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. ``` tableau:permissions:read ``` #### Response Code 200 #### Response Body ``` ``` #### Version Version 3.12 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
404	404038	Resource not found	The collection ID in the URI wasn't found.
404	404000	Resource not found	The site ID in the URI wasn't found.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## List collections Lists collections. **Version:** Available in API 3.28 (Cloud February 2026 / Server 2026.2) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Tableau administrators can call this method for all sites they administer. Other users can call this method for collections that they own. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:collections:read. Added in API 3.28. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/collections [view details](#) ## List Connected Apps Query all connected apps configured on a site. #### URI GET api/_api-version_/sites/_site-id_/connected-apps/direct-trust **Note:** The `connected-applications` endpoint that performed this function was deprecated in API 3.17 (Tableau Cloud October 2022 / Tableau Server 2022.3), is no longer supported and may be retired in a future release. #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.

#### Request Body None #### Permissions Tableau Server admins or Tableau Cloud site admins only. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:connected_apps_direct_trust:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body The request returns details about the connected app, including the following: - ``: Information related to the secret only if it has been previously generated. To create a secret for a connected app, see [Create Connected App Secret](#create_connectedapp_secret). To get the secret value, see [Query Connected App Secret](#get_connectedapp_secret). - ``: Name of the connected app. - ``: Whether the connected app is enabled or not. - ``: The ID of the connected app. - `:` The project that the connected app's access level is scoped to. - `:` If specified, one or more domains that the connected app is allowed to be hosted on. - ``: Whether the connected app can be hosted on all domains. If `false` is returned, the `` attribute determines the domain access. **Example response:** ``` 7ecc5c7c-d923-4ffd-917b-cab1bd89f03b 2021-08-10T18:48:40Z ConnectedApp_MyCo true ac95d175-c844-4779-9d58-415e01fe7dab 1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e 1234de4e-5d6d-7c8c-9b0b-1a2a3f4f5e0e 2021-08-10T18:46:30Z https://myco.com false ConnectedApp_MyCo_stage1 false 7370df14-2741-43f9-bbdd-450f707530a0 11213e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e 21234de4e-5d6d-7c8c-9b0b-1a2a3f4f5e0e 2021-08-18T00:49:05Z true ConnectedApp_MyCo_stage2 false f1e57298-ecd4-46a9-b8d9-e5ab0bf76a82 2021-08-18T00:54:30Z ``` #### Version Version 3.14 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). The resource, GET api/_api-version_/sites/_site-id_/connected-apps/direct-trust, was added in version 3.17. The original resource, GET api/_api-version_/sites/_site-id_/connected-applications, was deprecated in version 3.17 and will be retired in a future release. #### Errors

HTTP status	`error` Code	Condition	Details
400	400143	Generic connected app error	The connected app could not be deleted for some other reason than those specified in this table.
403	403000	Admin permissions required	A non-admin user called this method and doesn't have adequate permissions to perform the action.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404041	Connected app not found	The requested connected app could not be found.

## List Custom Views Gets a list of custom views on a site. The list includes details of each custom view. **Version:** Available in API 3.18 (Tableau Cloud December 2022 and Tableau Server 2023.1) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Tableau administrators can get the list of the custom views on a site, including details of each custom view. For details of non-administrator users' permissions, see _[Permissions Details](#list_custom_views_permissions)_ . _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:content:read - Scope added in API 3.18 (Tableau Cloud December 2022 / Tableau Server 2023.1). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-luid/customviews GET /api/api-version/sites/site-luid/customviews?pageSize=page-size&pageNumber=page-number GET /api/api-version/sites/site-id/customviews?sort=sort-expression GET /api/api-version/sites/site-id/customviews?fields=field-expression GET /api/api-version/sites/site-id/customviews?fields=filter-expression #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
page-size	(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number	(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.
field-expression	(Optional) An expression that lets you specify the set of available fields to return. When a request has a valid field expression, describing the attributes of a Tableau resource like a workbook or data source, only the attributes specified in the expression will be present in the response. For example, a field expression that results in a response containing only the resources LUIDs of the resources being requested would look like: `?field=id` You can qualify the expression to return values based upon predefined keywords such as `_default_`, which returns only default values, and `_all_`, which returns default and non-default values. You can include multiple field expressions in a request, and mix field, sort, and filter expressions in the same request. The supported fields for custom views are its attributes: `id`, `name`, `createdAt`, `updatedAt`, and `shared`. For more information, see Using Fields in the REST API.
filter-expression	(Optional) An expression that lets you filter which Tableau resources are present in the response. A filter expression has a resource, an operator, and a value. For example, a filter that returns only resources created after a specified date would look like: `?filter=createdAt:gt:2016-08-26T18:00:33Z` (where `gt` is the greater-than operator) You can include multiple filter expressions in a request, and mix field, sort, and filter expressions in the same request. The supported filters for custom views use the `eq` (equals) operator, with the resources: `viewId`, `ownerId`, and `workbookId`. For more information, see Filtering and Sorting in the Tableau REST API.
sort-expression	(Optional) An expression that lets you sort the Tableau resources present in the response. A sort expression contains an attribute name and a direction (`asc` or `desc`). For example, a sort expression that sorts the requested resource by creation date with the latest date first would look like: `?sort=createdAt:desc` You can include multiple sort expressions in a request, and mix field, sort, and filter expressions in the same request. The supported filters for custom views use the `eq` (equals) operator, with the resources: `viewId`, `ownerId`, and `workbookId`. For more information, see Filtering and Sorting in the Tableau REST API.

#### Request Body None. #### Required scope for JWT authorization _Introduced in Tableau Server 2022.3 (API 3.17)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) see [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. `tableau:content:read` #### cURL Request Example `curl -L -X GET "https://qa-near/api/3.18/sites/a946d998-2ead-4894-bb50-1054a91dcab3/customviews" -H "X-Tableau-Auth: njR9EGn0QSCpbDrUOh0IKg"wamRRyVFFUHTVwFL6OWEyOggxCwWYXuq"a946d998-2ead-4894-bb50-1054a91dcab3"` #### Response Code 200 #### Response Body ``` ``` ``` { "pagination": { "pageNumber": "1", "pageSize": "100", "totalAvailable": "1673" }, "customViews": { "customView": { "id": "37d015c6-bc28-4c88-989c-72c0a171f7aa", "name": "New name 2", "createdAt": "2016-02-03T23:35:09Z", "updatedAt": "2022-09-28T23:56:01Z", "lastAccessedAt": "2022-09-28T23:58:25Z", "shared": "false", "view": { "id": "8e33ff19-a7a4-4aa5-9dd8-a171e2b9c29f", "name": "circle" }, "workbook": { "id": "2fbe87c9-a7d8-45bf-b2b3-877a26ec9af5", "name": "marks and viz types 2" }, "owner": { "id": "cdfe8548-84c8-418e-9b33-2c0728b2398a", "name": "workgroupuser" } } // more customViews } } ``` #### Permissions Details **For users who do not have administrator permissions:** The custom views present in the response to a request, and the details of those views that are displayed, depend on four things: - Does the user have both **Write** and **WebAuthoring** permissions for the custom view? - Is the user is the owner of the custom view - Is there filter applied in the request parameters. - Is [site user visibility](https://help.tableau.com/current/server/en-us/user_visibility.htm) set to **Limited**? The expected behavior in a response is as follows: - If the request has no filter parameters: Users will see only custom views that they own. - If the filter parameters include `ownerId`: Users will see only custom views that they own. - If the filter parameters include `viewId` and/or `workbookId`, and don't include `ownerId`: - Users will see those custom views that they have **Write** and **WebAuthoring** permissions for. - If site user visibility in not set to **Limited**, the Users will see those custom views that are "public", meaning the value of their `shared` attribute is `true`. #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403162	Unauthorized Access	The user does not have adminstrator permissions or Read permissions for the custom view..
405	405000	Invalid Request Method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## List dashboard extension settings of site - Retired in API 3.21 * * * Retired in API 3.21 (Cloud October 2023 / Server 2023.3) > > [!WARNING] > > > > In October 2023 Tableau Cloud and Tableau Server version 2023.3 releases, Tableau's REST API methods for dashboard extensions settings are retired. We recommend you replace dashboard extensions methods for enabling, listing, getting details of, and updating dashboard extensions with [Tableau extensions settings methods](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_tableau_extensions_settings.htm) that have similar functionality. * * * Lists the dashboard extension settings of the site you are signed into. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server or site administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/settings/site/extensions/dashboard [view details](#) ## List Data Source Permissions Returns a list of permissions for a specific data source. #### URI GET /api/api-version/sites/site-id/datasources/datasource-id/permissions #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the data source.
datasource-id	The ID of the data source to get permissions for.

#### Request Body None #### Permissions Users who are not server administrators or site administrators can view a data source only if they have Read (view) permission for the data source (either explicitly or implicitly). #### Required scope for JWT authorization _Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. ``` tableau:permissions:read ``` #### Response Code 200 #### Response Body ``` ... additional capabilities ... ... additional capabilities ... ... additional grantee capability sets ... ``` **Note**: The parent element is included in the response only if the workbook's permissions are determined by project-level default permissions and project permissions are locked. Project permissions can be locked for a new project when you call [Create Project](#create_project) or for an existing project by calling [Update Project](#update_project). For more information, see [Lock Content Permissions to the Project](https://help.tableau.com/current/server/en-us/help.htm#permissions_project_lock.htm). #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404004	Data source not found	The data source ID in the URI doesn't correspond to an existing data source.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains data-driven alerts.

**Version:** Available in API 3.2 (Tableau Cloud / Tableau Server 2018.3) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required.> **Permissions:** This method can only be called by server administrators and site administrators, and by users who are owners of the specified alert. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:data\_driven\_alerts:read - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Request Body None #### Response Code 200 #### Response Body ``` ``` The **createdAt** and **updatedAt** values are dates and times in UTC format (YYYY-MM-DDTHH:MM:SSZ). #### Version Version 3.2 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400006	Invalid page number	The page number parameter is not an integer, is less than one, or is greater than the final page number for the sites at the requested page size.
400	400007	Invalid page size	The page size parameter is not an integer, or is less than one.
403	403004	Read forbidden	A user queried this method who does not have the required permissions
403	403014	Page size limit exceeded	The specified page size is larger than the maximum page size.
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/13020592-762f-4de4-a25e-f4beb005836e/dataAlerts" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` **Example response:** ``` ``` ## List Database Permissions Get information about the permissions on a database asset. #### URI GET api/_api-version_/sites/_site-luid_/databases/_database-luid_/permissions #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site asset.
database-luid	The LUID of the database asset.

#### Request Body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following authorized users have permissions to query the permissions on the database asset: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to set or "ChangePermissions" to the asset metadata #### Response Code 200 #### Response Body **Example response with explicit permissions set on a database asset:** ``` ``` **Example response without explicit permissions set on a database asset:** ``` ``` #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400120	Bad request	Permissions could not be returned because support for explicit permissions is available for database assets associated with published data sources only.
401	401000	Unauthorized access	No authorization credentials were provided.
400	400120	Bad request	Support for explicit permissions is available for database assets associated with published data sources only.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
404	404000	Resource not found	The site LUID in the URI doesn't correspond to an existing site.
404	404031	Database not found	The requested database could not be found.
409	409045	Database error	An unknown database asset error occurred.

## List Default Database Permissions Get the default permissions applied to the database asset and its children tables. Note: If a database is in a project, default database permissions are not evaluated to determine table permissions. Use [Query Default Permissions](#query_default_permissions) to see default permissions for projects instead. #### URI GET /api/_api-version_/sites/_site-luid_/databases/_database-luid_/default-permissions/tables #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site asset.
database-luid	The LUID of the database asset to set default permissions for.

#### Request Body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following authorized users set default permissions for the database asset: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Response Code 200 #### Response Body **Example response** ``` ``` #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400120	Bad request	Permissions could not be returned because support for explicit permissions is available for database assets associated with published data sources only.
404	404000	Site not found	The site LUID in the URI doesn't correspond to an existing site.
404	404003	Resource not found	The database LUID in the URI doesn't correspond to a database asset on the site.

## List Default Permissions Returns details of default permission rules granted to users and groups for workbook, data source, data role, lens, flow, metric, or virtual connection resources in a project for a user or group. If Tableau Catalog is enabled, this method can also return details of default permission rules granted to users and groups for database or table resources in a project. #### URI Workbooks: GET /api/api-version/sites/site-luid/projects/project-luid/default-permissions/workbooks Data sources: GET /api/api-version/sites/site-luid/projects/project-luid/default-permissions/datasources Data roles: GET /api/api-version/sites/site-luid/projects/project-luid/default-permissions/dataroles Lenses: GET /api/api-version/sites/site-luid/projects/project-luid/default-permissions/lenses Metrics: GET /api/api-version/sites/site-luid/projects/project-luid/default-permissions/metrics Flows: GET /api/api-version/sites/site-luid/projects/project-luid/default-permissions/flows Virtual Connections _(endpoint introduced in [API version](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm#rest_and_tableau_version_table) 3.23)_: GET /api/api-version/sites/site-luid/projects/project-luid/default-permissions/virtualconnections Databases: GET /api/api-version/sites/site-luid/projects/project-luid/default-permissions/databases Tables: GET /api/api-version/sites/site-luid/projects/project-luid/default-permissions/tables #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site that contains the project.
project-luid	The LUID of the project to get default permissions for.

#### Request Body None #### Permissions Users who are not server administrators can query default permissions for a project only if they have the ProjectLeader permission for that project (either explicitly or implicitly). #### Required scope for JWT authorization _Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. **Note:** The following scope applies to data sources, workbooks, and metrics only. ``` tableau:permissions:read ``` #### Response Code 200 #### Response Body ``` <... additional capabilities ...> <... additional grantee capabilities ...> ``` #### Version - Version 2.1 and later. - Version 3.23 and later for the virtual connection default permissions methods. - For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403035	Querying data source permissions forbidden	The caller doesn't have permissions to query the project's default permissions for data sources.
403	403036	Querying workbook permissions forbidden	The caller doesn't have permissions to query the project's default permissions for workbooks.
403	403035	Querying flow permissions forbidden	The caller doesn't have permissions to query the project's default permissions for flows.
404	404000	Site not found	The site LUID in the URI doesn't correspond to an existing site.
404	404005	Project not found	The project LUID in the URI doesn't correspond to an existing project.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## List edges around a node List the edges connected to a node. **Version:** Available in Tableau Cloud September 2026 and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any authenticated user. The user can read nodes allowed by content permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** Tableau Cloud+ **Access Scope:** \`tableau:knowledge:read\` [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/v1/knowledge/edges/search [view details](#) ## List Extract Refresh Tasks in Server Schedule Returns a list of the extract refresh tasks for a specified server schedule on the specified site on Tableau Server. To get the ID of a schedule, call the [List Server Schedules](#query_schedules) method. Note that the List Server Schedules method is global to the server; schedules are not specific to a site. Therefore, the URI for the List Server Schedules method does not include `/sites/` or a site ID. However, individual scheduled tasks are specific to a site, and the URI for Query Extract Refresh Tasks must include the site information. For more information about refresh tasks, see [Manage Refresh Tasks](https://help.tableau.com/current/server/en-us/help.htm#task.htm). _Not available for Tableau Cloud._ #### URI GET /api/api-version/sites/site-id/schedules/schedule-id/extracts GET /api/api-version/sites/site-id/schedules/schedule-id/extracts?pageSize=page-size&pageNumber=page-number #### Parameter Values

api-version	The version of the API to use, such as `2.2`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the refresh tasks.
schedule-id	The ID of the schedule to get extract information for.
page-size	(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number	(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.

#### JWT Access Scope Not available. For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Request Body None #### Permissions This method can only be called by server administrators and site administrators. When a site administrator calls this method, the payload contains only the tasks that are associated with the site that the user is signed in to. #### Response Code 200 #### Response Body ``` ... additional extract refresh tasks ... ``` #### Version Version 2.2 and later. Virtual connection support added in 3.30. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400006	Invalid page number	The page number parameter is not an integer, is less than one, or is greater than the final page number for data sources at the requested page size.
400	400007	Invalid page size	The page size parameter is not an integer, or is less than one.
400	400047	Invalid schedule type	The schedule type does not represent an extract refresh task. (For example, it might be a subscription task.)
403	403014	Page size limit exceeded	The specified page size is larger than the maximum page size.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404	Schedule not found	The schedule ID in the URI doesn't correspond to an existing schedule.
405	405000	Invalid request method	Request type was not GET.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site.

#### JWT Access Scope Available in API 3.20 (Tableau Cloud June 2023). `tableau:tasks:read` (this scope is included in the scope: `tableau:tasks`) For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### cURL Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/tasks/extractRefreshes" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` #### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can only access the list of extract refresh tasks that they own. #### Response Code 200 #### Response Body Tableau Server and Tableau Cloud return different payloads in response to this request. Output for virtual connections includes `transactionLevel` and table ids in addition to the output that's standard for data sources and workbooks. ### Tableau Server Response On Tableau Server, a list of extract refresh tasks with their server schedules is returned. ``` ``` ``` { "tasks": [ { "extractRefresh": { "id": "refresh_task_id", "priority": "nn", "consecutiveFailedCount": "n", "type": "REFRESH_EXTRACT", "schedule": { "id": "schedule_id", "name": "schedule_name", "state": "state", "priority": "nn", "createdAt": "DATE_TIME", "updatedAt": "DATE_TIME", "type": "Extract", "frequency": "frequency", "nextRunAt": "DATE_TIME" }, "datasource": { "id": "datasource_id" } } }, [] ] } ``` ### Tableau Cloud Response On Tableau Cloud, a list of extract tasks with their frequency is returned. ``` ``` ``` { "tasks": { "task": { "extractRefresh": { "id": "0ece2369-c4eb-4382-be0f-961039d708a0", "priority": "50", "consecutiveFailedCount": "5", "type": "RefreshExtractTask", "schedule": { "frequency": "Weekly", "nextRunAt": "2023-06-08T04:50:00Z", "frequencyDetails": { "start": "21:50:00", "intervals": { "interval": [ { "weekDay": "Thursday" } ] } } }, "workbook": { "id": "7e766949-7166-4b3d-90ba-784f7575743b" } } } } } ``` #### Version Version 2.6 and later. Virtual connection support added in 3.30. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

405

405000

Invalid requests method

Request type was not GET

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## List Flow Permissions Returns a list of permissions for the specific flow. #### URI GET /api/api-version/sites/site-id/flows/flow-id/permissions #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the flow.
flow-id	The ID of the flow to get permissions for.

#### Request Body None #### Permissions This method can only be called by server administrators and site administrators. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:permissions:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ... additional capabilities ... ``` **Note**: The parent element is included in the response only if the workbook's permissions are determined by project-level default permissions and project permissions are locked. Project permissions can be locked for a new project when you call [Create Project](#create_project) or for an existing project by calling [Update Project](#update_project). For more information, see [Lock Content Permissions to the Project](https://help.tableau.com/current/server/en-us/help.htm#permissions_project_lock.htm). #### Version Version 3.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404027	Flow not found	The flow ID in the URI doesn't correspond to an existing flow.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/flows/1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d/permissions" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` **Example response:** ``` ``` ## List followed metrics groups Gets the user's followed metrics. Optionally metrics can be grouped by characteristics like datasource, and sorted. **Version:** Available in API 3.23 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can create a metric in a definition as long as the user has read or connect access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insights:read\` [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/metrics:followedMetricsGroups [view details](#) ## List Group Sets Lists all group sets matching optional filter and ordered by optional sort expression. **Note**: After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. **Version:** Available in API 3.22 (Tableau Cloud February 2024 / Server 2024.2) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** This method can only be called by Tableau Server administrators or Tableau Cloud site admins. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** tableau:groupsets:read - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-id/groupsets?pageSize\=page-size&pageNumber\=page-number GET /api/api-version/sites/site-id/groupsets?filter=filter-expression GET /api/api-version/sites/site-id/groupsets?sort=sort-expression #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the group sets.
page-size	(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number	(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.
filter-expression	(Optional) An expression that lets you specify a subset of group sets to return. You can filter on predefined fields such as `name`. You can include multiple filter expressions. For more information, see Filtering and Sorting.
sort-expression	(Optional) An expression that lets you specify the order in which group set information is returned. If you don’t specify a sort expression, the sort order of the information that's returned is undefined. For more information, see Filtering and Sorting.

#### Request Body None #### cURL Request Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/groupsets&[resultlevel=[members,local]]" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` #### Response Code 200 #### Response Body Copy ``` ``` Copy ``` { "pagination": { "pageNumber": "1", "pageSize": "100", "totalAvailable": "3" }, "groupSets": [ { "id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d", "name": "All Users", "groupCount": "1", "group": { "id": "gs-1", "name": "group-one" } }, { "id": "9a8a7b6b-5c4c-3d2d-1e0e-9a8a7b6b5b4b", "name": "active-directory-group-import", "group": { "id": "gs21", "name": "group-two" } }, { "id": "7b6b59a8-ac3c-4d1d-2e9e-0b5b4ba8a7b6", "name": "local-group-license-on-login", "group": { "id": "gs-3", "name": "group-three" } } ]} ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400006	Invalid page number	The page number parameter isn’t an integer, is less than one, or is greater than the final page number for data sources at the requested page size.
400	400007	Invalid page size	The page size parameter isn’t an integer, or is less than one.
403	403014	Page size limit exceeded	The specified page size is larger than the maximum page size.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	The request type wasn’t GET.
409	409120	Group set not found	The group set ID in the URI doesn't correspond with an existing group set.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## List Identity Pools List all identity pools. **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/authn-service/identity-pools [view details](#) ## List Identity Stores List information about all identity store instances used to provision users. **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/authn-service/identity-stores [view details](#) ## List items in a collection Lists items in a collection. **Version:** Available in API 3.28 (Cloud February 2026 / Server 2026.2) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Tableau administrators can call this method for all sites they administer. Other users can call this method for collections that they own. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:collections:read. Added in API 3.28. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/collections/{luid}/items [view details](#) ## List knowledge graphs List the knowledge graphs on the caller's Tableau site, each with its ID, name, description, status, and **Version:** Available in Tableau Cloud September 2026 and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any authenticated user. The user can read nodes allowed by content permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** Tableau Cloud+ **Access Scope:** \`tableau:knowledge:read\` [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/v1/knowledge/graphs [view details](#) ## List knowledge sources List the data sources and workbooks connected to the graph. **Version:** Available in Tableau Cloud September 2026 and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any authenticated user. The user can read nodes allowed by content permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** Tableau Cloud+ **Access Scope:** \`tableau:knowledge:read\` [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/v1/knowledge/sources/search [view details](#) ## List Label Categories on Site Lists all data label categories on the site. Note that category is one property of a label value (labelValue), which is itself a property of a label on an asset. Other properties of a labelValue include name and description. These properties determine label behavior and options that users see in label dialogs. For more information on data label objects and properties, see the [Data Labels in the REST API](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_data_labels.htm) topic. #### URI GET api/api-version/sites/site-luid/labelCategories #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The unique LUID of the site asset.

#### Request Body None #### Permissions Any logged in user can view the label categories for their site. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:label_categories:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Version Introduced in Tableau Cloud October 2023 (API 3.21) / Server 2023.3 (API 3.21). #### Response Body ``` Copy ``` { "pagination": { "pageNumber": "pageNumber", "pageSize": "page-size", "totalAvailable": "total-available" }, "subscriptions": { "subscription": { "id": "subscription-id", "subject": "subscription-subject", "attachImage": "attach-image-flag", "attachPdf": "attach-pdf-flag", "suspended": "suspended-flag", "pageOrientation": "page-orientation", "pageSizeOption": "page-size-option", "content": { "id": "content-id", "type": "content-type", "sendIfViewEmpty": "send-view-if-empty-flag" }, "schedule": { "id": "schedule-id", "name": "schedule-name" }, "user": { "id": "user-id", "name": "user-name" } } }} ``` ### Tableau Cloud Request For Tableau Cloud, a task with frequency is returned. Copy ``` ``` Copy ``` { "pagination": { "pageNumber": "1", "pageSize": "100", "totalAvailable": "1" }, "subscriptions": { "subscription": { "id": "92cb4f51-7a15-41d4-bce4-a0fcce5fa985", "subject": "Subscription - postman", "message": "weekly report", "attachImage": "true", "attachPdf": "false", "suspended": "false", "content": { "id": "be016ba6-d0a8-44ae-a057-b6df6931ccaa", "type": "Workbook", "sendIfViewEmpty": "true" }, "schedule": { "frequency": "Weekly", "nextRunAt": "2023-06-08T17:05:00-0700", "frequencyDetails": { "start": "17:05:00", "intervals": { "interval": [ { "weekDay": "Thursday" } ] } } }, "user": { "id": "14064b01-7d58-4978-bdeb-a5f8d7694863", "name": "memysite.com" } } }} ``` #### Version For Tableau Server: API 2.3 and later. For Tableau Cloud: API 3.20 (June 2023) and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400006	Invalid page number	The page number parameter is not an integer, is less than one, or is greater than the final page number for the sites at the requested page size.
400	400007	Invalid page size	The page size parameter is not an integer, or is less than one.
403	403014	Page size limit exceeded	The specified page size is larger than the maximum page size.
404	404000	Site not found	The specified site doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## List subscriptions Lists the subscriptions to a specified metric and/or for a specified user. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user that has read or connect permission to the data source used in the definition can list subscriptions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:metric\_subscriptions:read Access Scopes [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/subscriptions [view details](#) ## List Table Permissions Get information about the permissions on a table asset. #### URI GET api/_api-version_/sites/_site-id_/tables/_table-id_/permissions #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
table-id	The unique ID of the table asset.

``` #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400120	Bad request	Permissions could not be returned because support for explicit permissions is available for table assets associated with published data sources (not embedded data sources) only.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404032	Table not found	The requested table asset could not be found.
409	409052	Table error	An unknown table asset error occurred.
409	409053	Unknown table query error	An unknown error occurred and the table query could not complete.

## List Tableau extensions server settings Lists the settings for extensions of a server. **Version:** Available in API 3.21 (Tableau Server 2023.3) and later. Not available for Tableau Cloud. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** This method can only be called by users with server administrator permissions. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** tableau:extensions\_server\_settings:read - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/settings/extensions #### URI Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.

#### Request Body None #### cURL Request Example `curl -X GET "http://MY-SERVER/api/3.29/settings/extensions" -H "Content-Type: application/xml" -H "X-Tableau-Auth: SBGBfOYRSN2JoFe866wpIg|hLI0ZzWmK3xfMtwD8WoztCMqfWaFdcCj|a946d998-2ead-4894-bb50-1054a91dcab3"` #### Response Code 200 #### Response Body Copy ``` true https://test.com ``` Copy ``` { "extensionsServerSettings": { "extensionsGloballyEnabled": "true", "blockList": "https://test.com" }} ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403000	Non-admin access forbidden	The client attempted to access an API method while signed in as a non-administrator user.
404	404000	Bad Request	The requested resource could not be found.
500	500000	Internal Server Error	The request could not be completed.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## List Tableau extensions site settings Lists the settings for extensions of a site. **Version:** Available in API 3.21 (Tableau Cloud June 2023 / Tableau Server 2023.3) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Any authenticated user can list the extension settings for a site using this method. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** tableau:extensions\_site\_settings:read - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-luid/settings/extensions #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.

#### Request Body None #### cURL Request Example `curl --location "http://MY-SERVER/api/3.29/sites/a946d998-2ead-4894-bb50-1054a91dcab3/settings/extensions " --header "X-Tableau-Auth: SBGBfOYRSN2JoFe866wpIg|hLI0ZzWmK3xfMtwD8WoztCMqfWaFdcCj|a946d998-2ead-4894-bb50-1054a91dcab3"` #### Response Code 200 #### Response Body Copy ``` true false http://localhost:9123/Dynamic.html true true true true true false ``` Copy ``` { "extensionsEnabled": "true", "useDefaultSetting": "false", "safeList": [ { "url": "http://localhost:9123/Dynamic.html", "fullDataAllowed": true, "promptNeeded": true } ], "allowTrusted": true, "includeSandboxed": true, "includeTableauBuilt": true, "includePartnerBuilt": false }} ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403000	Non-admin access forbidden	The client attempted to access an API method while signed in as a non-administrator user.
404	404000	Site Not Found	The site ID in the URI doesn't correspond to an existing site.
500	500000	Internal Server Error	The request could not be completed.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## List Users with Custom View as Default Gets the list of users whose default view is the specified custom view. **Version:** Available in API 3.21 (Tableau Cloud October 2023 / Server 2023.3) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Only Tableau administrators can list users whose default view is the specified custom view. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:content:read - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-luid/customviews/custom-view-luid/default/users #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
custom-view-luid	The LUID for the custom view being updated.

#### Request Body None. #### cURL Request Example ``` curl --location 'https://qa-near.tsi.lan/api/3.21/sites/a946d998-2ead-4894-bb50-1054a91dcab3/customviews/3321cb71-6606-4d78-8a0c-e69a7e7d2261/default/users' --header 'Accept: application/xml' --header 'X-Tableau-Auth: LfzV48kKRUOYMYbzamWRpA|bfkD8ruGmN8ZNGmdL03PHB0gMHGtCfOk|a946d998-2ead-4894-bb50-1054a91dcab3' ``` #### Response Code 200 #### Response Body Copy ``` ``` Copy ``` { "pagination": { "pageNumber": "1", "pageSize": "100", "totalAvailable": "1" }, "users": { "user": [ { "id": "5c9a81df-7ec0-4752-a057-82cd2bb22c44" } ] }} ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403162	Unauthorized Access	The user does not have adminstrator permissions.
404	404008	Resource Not Found	A custom view with the requested LUID could not be found.
405	405000	Invalid Request Method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## List View Permissions Returns a list of permissions for the specific view. #### URI GET /api/api-version/sites/site-id/views/view-id/permissions #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the view.
view-id	The ID of the view to get permissions for.

#### Request Body None #### Permissions This method can only be called by server and site administrators, and users who have Read (view) permission for the specific view. #### Required scope for JWT authorization _Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. ``` tableau:permissions:read ``` #### Response Code 200 #### Response Body ``` ... additional capabilities ... ... additional capabilities ... ... additional capabilities ... ``` **Note**: The parent element is included in the response only if the view's permissions are determined by project-level default permissions and project permissions are locked. Project permissions can be locked for a new project when you call [Create Project](#create_project) or for an existing project by calling [Update Project](#update_project). For more information, see [Lock Content Permissions to the Project](https://help.tableau.com/current/server/en-us/help.htm#permissions_project_lock.htm). #### Version Version 3.2 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Permissions setting forbidden	A non-administrator user called this method but doesn't have permission to set permissions on the view.
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
404	404011	View not found	The view ID in the URI doesn't correspond to an existing view.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID for the site that contains the virtual connection.
virtual-connection-id	The LUID for the virtual connection that includes the database connections.
page-size	(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number	(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.

#### Request Body None #### cURL Request Example `curl --location --request GET "https://MY_SERVER/api/3.18/sites/a946d998-2ead-4894-bb50-1054a91dcab3/virtualconnections/26bc30d8-90d6-4af1-922d-ac285e7b08fb/connections?X-Tableau-Auth =3bl3fJb0T6qxhaCqneNhWg"Nmv6zrJfYeiiovCuEs2grrBAZlREbRGl"a946d998-2ead-4894-bb50-1054a91dcab3"` #### Response Code 200 #### Response Body ```

``` ``` { "pagination": { "pageNumber": "pageNumber", "pageSize": "page-size", "totalAvailable": "total-available" }, "virtualConnectionConnections": { "connection": { "id": "connection-id", "serverAddress": "server-address", "dbClass": "database-type", "serverPort": "port-number", "userName": "connection-user-name" } }} ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400006	Invalid page number	The page number parameter is not an integer, is less than one, or is greater than the final page number for virtual connections at the requested page size.
400	400007	Invalid page size	The page size parameter is not an integer, or is less than one.
401	401002	Unauthorized	The authentication token provided in the request header was invalid or has expired.
403	403014	Page size limit exceeded	The specified page size is larger than the maximum page size.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## List Virtual Connection Permissions Returns a list of permissions for a specific virtual connection. #### URI GET /api/api-version/sites/site-id/virtualconnections/virtualconnection-id/permissions #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the virtual connection.
virtualconnection-id	The ID of the virtual connection to get permissions for.

#### Request Body None #### Permissions You must be an administrator or have the Read (View) permission for the virtual connection (either explicitly or implicitly). #### Required scope for JWT authorization _Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. ``` tableau:permissions:read ``` #### Response Code 200 #### Response Body ``` ``` **Note**: The parent element is included in the response only if the workbook's permissions are determined by project-level default permissions and project permissions are locked. Project permissions can be locked for a new project when you call [Create Project](#create_project) or for an existing project by calling [Update Project](#update_project). For more information, see [Lock Content Permissions to the Project](https://help.tableau.com/current/server/en-us/help.htm#permissions_project_lock.htm). #### Version Version 3.23 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404004	Virtual Connection not found	The virtual connection ID in the URI doesn't correspond to an existing virtual connection.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl --location 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd/permissions' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3'` ## List Virtual Connection Revisions Lists revisions for a virtual connection. **Version:** Available in API 3.23 (Tableau Cloud June 2024 / Tableau Server 2024.2) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** Requires [Tableau Data Management](https://help.tableau.com/current/online/en-us/dm_overview.htm). **Permissions:** You must have the Overwrite permission for the virtual connection and your site role must be at least Creator. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:virtual\_connections:read - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). **Note:** This method can only succeed if version history is enabled for the specified site. For more information, see [Maintain a History of Revisions](https://help.tableau.com/current/server/en-us/help.htm#revision_history_maintain.htm) in the Tableau Server Help. #### URI GET /api/api-version/sites/site-id/virtualconnections/virtual-connection-id/revisions GET /api/api-version/sites/site-id/virtualconnections/virtual-connection-id/revisions/?pageSize\=page-size&pageNumber\=page-number #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID for the site.
virtual-connection-id	The LUID for the virtual connection.
page-size	(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number	(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.

#### Request Body None #### cURL Request Example _(Use the icon in the top right corner to copy the text.)_ ``` curl 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd/revisions' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3 ' ``` #### Response Code 200 #### Response Body ``` ``` ``` "pagination": { "pageNumber": "page-number", "pageSize": "page-size", "totalAvailable": "page-count" }, "revisions": { "revision": [ { "publisher": { "id": "publisher-id", "name": "publisher-username" }, "revisionNumber": "revision-number", "publishedAt": "datetime", "deleted": deleted-flag, "current": current-flag }, { "publisher": { "id": "publisher-id", "name": "publisher-username" }, "revisionNumber": "revision-number", "publishedAt": "datetime", "deleted": deleted-flag, "current": current-flag }, { ...Additional revisions... } ] } } ``` The `current` property of a revision shows `false` for all revisions except for the currently active virtual connection revision, in which case it shows `true`. #### Errors

HTTP status	`error` Code	Condition	Details
400	400058	Generic error	An unknown error occurred.
403	403054	User not authorized.	User doesn't have permissions to revisions on this virtual connection. Check the user's permissions.
403	403173	User not authorized.	User forbidden from listing virtual connection revisions. Check the user's permissions and site role.
403	403053	Revision history is disabled on the site.	Check the revision history setting.
404	404049	Virtual connection not found	Check the virtual connection LUID.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## List Virtual Connections Returns a list of available virtual connection names and IDs. **Version:** Available in API 3.18 (Tableau Cloud December 2022 / Server 2023.1) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** Requires [Tableau Data Management](https://help.tableau.com/current/online/en-us/dm_overview.htm). **Permissions:** By default, all users can view virtual connections. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:content:read - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-id/virtualconnections GET /api/api-version/sites/site-id/virtualconnections/?pageSize=page-size&pageNumber=page-number GET /api/api-version/sites/site-id/virtualconnections/?sort=sort-expression #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID for the site that contains the virtual connection.
page-size	(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number	(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.
sort-expression	(Optional) An expression that lets you specify the order in which virtual connection information is returned. If you do not specify a sort expression, the sort order of the information that's returned is undefined. For more information, see Filtering and Sorting.

#### Request Body None #### cURL Request Example `curl --location --request GET "https://MY_SERVER/api/3.18/sites/a946d998-2ead-4894-bb50-1054a91dcab3/virtualconnections" \ --header "X-Tableau-Auth: 3bl3fJb0T6qxhaCqneNhWg"Nmv6zrJfYeiiovCuEs2grrBAZlREbRGl"a946d998-2ead-4894-bb50-1054a91dcab3"` #### Response Code 200 #### Response Body ```

``` ``` { "pagination": { "pageNumber": "page-number", "pageSize": "page-size", "totalAvailable": "total-available" }, "virtualConnections": { "virtualConnection": { "createdAt": "datetime-created", "hasExtracts": "has-extracts-flag", "id": "virtual-connection-id", "isCertified": "is-certified-flag", "name": "virtualconnection-name", "updatedAt": "datetime-updated", "webpageUrl": "web-page-url" } }} ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400006	Invalid page number	The page number parameter is not an integer, is less than one, or is greater than the final page number for virtual connections at the requested page size.
400	400007	Invalid page size	The page size parameter is not an integer, or is less than one.
400	400008	Invalid parameter value	A parameter in the request body is missing or invalid.
403	403014	Page size limit exceeded	The specified page size is larger than the maximum page size.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## List Webhooks Returns a list of all the webhooks on the specified site. #### URI GET /api/3.6/sites//webhooks #### Parameter Values

site-id

The ID of the site that contains the webhooks.   

#### Request Body None #### Permissions This method can only be called by server and site administrators. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:webhooks:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body

## List Workbook Permissions Returns a list of permissions for the specific workbook. #### URI GET /api/api-version/sites/site-id/workbooks/workbook-id/permissions #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook.
workbook-id	The ID of the workbook to get permissions for.

#### Request Body None #### Permissions This method can only be called by server administrators and site administrators. #### Required scope for JWT authorization _Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17)._ Authorize use of this method by including this scope in the JSON Web Token (JWT). For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Access Scopes for Connected Apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) in the Tableau Cloud Help or [Access Scopes for Connected Apps](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) in the Tableau Server Help. ``` tableau:permissions:read ``` #### Response Code 200 #### Response Body ``` ... additional capabilities for users ... ... additional capabilities for groups ... ... additional grantee capability sets ... ``` **Note**: The parent element is included in the response only if the workbook's permissions are determined by project-level default permissions and project permissions are locked. Project permissions can be locked for a new project when you call [Create Project](#create_project) or for an existing project by calling [Update Project](#update_project). For more information, see [Lock Content Permissions to the Project](https://help.tableau.com/current/server/en-us/help.htm#permissions_project_lock.htm). #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404006	Workbook not found	The workbook ID in the URI doesn't correspond to an existing workbook.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/workbooks/1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d/permissions" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` **Example response:** ``` ``` ## Lists all definition tags for the site. Lists all definition tags for the site. Results can be filtered by tag value, definition name, or datasource ID. Each result includes the tag value and a count of how many definitions use it. **Version:** Available in API 3.29 (Tableau Cloud August 2026) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Can be called by any user, but only returns definitions and metrics that the user has permissions to view. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_definitions\_metrics:read\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) GET {server}/api/-/pulse/definitions/tags [view details](#) ## Move Bridge Client Moves a Bridge client between pools or to unassigned status. The operation is atomic (all-or-nothing). For moveToNamedPool the pool must exist and be a valid UUID; moveToUnassigned is useful for temporarily deactivating a client without deleting it. This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PATCH /api/api-version/sites/site-luid/bridge-clients/bridge-client-id #### URI Parameter Values

api-version	The version of the API to use. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
bridge-client-id	The unique identifier for the Bridge client to move.

#### Request Body ``` ``` ``` { "bridgeClientMoveRequest": { "moveToNamedPool": { "poolId": "abc-123-def-456" } } } ``` #### Attribute Values

poolId	Required when using `moveToNamedPool`. The UUID of the Bridge pool to move the client to.
moveToDefaultPool	Set to `true` to move the Bridge client to the default pool. Use in place of `moveToNamedPool`.
moveToUnassigned	Set to `true` to move the Bridge client to unassigned status. Use in place of `moveToNamedPool`.

#### Response Code 204 No Content #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
400	BAD_REQUEST	Multiple operations specified	Cannot specify more than one move operation in a single request.
400	BAD_REQUEST	No operation / Missing poolId / Invalid poolId	Request must contain exactly one valid move operation; poolId required for moveToNamedPool and must be a valid UUID.
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	403000	Insufficient permissions	User does not have Site Administrator role.
404	503001	Bridge client not found	Bridge client with the specified ID does not exist on this site.
404	503005	Pool not found	The specified poolId does not exist on this site.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500	503004	Unexpected server error	An unexpected error occurred while moving the Bridge client.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Move Database Move one or more databases to a project. You can move the database and its tables, or move only the database. To move a table independently of its database, use the [Move Table](#move_table) method. Note: Starting in Tableau Cloud June 2022 and Tableau Server 2022.3, projects can contain databases and tables, and database and table permissions can be managed at the project level through inheritance. In Tableau Cloud March 2022 and Tableau Server 2022.1 and earlier, projects couldn't contain databases or tables. The Move Database method can either: - Move a database from one project to another project. - Move a database not in a project to a project. This method can't remove a database from all projects. (The only way to remove a database from all projects is to delete the project that the database is in.) This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI POST api/api-version/sites/site-luid/databases #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site that contains the database.

#### Request Body ``` ``` The contentAction element is optional. - If the contentAction element is not included, moving the database will also move its tables. - If the contentAction element is included and the action attribute is set to MoveDatabaseOnly, moving the database will not move its tables. The resourceList element can contain a minimum of 1 and a maximum of 1000 resource elements. #### Attribute Values

project-luid	The LUID of the destination project.
location-type	The destination type. Currently, this value must be "PROJECT".
action-type	To move a database without moving its tables, this value must be "MoveDatabaseOnly".
database-luid	The LUID of the database.
asset-type	The type of asset being moved. Currently, this value must be "DATABASE".

#### Permissions If you are moving a database _without_ its tables, you must have read and changeHierarchy permissions for the database, and write permission for the target project. If you are moving both a database and its tables, you must have read and changeHierarchy permissions for both the database and its tables, and write permission for the target project. Note: Currently, you can only set the ChangeHierarchy permission for databases and tables using the REST API. See [Add Database Permissions](#add_database_perms) and [Add Table Permissions](#add_table_perms) for information on adding this permission. Setting the required database and table permissions depends on whether the database is in a project or not. - If the database is in a project, the database and table permissions will follow the rules for permissions on content inside of projects. See [Set Permissions](https://help.tableau.com/current/server/en-us/permissions.htm#set-permissions) for information on these rules. - If the database is not in a project, the database and table permissions will follow the rules for permissions on external assets. See [Set permissions on individual external assets](https://help.tableau.com/current/server/en-us/dm_perms_assets.htm#set-permissions-on-individual-external-assets) for information on these rules. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:database_projects:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response when all elements were moved successfully:** ``` ``` **Example response when not all elements were moved successfully.:** When some database resource elements of a request with multiple database resource elements can’t be moved, the HTTP status 400 is returned, and the response contains additional information about failures. Resource elements from the request body that are not referenced in the response body were successfully moved. A response indicating partial success looks like: ```

Bad Request

There was a problem completing one or more requests. ``` #### Version Introduced Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	409100	Invalid location type	The location element's type attribute must be "PROJECT".
400	409103	Invalid content type	The resource element's contentType attribute must be "DATABASE".
403	403004	Operation on resource unauthorized	Insufficient permissions or operation not allowed. Make sure Tableau Catalog is enabled.
403	403030	Permissions denied	The user does not have permission to move the database.
403	403112	Invalid Operation	The database may be embedded, and therefore cannot be moved.
403	403156	External assets can not be moved	The user does not have appropriate permissions.
404	404005	Project not found	The project LUID doesn't correspond to an existing project.
404	404031	Database not found	The database LUID doesn't correspond to an existing database. In a case where multiple databases were specified in the request, other database moves could have succeeded.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl --location --request POST 'http://MY-SERVER/api/3.16/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/databases' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: 12ab34cd56ef78ab90cd12ef34ab56cd' -d @move-database.xml` **Content of move-database.xml:** ``` ``` **Example response:** ``` ``` ## Move Table Moves one or more tables to a project. Note: Starting in Tableau Cloud June 2022 and Tableau Server 2022.3, projects can contain databases and tables, and database and table permissions can be managed at the project level through inheritance. In Tableau Cloud March 2022 and Tableau Server 2022.1 and earlier, projects couldn’t contain databases or tables. The Move Table method can either: - Move a table from one project to another project. - Move a table not in a project to a project. This method can’t remove a table from all projects. (The only way to remove a table from all projects is to delete the project that the table is in.) This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI POST api/api-version/sites/site-luid/tables #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site that contains the table.

#### Request Body ``` ``` The resourceList element can contain a minimum of 1 and a maximum of 1000 resource elements. #### Attribute Values

project-luid	The LUID of the destination project.
location-type	The destination type. Currently, this value must be "PROJECT".
table-luid	The LUID of the table.
asset-type	The type of asset being moved. Currently, this value must be "TABLE".

#### Permissions You must have read and changeHierarchy permissions for the table, and write permission for the target project. If you are moving both a database and its tables, you must have read and changeHierarchy permissions for both the database and its tables, and write permission for the target project. Note: Currently, you can only set the ChangeHierarchy permission for databases and tables using the REST API. See [Add Database Permissions](#add_database_perms) and [Add Table Permissions](#add_table_perms) for information on adding this permission. Setting the required table permissions depends on whether the parent database is in a project or not. - If the table is in a project, the table permissions will follow the rules for permissions on content inside of projects. See [Set Permissions](https://help.tableau.com/current/server/en-us/permissions.htm#set-permissions) for information on these rules. - If the table is not in a project, the table permissions will follow the rules for permissions on external assets. See [Set permissions on individual external assets](https://help.tableau.com/current/server/en-us/dm_perms_assets.htm#set-permissions-on-individual-external-assets) for information on these rules. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:table_projects:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response when all elements were moved successfully:** ``` ``` **Example response when not all elements were moved successfully.:** When some table resource elements of a request with multiple table resource elements can’t be moved, the HTTP status 400 is returned, and the response contains additional information about failures. Resource elements from the request body that are not referenced in the response body were successfully moved. A response indicating partial success looks like: ```

Bad Request

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	409100	Invalid location type	The location element's type attribute must be "PROJECT".
400	409103	Invalid content type	The resource element's contentType attribute must be "TABLE".
403	403004	Operation on resource unauthorized	Insufficient permissions or operation not allowed. Make sure Tableau Catalog is enabled.
403	403030	Permissions denied	The user does not have permission to move the table.
403	403112	Invalid Operation	The table may belong to an embedded database, and therefore cannot be moved.
403	403156	External assets can not be moved	The user does not have appropriate permissions.
404	404005	Project not found	The project LUID doesn't correspond to an existing project.
404	404032	Table not found	The table LUID doesn't correspond to an existing table. In a case where multiple tables were specified in the request, other table moves could have succeeded.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl --location --request POST 'http://MY-SERVER/api/3.16/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/tables' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: 12ab34cd56ef78ab90cd12ef34ab56cd' -d @move-table.xml` **Content of move-table.xml:** ``` ``` **Example response:** ``` ``` ## Organize Favorites Move an item to organize a user's favorites. #### URI PUT /api/api-version/sites/site-id/orderFavorites/user-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that the user is a member of.
user-id	The ID of the user for which you want to get a list favorites.

#### Request Body ``` ``` #### Attribute Values

favorite-id	The ID of the favorite you want to move.
content-type	The content type of a favorite. To specify the type, use one of the following values: datasource workbook view project flow These values are not case sensitive.
favorite-id-after	The ID of the favorite that should follow, or come after, the favorite you want to move.

#### Permissions Users who are not server administrators or site administrators can call this method only if they are the user for which they want to move favorites. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:favorites:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body None #### Version Version 3.8 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

403	403004	Forbidden Favorites access	A non-administrator user called this method but doesn't have permission to view the specified user's favorites.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user.
404	404010	Favorite not found	The favorite ID specified doesn't correspond to a user's favorite.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Publish Data Source Publishes a data source on the specified site, or appends data to an existing data source. To make other changes to a published data source, call [Update Data Source](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_data_sources.htm#update_data_source) or [Update Data Source Connection](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_data_sources.htm#update_data_source_connection). **Version**: Available in API 2.0 and later. **License**: Available for Tableau Server and Tableau Cloud. **Permissions**: You can publish a data source if you have implicit or explicit Publish permissions for the data source, or are a Tableau administrator. Note: The `queryTaggingEnabled` attribute is returned only for administrator users. **Access Scope**: `tableau:datasources:create` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). This method is used in two ways. You can call it to publish a data source in a single request. To do that, you include the content of the data source file in the body of the request. The maximum size of a file that can be published in a single request is 64 MB. If you want to avoid having the publishing process time out, you can use the _asJob_ parameter to make data source publication asynchronous. Alternatively, you can publish a data source in multiple parts. To do that, you initiate a file upload by calling [Initiate File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_publishing.htm#initiate_file_upload), send portions of the file to the server using [Append to File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_publishing.htm#append_to_file_upload), and then commit the upload by calling Publish Data Source. In this case, Publish Data Source doesn't contain the file to publish. **Extracts with multiple table options** Starting in v2021.4, you can publish multi table Hyper extract files created using the [Hyper API](https://help.tableau.com/current/api/hyper_api/en-us/docs/hyper_api_create_update.html). The data must include a single [fact table](https://en.wikipedia.org/wiki/Fact_table) containing the foreign keys that relate the tables to each other. The Hyper API infers the data object model, but does not perform any validation, such as referential integrity checking. If the Hyper API can’t infer the data object model of a Hyper extract, for instance, because there is more than one fact table, then attempting to publish the extract will fail. Prior to v2021.4, there was no way to append data to an extract with multiple tables using the REST API. **Data Sources stored locally** When you publish a data source from your local computer to the server, you must make sure that the server has all the components that are required in order for other users to see and interact with the data source. For example, if the data source is based on an Excel spreadsheet, you typically publish a packaged data source (`.tdsx` file) that contains all the components for that data source. **Replace data source** Starting in version 2025.1, you can use the replace parameter. You can include `overwrite`, `append`, and `replace` in a single request, but only one of these parameters can be set to true. If more than one is set to true, the request returns an HTTP 400 error. **Working with Parquet files** \- When publishing a Parquet file to a data source through a live-to-Hyper connection, the files are converted to Hyper files. You may want to publish a copy of your original Parquet file to retain that data in its native format. \- A data source with a live-to-Hyper connection to data in a Hyper file converted from Parquet can only have a single connection. \- When incrementally updating that data from that connection, using the Update Hyper in Data Source method, the Parquet file is not converted to Hyper. **Composed data sources and extended data sources** Starting in REST API version 3.29 (Cloud 262 and Server 2026.2), you can publish composed and extended data sources. When you publish a composed data source, you must include a `parentDataSourceUrls` element in addition to the `.tds` file so the composed data source is correctly linked to its parents. Include one entry for every published data source that is a direct parent of the composed data source. These correspond to the `datasource-url` tags serialized in the `.tds` file's data source tree. Include only the immediate parent data sources that the data source you are publishing depends on. When you publish an extended data source, include the `.tds` file as usual; no `parentDataSourceUrls` element is required. For more information, see [Publishing Resources](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_publish.htm). #### URI POST /api/api-version/sites/site-luid/datasources POST /api/api-version/sites/site-luid/datasources?overwrite=overwrite-flag&asJob=asJob-value POST /api/api-version/sites/site-luid/datasources?append=append-flag POST /api/api-version/sites/site-luid/datasources?uploadSessionId=upload-session-id&datasourceType=datasource-file-type&overwrite=overwrite-flag&append=append-flag&replace=replace-flag #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site to publish to.
overwrite-flag	true to overwrite a data source that has the same name, or false to fail if the specified data source already exists. The default is false. If overwrite-flag is set to true but the data source doesn't already exist, the operation succeeds. You can include both the overwrite and append parameters in a request, but they cannot both be true.
replace-flag	(New in 2025.1) A boolean value (true or false). Set to true to replace the data in an existing data source. The default is false.
asJob-value	A Boolean value that is used to publish data sources asynchronously. If you set this value to false (the default), the publishing process runs as a synchronous process. If a data source is very large, the process might time out before it finishes. If you set this value to true, the process runs asynchronously, and a job will start to perform the publishing process and return the job ID. You can check the status of the import job by calling Query Job.
append-flag	true to append the data being published to an existing data source that has the same name. The default is false. If append-flag is set to true but the data source doesn't already exist, the operation fails. In order to append data to a published data source on Tableau Server, both the source file and the published file must be an extract with the file extension `.hyper` or `.tde`. The schema of the source and the published extract must match. If an extract was stored using the multiple tables option, you can't append data to it. You can include both the overwrite and append parameters in a request, but they cannot both be true.
upload-session-luid	If you are calling this method to commit a file that was uploaded in parts, this value contains the upload session LUID that was generated by a call to Initiate File Upload. If this value is not included, the server assumes that the body of the request contains the file to be published.
datasource-file-type	hyper, tds, tdsx, or tde the kind of file that you are uploading. This value is required if you are calling Publish Data Source in order to commit a file that was previously uploaded using Append to File Upload. The value is not used if you upload a file in the body of the request.

#### Request Body The content type in the header of requests to publish a data source must use the mixed multipart content type with a boundary string definition, in the form of: `Content-Type: multipart/mixed; boundary=boundary-string`. **Publishing a file in the request body** ``` --boundary-string Content-Disposition: name="request_payload" Content-Type: text/xml parent-datasource-url --boundary-string Content-Disposition: name="tableau_datasource"; filename="SALES.TDSX" Content-Type: application/octet-stream content-of-datasource-file --boundary-string-- ``` **Committing a file previously uploaded** ``` --boundary-string Content-Disposition: name="request_payload" Content-Type: text/xml parent-datasource-url --boundary-string-- ``` **Publishing a file in the request body** ``` Content-Length: 16301 Content-Type: multipart/form-data; boundary=----------------------my_boundary_string ----------------------my_boundary_string Content-Disposition: form-data; name="part1.json" Content-Type: application/json { "datasource": { "name": "datasource-name", "useRemoteQueryAgent": "remote-query-agent-flag", "description": "datasource-description", "connectionCredentials": { "name": "connection-username", "password": "connection-password", "embed": "embed-flag", "oAuth": "oauth-flag" }, "project": { "id": "project-id" }, "parentDataSourceUrls": [ "parent-datasource-url" ] } } ----------------------my_boundary_string Content-Disposition: form-data; name="datasource.tdsx" Content-Type: application/octet-stream content-of-datasource-file ----------------------my_boundary_string-- ``` **Committing a file previously uploaded** ``` Content-Length: 16301 Content-Type: multipart/form-data; boundary=----------------------my_boundary_string ----------------------my_boundary_string Content-Disposition: form-data; name="part1.json" Content-Type: application/json { "datasource": { "name": "datasource-name", "connectionCredentials": { "name": "connection-username", "password": "connection-password", "embed": "embed-flag", "oAuth": "oauth-flag" }, "project": { "id": "project-id" }, "parentDataSourceUrls": [ "parent-datasource-url" ] } } ----------------------my_boundary_string-- ``` #### Request Attributes

boundary-string	(Required) A string of characters that is guaranteed to be unique within the body of the request, and that is used to delimit sections of the request body. This value must be declared as a header that has this format: `Content-type: multipart/mixed; boundary=boundary-string`
datasource-name	(Required) The name to assign to the data source when it is saved on the server.
remote-query-agent-flag	(Optional) When `true`, this flag will allow your Tableau Cloud site to use Tableau Bridge clients. Bridge allows you to maintain data sources with live connections to supported on-premises data sources.
datasource-description	(Optional) A description of the data source.
connection-username	(Optional) If the data source connection requires credentials, the <connectionCredentials> elements is included and this attribute specifies the connection username. If the element is included but is not required, the server ignores the element and its attributes. If your auth type allows secrets to be passed as generic username and password variables, use this attribute for the appropriate secret, such as client id. (Example auth types include 2-legged OAuth, like Service Principal OAuth with Databricks and Client Credentials OAuth with Snowflake.)
connection-password	(Optional) If the data source connection requires credentials, the <connectionCredentials> elements is included and this attribute specifies the connection password. If the element is included but is not required, the server ignores the element and its attributes. If your auth type allows secrets to be passed as generic username and password variables, use this attribute for the appropriate secret, such as client secret. (Example auth types include 2-legged OAuth, like Service Principal OAuth with Databricks and Client Credentials OAuth with Snowflake.)
embed-flag	(Optional) If the data source connection requires credentials, the <connectionCredentials> element is included. Setting this attribute to true instructs the server to save the credentials.
oauth-flag	(Optional) If the data source connection is configured to use OAuth, set this to `true` to specify that the value of the name attribute in the connectionCredentials element is an OAuth username. In that case, no password is required and the value of the embed attribute specifies whether to embed the OAuth credential with the data source. If your auth type allows secrets to be passed as generic username and password variables, set the oAuth attribute to `false`. (Example auth types include 2-legged OAuth, like Service Principal OAuth with Databricks and Client Credentials OAuth with Snowflake.) For more information on OAuth, see the OAuth Connections section of the Tableau Cloud or Tableau Server Product Help.
project-id	The LUID of the project to assign the data source to. If the project is not specified, the data source will be published to the default project.
datasource-file-name	The file name (including extension) of the data source file to upload. This attribute is used in the request body only if the request also includes the content of the data source file; it is not used if you are committing a file uploaded using previous requests.
content-of-datasource-file	The content of the data source file, if the request includes the file. The maximum size of a file that can be uploaded in one call is 64 MB.
askDataEnablement	This attribute is not available in API 3.12 and later (Tableau Cloud September 2021 / Server 2021.3).
parentDataSourceUrls	The name (URL) of the immediately referenced published data source that the data source being published depends on. For a composed data source, you must include one entry for each top-level parent data source in the data model.

#### cURL Example `curl "http://MY_SERVER/api/3.4/sites/ff2a8360-3c2b-4b05-a793-7607c602e1fb/datasources" -X POST -H "X-Tableau-Auth:6fSulU7ET8yjpHteQj56MQ|LrkEdTHcmPkWFcD8wOEy29hlVXm8iPo4" -H "Content-Type: multipart/mixed;" -F "request_payload=@publish-datasource.xml" -F "tableau_datasource=@data-source.tds"` **Content of publish-datasource.xml**: ``` ``` #### Response Code 201 #### Response Body ``` ``` ``` { "datasource": { "id": "75b71d2f-e8d3-42af-b654-d953659326ee", "name": "Sales", "contentUrl": "mySite", "description": "Sales Data Source", "useRemoteQueryAgent": "True", "webpageUrl": "https://my_server/#/datasources/222", "type": "excel-direct", "createdAt": "2016-02-12T23:36:09Z", "updatedAt": "2020-12-16T15:33:03Z", "isCertified": "False", "certificationNote": "This is a certification note.", "encryptExtracts": "True", "project": { "id": "56c86f04-b834-4a08-a561-86497bb4b2df", "name": "Visualization" }, "owner": { "id": "20148c74-7818-4eb8-b2a1-9f3f5f582613" }, "tags": [] } } ``` The `createdAt` and `updatedAt` attribute values are returned in UTC format (YYYY-MM-DDTHH:MM:SSZ). #### Response Headers `Location: /api/3.29/sites/site-id/datasources/id-from-server` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The request message is missing or incomplete, or contains malformed XML. Make sure that the Content-Length value is set.
400	400000	Missing data source	There is no attachment in the request for the data source.
400	400008	Invalid overwrite value	The overwrite parameter must be set to true or false.
400	400008	Invalid append value	The append parameter must be set to true or false.
400	400008	Invalid embed value	The request body contains a <connectionCredentials> element and it has an embed attribute whose value is not true or false.
400	400010	Invalid data source filename	The name of the data source file did not end with the suffix `.hyper`, `.tds`, `.tdsx`, or `.tde`.
400	400010	Missing or invalid file type	The request included an uploadSessionId parameter but no file type, or the file type was something other than hyper, tds, tdsx, or tde.
400	400010	Unexpected attachments	The message had both a uploadSessionId parameter and an attachment, or the message contained more than one attachment.
400	400011	Publishing error	The data source could not be published for some other reason than those specified earlier.
400	400011	Bad Request	The request is invalid. This can occur if more than one of the conflict resolution parameters (overwrite, append, or replace) is set to `true`. Only one of these parameters can be true in a single request.
400	400019	Malformed request body	The request message is missing or incomplete, or contains malformed XML. Make sure that the Content-Length value is set.
400	400055	Incompatible overwrite and append values	The overwrite and append parameter cannot both be set to true.
400	400129	Invalid Ask Data enablement	The enablement setting in the request body is not valid for the current server configuration.
403	403007	Insufficient publishing permission	A non-administrator user attempted to publish a data source, but the caller doesn't have sufficient project permissions.
403	403007	Unlicensed publishing forbidden	A non-administrator user who is unlicensed attempted to publish a data source. This is disallowed for all projects (including the default project).
403	403007	Overwrite forbidden	A data source with the specified name already exists and the overwrite parameter was not set to true.
403	403007	Problem connecting to data source	There was a problem connecting to a data source. This can be due to missing or invalid connection credentials or because the referenced data source is not available on the server.
403	403008	Insufficient storage quota	The data source could not be published because there is not enough storage remaining on the server to accommodate its size.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404004	Data source not found	The append parameter is true but the data source name specified in the request body does not correspond to an existing data source.
404	404005	Project not found	The project ID in the request body doesn't correspond to an existing project on the site.
404	404015	File upload not found	The file upload session ID in the request body doesn't correspond to an existing file upload on the site.
405	405000	Invalid request method	Request type was not POST.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Publish Flow Publishes a flow on the specified site. To make other changes to a published flow, call [Update Flow](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_flow.htm#update_flow) or [Update Flow Connection](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_flow.htm#update_flow_connection). **Version**: Available in API 3.3 and later. **License**: No additional license required. **Permissions**: Users who are not server administrators or site administrators can publish a flow only if the flow belongs to a project that they have permissions to publish to, have a site role that allows publishing and have write permissions on the flow if overwriting. **Access Scope**: `tableau:flows:create` - Scope added in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). You can publish a flow in a single request or in multiple parts. To publish a flow in a single request you include the content of the workbook file in the body of the request. The maximum size of a file that can be published in a single request is 64 MB. To publish a flow in multiple parts, you initiate a file upload by calling [Initiate File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#initiate_file_upload), send portions of the file to the server using [Append to File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref.htm#append_to_file_upload), and then commit the upload by calling Publish Flow. In this case, Publish Flow doesn't contain the file to publish but the `uploadSessionId` and the `flowType` parameters are required. #### URI POST /api/api-version/sites/site-id/flows POST /api/api-version/sites/site-id/flows?overwrite=overwrite-flag POST /api/api-version/sites/site-id/flows?overwrite=overwrite-flag&uploadSessionId=upload-session-id&flowType=flow-file-type #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site to publish to.
overwrite-flag	(Optional) true to overwrite a flow that has the same name, or false to fail if the specified flow already exists. The default is false. If overwrite-flag is set to true but the flow doesn't already exist, the operation succeeds.
upload-session-id	If you are calling this method to commit a file that was uploaded in parts, this value contains the upload session ID that was generated by a call to Initiate File Upload. If this value is not included, the server assumes that the body of the request contains the file to be published.
flow-file-type	tfl or tflx to indicate whether you have uploaded a flow file (tfl) or a packaged flow file (tflx). This value is only necessary and required if you upload a file in multiple parts. In the Publish Flow call after completing file upload, specify the file type.

#### Publishing a file in the Request Body ``` --boundary-string Content-Disposition: name="request_payload" Content-Type: text/xml --boundary-string Content-Disposition: name="tableau_flow"; filename="flow-file-name" Content-Type: application/octet-stream content-of-flow-file --boundary-string-- ``` #### Attribute Values

boundary-string	(Required) A string of characters that is guaranteed to be unique within the body of the request, and that is used to delimit sections of the request body. This value must be declared as a header that has this format: `Content-type: multipart/mixed; boundary=boundary-string`
name	The name to assign to the flow when it is saved on the server.
description	The description of the flow.
server-address	Specify the server address for an input connections.
port-number	Specify the port number for input connections.
connection-username	(Optional) If the flow input connections require credentials, the <connectionCredentials> elements are included and this attribute specifies the connection username. If the element is included but is not required, the server ignores the element and its attributes. If your auth type allows secrets to be passed as generic username and password variables, use this attribute for the appropriate secret, such as client id. (Example auth types include 2-legged OAuth, like Service Principal OAuth with Databricks and Client Credentials OAuth with Snowflake.)
connection-password	(Optional) If the flow input connections require credentials, the <connectionCredentials> elements are included and this attribute specifies the connection password. If the element is included but is not required, the server ignores the element and its attributes. If your auth type allows secrets to be passed as generic username and password variables, use this attribute for the appropriate secret, such as client secret. (Example auth types include 2-legged OAuth, like Service Principal OAuth with Databricks and Client Credentials OAuth with Snowflake.)
embed-flag	(Optional) If the flow input connection requires credentials, the <connectionCredentials> element is included. Setting this attribute to true instructs the server to save the credentials.
oauth-flag	(Optional) If the flow input connection is configured to use OAuth, set this to `true` to specify that the value of the name attribute in the connectionCredentials element is an OAuth username. In that case, no password is required and the value of the embed attribute specifies whether to embed the OAuth credential with the data source. If your auth type allows secrets to be passed as generic username and password variables, set the oAuth attribute to `false`. (Example auth types include 2-legged OAuth, like Service Principal OAuth with Databricks and Client Credentials OAuth with Snowflake.) For more information on OAuth, see the OAuth Connections section of the Tableau Cloud or Tableau Server Product Help.
project-id	The ID of the project to assign the flow to.
content-of-flow-file	The file itself if you are including it in the request body.

#### Response Code 201 #### Response Body ``` ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Malformed request body	The XML content in the MIME multipart request is not empty.
400	400089	Missing flow name	Flow name is required and was not specified.
403	403007	Invalid permissions	The caller does not have the necessary permissions to publish the flow.
400	400090	Missing flow payload	The flow information (the structure containing the flow description, flow project) was not included in the request body.
400	400086	Invalid flow attachment	The name of the flow doesn't end in .tfl or .tflx.
400	400087	Generic flow publishing error	The flow could not be published for some other reason than those specified earlier.
409	409041	Flow already found in destination	The flow name should be unique, or the overwrite flag parameter should be set to true.
403	403008	Insufficient storage quota	The flow could not be published because there is not enough storage remaining on the server to accommodate its size.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404005	Project not found	The project ID in the request body doesn't correspond to an existing project on the site.
404	404027	Flow not found	The flow ID in the URI doesn't correspond to an existing flow.
405	405000	Invalid request method	Request type was not POST.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Publish Virtual Connection Publishes a virtual connection on the specified site, either from a packaged virtual connection file (`.tvcx`) or from a downloaded JSON representation. If the virtual connection does not exist, it is published as a new virtual connection. If it already exists and you choose to overwrite it, the virtual connection is published as a revision of the existing virtual connection. You can publish in either of these ways: - **`.tvcx` file**. Send a packaged virtual connection file, as returned by [Download Virtual Connection](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_virtual_connections.htm#download_virtual_connection). A `.tvcx` file can include extracts. - **JSON representation**. Send the virtual connection schema, as returned by [Download Virtual Connection as JSON](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_virtual_connections.htm#download_virtual_connection_as_json), inline in the request body. **Version**: Available in API 3.23 (Tableau Cloud June 2024 / Tableau Server 2024.2) and later. Support for publishing a `.tvcx` file added in API 3.30. **License**: Requires [Tableau Data Management](https://help.tableau.com/current/online/en-us/dm_overview.htm). **Permissions**: You must have the Overwrite permission for the virtual connection and your site role must be at least Creator, or you must be a Tableau administrator. **Access Scope**: `tableau:virtual_connections:create`. Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). To publish a `.tvcx` file, you can call this method in two ways. You can publish a virtual connection in a single request. To do that, you include the content of the `.tvcx` file in the body of the request. The maximum size of a file that can be published in a single request is about 64 MB. Alternatively, you can publish a `.tvcx` file in multiple parts. To do that, you initiate a file upload by calling [Initiate File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_publishing.htm#initiate_file_upload), send portions of the file to the server using [Append to File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_publishing.htm#append_to_file_upload), and then commit the upload by calling Publish Virtual Connection. In this case, Publish Virtual Connection doesn't contain the file to publish. We recommend this approach for files larger than about 64 MB, such as files that include large extracts. **Virtual connections with extracts** A `.tvcx` file for a virtual connection that uses extracts contains the Hyper extract files, in addition to the virtual connection schema. A `.tvcx` file for a live virtual connection contains only the schema. This method accepts both kinds of file. **Draft or active** When you publish a JSON representation, the virtual connection can be published as a draft or as an active virtual connection, as set by the `publishAsDraft` parameter. A virtual connection that you publish from a `.tvcx` file is always published as an active virtual connection, whether or not the file includes extracts. The `publishAsDraft` parameter does not apply to a `.tvcx` file. For more information, see [Publishing Resources](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_publish.htm). #### URI POST /api/api-version/sites/site-id/virtualconnections POST /api/api-version/sites/site-id/virtualconnections?publishAsDraft=publish-as-draft-flag POST /api/api-version/sites/site-id/virtualconnections?overwrite=overwrite-flag POST /api/api-version/sites/site-id/virtualconnections?uploadSessionId=upload-session-id&overwrite=overwrite-flag #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID of the site to publish to.
publish-as-draft-flag	(Optional) true to publish the virtual connection as a draft, or false to publish it as an active virtual connection. The default is true. This parameter applies only when you publish a JSON representation. The parameter is case sensitive. If the virtual connection contains an extract, the publishAsDraft parameter value is ignored and the virtual connection is published as a draft. Note: If you are using the REST API to publish a virtual connection as a draft, note the virtual connection's LUID (`virtualconnection id`) in the response body. Use that LUID to build a URL to further edit, create extracts for, or publish the virtual connection using the virtual connection editor in the regular web interface. For more information, see "Draft in Progress" in the Tableau Cloud Product Help and Tableau Server Product Help.
overwrite-flag	true to overwrite a virtual connection that has the same name in the target project, or false to fail if the specified virtual connection already exists. The default is false. If overwrite-flag is set to true but the virtual connection doesn't already exist, the operation succeeds.
upload-session-id	(Optional, `.tvcx` files only) If you are calling this method to commit a file that was uploaded in parts, this value contains the upload session ID that was generated by a call to Initiate File Upload. If this value is not included, the server assumes that the body of the request contains the file to be published.

#### Request Body The request body depends on whether you publish a `.tvcx` file or a JSON representation. **Publishing a .tvcx file** The content type in the header of requests to publish a `.tvcx` file must use the mixed multipart content type with a boundary string definition, in the form of: `Content-Type: multipart/mixed; boundary=boundary-string`. The server uses this content type to tell a `.tvcx` request from a JSON request. A request with any other content type, such as `application/octet-stream` or `multipart/form-data`, is handled as a request to publish a JSON representation and fails. **Publishing a file in the request body** ``` --boundary-string Content-Disposition: name="request_payload" Content-Type: text/xml --boundary-string Content-Disposition: name="tableau_virtual_connection"; filename="virtualconnection-name.tvcx" Content-Type: application/octet-stream content-of-virtualconnection-file --boundary-string-- ``` **Committing a file previously uploaded** ``` --boundary-string Content-Disposition: name="request_payload" Content-Type: text/xml --boundary-string-- ``` **Publishing a JSON representation** ``` virtualconnection-as-json ``` ``` { "virtualConnection": { "project": { "id": "project-id" }, "owner": { "id": "owner-id" }, "content": "virtualconnection-as-json", "name": "virtualconnection-name" } } ``` #### Request Attributes **For a .tvcx file**

boundary-string	(Required) A string of characters that is guaranteed to be unique within the body of the request, and that is used to delimit sections of the request body. This value must be declared as a header that has this format: `Content-type: multipart/mixed; boundary=boundary-string`
virtualconnection-name	(Required) The name to assign to the virtual connection when it is saved on the server. This is typically derived from the file name.
project-id	(Optional) The LUID of the project to publish to. If you omit it, the virtual connection is published to the default project.
owner-id	(Optional) The LUID of the owner of the virtual connection. If you omit it, the authenticated user becomes the owner.
`tableau_virtual_connection` file part	The `.tvcx` file. Include it when you publish in a single request. Omit it when you commit a file that was uploaded in parts. If you include both a file part and the `uploadSessionId` parameter, or if you include neither, the request fails.

**For a JSON representation**

virtualconnection-name	The name of the virtual connection you are publishing. If publishing an existing virtual connection as a revision, the virtual connection name is ignored.
project-id	The LUID of the project you are publishing to.
owner-id	This attribute is required, but is ignored.
virtualconnection-as-json	The virtual connection schema rendered as JSON, as obtained using the Download Virtual Connection as JSON or Download Virtual Connection Revision as JSON method. The schema appears in the content element (for XML output) or content property (for JSON output). Note: Changing the downloaded schema and then using it with this method isn't supported. When using the Publish Virtual Connection method, we recommend using the virtual connection schema format that matches the format you used for downloading it. This is important because the virtual connection schema returned by the download methods has escape characters in it if the output was JSON. If you download and publish using different formats, you will have to make changes to the JSON representation of the virtual connection. In other words: If the output of the Download Virtual Connection as JSON method was XML (except for the `content` element, which is always a form of JSON), use XML when using this Publish Virtual Connection method. If the output of the Download Virtual Connection as JSON method was JSON (in which case it will have escape characters in the `content` property), use JSON when using this Publish Virtual Connection method. Alternatively, you can escape or unescape the schema yourself if you are downloading and publishing using different formats. For more information on the difference between using XML and using JSON with the REST API, see Fundamentals of the Tableau Server REST API.

#### cURL Example **Publishing a .tvcx file** `curl "http://MY_SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections?overwrite=false" -X POST -H "X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3" -H "Content-Type: multipart/mixed; boundary=----TabBoundary" --data-binary @publish-vconn-request.txt` The file `publish-vconn-request.txt` contains the multipart request body shown above in **Publishing a file in the request body**. **Publishing a JSON representation** `curl --location 'http://MY_SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections?overwrite=true&publishAsDraft=false' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3' --data @data.xml` **Content of data.xml**: ``` virtualconnection-as-json ``` Replace virtualconnection-as-json in this example with the virtual connection schema you downloaded using the [Download Virtual Connection as JSON](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_virtual_connections.htm#download_virtual_connection_as_json) method. #### Response Code 201 #### Response Body The response is the same whether you publish a JSON representation or a `.tvcx` file. ``` ``` ``` { "virtualConnection": { "project": { "id": "project-id" }, "id": "virtualconnection-id", "name": "virtualconnection-name" } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	When you publish a .tvcx file, the request is not valid for one of these reasons: The request does not include `request_payload` or the `virtualConnection` element. The `virtualConnection` element does not include a `name`. The request includes both the .tvcx file and `uploadSessionId`, or it includes neither. Include only one. The file for the `uploadSessionId` is no longer available. The .tvcx file is not valid. The virtual connection could not be published with the extract in the .tvcx file.
400	400201	Publish virtual connection error	The virtual connection could not be published. This includes content that is not valid virtual connection JSON, or a .tvcx file or its contents that could not be read.
403	403008	Insufficient site storage	The content would exceed the site's storage quota. Applies when publishing a .tvcx file.
403	403175	Publish virtual connection forbidden	The user does not have permission to publish the virtual connection.
404	404015	File upload not found	The `uploadSessionId` does not match an upload owned by the user. Applies when publishing a .tvcx file.
404	404049	Virtual connection not found	The virtual connection could not be found while publishing it with the extract in the .tvcx file.
405	405000	Invalid request method	Request type was not POST.
409	409123	Virtual connection exists	A virtual connection with the same name already exists in the project and `overwrite` is false. Applies when publishing a .tvcx file.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Publish Work Copy Publishes a work copy as a data source. Send the published data source `name` and an optional `description`. The response returns the new data source LUID. A blank name is rejected. **Version**: Available in API 3.30 (Tableau Cloud October 2026 / Server 2026.3) and later. **License**: Data Management or Tableau+. **Permissions**: Users who are not server administrators or site administrators can call this method only if they have Connect, Write (save), and VizqlDataApiAccess (API Access) permissions for the data source that the work copy was created from (either explicitly or implicitly). **Access Scope**: `tableau:datasources:create` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI POST /api/api-version/tds/sites/site-luid/workcopy/workcopy-luid/publish #### URI Parameter Values

api-version	The version of the API to use. These TDS Edit methods are available in API 3.30 and later. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site in the URI. This handler does not bind the path variable — the service uses the authenticated user's site LUID (`authUser.getSiteLuid()`).
workcopy-luid	The LUID of the work copy. Must be a UUID (8-4-4-4-12 hexadecimal digits), matching `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}`.

#### Request Body ``` ``` ``` { "datasource": { "name": "Quarterly Sales", "description": "Quarterly sales rollup." } } ``` #### Attribute Values

datasource	Required. Published data source name and optional description. Other data source fields are not read by this method.
datasource.name	Required. Name of the data source to publish. A null, empty, or whitespace-only value is HTTP 400 with error code `400008`.
datasource.description	Optional. Description of the published data source. May be null, empty, or whitespace.

#### Response Code 201 Created #### Response Body Returns the published data source's identifiers in `tdsWorkCopy`. The response includes `datasourceLuid` but not `workCopyLuid`. ``` a1b2c3d4-e5f6-4321-8765-1234567890ab ``` ``` { "tdsWorkCopy": { "datasourceLuid": "a1b2c3d4-e5f6-4321-8765-1234567890ab" } } ``` #### Attribute Values

tdsWorkCopy	Required. Work copy and published data source identifiers.
tdsWorkCopy.workCopyLuid	Optional. LUID of the work copy. Not returned by this method; returned by Create Work Copy.
tdsWorkCopy.datasourceLuid	LUID of the newly published data source.

#### Errors

HTTP status	`error` Code	Condition	Details
400	400008	Datasource name missing	The published data source name is missing or blank.
400		Invalid work copy LUID	The work copy LUID in the URI is not a UUID (8-4-4-4-12 hexadecimal digits).
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	403004	Data Management Bundle not licensed	On Tableau Server the TDS Edit API requires a Data Management Bundle license. The call is rejected when that license is absent.
403	403004	Unable to resolve tenant	On Tableau Cloud the subscription could not be checked because the tenant id for the site could not be retrieved.
403	403004	No cloud entitlements	On Tableau Cloud no entitlements were found for the tenant. The TDS Edit API requires a Tableau+ subscription.
403	403004	Subscription not entitled	On Tableau Cloud the site edition is not Tableau+. The TDS Edit API requires a Tableau+ subscription.
404		Work copy not found or not visible to the caller	The work copy LUID in the URI doesn't correspond to an existing work copy, or the caller doesn't have permission to access it.
405	405000	Method not allowed	The HTTP method is not supported for this resource.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500		Unknown error	There was an internal server error.
503		Service unavailable	Service unavailable.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Publish Workbook Publishes a workbook on the specified site. To make changes to a published workbook, call [Update Workbook](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooks_and_views.htm#update_workbook) or [Update Workbook Connection](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooks_and_views.htm#update_workbook_connection). **Version**: Available in API 2.0 and later. **License**: No additional license required. **Permissions**: Users who are not server administrators or site administrators can publish a workbook only if the workbook belongs to a project that they have permissions to publish to. **Access Scope**: `tableau:workbooks:create` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). This method is used in two ways. You can call it to publish a workbook in a single request. To do that, you include the content of the workbook file in the body of the request. The maximum size of a file that can be published in a single request is 64 MB. If you want to avoid having the publishing process time out, you can use the _asJob_ parameter to make workbook publication asynchronous. Alternatively, you can publish a workbook in multiple parts. To do that, you initiate a file upload by calling [Initiate File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_publishing.htm#initiate_file_upload), send portions of the file to the server using [Append to File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_publishing.htm#append_to_file_upload), and then commit the upload by calling Publish Workbook. In this case, Publish Workbook doesn't contain the file to publish. **Hiding views in a published workbook** To exclude certain sheets (also known as views) when you publish a workbook, configure them in the request as `hidden`. You cannot publish a workbook if all sheets are hidden. **Extracts with multiple table options** If an extract was stored using the multiple tables option, you can't append data to it. **Workbooks that rely on external local resources** When you publish a workbook from your local computer to the server, the publish process will fail if the workbook relies on resources (such as an Excel file or other data file) that are on your local computer but are not available on the server. (Unlike the publish process that is used in Tableau Desktop, the REST API publish process cannot automatically include extracts or other resources that the workbook uses.) If you are publishing a workbook that gets its data from a source on your computer, save the workbook as a packaged workbook (`.twbx` file) and publish the package so that workbook has all the resources it needs on the server. For more information, see [Publishing Resources](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_publish.htm). #### URI POST /api/api-version/sites/site-id/workbooks POST /api/api-version/sites/site-id/workbooks?overwrite=overwrite-flag POST /api/api-version/sites/site-id/workbooks?skipConnectionCheck=skip-connection-check-flag POST /api/api-version/sites/site-id/workbooks?uploadSessionId=upload-session-id&workbookType=workbook-file-type&overwrite=bool&asJob=asJob-value #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site to publish to.
overwrite-flag	(Optional) true to overwrite a workbook that has the same name, or false to fail if the specified workbook already exists. The default is false. If overwrite-flag is set to true but the workbook doesn't already exist, the operation succeeds.
asJob-value	(Optional, boolean) If `false`, the workbook publishing process runs as a synchronous process. If a workbook is very large, the process might time out before it finishes. If you set this value to true, the process runs asynchronously, and a job will start to perform the publishing process and return the job ID. You can check the status of the import job by calling Query Job. Default value is `false`.
skip-connection-check-flag	(Optional, boolean) If `true`, then the Tableau server will not check if a non-published connection of a workbook is reachable. Publishing will succeed but unchecked connection issues may result in a non-functioning workbook. If you encounter this issue, follow Keep Data Fresh guidelines. Default value is `false`.
upload-session-id	If you are calling this method to commit a file that was uploaded in parts, this value contains the upload session ID that was generated by a call to Initiate File Upload. If this value is not included, the server assumes that the body of the request contains the file to be published.
workbook-file-type	twb or twbx to indicate whether you have uploaded a workbook file (twb) or a packaged workbook file (twbx). This value is required if you are calling Publish Workbook in order to commit a file that was previously uploaded using Append to File Upload. The value is not used if you upload a file in the body of the request.

#### Request Body The content type in the header of requests to publish a workbook must use the mixed multi-part content type with a boundary string definition, in the form of: `Content-Type: multipart/mixed; boundary=boundary-string`. **Publishing a file in the request body** ``` --boundary-string Content-Disposition: name="request_payload" Content-Type: text/xml --boundary-string Content-Disposition: name="tableau_workbook"; filename="workbook-file-name" Content-Type: application/octet-stream content-of-workbook-file --boundary-string-- ``` **Committing a file previously uploaded** ``` --boundary-string Content-Disposition: name="request_payload" Content-Type: text/xml --boundary-string-- ``` **Hiding a view when publishing a workbook** ``` --boundary-string Content-Disposition: name="request_payload" Content-Type: text/xml --boundary-string-- ``` #### Attribute Values

boundary-string	A string of characters that is guaranteed to be unique within the body of the request, and that is used to delimit sections of the request body. This value must be declared as a header that has this format: `Content-type: multipart/mixed; boundary=boundary-string`
workbook-name	The name to assign to the workbook when it is saved on the server.
workbook-description	(Optional) Starting in API 3.20, the description for the workbook.
show-tabs-flag	(Optional) Specify true to have the published workbook show views in tabs; otherwise, false. The default is false.
user-luid	(Optional) The LUID of the user to generate thumbnails as. You can get the user LUID by calling Get Users on Site.
server-address	(Optional) Specify the server address for a data source connection if that data source does not use OAuth.
port-number	(Optional) Specify the port number for a data source connection if that data source does not use OAuth.
connection-username	(Optional) If the workbook's data source connections require credentials, the <connectionCredentials> elements are included and this attribute specifies the connection username. If the element is included but is not required (for example, if the data source uses OAuth), the server ignores the element and its attributes. If your auth type allows secrets to be passed as generic username and password variables, use this attribute for the appropriate secret, such as client id. (Example auth types include 2-legged OAuth, like Service Principal OAuth with Databricks and Client Credentials OAuth with Snowflake.) Note: Even if credentials are embedded in a workbook, you must still provide credentials when connecting to a data source that requires credentials, unless that data source uses OAuth.
connection-password	(Optional) If the workbook's data source connections require credentials, the <connectionCredentials> elements are included and this attribute specifies the connection password. If the element is included but is not required (for example, if the data source uses OAuth), the server ignores the element and its attributes. If your auth type allows secrets to be passed as generic username and password variables, use this attribute for the appropriate secret, such as client secret. (Example auth types include 2-legged OAuth, like Service Principal OAuth with Databricks and Client Credentials OAuth with Snowflake.) Note: Even if credentials are embedded in a workbook, you must still provide credentials when connecting to a data source that requires credentials, unless that data source uses OAuth.
embed-flag	(Optional) If the workbook's data source connection requires credentials, the <connectionCredentials> element is included. Setting this attribute to true instructs the server to save the credentials for when the data source is used.
oauth-flag	(Optional) If the workbook's data source connection is configured to use OAuth, set this to `true` to specify that the value of the name attribute in the <connectionCredentials> element is an OAuth username. In that case, no password is required and the value of the embed attribute specifies whether to embed the OAuth credential with the workbook, and the server address and port number are not required. If your auth type allows secrets to be passed as generic username and password variables, set the oAuth attribute to `false`. (Example auth types include 2-legged OAuth, like Service Principal OAuth with Databricks and Client Credentials OAuth with Snowflake.) For more information on OAuth, see the OAuth Connections section of the Tableau Cloud or Tableau Server Product Help.
hide-view-flag	Setting this flag to `true` will cause the named view to be hidden in the published workbook. The default value is `false`. You can specify any number of views to hide. If all views in a workbook are hidden the server will not perform a publish.
project-id	The ID of the project to assign the workbook to. If the project is not specified, the workbook will be published to the default project.
workbook-file-name	The file name (including extension) of the workbook file to upload. This attribute is used in the request body only if the request also includes the content of the workbook file; it is not used if you are committing a file uploaded using previous requests.
content-of-workbook-file	The content of the workbook file, if the request includes the file. The maximum size of a file that can be uploaded in one call is 64 MB.
encryptExtracts	(Optional) true to encrypt the extracts or false to not encrypt extracts. For more information, see Extract and Encryption Methods.

#### Response Code 201 #### Response Body ``` ``` The datetime-created and datetime-updated attribute values are returned in UTC format (YYYY-MM-DDTHH:MM:SSZ). #### cURL Request Example ``` curl "http://MY_SERVER/api/3.4/sites/ff2a8360-3c2b-4b05-a793-7607c602e1fb/workbooks" -X POST -H "X-Tableau-Auth:7T_33sOfS8Ks_0cht4tYxw|8tsTYQyyOZXfOgxZEHWQ4jUTCQ08GhRr" -H "Content-Type: multipart/mixed;" -F "request_payload=@publish-workbook.xml" -F "tableau_workbook=@MY_WORKBOOK.twbx" ``` **Content of publish-workbook.xml** (publish the Test1 workbook, hide the Test Sheet 1 view): ``` ``` **Example response:** ``` ``` #### Response Headers Location: /api/3.29/sites/site-id/workbooks/workbook-id #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Malformed request body	The XML content in the MIME multipart request is not empty.
400	400000	Missing workbook	There is no attachment in the request and no uploadSessionID parameter.
400	400000	Unexpected attachments	The message had both an uploadSessionId parameter and an attachment, or the request body contained more than one attachment.
400	400008	Invalid embed value	The request body contains a <connectionCredentials> element and it has an embed attribute whose value is not true or false.
400	400008	Invalid overwrite value	The overwrite parameter must be true or false.
400	400011	Publishing error	The workbook could not be published for some other reason than those specified earlier.
400	400020	Invalid workbook file name	The name of the workbook doesn't end in `.twb` or `.twbx`.
400	400035	Missing or invalid file type	The request included an uploadSessionId parameter but no file type, or the file type was something other than `.twb` or `.twbx`.
403	403007	Insufficient publishing permission	A non-administrator user attempted to publish a workbook, but the caller doesn't have sufficient project permissions.
403	403007	Unlicensed publishing forbidden	A non-administrator user attempted to publish a workbook. This is disallowed for all projects (including the default project).
403	403007	Overwrite forbidden	A workbook with the specified name already exists and the overwrite parameter was not set to true.
403	403007	Problem connecting to data source	There was a problem connecting to a data source used by the workbook. This can be due to missing or invalid connection credentials or because the referenced data source is not available on the server.
403	403008	Insufficient storage quota	The workbook could not be published because there is not enough storage remaining on the server to accommodate its size.
403	403130	Publishing overwrite	A workbook with the same name already exists.
403	403131	Concurrent update	The workbook is already being published in another process.
403	403132	Failed connection check	One or more data sources used by the workbook could not be reached.
404	404005	Project not found	The project ID in the request body doesn't correspond to an existing project on the site.
404	404006	Workbook not found	The user specified overwrite as true but no workbook with the specified name exists on the site.
404	404015	File upload not found	The file upload session ID in the uploadSessionId parameter doesn't correspond to an existing file upload on the site.
405	405000	Invalid request method	Request type was not POST.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Query All Quality Warning Triggers by Content Get information about all quality warning triggers for a content item. #### URI GET api/_api-version_/sites/_site-id_/dataQualityTriggers/content-type/_content-luid_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
content-type	The type of content that the quality warning trigger has been applied to. To specify the type, use one of the following values: datasource flow These values are not case sensitive.
content-luid	The unique ID of the asset. This is the same as the content ID.

#### Request body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to query quality warning triggers: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have "derived permissions" (if enabled) or have been granted explicit "Read" (view) permissions to the asset Otherwise, authorized users who have "derived permissions" (if enabled), and Tableau Server admins or Tableau Cloud site admins. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:labels:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response** ``` ``` #### Version Version 3.11 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400134	Generic quality warning trigger error	The quality warning triggers could not be queried for some other reason than those specified below.
403	403004	Unauthorized operation	Insufficient permissions to perform the operation.
404	404037	Quality warning not found	The requested quality warning trigger was not found.
409	409004	Invalid parameter	One or more values in the request body are invalid.

## Query Column in a Table Get information about a column in a table asset. #### URI GET api/_api-version_/sites/_site-id_/tables/_table-id_/columns/_column-id_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
table-id	The unique ID of the table asset.
column-id	The unique ID of the column asset.

#### Request Body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to query a column asset in a table: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have "derived permissions" (if enabled) or have been granted explicit "Read" (view) permissions to the asset Otherwise, authorized users who have "derived permissions" (if enabled), and Tableau Server admins or Tableau Cloud site admins. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:columns:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response:** ``` ``` #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
409	409059	Unknown column error	An unknown column asset error occurred.
409	409060	Unknown column query error	An unknown error occurred and the column query could not complete.
409	409066	Column not found	The requested column asset could not be found.

## Query Columns in a Table Get information about the columns in a table asset. #### URI GET api/_api-version_/sites/_site-id_/tables/_table-id_/columns #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
table-id	The unique ID of the table asset.

#### Request Body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to query column assets in a table: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have "derived permissions" (if enabled) or have been granted explicit "Read" (view) permissions to the asset Otherwise, authorized users who have "derived permissions" (if enabled), and Tableau Server admins or Tableau Cloud site admins. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:columns:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response:** ``` ``` #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
409	409059	Unknown column error	An unknown column asset error occurred.
409	409060	Unknown column query error	An unknown error occurred and the column query could not complete.
409	409066	Column not found	The requested column assets could not be found.

## Query Data Quality Certification by ID Get information about a data quality certification. **Note:** Data quality warnings and certifications can be more generally managed through the newer **Labels** methods. Tableau recommends using them to help ensure that you can manage your assets as new features are developed. Try the [Get Label](#get_label) method instead. #### URI GET api/_api-version_/sites/_site-id_/dataQualityCertifications/_certification-luid_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
certification-luid	The unique ID of the data quality certification.

#### Request body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to query a data quality certification: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have "derived permissions" (if enabled) or have been granted explicit "Read" (view) permissions to the asset Otherwise, authorized users who have "derived permissions" (if enabled), and Tableau Server admins or Tableau Cloud site admins. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:labels:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response** ``` id="d5a4006c-0276-4c5a-bb98-712815c91ce7" userDisplayName="Mark Nguyen" contentId="a34884d0-1d80-4505-bf21-c6b7ce10814a" contentType="DATASOURCE" message="Marketing approved" type="CERTIFIED" active="true" createdAt="2021-06-08T17:22:20Z" updatedAt="2021-09-08T17:27:57Z" severe="false"/> siteID="284e2a17-65c8-47bf-b88f-ff96d69c2303" ownerID="f95180e7-0c64-4a58-86da-b9f4d3db2583" ``` #### Version Version 3.13 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400103	Generic data quality certification error	The data quality certification could not be queried for some reason other than those specified in this table.
403	403004	Unauthorized operation	Insufficient permissions to perform the operation.
404	404030	Data quality indicator not found	The requested data quality certification was not found.
409	409004	Invalid parameter	One or more values in the request body are invalid.

## Query Data Quality Certifications by Content Get all data quality certifications for content or asset items. **Note:** Data quality warnings and certifications can be more generally managed through the newer **Labels** methods. Tableau recommends using them to help ensure that you can manage your assets as new features are developed. Try the [Get Labels](#get_labels_on_assets) method instead. #### URI GET api/_api-version_/sites/_site-id_/dataQualityCertifications/_content-type_/_content-luid_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
content-type	The type of content the data quality certification has been applied to. To specify the type, use one of the following values: database table datasource virtualconnection virtualconnectiontable These values are not case sensitive.
content-luid	The LUID of the content (database, table, published data source, flow, virtual connection, or virtual connection table).

#### Request body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to query data quality certifications: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have "derived permissions" (if enabled) or have been granted explicit "Read" (view) permissions to the asset Otherwise, authorized users who have "derived permissions" (if enabled), and Tableau Server admins or Tableau Cloud site admins. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:labels:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response** ``` id="d5a4006c-0276-4c5a-bb98-712815c91ce7" userDisplayName="Mark Nguyen" contentId="a34884d0-1d80-4505-bf21-c6b7ce10814a" contentType="DATASOURCE" message="Marketing approved" type="CERTIFIED" active="true" createdAt="2021-06-08T17:22:20Z" updatedAt="2021-09-08T17:27:57Z" severe="false"/> siteID="284e2a17-65c8-47bf-b88f-ff96d69c2303" ownerID="f95180e7-0c64-4a58-86da-b9f4d3db2583" ``` #### Version Version 3.13 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400104	Generic data quality certification error	The data quality certification could not be queried for some reason other than those specified in this table.
403	403004	Unauthorized operation	Insufficient permissions to perform the operation.
404	404029	Data quality indicator not found	The requested data quality certification was not found.
409	409004	Invalid parameter	One or more values in the request body are invalid.

## Query Data Quality Warning by Content Get information about the data quality warning for the database, table, column, published data source, flow, virtual connection, or virtual connection table. **Note:** Data quality warnings and certifications can be more generally managed through the newer **Labels** methods. Tableau recommends using them to help ensure that you can manage your assets as new features are developed. Try the [Get Labels](#get_labels_on_assets) method instead. #### URI GET api/_api-version_/sites/_site-id_/dataQualityWarnings/_content-type_/_content-luid_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
content-type	The type of asset that the data quality warning is being attached to. To specify the type, use one of the following values: database table column - Available in API 3.16 and later (Tableau Cloud October 2022, Server 2022.3) datasource flow virtualconnection virtualconnectiontable These values are not case sensitive.
content-luid	The LUID of the content (database, table, column, published data source, flow, virtual connection, or virtual connection table).

#### Request Body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to query the data quality warning: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have "derived permissions" (if enabled) or have been granted explicit "Read" (view) permissions to the asset Otherwise, authorized users who have "derived permissions" (if enabled), and Tableau Server admins or Tableau Cloud site admins. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:labels:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response:** ``` ``` #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400104	Unknown data quality warning query error	An unknown error occurred and the data quality warning query could not complete.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404029	Content not found	The requested asset could not be found.
404	404030	Data quality warning not found	The data quality warning for the requested asset could not be found.

## Query Data Quality Warning by ID Get information about a specific data quality warning. **Note:** Data quality warnings and certifications can be more generally managed through the newer **Labels** methods. Tableau recommends using them to help ensure that you can manage your assets as new features are developed. Try the [Get Label](#get_label) method instead. #### URI GET api/_api-version_/sites/_site-id_/dataQualityWarnings/_dataqualitywarning-id_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
dataqualitywarning-id	The unique ID of the data quality warning.

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400103	Unknown data quality warning query error	An unknown error occurred and the data quality warning query could not complete.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404030	Data quality warning not found	The data quality warning for the requested asset could not be found.

## Query Data Source Returns information about the specified data source. **Note**: After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. #### URI GET /api/api-version/sites/site-id/datasources/datasource-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The site that contains the data source.
datasource-id	The ID of the data source to get.

#### Request Body None #### Permissions Users who are not server administrators or site administrators can view a data source only if they have Connect permission for the data source (either explicitly or implicitly). #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:content:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ... additional tags ... ``` The datetime-created and datetime-updated attribute values are returned in UTC format (YYYY-MM-DDTHH:MM:SSZ). #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Read forbidden	A non-administrator user attempted to query a data source, but the caller doesn't have Connect permission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404004	Data source not found	The data source ID in the URI doesn't correspond to an existing data source.
405	405000	Invalid request method	Request type was not GET.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the data source.
datasource-id	The ID of the data source to return connection information about.

#### Request Body None #### Permissions Users who are not server administrators or site administrators can query a data source only if they have Read (view) permission for the data source (either explicitly or implicitly). `queryTaggingEnabled` is returned only for administrator users. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:content:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` HTTP statuserror CodeConditionDetails403403021Read forbiddenA user who is not a server administrator user attempted to query the data source connections, but the caller doesn't have Read permission.404404000Site not foundThe site ID in the URI doesn't correspond to an existing site.404404011Data source not foundThe data source ID in the URI doesn't correspond to an existing data source.405405000Invalid request methodRequest type was not GET. For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/datasources/1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d/connections" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` **Example response:** ``` ``` **Note:** This method returns connection information, including connection type. In some cases, the name of the connection type might not map directly to a name of a connection type that you're familiar with. In those cases, see [Mapping ConnectionType Names](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_connectiontype.htm) for more information. ## Query Data Sources Returns a list of published data sources on the specified site, with optional parameters for specifying the paging of large results. To get a list of data sources embedded in a workbook, use the [Query Workbook Connections](#query_workbook_connections) method. **Note**: After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. **Version**: Available in API 1.0 and later. **License**: No additional license required. **Permissions**: Tableau Server users who are not server administrators or site administrators can view a data source only if they have Connect permissions for the data source (either explicitly or implicitly). **Access Scope**: `tableau:content:read` - For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-id/datasources GET /api/api-version/sites/site-id/datasources?pageSize\=page-size&pageNumber\=page-number GET /api/api-version/sites/site-id/datasources?filter=filter-expression GET /api/api-version/sites/site-id/datasources?sort=sort-expression GET /api/api-version/sites/site-id/datasources?fields=field-expression #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the data sources.
page-size	(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number	(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.
filter-expression	(Optional) An expression that lets you specify a subset of data sources to return. You can filter on predefined fields such as `name` and `updatedAt`. You can include multiple filter expressions. For more information, see Filtering and Sorting.
sort-expression	(Optional) An expression that lets you specify the order in which user information is returned. If you do not specify a sort expression, the sort order of the information that's returned is undefined. For more information, see Filtering and Sorting.
field-expression	(Optional) An expression that lets you specify the set of available fields to return. You can qualify the return values based upon predefined keywords such as `_all_` or `_default_`, and you can specify individual fields for the data sources or other supported resources. You can include multiple field expressions in a request. For more information, see Using Fields in the Rest API.

**Note**: The filter and sort parameters can be combined with each other and with paging parameters and fields parameters using an ampersand (**`&`**). #### Request Body None #### Response Code 200 #### Response Body ``` ``` ``` { "pagination": { "pageNumber": "pageNumber", "pageSize": "page-size", "totalAvailable": "total-available" }, "datasources": { "datasource": [ { "id": "datasource1-id", "description": "data-source-description", "name": "datasource-name", "size": "datasource-size", "type": "datasource-type", "contentUrl": "datasource-content-url", "createdAt": "datetime-created", "updatedAt": "datetime-updated", "encryptExtracts": "encrypt-extracts-flag", "hasExtracts": "has-extracts-flag", "isCertified": "is-certified-flag", "useRemoteQueryAgent": "use-remote-query-agent-flag", "webpageUrl": "datasource-webpage-url", "project": { "id": "project-id", "name": "project-name" }, "owner": { "id": "datasource-owner-id" }, "tags": [ { "label": "tag" } ] } ] } } ``` #### cURL Example ``` curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/datasources" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" ``` **Example response:** ``` ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400006	Invalid page number	The page number parameter is not an integer, is less than one, or is greater than the final page number for data sources at the requested page size.
400	400007	Invalid page size	The page size parameter is not an integer, or is less than one.
403	403014	Page size limit exceeded	The specified page size is larger than the maximum page size.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Query Database Get information about a database asset. #### URI GET api/_api-version_/sites/_site-luid_/databases/_database-luid_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site asset.
database-luid	The LUID of the database asset.

#### Request Body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to query a database asset: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have "derived permissions" (if enabled) or have been granted explicit "Read" (view) permissions to the asset Otherwise, authorized users who have "derived permissions" (if enabled), and Tableau Server admins or Tableau Cloud site admins. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:databases:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response:** ``` ``` **Note:** This method returns connection information, including connection type. In some cases, the name of the connection type might not map directly to a name of a connection type that you're familiar with. In those cases, see [Mapping ConnectionType Names](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_connectiontype.htm) for more information. #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
404	404000	Resource not found	The site LUID in the URI doesn't correspond to an existing site.
404	404031	Database not found	The requested database could not be found.
409	409045	Database error	An unknown database asset error occurred.
409	409046	Unknown database query error	An unknown error occurred and the database query could not complete.

## Query Databases Get information about all database assets for a site. #### URI GET api/_api-version_/sites/_site-luid_/databases #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site asset.

#### Request Body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to query database assets: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have "derived permissions" (if enabled) or have been granted explicit "Read" (view) permissions to the asset Otherwise, authorized users who have "derived permissions" (if enabled), and Tableau Server admins or Tableau Cloud site admins. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:databases:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response:** ``` ``` **Note:** This method returns connection information, including connection type. In some cases, the name of the connection type might not map directly to a name of a connection type that you're familiar with. In those cases, see [Mapping ConnectionType Names](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_connectiontype.htm) for more information. #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
404	404000	Resource not found	The site LUID in the URI doesn't correspond to an existing site.
404	404031	Database not found	The requested databases could not be found.
409	409045	Database error	An unknown database asset error occurred.
409	409046	Unknown database query error	An unknown error occurred and the database query could not complete.

## Query Flow Returns information about the specified flow, including information about the project, owner, and output steps. **Note**: After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. #### URI GET /api/api-version/sites/site-id/flows/flow-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the flow.
flow-id	The ID of the flow to return information about.

#### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can query a flow only if they have Read(view) permission for the flow (either explicitly or implicitly). #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:flows:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ...additional output steps... ...additional parameters... ``` **Note:** Parameters is only shown in the response if parameters are enabled on the site and the flow contains parameters. #### Version Version 3.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Read forbidden	A non-administrator user attempted to query the flow, but the caller doesn't have Read permission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404027	Flow not found	The flow ID in the URI doesn't correspond to an existing flow.
405	405000	Invalid request method	Request type was not GET.
405	405000	Invalid request method	Request type was not GET.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the flow.
flow-id	The ID of the flow to return connection information about.

#### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can query a flow only if they have Read(view) permission for the flow (either explicitly or implicitly). #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:flow_connections:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ... additional connections ... ``` #### Version Version 3.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403092	Read forbidden	A user who is not a server administrator user attempted to query the flow connections, but the caller doesn't have Readpermission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404027	Flow not found	The flow ID in the URI doesn't correspond to an existing flow.
405	405000	Invalid request method	Request type was not GET.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the flows.
filter-expression	(Optional) An expression that lets you specify a subset of flows to return. You can filter on predefined fields such as name, tags, and createdAt. You can include multiple filter expressions. For more information, see Filtering and Sorting.
sort-expression	(Optional) An expression that lets you specify the order in which flow information is returned. If you do not specify a sort expression, the sort order of the information that's returned is undefined. For more information, see Filtering and Sorting.
page-size	(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number	(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.

**Note**: The filter and sort parameters can be combined with each other and with paging parameters using an ampersand (**`&`**). #### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can get flows that they have Read (view) permissions for (either explicitly or implicitly). #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:flows:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ... additional flows ... ``` The datetime-created and datetime-updated attribute values are returned in UTC format (YYYY-MM-DDTHH:MM:SSZ). #### Version Version 3.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400006	Invalid page number	The page number is not an integer, is less than one, or is greater than the final page number for users at the requested page size.
400	400007	Invalid page size	The page size parameter is not an integer, or is less than one.
403	403101	Read forbidden	A non-administrator user attempted to query flows for the site, but the caller doesn't have Read permission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/9954070a-581d-40fa-ae73-e815ce8b0562/flows" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` **Example response:** ## Query Flows for User Returns the flows that the specified user owns in addition to those that the user has Read (view) permissions for. **Note:** After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. #### URI GET /api/api-version/sites/site-id/users/user-id/flows GET /api/api-version/sites/site-id/users/user-id/flows?ownedBy=isOwner&pageSize=page-size&pageNumber=page-number #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the user.
user-id	The ID of the user to get flows for.
isOwner	(Optional) trueto return only flows that the specified user owns, or falseto return all flows that the specified user has at least read access to. The default is false.
page-size	(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number	(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.

#### Request Body None #### Permissions All users can call this method, but the results of the call depend on the user's permissions. Server and site administrators see all flows for the specified user. If the isOwnerparameter is true, users who are not server or site administrators see the flows that they own on the site. If isOwnerparameter is false, users who are not server administrators see the flows that they have Read (view) permissions for. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:flows:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ... additional flows... ``` The datetime-created and datetime-updated attribute values are returned in UTC format (YYYY-MM-DDTHH:MM:SSZ). #### Version Version 3.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400006	Invalid page number	The page number parameter is not an integer, is less than one, or is greater than the final page number for flows at the requested page size.
400	400007	Invalid page size	The page size parameter is not an integer, or is less than one.
403	403014	Page size exceeds upper limit	The page size parameter exceeds the system-wide upper limit of 1000.
403	403101	Read forbidden	A non-administrator user attempted to query flows for the user, but the caller doesn't have Read permission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user.
405	405000	Invalid request method	Request type was not GET.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the groups.
page-size	(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number	(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.
filter-expression	(Optional) An expression that lets you specify a subset of groups to return. You can filter on predefined fields such as `name`. You can include multiple filter expressions. For more information, see Filtering and Sorting.
sort-expression	(Optional) An expression that lets you specify the order in which user information is returned. If you do not specify a sort expression, the sort order of the information that's returned is undefined. For more information, see Filtering and Sorting.

#### Request Body None #### Permissions This method can only be called by server administrators and site administrators. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:groups:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ... additional groups ... ``` Notes: - If the group was imported from Active Directory, the name attribute of the element contains the group's Active Directory domain. For a group that uses local authentication, the value of that attribute is `local`. - The response body for a local group that has enabled onLogin for its grant license mode will have an import element with a domain name of `local`. Local groups with grant license mode unset, have no import element in their response. - Starting in July 2026 (version 3.29), the externalUserEnabled attribute (Tableau Cloud only) is omitted from the element in the response if the site isn't licensed for on-demand access. #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400006	Invalid page number	The page number parameter is not an integer, is less than one, or is greater than the final page number for data sources at the requested page size.
400	400007	Invalid page size	The page size parameter is not an integer, or is less than one.
403	403014	Page size limit exceeded	The specified page size is larger than the maximum page size.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/groups/" -X GET -H "X-Tableau-Auth:e35Z608JMPHgZfVyJncnedlUeXSX8bmb"` **Example response:** ``` ``` ## Query Job Returns status information about an asynchronous process that is tracked using a job. This method can be used to query jobs that are used to do the following: - Import users from Active Directory (the result of a call to [Create Group](#create_group)). - Synchronize an existing Tableau Server group with Active Directory (the result of a call to [Update Group](#update_group)). - Run extract refresh tasks (the result of a call to [Run Extract Refresh Task](#run_extract_refresh_task)). - Publish a workbook asynchronously (the result of a call to [Publish Workbook](#publish_workbook)). - Run workbook or view subscriptions (the result of a call to [Create Subscription](#create_subscription) or [Update Subscription](#update_subscription)) - Run a flow task (the result of a call to [Run Flow Task](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_flow.htm#RunFlowTask)) - Status of Tableau Server site deletion (the result of a call to asynchronous [Delete Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_site.htm#async) beginning API 3.18) **Note:** To query a site deletion job, the server administrator must be first signed into the default site (`contentUrl=" "`). **Version**: Available in API 2.0 and later. **License**: No additional license required. **Permissions**: This method can only be called by server administrators and site administrators. **Access Scope**: `tableau:jobs:read` - For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-id/jobs/job-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site where the job is running.
job-id	The ID of the job to get status information for.

#### Request Body None #### Response Code 200 #### Response Body ``` ... view, workbook, or datasource id and name ... ... additional job notes ... ``` The createdAt, updatedAt, and CompletedAt values are dates and times in UTC format (YYYY-MM-DDTHH:MM:SSZ). The finishCode indicates the status of the job. - For most jobs, the `finishCode` indicates the status of the job: `0` for success, `1` for error, or `2` for canceled. - For bridge extract refresh jobs, a `finishCode` of `0` indicates that the bridge client is assigned to execute the job, while a `3` indicates that the job completed. - For [asynchronous workbook publishing](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_publish.htm#async) jobs, progress will switch from `0` when the job is in-progress to `100` when it is complete. `finishCode` will switch from `1` when the job is in-progress to `0` when it is complete, and no `statusNotes` elements are provided. The statusNotes element contains one or more notes that provide details about the status of a job in a format that can be used for logging, auditing, and error recovery. Each status note contains three attributes: - type. An enumerated value (a string) that indicates the classification of the note. - value. A value that indicates the number of records reported by the current status, such as the count of records processed. - text. A description of the status that can be displayed to users. If you are working with a localized (translated) version of Tableau Server, this text is also localized. You should not rely on this text for any application logic. If you need to take action based on a specific status, test the value of the type attribute. The following table lists job status types. Some values are returned only when the job is synchronizing groups (Update Group).

Type	Value	Text
CountOfUsersAddedToGroup	Integer	Description of how many users were added to the group during the import.
CountOfUsersAddedToSite	Integer	Description of how many users were added to the site during the import.
CountOfUsersWithInsufficientLicenses	Integer	Description of how many users could not have their site role updated due to server lacking sufficient licenses for them.
CountOfUsersInActiveDirectoryGroup	Integer	Description of the total number of users in the Active Directory group being imported or synchronized
CountOfUsersProcessed	Integer	Description of the total number of users processed during the import or synchronization process.
CountOfUsersSkipped	Integer	Description of the total number of users skipped during the import or synchronization process
CountOfUsersInformationUpdated	Integer	Description of the total number of users whose information was updated during the import or synchronization process.
CountOfUsersSiteRoleUpdated	Integer	Description of the total number of users whose site role was updated during the import or synchronization process.
CountOfUsersRemovedFromGroup	Integer	(Synchronization process only) Description of the number of users removed from the group during the synchronization process.
CountOfUsersUnlicensed	Integer	(Synchronization process only) Description of the number of users who were unlicensed during the synchronization process.
SiteDelete	Integer	Description of the site deletion progress. Can include a general error or `errorCode=9` when a site can't be deleted.

#### Errors

HTTP status	`error` Code	Condition	Details
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404018	Job not found	The job ID in the URI doesn't correspond to an existing job.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Query Jobs Returns a list of active jobs on the specified site. To get details on a specific job, pass a job ID returned by this method to the [Query Job](#query_job) method. To cancel an active job, pass a job ID returned by this method to the [Cancel Job](#cancel_job) method. Calls to this method can be filtered, as shown in the URI examples shown below. To learn more about filtering, see [Filtering and Sorting in the REST API](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm). **Version**: Available in API 3.1 and later. **License**: No additional license required. **Permissions**: This method can only be called by server administrators and site administrators. **Access Scope**: `tableau:jobs:read` - For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/_api-version_/sites/_site-id_/jobs GET /api/_api-version_/sites/_site-id_/jobs?filter=progress:lte:0 GET /api/_api-version_/sites/_site-id_/jobs?filter=jobType:eq:refresh\_extracts GET /api/_api-version_/sites/_site-id_/jobs?filter=createdAt:gt:2018-04-18T11:00:56z GET /api/_api-version_/sites/_site-id_/jobs?filter=title:has:Superstore GET /api/_api-version_/sites/_site-id_/jobs?filter=notes:has:nightly GET /api/_api-version_/sites/_site-id_/jobs?filter=jobType:eq:run\_flow #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site where the job is running.

#### Request Body None #### Response Code 200 #### Response Body ``` ``` #### Errors

HTTP status	`error` Code	Condition	Details
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/1edc53ac-e247-4870-9fd3-6fad0ce5f84d/jobs" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` **Example response:** ``` ``` ## Query Projects Returns a list of projects on the specified site, with optional parameters for specifying the paging of large results. **Note**: After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. #### URI GET /api/api-version/sites/site-id/projects GET /api/api-version/sites/site-id/projects?pageSize=page-size&pageNumber=page-number GET /api/api-version/sites/site-id/projects?filter=filter-expression GET /api/api-version/sites/site-id/projects?sort=sort-expression #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the projects.
page-size	(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number	(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.
filter-expression	(Optional) An expression that lets you specify a subset of data sources to return. You can filter on predefined fields such as `name`, `ownerName`, and `parentProjectId`. You can include multiple filter expressions. For more information, see Filtering and Sorting.
sort-expression	(Optional) An expression that lets you specify the order in which user information is returned. If you do not specify a sort expression, the sort order of the information that's returned is undefined. For more information, see Filtering and Sorting.

#### Request Body None #### Permissions Users who are not server administrators or site administrators can call this method only if they have Read (view) permission for the project (either implicitly or explicitly). #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:content:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ... additional attributes and projects ... ``` #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400006	Invalid page number	The page number parameter is not an integer, is less than one, or is greater than the final page number for data sources at the requested page size.
400	400007	Invalid page size	The page size parameter is not an integer, or is less than one.
403	403014	Page size limit exceeded	The specified page size is larger than the maximum page size.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example: Filter query by project ID `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/projects?filter=parentProjectId:eq:711d4c5d-60b7-4f77-a9a6-bbf05021b6ec" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` **Example response:** ``` ``` #### Example: Show all fields in the first ten query results `curl "https://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/projects?pageSize=10&fields=_all_" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` **Example response:** ``` ``` ## Query Quality Warning Trigger Get information about a quality warning trigger. #### URI GET api/_api-version_/sites/_site-id_/dataQualityTriggers/_trigger-id_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
content-type	The type of content the quality warning trigger has been applied to. To specify the type, use on of the following values: datasource flow These values are not case sensitive.
trigger-id	The unique ID of the quality warning trigger.

#### Request body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to query a quality warning trigger: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have "derived permissions" (if enabled) or have been granted explicit "Read" (view) permissions to the asset Otherwise, authorized users who have "derived permissions" (if enabled), and Tableau Server admins or Tableau Cloud site admins. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:labels:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response** ``` ``` #### Version Version 3.11 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400134	Generic quality warning trigger error	The quality warning trigger could not be queried for some reason other than those specified below.
403	403004	Unauthorized operation	Insufficient permissions to perform the operation.
404	404037	Quality warning not found	The requested quality warning trigger was not found.
409	409004	Invalid parameter	One or more values in the request body are invalid.

## Query Site Returns information about the specified site, with the option to return information about the storage space and user count for the site. **Note**: After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. You can specify the site to delete by using the site ID, the site name, or the content URL. You use the key query string parameter to indicate how you are specifying the site, as shown in the URIs. **Note**: You can only get site information for the site that you have signed in to. #### URI GET /api/api-version/sites/site-id GET /api/api-version/sites/site-name?key=name GET /api/api-version/sites/content-url?key=contentUrl GET /api/api-version/sites/site-id?includeUsage=include-usage-flag #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site to get information for.
site-name	The name of the site to get information for. If you specify a site name, you must also include the parameter `key=name`.
content-url	The URL of the site to get information for. If you specify a content URL, you must also include the parameter `key=contentUrl`.
include-usage-flag	The boolean flag to include site usage metrics in the response body. If true, then the site element of the response will contain a `usage` node with the attributes `numUsers` (number of users) and `storage` (storage in megabytes). To set the flag to include usage in the response, append `includeUsage=true` as a querystring element any valid query site URI.

#### Request Body None #### Permissions This method can only be called by server administrators and site administrators. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:sites:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` Response Body Details: - userQuota, storageQuota, and tiered capacity (tierCreatorCapacity, tierExplorerCapacity, tierViewerCapacity) attributes are only present in the response body if those quotas have been set for the site being queried. - **attributeCaptureEnabled** attribute is present in the response body for Tableau Cloud starting from API version 3.19 (March 2023) and Tableau Server starting from API version 3.25 (Tableau Server 2025.1). #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
404	404000	Site not found	The specified site doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example **Command:** ``` curl "http://MY-SERVER/api/3.29/sites/1234abcd-12ab-12ab-12ab-1234abcd1234?includeUsage=true" -X GET \ -H "X-Tableau-Auth:ABCD1234abcdABCD|ABCD1234abcdABCDABCD1234abcd-1" ``` **Example response:** ``` ``` **Command:** ``` curl "http://MY-SERVER/api/3.29/sites/Default?key=name" -X GET \ -H "X-Tableau-Auth:ABCD1234abcdABCD|ABCD1234abcdABCDABCD1234abcd-1" ``` **Example response:** ``` userQuota="4" tierCreatorCapacity="2" tierExplorerCapacity="1" tierViewerCapacity="1" askDataMode="DisabledByDefault" useDefaultTimeZone="false" timeZone="America/Los_Angeles" /> ``` ## Query Sites Returns a list of the sites on the server that the caller of this method has access to. This method is not available for Tableau Cloud. **Note**: After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. #### URI GET /api/api-version/sites GET /api/api-version/sites?pageSize=page-size&pageNumber=page-number #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
page-size	(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number	(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.

#### Request Body None #### Permissions This method can be called by all users. The method only returns the sites that the user has access to. #### Required scope for JWT authorization Introduced in Tableau Server 2022.3 (API 3.17). ``` tableau:sites:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` The response for users without administrative permissions contains only the site id, name, and content-url attributes. #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400006	Invalid page number	The page number parameter is not an integer, is less than one, or is greater than the final page number for the sites at the requested page size.
400	400007	Invalid page size	The page size parameter is not an integer, or is less than one.
403	403014	Page size limit exceeded	The specified page size is larger than the maximum page size.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example ``` curl "http://MY-SERVER/api/3.29/sites?pageSize=1&pageNumber=1" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" ``` **Example response:** ``` ``` ## Query Table Get information about a table asset. #### URI GET api/_api-version_/sites/_site-id_/tables/_table-id_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
table-id	The unique ID of the table asset.

#### Request Body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to query the table asset: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have "derived permissions" (if enabled) or have been granted explicit "Read" (view) permissions to the asset Otherwise, authorized users who have "derived permissions" (if enabled), and Tableau Server admins or Tableau Cloud site admins. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:tables:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response:** ``` ``` #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404032	Table not found	The requested table could not be found.
409	409052	Unknown table error	An unknown table asset error occurred.
409	409053	Unknown table query error	An unknown error occurred and the table query could not complete.

## Query Tables Get information about all table assets for a site. #### URI GET api/_api-version_/sites/_site-id_/tables #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.

#### Request Body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to query table assets: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have "derived permissions" (if enabled) or have been granted explicit "Read" (view) permissions to the asset Otherwise, authorized users who have "derived permissions" (if enabled), and Tableau Server admins or Tableau Cloud site admins. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:tables:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response:** ```

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404032	Table not found	The requested tables could not be found.
409	409052	Unknown table error	An unknown table asset error occurred.
409	409053	Unknown table query error	An unknown error occurred and the table query could not complete.

## Query User On Site Returns information about the specified user. **Note**: After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. #### URI GET /api/api-version/sites/site-id/users/user-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the user.
user-id	The ID of the user to get information for.

#### Request Body None #### Permissions Using this method server administrators and site administrators can view user information directly or through the various ways that data is used throughout Tableau. Use of this method by non-administrator users to view their own information depends on the visibility settings of a site. Using the Visibility Setting in the server UI, or the [Create Site](#create_site) or [Update Site](#update_site) methods, you can change user visibility settings of a Site. For more information, see [Manage Site User Visibility](https://help.tableau.com/current/server/en-us/user_visibility.htm). #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:users:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` **Notes:** - The lastLogin attribute value is returned as a date in UTC format (YYYY-MM-DDTHH:MM:SSZ). - The siteRole value is returned as one of the following values: Creator, Explorer, ExplorerCanPublish, ServerAdministrator, SiteAdministratorExplorer, SiteAdministratorCreator, Unlicensed, ReadOnly, or Viewer. - The externalAuthUserId value represents an ID for the user for single sign-on (SSO) with an external identity provider. If the user is not configured to use external authentication, this value is an empty string. - In Tableau Server version 9.0.1 or API version 2.0.1 and later - if SAML is enabled, and the user was imported from Active Directory, the name attribute of the element contains the user's Active Directory domain. - Starting in API 3.24, **idpConfigurationId** indicates the authentication configuration assigned to the user in Tableau Cloud only. - Starting in API 3.26 (July 2025), email indicates an email address that is different from the username. #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
403	403133	Query user permissions forbidden	The user does not have permissions to query user information for other users.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user.
405	405000	Invalid request method	Request type was not GET.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the view.
view-id	The ID of the view to render as data.
max-age-minutes	(Optional) The maximum number of minutes view data will be cached before being refreshed. To prevent multiple view data requests from overloading the server, the shortest interval you can set is one minute. There is no maximum value, but the server job enacting the caching action may expire before a long cache period is reached.
filter-value	The value of the field that you want to use to filter the workbook view. For example, a workbook with the filter `/data?vf_year=2017` would only display data from the year 2017. To learn more, see View filter queries.

#### Request Body None #### cURL Request `curl "http://MY-SERVER/api/3.29/sites/1edc53ac-e247-4870-9fd3-6fad0ce5f84d/views/2474164d-8d37-4a4c-abc7-c2070fd25fd5/data?maxAge=60" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` #### Response Code 200 #### Response Body The response body contains view data in CSV format no more than 60 minutes old. ``` Month of Date,Year of Date,Above Median?,Avg. Median January,1893,below median,-1.0 January,1864,below median,-0.9 January,1861,below median,-0.9 December,1862,below median,-0.9 March,1917,below median,-0.8 December,1892,below median,-0.8 February,1862,below median,-0.8 February,1911,below median,-0.8 February,1917,below median,-0.8 May,1861,below median,-0.8 November,1862,below median,-0.8 March,1898,below median,-0.8 December,1860,below median,-0.8 January,1862,below median,-0.7 March,1850,below median,-0.7 February,1893,below median,-0.7 December,1870,below median,-0.7 ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400080	Bad Request	The view ID in the URI doesn't correspond to a view available on the specified site.
401	401002	Unauthorized	The authentication token provided in the request header was invalid or has expired.
403	403032	Read forbidden	A non-administrator user attempted to query workbook views, but the caller doesn't have Read permission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.
429	429000	Concurrent request limit exceeded	For Tableau Cloud, the cumulative number of concurrent requests has exceeded the limit of 20. This limit applies to long-running jobs such as exports and downloads for view data, images, .pdf or .pptx files, datasources, and crosstabs, Retry this request at a later time. Introduced September 2021.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Query View Image Downloads an image file of the specified view. **Version**: Available in API 2.5 and later. **License**: No additional license required. **Permissions**: Tableau Server users who are not server administrators or site administrators can query workbook views only if they have Read (view) permission for the views (either explicitly or implicitly). **Access Scope**: `tableau:views:download` - For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). If you make multiple requests for an image, subsequent calls return a cached version of the image. This means that the returned image might not include the latest changes to the view. To decrease the amount of time that an image is cached, use the maxAge parameter. This method includes the ability to filter a view using fields in the underlying workbook data. To learn more about filtering query views, see [Filtering and Sorting in the REST API](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm#Filter-query-views). **Note**: If you want to disable this endpoint, use TSM to set the `sheet_image.enabled` setting to false. For more information, see [tsm configuration set options](https://help.tableau.com/current/server/en-us/cli_configuration-set_tsm.htm) in the Tableau Server help. #### URI GET /api/api-version/sites/site-id/views/view-id/image GET /api/api-version/sites/site-id/views/view-id/image?resolution=image-resolution GET /api/api-version/sites/site-id/views/view-id/image?maxAge=max-age-minutes GET /api/api-version/sites/site-id/views/view-id/image?vf\_=_filter-value_ Available in API 3.23 (Tableau Cloud December 2024 / Server 2024.3) and later: GET /api/api-version/sites/site-id/views/view-id/image?resolution=image-resolution GET /api/api-version/sites/site-id/views/view-id/image?vizHeight=viz-height&vizWidth=viz-width Available in API 3.29 (Tableau Cloud June 2026 / Server 2026.2 and later: GET /api/api-version/sites/site-id/views/view-id/image?format=image-format #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the view.
view-id	The ID of the view to return an image for.
viz-height	Available in API 3.23 (Tableau Cloud December 2024 / Server 2024.3) and later: (Optional) The height of the rendered pdf image in pixels that, along with the value of `vizWidth` determine its resolution and aspect ratio.
viz-width	Available in API 3.23 (Tableau Cloud December 2024 / Server 2024.3) and later: (Optional) The width of the rendered pdf image in pixels that, along with the value of `vizHeight` determine its resolution and aspect ratio.
image-resolution	(Optional) The resolution of the image. Image width and actual pixel density are determined by the display context of the image. Aspect ratio is always preserved. Set the value to `high` to ensure maximum pixel density.
max-age-minutes	(Optional) The maximum number of minutes a view image will be cached before being refreshed. To prevent multiple image requests from overloading the server, the shortest interval you can set is one minute. There is no maximum value, but the server job enacting the caching action may expire before a long cache period is reached.
filter-value	The value of the field that you want to use to filter the workbook view. For example, a workbook with the filter `/data?vf_year=2017` would only display data from the year 2017. To learn more, see View filter queries.
image-format	(Optional) The format of the returned image. Valid values are `png` (default) or `svg`. Available in API 3.29 and later.

#### Request Body None #### Response Code 200 #### Response Body The response `Content-Type` header changes based on the `image-format` parameter: - Default/PNG: `image/png` - SVG: `image/svg+xml` #### cURL Request Example ``` curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/views/9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d/image?resolution=high&maxAge=60" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400010	Bad request	Invalid query parameter. For example, attempting to query 'jpg' `image-format`.
403	403004	Read forbidden	A non-administrator user attempted to query a view preview image, but the caller doesn't have Read permission.
403	403068	Forbidden	The endpoint has been disabled on the server. To enable the endpoint, a server administrator must use tsm to configure the `sheet_image.enabled` setting. For more information, see tsm configuration set Options in the Tableau Server help.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404006	Workbook not found	The workbook ID in the URI doesn't correspond to an existing workbook.
404	404011	View not found	The view ID in the URI doesn't correspond to an existing view in the specified workbook.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Query View PDF Returns a specified view rendered as a .pdf file. **Version**: Available in API 2.8 and later. **License**: No additional license required. **Permissions**: Tableau Server users who are not server administrators or site administrators can query workbook views only if they have Read (view) permission for the views (either explicitly or implicitly). **Access Scope**: `tableau:views:download` - For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). If you make multiple requests for a PDF, subsequent calls return a cached version of the file. This means that the returned PDF might not include the latest changes to the view. To decrease the amount of time that an PDF is cached, use the maxAge parameter. This method includes the ability to filter a view using fields in the underlying workbook data. To learn more about filtering query views, see [Filtering and Sorting in the REST API](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_filtering_and_sorting.htm#Filter-query-views). #### URI GET /api/api-version/sites/site-id/views/view-id/pdf GET /api/api-version/sites/site-id/views/view-id/pdf?vizHeight=viz-height&vizWidth=viz-width GET /api/api-version/sites/site-id/views/view-id/pdf?maxAge=max-age-minutes GET /api/api-version/sites/site-id/views/view-id/pdf?type=page-type&orientation=orientation GET /api/api-version/sites/site-id/views/view-id/pdf?vf\_=_filter-value_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the view.
view-id	The ID of the view to render as a .pdf file.
filter-value	The value of the field that you want to use to filter the workbook view. For example, a workbook with the filter `/data?vf_year=2017` would only display data from the year 2017. To learn more, see View filter queries.
viz-height	(Optional) The height of the rendered pdf image in pixels that, along with the value of `vizWidth`, determines its resolution and aspect ratio.
viz-width	(Optional) The width of the rendered pdf image in pixels that, along with the value of `vizHeight`, determines its resolution and aspect ratio.
max-age-minutes	(Optional) The maximum number of minutes a view PDF will be cached before being refreshed. To prevent multiple PDF requests from overloading the server, the shortest interval you can set is one minute. There is no maximum value, but the server job enacting the caching action may expire before a long cache period is reached.
orientation	(Optional) The orientation of the pages in the .pdf file produced. The value can be `Portrait` or `Landscape`. If this parameter is not present the page orientation will default to `Portrait`.
page-type	(Optional) The type of page, which determines the page dimensions of the .pdf file returned. The value can be: `A3`, `A4`, `A5`, `B5`, `Executive`, `Folio`, `Ledger`, `Legal`, `Letter`, `Note`, `Quarto`, or `Tabloid`. If this parameter is not present the page type will default to `Legal`.

#### Request Body None #### Response Code 200 #### Response Body This method has no response body. The response is in the form of a downloaded `.pdf` file. The response header content will have `Content-Type:application/pdf`. #### cURL Example ``` curl "http://MY-SERVER/api/3.29/sites/1edc53ac-e247-4870-9fd3-6fad0ce5f84d/views/2474164d-8d37-4a4c-abc7-c2070fd25fd5/pdf/maxAge=60" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" ``` The response is a file that contains the view, whose data is no older than 60 minutes, saved as a pdf. #### Errors

HTTP status	`error` Code	Condition	Details
400	400080	Bad Request	The view ID in the URI doesn't correspond to a view available on the specified site.
401	401002	Unauthorized	The authentication token provided in the request header was invalid or has expired.
403	403032	Read forbidden	A non-administrator user attempted to query workbook views, but the caller doesn't have Read permission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Query View Preview Image Returns the thumbnail image for the specified view. **Note**: After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. #### URI GET /api/api-version/sites/site-id/workbooks/workbook-id/views/view-id/previewImage #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the view.
workbook-id	The ID of the workbook that contains the view to return a thumbnail image for.
view-id	The ID of the view to return a thumbnail image for.

#### Request Body None #### Permissions Users who are not server administrators or site administrators can query workbook views only if they have Read (view) permission for the views (either explicitly or implicitly). #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:views:download ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body The view's preview image in PNG format (MIME media type `image/png`). #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Read forbidden	A non-administrator user attempted to query a view preview image, but the caller doesn't have Read permission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404006	Workbook not found	The workbook ID in the URI doesn't correspond to an existing workbook.
404	404011	View not found	The view ID in the URI doesn't correspond to an existing view in the specified workbook.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Query Views for Site Returns all the views for the specified site, optionally including usage statistics. **Note**: After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. **Version**: Available in API 2.2 and later. **License**: No additional license required. **Permissions**: For users who are not server administrators or site administrators, the method returns only the views that the user owns or has Read permissions for (either explicitly or implicitly). **Access Scope**: `tableau:content:read` - For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-id/views GET /api/api-version/sites/site-id/views?includeUsageStatistics=get-usage-information GET /api/api-version/sites/site-id/views?pageSize=page-size&pageNumber=page-number GET /api/api-version/sites/site-id/views?includeUsageStatistics=get-usage-information&pageSize=page-size&pageNumber=page-number GET /api/api-version/sites/site-id/views?filter=filter-expression GET /api/api-version/sites/site-id/views?sort=sort-expression GET /api/api-version/sites/site-id/views?fields=field-expression #### Parameter Values

api-version	The version of the API to use, such as `2.2`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the views.
get-usage-information	(Optional) true to return usage statistics. The default is false.
page-size	(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number	(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.
filter-expression	(Optional) Fields and operators that you can use to filter results. For more information, see Filter expressions.
sort-expression	(Optional) Field and direction to sort results. For more information, see Sorting.
field-expression	(Optional) An expression that lets you specify the set of available fields to return. You can qualify the return values based upon predefined keywords such as `_all_` or `_default_`, and you can specify individual fields for the workbooks or other supported resources. You can include multiple field expressions in a request. For more information, see Using Fields in the REST API.

**Note**: The filter and sort parameters can be combined with each other and with paging parameters and fields parameters using an ampersand (**`&`**). #### Request Body None #### cURL Request `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/views" -X GET -H "X-Tableau-Auth:1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d"` #### Response Code 200 #### Response Body ``` ``` ``` { "pagination": { "pageNumber": "1", "pageSize": "100", "totalAvailable": "2" }, "views": [ { "id": "1f1e1d1c-2b2a-2f2e-3d3c-3b3a4f4e4d4c", "name": "Economic Indicators", "contentUrl": "Finance/sheets/EconomicIndicators", "workbook": { "id": "1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d" }, "owner": { "id": "9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d" } }, { "id": "9a8a7b6b-5c4c-3d2d-1e0e-9a8a7b6b5b4b", "name": "Investing in the Dow", "contentUrl": "Finance/sheets/InvestingintheDow", "workbook": { "id": "59a8a7b6-be3a-4d2d-1e9e-08a7b6b5b4ba" }, "owner": { "id": "9f8e7d6c5-b4a3-f2e1-d0c9-b8a7f6e5d4c" } } ] } ``` The element is included in the response only if the method has `includeUsageStatistics=true` in the URI. #### Errors

HTTP status	`error` Code	Condition	Details
400	400006	Invalid page number	The page number parameter is not an integer, is less than one, or is greater than the final page number for data sources at the requested page size.
400	400007	Invalid page size	The page size parameter is not an integer, or is less than one.
400	400008	Invalid parameter value	The includeUsageStatistics was provided with a value other than true or false.
403	403004	Read forbidden	A non-administrator user attempted to query workbook views, but the caller doesn't have Read permission.
403	403014	Page size limit exceeded	The specified page size is larger than the maximum page size.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Query Views for Workbook Returns all the views for the specified workbook, optionally including usage statistics. **Note**: After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. #### URI GET /api/api-version/sites/site-id/workbooks/workbook-id/views GET /api/api-version/sites/site-id/workbooks/workbook-id/views?includeUsageStatistics=get-usage-information #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook.
workbook-id	The ID of the workbook to get the views for.
(Optional) get-usage-information	true to return usage statistics. The default is false.

#### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can query workbook views only if they have Read (view) permission for the views (either explicitly or implicitly). #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:content:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ... additional views ... ``` The element is included in the response only if the method has `includeUsageStatistics=true` in the URI. #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400008	Invalid parameter value	The includeUsageStatistics was provided with a value other than true or false.
403	403004	Read forbidden	A non-administrator user attempted to query workbook views, but the caller doesn't have Read permission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404006	Workbook not found	The workbook ID in the URI doesn't correspond to an existing workbook.
405	405000	Invalid request method	Request type was not GET.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook.
workbook-id	The ID of the workbook to return connection information about.

#### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can query a workbook only if they have Read (view) permission for the workbook (either explicitly or implicitly). `queryTaggingEnabled` is returned only for administrator users. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:content:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` HTTP statuserror CodeConditionDetails403403021Read forbiddenA user who is not a server administrator user attempted to query the workbook connections, but the caller doesn't have Read permission.404404000Site not foundThe site ID in the URI doesn't correspond to an existing site.404404006Workbook not foundThe workbook ID in the URI doesn't correspond to an existing workbook.405405000Invalid request methodRequest type was not GET. For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/workbooks/1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d/connections" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` **Example response:** ``` ``` **Note:** This method returns connection information, including connection type. In some cases, the name of the connection type might not map directly to a name of a connection type that you're familiar with. In those cases, see [Mapping ConnectionType Names](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_connectiontype.htm) for more information. ## Query Workbook Preview Image Returns the thumbnail image as a PNG file for the specified workbook. Usually the image that is returned is for the first sheet in the workbook. **Note**: After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. #### URI GET /api/api-version/sites/site-id/workbooks/workbook-id/previewImage #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook.
workbook-id	The ID of the workbook to return the thumbnail image for.

#### Request Body None #### Permissions Users who are not server administrators or site administrators can query a workbook preview image only if they have Read (view) permission for the workbook (either explicitly or implicitly) and also have Read (view) permission for the view that is used as the preview image. If the user doesn't have Read permissions to that view, the preview image for another view might be used. If the user doesn't have Read permissions to any views in the workbook, the user is not allowed to query a workbook query image. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:workbooks:download ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body The workbook's preview image in PNG format (MIME media type `image/png`). #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Read forbidden	A non-administrator user attempted to query the workbook preview image, but the caller doesn't have Read permission for the workbook.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404006	Workbook not found	The workbook ID in the URI doesn't correspond to an existing workbook.
405	405000	Invalid request method	Request type was not GET.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbooks.
filter-expression	(Optional) An expression that lets you specify a subset of workbooks to return. You can filter on predefined fields such as `name`, `tags`, and `createdAt`. You can include multiple filter expressions. For more information, see Filtering and Sorting.
sort-expression	(Optional) An expression that lets you specify the order in which workbook information is returned. If you do not specify a sort expression, the sort order of the information that's returned is undefined. For more information, see Filtering and Sorting.
page-size	(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number	(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.
field-expression	(Optional) An expression that lets you specify the set of available fields to return. You can qualify the return values based upon predefined keywords such as `_all_` or `_default_`, and you can specify individual fields for the workbooks or other supported resources. You can include multiple field expressions in a request. For more information, see Using Fields in the REST API.

**Note**: The filter and sort parameters can be combined with each other and with paging parameters and fields parameters using an ampersand (**`&`**). #### Request Body None #### Permissions Users who are not server administrators or site administrators can get workbooks that they have Read (view) permissions for (either explicitly or implicitly). #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:content:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ... additional tags ... ... additional workbooks ... ``` The datetime-created and datetime-updated attribute values are returned in UTC format (YYYY-MM-DDTHH:MM:SSZ). #### Response Attribute Values

accelerationEnabled

true if data acceleration is enabled, otherwise false. For more information, see Data Acceleration (Retired). Tableau's View Acceleration feature and Data Acceleration-related APIs were retired in Tableau Cloud in June 2026 and in Tableau Server version 2026.2.

accelerationStatus

The status can be:

accelerated: The acceleration job succeeded.
failed: The acceleration job failed.
inProgress: The acceleration job is running.
notUseful: The acceleration job completed but none of the queries in the workbook were supported for acceleration.
waiting: The workbook is enabled for acceleration but no background job has been submitted yet to accelerate it.

Tableau's View Acceleration feature and Data Acceleration-related APIs were retired in Tableau Cloud in June 2026 and in Tableau Server version 2026.2.

#### Version Version 2.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400006	Invalid page number	The page number is not an integer, is less than one, or is greater than the final page number for users at the requested page size.
400	400007	Invalid page size	The page size parameter is not an integer, or is less than one.
403	403014	Page size exceeds upper limit	The page size parameter exceeds the system-wide upper limit of 1000.
403	403018	Read forbidden	A non-administrator user attempted to query workbooks for the site, but the caller doesn't have Read permission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example: Get workbooks without filter `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/workbooks" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` **Example response:** ``` ...more workbooks ... ``` #### Example: Get workbooks with date/time filter The following example includes a filter to return the workbooks that were updated on 1 May 2016 at 6:00 AM or later and specifies that the results should be sorted by the workbook name. `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/workbooks?filter=updatedAt:gte:2016-05-01T06:00:00Z&sort=name:asc" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` ## Query Workbooks for User Returns the workbooks that the specified user owns in addition to those that the user has Read (view) permissions for. **Note**: After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. #### URI GET /api/api-version/sites/site-id/users/user-id/workbooks GET /api/api-version/sites/site-id/users/user-id/workbooks?ownedBy=isOwner&pageSize=page-size&pageNumber=page-number #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the user.
user-id	The ID of the user to get workbooks for.
isOwner	(Optional) true to return only workbooks that the specified user owns, or false to return all workbooks that the specified user has at least read access to. The default is false.
page-size	(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number	(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.

#### Request Body None #### Permissions All users can call this method, but the results of the call depend on the user's permissions. Server and site administrators see all workbooks for the specified user. If the isOwner parameter is true, users who are not server or site administrators see the workbooks that they own on the site. If isOwner parameter is false, users who are not server administrators see the workbooks that they have Read (view) permissions for. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:content:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ... additional tags ... ... additional workbooks ... ``` The datetime-created and datetime-updated attribute values are returned in UTC format (YYYY-MM-DDTHH:MM:SSZ). #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400006	Invalid page number	The page number parameter is not an integer, is less than one, or is greater than the final page number for data sources at the requested page size.
400	400007	Invalid page size	The page size parameter is not an integer, or is less than one.
403	403014	Page size exceeds upper limit	The page size parameter exceeds the system-wide upper limit of 1000.
403	403018	Read forbidden	A non-administrator user attempted to query workbooks for the user, but the caller doesn't have Read permission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user.
405	405000	Invalid request method	Request type was not GET.

api-version	The version of the API to use. These TDS Edit methods are available in API 3.30 and later. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site in the URI. This handler does not bind the path variable — the service uses the authenticated user's site LUID (`authUser.getSiteLuid()`).
datasource-luid	The LUID of the data source. Must be a UUID (8-4-4-4-12 hexadecimal digits), matching `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}`.
`elementType`	Required. The kind of element to return. Allowed values are `Column`, `FieldDescription`, and `TableDescription`.
`name`	Optional. The name of a single element to read. When omitted, the call lists elements of the requested `elementType`. When this value is non-empty and the TDS service returns gRPC `NOT_FOUND`, the API responds 404 with error code `404065`.

#### Response Code 200 OK #### Response Body Returns the elements read from the data source or work copy in `tdsElementList`. Each entry carries either a `column` payload (when `elementType` is `Column`) or a `description` string (when `elementType` is `FieldDescription` or `TableDescription`). If an individual read record fails, that entry carries an `error` object instead and the overall HTTP status stays 200. ``` Column Sales Sales MEASURE REAL FieldDescription Sales Total sales amount. Orders 5 NOT_FOUND ``` ``` { "tdsElementList": [ { "elementType": "Column", "name": "Sales", "column": { "caption": "Sales", "role": "MEASURE", "type": "REAL" } }, { "elementType": "FieldDescription", "name": "Sales", "description": "Total sales amount." }, { "name": "Orders", "error": { "code": 5, "message": "NOT_FOUND" } } ] } ``` #### Attribute Values

tdsElementList[]	Required. Elements read from the data source or work copy. Empty when the TDS service returns no records.
tdsElementList[].elementType	Optional. Element type. Not set by the read converter for this operation.
tdsElementList[].name	Required. Name of the element, set from the gRPC read result or from the failure record when the record failed.
tdsElementList[].column	Optional. Present when the read result is a column. Mutually exclusive with `description`.
tdsElementList[].column.caption	Optional. Column display caption from the TDS service.
tdsElementList[].column.role	Optional. Column role, `FieldRole.name()` from the TDS service.
tdsElementList[].column.type	Optional. Column field type, `FieldType.name()` from the TDS service.
tdsElementList[].description	Optional. Description text. Present when the read result is a field description or a table description. Mutually exclusive with `column`.
tdsElementList[].error	Optional. Present only when this read record failed. The HTTP status of the read stays 200.
tdsElementList[].error.code	Required (within `error`). The raw gRPC status code for the failed record — not a translated HTTP code and not a Tableau 6-digit error code.
tdsElementList[].error.message	Optional. Error message from the TDS service.

#### Errors

HTTP status	`error` Code	Condition	Details
400		Invalid data source LUID	The data source LUID in the URI is not a UUID (8-4-4-4-12 hexadecimal digits).
400		Invalid elementType	`elementType` must be `Column`, `FieldDescription`, or `TableDescription`.
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	403004	Data Management Bundle not licensed	On Tableau Server the TDS Edit API requires a Data Management Bundle license. The call is rejected when that license is absent.
403	403004	Unable to resolve tenant	On Tableau Cloud the subscription could not be checked because the tenant id for the site could not be retrieved.
403	403004	No cloud entitlements	On Tableau Cloud no entitlements were found for the tenant. The TDS Edit API requires a Tableau+ subscription.
403	403004	Subscription not entitled	On Tableau Cloud the site edition is not Tableau+. The TDS Edit API requires a Tableau+ subscription.
404	404065	TDS element not found	No element with the requested name exists. Returned only when the `name` query parameter is non-empty. A missing data source or work copy is not given this code.
405	405000	Method not allowed	The HTTP method is not supported for this resource.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500		Unknown error	There was an internal server error.
503		Service unavailable	Service unavailable.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Read Work Copy Elements Reads columns, field descriptions, or table descriptions from a work copy. Set `elementType` to the kind of element, and optionally set `name` to read one element. A missing named element returns HTTP 404. When a read record fails inside a successful response, the failure is on that element's `error` field and the HTTP status stays 200. **Version**: Available in API 3.30 (Tableau Cloud October 2026 / Server 2026.3) and later. **License**: Data Management or Tableau+. **Permissions**: Users who are not server administrators or site administrators can call this method only if they have Connect, Write (save), and VizqlDataApiAccess (API Access) permissions for the data source that the work copy was created from (either explicitly or implicitly). **Access Scope**: `tableau:content:read` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/tds/sites/site-luid/workcopy/workcopy-luid #### URI Parameter Values

api-version	The version of the API to use. These TDS Edit methods are available in API 3.30 and later. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site in the URI. This handler does not bind the path variable — the service uses the authenticated user's site LUID (`authUser.getSiteLuid()`).
workcopy-luid	The LUID of the work copy. Must be a UUID (8-4-4-4-12 hexadecimal digits), matching `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}`.
`elementType`	Required. The kind of element to return. Allowed values are `Column`, `FieldDescription`, and `TableDescription`.
`name`	Optional. The name of a single element to read. When omitted, the call lists elements of the requested `elementType`. When this value is non-empty and the TDS service returns gRPC `NOT_FOUND`, the API responds 404 with error code `404065`.

#### Response Code 200 OK #### Response Body Returns the elements read from the work copy in `tdsElementList`. Each entry carries either a `column` payload (when `elementType` is `Column`) or a `description` string (when `elementType` is `FieldDescription` or `TableDescription`). If an individual read record fails, that entry carries an `error` object instead and the overall HTTP status stays 200. ``` FieldDescription Sales Total sales amount, updated on the work copy. TableDescription Orders Order line items. Region 5 NOT_FOUND ``` ``` { "tdsElementList": [ { "elementType": "FieldDescription", "name": "Sales", "description": "Total sales amount, updated on the work copy." }, { "elementType": "TableDescription", "name": "Orders", "description": "Order line items." }, { "name": "Region", "error": { "code": 5, "message": "NOT_FOUND" } } ] } ``` #### Attribute Values

tdsElementList[]	Required. Elements read from the data source or work copy. Empty when the TDS service returns no records.
tdsElementList[].elementType	Optional. Element type. Not set by the read converter for this operation.
tdsElementList[].name	Required. Name of the element, set from the gRPC read result or from the failure record when the record failed.
tdsElementList[].column	Optional. Present when the read result is a column. Mutually exclusive with `description`.
tdsElementList[].column.caption	Optional. Column display caption from the TDS service.
tdsElementList[].column.role	Optional. Column role, `FieldRole.name()` from the TDS service.
tdsElementList[].column.type	Optional. Column field type, `FieldType.name()` from the TDS service.
tdsElementList[].description	Optional. Description text. Present when the read result is a field description or a table description. Mutually exclusive with `column`.
tdsElementList[].error	Optional. Present only when this read record failed. The HTTP status of the read stays 200.
tdsElementList[].error.code	Required (within `error`). The raw gRPC status code for the failed record — not a translated HTTP code and not a Tableau 6-digit error code.
tdsElementList[].error.message	Optional. Error message from the TDS service.

#### Errors

HTTP status	`error` Code	Condition	Details
400		Invalid work copy LUID	The work copy LUID in the URI is not a UUID (8-4-4-4-12 hexadecimal digits).
400		Invalid elementType	`elementType` must be `Column`, `FieldDescription`, or `TableDescription`.
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	403004	Data Management Bundle not licensed	On Tableau Server the TDS Edit API requires a Data Management Bundle license. The call is rejected when that license is absent.
403	403004	Unable to resolve tenant	On Tableau Cloud the subscription could not be checked because the tenant id for the site could not be retrieved.
403	403004	No cloud entitlements	On Tableau Cloud no entitlements were found for the tenant. The TDS Edit API requires a Tableau+ subscription.
403	403004	Subscription not entitled	On Tableau Cloud the site edition is not Tableau+. The TDS Edit API requires a Tableau+ subscription.
404	404065	TDS element not found	No element with the requested name exists. Returned only when the `name` query parameter is non-empty. A missing data source or work copy is not given this code.
405	405000	Method not allowed	The HTTP method is not supported for this resource.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500		Unknown error	There was an internal server error.
503		Service unavailable	Service unavailable.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Reencrypt Extracts in a Site Extract encryption at rest is a data security feature that allows you to encrypt .hyper extracts while they are stored on Tableau Server. For more information, see [Extract Encryption at Rest](https://help.tableau.com/current/server/en-us/security_ear.htm). Reencrypt all extracts on a site with new encryption keys. If no site is specified, extracts on the default site will be reencrypted. **Note:** Depending on the number and size of extracts, this operation may consume significant server resources. Consider running this command outside of normal business hours. #### URI POST /api/api-version/sites/site-id/reencrypt-extracts #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site.

#### Request Body None #### Permissions Tableau Server administrators can call this method. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:extract_encryption:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body None #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
404	404000	Site not found	The specified site doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not POST.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Register EAS Create a connected app with OAuth 2.0 trust by registering an external authorization server (EAS) to a site. You can register an external authorization server (EAS) to establish a trust relationship between your Tableau Server site or Tableau Cloud site and EAS using the OAuth 2.0 standard protocol. By establishing a trust relationship, you’re able to provide your users with a single sign-on (SSO) experience to Tableau content embedded in your custom applications or REST API authorization through an identity provider (IdP) you've already configured. **Notes:** - Beginning in API version 3.22, you can register multiple EASs per site for Tableau Cloud. - Beginning in API version 3.23, Tableau Server supports site-level EAS (and multiple registrations of EASs per site). For more information, see one of the following: - For Tableau Server: [Register EAS to Enable SSO for Embedded Content](https://help.tableau.com/current/server-linux/en-us/connected_apps_eas.htm) - For Tableau Cloud: [Register EAS to Enable SSO for Embedded Content](https://help.tableau.com/current/online/en-us/connected_apps_eas.htm) #### URI POST api/_api-version_/sites/_site-id_/connected-apps/external-authorization-servers #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.

#### Request Body ``` ``` #### Attribute Values A combination of attributes inside the element is valid, however issuerUrl is required.

URL

The entity id of your identity provider (IdP) or URL that uniquely identifies your IdP.

URI

(Optional) The JSON Web Key (JKWS) of the EAS.

name

(Optional) The name of the connected app. If the name attribute is not specified, the connected app name defaults to "External Authorization Server."

This attribute is available starting from API version 3.22 (February 2024).

#### Permissions Tableau Server admins or Tableau Cloud site admins only. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:external_authorization_servers:create ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 201 #### Response Body The request returns details about the EAS, including the following: - ``: The name of the connected app. - ``: The ID of the EAS. - `:` The issuer URL of the EAS. - `:` The JSON web key set (JWKS) of the EAS. You can use the returned EAS ID (``) in [Update EAS](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_connected_app.htm#update_connectedapp_eas) and [Delete EAS](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_connected_app.htm#delete_connectedapp_eas) requests. **Example response:** ``` EAS_1 50bdc8cd-1aa4-48fe-a0e7-68982d85daa8 https://dev-57741098.okta.com/oauth2/aus3gd9kw7ixSfBKC5d7 https://dev-57741098.okta.com/jwks.json 2022-04-07T03:50:34Z ``` #### Version Introduced in Tableau Cloud June 2022 (API 3.16). Introduced in Tableau Server 2024.1 (API 3.23). #### Errors

HTTP status	`error` Code	Condition	Details
400	400008	Issuer URL missing	The required issuer URL is missing from the request body.
400	400157	Unexpected EAS error	There was a unexpected error when creating the connected app.
400	400161	EAS limit exceeded	The site has reached its limit of EAS that can be registered or the external authorization server (EAS) ID is not in the correct format.
400	400194	Issuer URL already configured	Another connected app on the site is using the same issuer URL.
403	403000	Admin permissions required	A non-admin user called this method and doesn't have adequate permissions to perform the action.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.

## Remove Column Permanently remove the column from a table asset. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI DELETE api/_api-version_/sites/_site-id_/tables/_table-id_/columns/_column-id_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
table-id	The unique ID of the table asset.
column-id	The unique ID of the column asset.

#### Request Body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to remove the column: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:columns:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404032	Table not found	The requested table asset could not be found.
409	409059	Column error	An unknown column asset error occurred.
409	409061	Unknown column delete error	An unknown error occurred and the column could not be deleted.
409	409066	Column not found	The requested column asset could not be found.

## Remove current analytics extension connection for workbook Remove the currently used analytics extension connection to an external service from the specified workbook. The connection remains configured, and is available for further usage by the workbook. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can be called by users that have permissions to the specified workbook. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:analytics\_extensions:delete\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) or [Server](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/settings/site/extensions/analytics/workbooks/{workbook\_luid}/selected\_connection [view details](#) ## Remove Data Source Revision Removes a specific version of a data source from the specified site. The content is removed, and the specified revision can no longer be downloaded using [Download Data Source Revision](#download_data_source_revision). If you call [Get Data Source Revisions](#get_data_source_revisions), the revision that's been removed is listed with the attribute `IsDeleted="true"`. **Note:** Calling this method permanently removes the specified data source revision. #### URI DELETE /api/api-version/sites/site-id/datasources/datasource-id/revisions/revision-number #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the group.
datasource-id	The ID of the data source to remove the revision for.
revision-number	The revision number of the data source to remove. To determine what versions are available, call Get Data Source Revisions.

#### Request Body None #### Permissions Tableau Server users who are site administrators can remove data source revisions on the site that they are administrators for. Users who are not server administrators or site administrators can remove data source revisions if they have all of the following: - A site role of ExplorerCanPublish. - Read (view), Write (save), and Download (save as) permissions for the specified data source. - Save (write) permissions for the project that contains the data source. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:datasources:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 2.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Deletion forbidden	A non-administrator user attempted to remove a data source revision, but the caller doesn't have required permissions.
403	403053	Version history not enabled	version history is not enabled for the specified site.
403	403055	Cannot delete head revision	The head (first) version cannot be deleted. To remove the data source, call Delete Data Source.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404006	Data source not found	The data source ID in the URI doesn't correspond to an existing data source.
404	404024	Data source revision not found	The revision number in the URI doesn't correspond to an existing data source revision.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Remove Database Permanently remove the database asset. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI DELETE api/_api-version_/sites/_site-id_/databases/_database-id_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
database-id	The unique ID of the database asset.

#### Request Body None #### Permissions Server or site administrators only. If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to remove the database asset: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:databases:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404031	Database not found	The requested database could not be found.
409	409045	Database error	An unknown database asset error occurred.
409	409047	Database delete error	An unknown error occurred and the database asset could not be deleted.

## Remove Group from Group Set Removes a group from the specified group set. **Version:** Available in API 3.22 (Tableau Cloud February 2024 / Server 2024.2) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** This method can only be called by Tableau Server administrators or Tableau Cloud site admins. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** tableau:groupsets:delete - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI DELETE /api/api-version/sites/site-id/groupsets/group-set-id/groups/group-id #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the group set.
group-set-id	The ID of the group set to remove the group from.
group-id	The ID of the group to remove.

#### Request Body None #### Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/groupsets/1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d/groups/9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
400	400032	Deletion failed	A problem arose that prevented the group from being removed from the group set.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404012	Group not found	The group ID in the URI doesn't correspond to an existing group.
405	405000	Invalid request method	Request type wasn’t DELETE.
409	409120	Group set not found	The group set ID in the URI doesn't correspond to an existing user.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Remove items from a collection Removes items from a collection. **Version:** Available in API 3.28 (Cloud February 2026 / Server 2026.2) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Tableau administrators can call this method for all sites they administer. Other users can call this method for collections that they own. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:collections: update. Added in API 3.28. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/-/collections/{luid}/items/batchDelete [view details](#) ## Remove OpenID Connect Configuration Disable and clear the Tableau Cloud site's OpenID Connect (OIDC) configuration. **Important:** Before removing the OIDC configuration, make sure that users who are set to authenticate with OIDC are set to use a different authentication type. Users who are not set with a different authentication type before removing the OIDC configuration will not be able to sign in to Tableau Cloud. **Version:** Available in API 3.22 (Tableau Cloud February 2024) and later. Not available for Tableau Server. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Tableau Cloud site admins only. **JWT Access Scope:** Not available. #### URI PUT /api/api-version/sites/site-luid/disable-site-oidc-configuration?idpConfigurationId=idp-configuration-id **Note:** The resource, PUT /api/api-version/sites/site-luid/disable-site-oidc-configuration?idpConfigurationId=idpConfigurationId, was added in version 3.24. The original resource, PUT /api/api-version/sites/site-luid/disable-site-oidc-configuration, continues to be a supported resource if your site is configured with only one OIDC authentication configuration. If you don’t specify an `idpConfigurationId` value starting in API 3.24, the initial (default) OIDC configuration on the site is removed. If there is no initial OIDC configuration on the site, then no OIDC configuration is removed. #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
idp-configuration-id	The ID of the configuration. To get the idpConfigurationId value, use the List Authentication Configurations for Site method.

#### Request Body None #### cURL Request Example `curl "https://us-west-2a.online.tableau.com/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/disable-site-oidc-configuration?idpConfigurationId=b2207590-024c-4a6e-ac4a-eca6eefabb2e" -X PUT -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` #### Response Code 200 #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Remove Projects from Routing Rule Removes one or more project filtering conditions from an existing allow rule, broadening the rule so it no longer applies only to those projects. This method applies to allow rules only; removing projects from a block rule is rejected. Each project ID must be a valid UUID. This method is not available for Tableau Server. **Version**: Available in API 3.30 (Tableau Cloud October 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI DELETE /api/api-version/sites/site-luid/bridge-routing-rules/routing-rule-id/projects #### URI Parameter Values

api-version	The version of the API to use. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
routing-rule-id	The unique identifier (UUID) of the allow rule to remove projects from.

#### Request Body ``` ``` ``` { "routingRuleProjects": { "mode": "remove", "project": [ { "id": "11111111-2222-3333-4444-555555555555" } ] } } ``` #### Attribute Values

mode	Required. The operation mode; must be `remove` for this method.
project	Required. One or more project IDs to remove. Each entry requires an `id`.

#### Response Code 200 #### Response Body Returns the updated `routingRule` with the removed projects no longer present in `project`. ``` ``` ``` { "routingRule": { "id": "d9e8f7a6-b5c4-3210-fedc-ba9876543210", "domain": "example.com", "isBlocked": false, "poolId": "ebae40a5-d7e4-4214-b3d5-b0715c627b71", "poolName": "WindowsPool", "project": [] } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	503909	Validation failed	Missing or empty project list, or invalid project or rule UUID.
400	503910	Invariant violation	Attempted to remove projects from a block rule.
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	503923	Permission denied	Caller is not a site administrator for the site.
404	503915	Routing rule not found	No routing rule exists with the given ID on this site.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500	503922	Unexpected server error	An unexpected error occurred while removing projects.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Remove Table Permanently remove the table asset. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI DELETE api/_api-version_/sites/_site-id_/tables/_table-id_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
table-id	The unique ID of the table asset.

#### Request Body None #### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to remove the table asset: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:tables:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404032	Table not found	The requested table asset could not be found.
409	409052	Table error	An unknown table asset error occurred.
409	409054	Unknown table delete error	An unknown error occurred and the table could not be deleted.

## Remove User from Group Removes a user from the specified group. Beginning in API 3.21, you can bulk remove users from a group by specifying multiple user IDs. #### URI **Remove a single user from a group** DELETE /api/api-version/sites/site-id/groups/group-id/users/user-id **Bulk remove users from a group** (beginning in API 3.21) PUT /api/api-version/sites/site-id/groups/group-id/users/remove #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the group.
group-id	The ID of the group to remove the user from.
user-id	The ID of the user to remove.

#### Request Body **Remove a single user from a group** None **Bulk remove users from a group** (beginning in API 3.21) ``` ``` #### Attribute Values (bulk remove users only)

user-id

The ID (not name) of the user to add. You can get the user ID by calling Get Users on Site .

Beginning in API 3.21, you can bulk remove users from a group by specifying multiple user IDs.

#### Permissions This method can only be called by server administrators and site administrators. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:groups:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400032	Deletion failed	A problem arose that prevented the user from being removed from the site.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	The user name in the URI doesn't correspond to an existing user.
404	404012	Group not found	The group name in the URI doesn't correspond to an existing group.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example ##### Remove a single user from a group `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/groups/1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d/users/9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` ##### Bulk remove users from a group (beginning in API 3.21) `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/groups/1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d/users/9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d" -X PUT -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @bulk-remove-users-from-group.xml` **Content of bulk-remove-users-from-group.xml:** ``` ``` **Example response:** The response contains no body (data) if the user (or users) is successfully removed from the group. The HTTP response code is 204 if the delete operation succeeded. ## Remove User from Identity Pool Remove a user from a specified identity pool. This method is not available for Tableau Cloud. **Version:** Available in API 3.19 and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Tableau Server administrators only. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:identity\_pools\_users:delete - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI DELETE /api/api-version/sites/site-id/users/user-id/identityPool/idpool-uuid #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that is associated with the user you want to remove from the identity pool.
user-id	The ID of the user to remove from the identity pool.
idpool-uuid	The ID of the identity pool to remove the user from. You can get the identity pool ID by calling the List Identity Pools endpoint in the Tableau REST OpenAPI.

#### Request Body None #### cURL Request Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/users/7ad8f89e-c2a1-44b4-9413-ac8a62286a7a/identityPool/" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` - `MY-SERVER` is the name or IP address of your server. - `9a8b7c6d5-e4f3-a2b1-c0d9-e8f7a6b5c4d` is the ID of the site, as returned by a previous call to [Sign In](#sign_in). - `7ad8f89e-c2a1-44b4-9413-ac8a62286a7a` is the ID of the user to remove. - `df47cf24-5ed3-11ed-9b6a-0242ac12000` is the ID of the identity pool. - `12ab34cd56ef78ab90cd12ef34ab56cd` is the credentials token returned by a previous call to [Sign In](#sign_in). The response contains no body (data) if the user is successfully removed from the identity pool. The HTTP response code is 204 if the delete operation succeeded. #### Permissions This method can only be called by Tableau Server administrators. #### Response Code 204 #### Response Body None #### Version Version 3.19 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not DELETE.
429	429003	Can't remove user	There was a problem and the user couldn't be removed from the identity pool.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Remove User from Site Removes a user from the specified site. The user will be deleted if they do not own any other assets other than subscriptions. If a user still owns content (assets) on Tableau Server, the user cannot be deleted unless the ownership is reassigned first. You can’t remove a user from the server if they own content on any site on that server. You can remove a user from a site if they no longer own content on the site. If a user is removed from all sites that the user is a member of, the user is deleted. #### URI DELETE /api/api-version/sites/site-id/users/user-id DELETE /api/api-version/sites/site-id/users/user-id?mapAssetsTo=new-user-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the user.
user-id	The ID of the user to remove.
mapAssetsTo	Optional. When included in the URI path, the contents owned by the user being removed are transferred to another user. If the user owns subscriptions and no mapAssetsTo is provided, the value of the owner is changed to unknown user. If a user owns only subscriptions, you can delete them from either server or site without having to set mapAssetsTo a different user. If a user owns only subscriptions, you can delete the user from the server or site without setting this value. Note: Even though both server administrators and site administrators can call this method, only server administrators can use the mapAssetsTo parameter to reassign content ownership. Site administrators can't use this parameter value. You must be a server administrator to remove a user who still owns content on Tableau Server.
new-user-id	The ID of a user that receives ownership of contents of the user being remove.

HTTP status	`error` Code	Condition	Details
400	400000	Deletion failed	Some other problem arose that prevented the user from being removed from the site.
403	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user.
405	405000	Invalid request method	Request type was not DELETE.
409	409003	User asset conflict	The specified user still owns content on Tableau Server and cannot be deleted.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the group.
workbook-id	The ID of the workbook to remove the revision for.
revision-number	The revision number of the workbook to remove. To determine what versions are available, call Get Workbook Revisions.

#### Request Body None #### Permissions Tableau Server users who are site administrators can remove workbook revisions on the site that they are administrators for. Users who are not server administrators or site administrators can remove workbook revisions if they have all of the following: - A site role of ExplorerCanPublish. - Read (view), Write (save), and Download (save as) permissions for the specified workbook. - Save (write) permissions for the project that contains the workbook. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:workbooks:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Deletion forbidden	A non-administrator user attempted to remove a data source revision, but the caller doesn't have required permissions.
403	403053	Version history not enabled	version history is not enabled for the specified site.
403	403055	Cannot delete head revision	The head (first) version cannot be deleted. To remove the workbook, call Delete Workbook.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404006	Workbook not found	The workbook ID in the URI doesn't correspond to an existing workbook.
404	404024	Workbook revision not found	The revision number in the URI doesn't correspond to an existing workbook revision.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Reorder items in a collection Reorders items in a collection. **Version:** Available in API 3.28 (Cloud February 2026 / Server 2026.2) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Tableau administrators can call this method for all sites they administer. Other users can call this method for collections that they own. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** tableau:collections:update. Added in API 3.28. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) PATCH {server}/api/-/collections/{luid}/orderItems [view details](#) ## Replace Content Permissions Replaces existing permissions in the specified content. You can specify multiple sets of permissions using one call. **Version:** Available in API 3.23 (Tableau Cloud June 2024 / Tableau Server 2024.2) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required **Permissions:** Users who are not server administrators or site administrators can add permissions only to content for which they have **ChangePermissions** permission. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** tableau:permissions:update For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI POST /api/api-version/sites/site-luid/datasources/datasource-luid/permissions POST /api/api-version/sites/site-luid/flows/flow-luid/permissions POST /api/api-version/sites/site-luid/projects/project-luid/permissions POST /api/api-version/sites/site-luid/views/view-luid/permissions POST /api/api-version/sites/site-luid/workbooks/workbook-luid/permissions #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
datasourc-luid	The LUID for the data source.
flow-luid	The LUID for the flow.
project-luid	The LUID for the project.
view-luid	The LUID for the view.
workbook-luid	The LUID for the workbook. (Optional, but can be included for compatibility with older versions.)

#### Request Body Copy ``` ``` Copy ``` { "permissions": { "granteeCapabilities": [ { "user": { "@id": "user-luid" }, "capabilities": { "capability": { "@name": "capability-name", "@mode": "capability-mode" }, "#text": "... additional capabilities ..." } }, { "group": { "@id": "group-luid" }, "capabilities": { "capability": { "@name": "capability-name", "@mode": "capability-mode" }, "#text": "... additional capabilities ..." } } ], "#text": "... additional grantee capability sets ..." }} ``` #### Request Attributes

workbook-id	The <workbook> element is not required, but can be included for compatibility with earlier versions of the REST API. If the <workbook> element is included, the workbook-id value must match the workbook ID in the URI. Any other attributes in the <workbook> element are ignored.
user-id	The ID (not name) of the user to add permissions for.
group-id	The ID (not name) of the group to add permissions for.

#### cURL Request Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/datasources/1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d/connections" -X POST -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @replace-view-permissions.xml` #### Response Code 200 #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400009	Invalid capability	The capability in the URI is invalid for a workbook resource. Valid capabilities for a workbook are AddComment, ChangeHierarchy, ChangePermissions, CreateRefreshMetrics, Delete, ExportData, ExportImage, ExportXml, Filter, Read (view), RunExplainData, ShareView, ViewComments, ViewUnderlyingData, WebAuthoring, and Write.
403	403004	Permissions setting forbidden	A non-administrator user called this method but doesn't have permission to set permissions on the workbook.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	A user ID in the request body doesn't correspond to an existing user.
404	404004	Data source not found	The data source ID in the URI doesn't correspond to an existing data source.
404	404005	Project not found	The project ID in the URI doesn't correspond to an existing project.
404	404006	Workbook not found	The workbook ID in the URI doesn't correspond to an existing workbook.
404	404011	View not found	The view ID in the ID doesn't correspond to an existing view.
404	404012	Group not found	A group ID in the request body doesn't correspond to an existing group.
404	404013	Capability not found	The specified capability doesn't correspond to a defined capability. This can apply to either an invalid capability name or a capability other than Allow or Deny for any mode value.
404	404027	Flow not found	The flow ID in the URI doesn't correspond to an existing flow.
405	405000	Invalid request method	The request type was not POST.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Replace Project's Default Permissions Replaces default permissions in the specified content. If Tableau Catalog is enabled, it also adds default permission rules for database or table resources in a project. After adding default permission rules, new resources of the type you specify that are added to the project will have those permission rules. If permissions are [locked to the project](https://help.tableau.com/current/server/en-us/permissions.htm#LockProject), then the same is true for all existing child content of the project. For more information, see [Permissions](https://help.tableau.com/current/server/en-us/permissions.htm). **Version:** Available in API 3.23 (Tableau Cloud June 2024 / Tableau Server 2024.2) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Users who are not server administrators, project owners, or project leaders can replace permissions defaults for a project only if they have effective **ChangePermissions** permission. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** tableau:permissions:update For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI POST /api/api-version/sites/site-luid/projects/project-luid/default-permissions/dataroles POST /api/api-version/sites/site-luid/projects/project-luid/default-permissions/databases POST /api/api-version/sites/site-luid/projects/project-luid/default-permissions/datasources POST /api/api-version/sites/site-luid/projects/project-luid/default-permissions/flows POST /api/api-version/sites/site-luid/projects/project-luid/default-permissions/tables POST /api/api-version/sites/site-luid/projects/project-luid/default-permissions/workbooks #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
project-luid	The LUID for the project.

#### Request Body Copy ``` ``` Copy ``` { "permissions": [ { "user": { "id": "user-luid" }, "capabilities": [ { "name": "capability-name", "mode": "capability-mode" } ] }, { "group": { "id": "group-luid" }, "capabilities": [ { "name": "capability-name", "mode": "capability-mode" } ] } ]} ``` #### Request Attributes

user-luid

The LUID of the user to add default permissions for.

group-luid

The LUID of the group to add permissions for.

capability-name

The capability to assign. Valid capabilities for a workbook are AddComment, ChangeHierarchy, ChangePermissions, Delete, ExportData, ExportImage, ExportXml, Filter, Read (view), RunExplainData, ShareView, ViewComments, ViewUnderlyingData, WebAuthoring, and Write.

Valid capabilities for a data source are ChangePermissions, Connect, Delete, ExportXml, SaveAs, Read (view), and Write.

For more information, see Permissions.

#### cURL Request Example `curl --location "http://MY-SERVER/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/projects/1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d/default-permissions/dataroles" --header "Content-Type: application/xml" --data @replace-default-permissions-workbook.xml` #### Response Code 200 #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400009	Invalid capability	The capability in the URI is invalid for a data source. Valid capabilities for a workbook are AddComment, ChangeHierarchy, ChangePermissions, Delete, ExportData, ExportImage, ExportXml, Filter, Read (view), RunExplainData, ShareView, ViewComments, ViewUnderlyingData, WebAuthoring, and Write. Valid capabilities for a data source are ChangePermissions, Connect, Delete, ExportXml, Read (view), and Write. For detailed information about capabilities for each content type, see Capabilities.
400	400042	Malformed permissions qualifier	The request body includes a <workbook> or <datasource> element.
403	403004	Permissions setting forbidden	A non-administrator user called this method but doesn't have permission to add permissions on the project.
404	404000	Site not found	The site LUID in the URI doesn't correspond to an existing site.
404	404002	User not found	A user LUID in the request body as the grantee doesn't correspond to an existing user.
404	404005	Project not found	The project LUID in the URI doesn't correspond to an existing project.
404	404009	Project ID mismatch	A project LUID specified in the URI doesn’t match the project ID specified in the request body. (You don’t have to specify a project ID in the request body.)
404	404012	Group not found	A group LUID in the request body doesn't correspond to an existing group.
404	404013	Capability not found	The capability in the request body doesn't correspond to a defined capability. This can apply to either an invalid capability name or to a capability other than Allow or Deny for any mode value.
405	405000	Invalid request method	The request type wasn’t POST.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Restore Recycle Bin Content Item Restores the specified content item from the Recycle Bin to a project. **Version**: Available in API 3.29 (Tableau Cloud June 2026 / Server 2026.2). **License**: No additional license required. **Permissions**: Server administrators, site administrators, or other users. The calling user also needs Publish permission for the project they're restoring content to. **Access Scope**: `tableau:recyclebin_content:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). Administrators can restore any content from the site's Recycle Bin. Other users can only restore content they own, and need Publish permission for the project they're restoring to. For information about how content properties change when it's deleted or restored. See [Recycle Bin](https://help.tableau.com/current/pro/desktop/en-us/recycle_bin.htm). #### URI POST /api/api-version/sites/site-id/recyclebin/content-type/content-id/restore?projectId=project-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID of the site that contains the Recycle Bin.
content-type	Content type in plural form: `workbooks`, `datasources`, `flows`, or `projects`.
content-id	The LUID of the recycle bin content item to restore.
project-id	The LUID of the project to restore the content to.

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	Check the request body and query string parameters.
401	401000	No auth credentials	Check the authorization header.
401	401002	Invalid auth credentials	Session expired or invalid.
403	403004	Operation on resource unauthorized	Check user permission.
403	403008	Insufficient site storage remaining	Restore would exceed site storage quota.
403	403157	Feature disabled	Recycle Bin disabled.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404003	Unknown resource	Requested content item not found.
405	405000	Method not allowed	Request type unrecognized for this method.
406	406000	Unacceptable media type	Bad Accept: header.
409	409004	Invalid parameter	Parameter type-mismatched, unknown content type, or malformed LUID.
429	429000	Too many requests	Request throttled.
500	500000	Internal server error	Unknown error.
503	500001	Internal service error	Internal service error.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Revoke Administrator Personal Access Tokens Revokes all [personal access tokens](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm) (PATs) created by server administrators. This method is not available for Tableau Cloud. #### URI DELETE /api/api-version/auth/serverAdminAccessTokens #### Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.

#### Request Body None #### Permissions Only Tableau Server users with server administrator permissions can use this method. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:server_admin_tokens:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 3.11 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Revoke server admin tokens forbidden,	The user does not have the server administrator permissions required to call this method.
404	404000	Server not found	The Tableau Server in the URI doesn't correspond to an existing server.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Revoke Personal Access Token Revoke a personal access token (PAT). If you're a site admin, you can revoke a users PAT owhen you are the site admin on all sites that the PAT owner is a member of. This method is not available for Tableau Server. **Version:** Available in API 3.21 (Tableau Cloud October 2023) and later._[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Any Tableau Cloud user. If you're a Tableau Cloud site admin, you can revoke the PAT of a user when you are the site admin on all sites that the PAT owner is a member of. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** Not available. #### URI DELETE /api/api-version/sites/site-luid/users/user-luid/personal-access-tokens/pat-name #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
user-luid	The LUID of the user. The user LUID is returned after you successfully authenticate to the Tableau REST API.
pat-name	The name of the PAT you want to revoke.

#### Request Body None #### cURL Request Example `curl "http://myco/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/users/d5704762-603a-42b2-a9a7-f9cd2b2c4253/personal-access-tokens/my_pat" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` #### Response Code 204 #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
401	401002	Unauthorized Access	The credentials token provided in the request header was invalid or has expired.
403	403004	Forbidden	You can only revoke PATs that are yours.
403	403010	Cross-site access is forbidden	You're a site admin and can't revoke a PAT when you're not the site admin for all sites the PAT owner is a member of.
404	404051	Personal access token not found	The PAT couldn't be revoked because it does not exist.
405	405000	Not supported	This error can occur for the following reasons: The URI contains an incorrect PAT name or the PAT name is missing The request type is not DELETE

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Run Extract Refresh Task Runs the specified extract refresh task. **Note:** This method will fail and result in an error if your Server Administrator has disabled the **RunNow** setting for the site. For more information, see [Tableau Server Settings](https://help.tableau.com/current/server/en-us/maintenance_set.htm). This method runs the scheduled task for the data source extract, the published workbook that connects to the data extract, or the virtual connection extract. You must first schedule the task for the extract refresh. You can do this using the [Create Schedule](#create_schedule) method to create the task. To get information about the extract refresh task, use the [Get Extract Refresh Tasks](#get_extract_refresh_tasks) method, which returns the extractRefresh ID that you use as the task-id. The method adds the refresh task to the backgrounder queue. Depending upon the backgrounder load, the task might not run immediately. The method returns information about the backgrounder job responsible for running the extract refresh task, including a **job id** that can be used with the [Query Job](#query_job) method to query the status of the extract refresh. An extract refresh task can be initiated by a REST API call, a tabcmd command, or a job calling the task on a schedule. A REST request to start a refresh task will fail if the task has been put in the task queue in any of these ways, or is already in progress. #### URI POST /api/api-version/sites/site-id/tasks/extractRefreshes/task-id/runNow #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that the user is a member of.
task-id	The ID of the extract refresh task that you want to run.

#### JWT Access Scope Available in API 3.20 (Tableau Cloud June 2023). Not available for Tableau Server. `tableau:tasks:run` (this scope is included in the scope: `tableau:tasks`) For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Request Body The request body is an empty tsRequest element. ``` ``` #### Permissions Tableau Server users who are not server administrators or site administrators can only run the extract refresh tasks that they own. #### Response Code 200 #### Response Body The content type (workbook, data source, or virtual connection) is indicated in the response. ``` ``` #### Version Version 2.6 and later. Virtual connection support added in 3.30. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400047	Extract refresh error	The task specified is not an extract refresh task.
400	409090	Extract operation not allowed	The extract operation is not allowed for the asset that the task refreshes.
403	403004	Operation on resource unauthorized	The user is not authorized to run the task.
403	409082	Run now disabled	The Run Now setting is disabled for the site.
404	404003	Unknown resource	The task ID in the URI doesn't correspond to an existing task.
404	404049	Virtual connection not found	The virtual connection that the task refreshes no longer exists.
405	405000	Method not allowed	The request type was not POST.
409	409093	Operation already in queue	The extract refresh job is already in the queue.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the flow.
flow-id	The ID of the flow to update.

#### Request Body ``` ``` A request body with for running a flow with no parameters: ``` ``` A request body for running a flow but not specifying output step (effectively running all output steps): ``` ``` #### Attribute Values

flow-id	The ID of the flow to add to the schedule. This will include all the output steps in the flow and any output steps created in the future.
flow-outputstep-id	The ID of the output steps you want to run. This parameter is optional. If you don't specify the output steps, all the output steps in the flow will be included. You can specify one or more output steps. Use the List Metrics for Site - Retired in API 3.22 method to get the list of flow-outputstep-ids.
flow-run-mode	The mode to use for running this flow, either full or incremental. This parameter is optional. If you don't specify an option the run mode will be full. The flow must be configured with incremental options on the input nodes to refresh incrementally.
parameter-id	The ID of the flow parameter. Use the List Metrics for Site - Retired in API 3.22 method to get the flow parameter ID. A parameter is a global placeholder value such as a number, text value, or boolean value that can replace a constant value in a flow. Note: Parameters are optional and only relevant for flows that contain parameters and the parameter setting is enabled. For more information, see Run flows with parameters.
overrideValue	The run-time value for the flow parameter. You must specify this if the parameter is required. Use the List Metrics for Site - Retired in API 3.22 method to see if the parameter is required and to get a list of allowed values if the parameter is expecting a value from an enumerated list. Note: Parameters are optional and only relevant for flows that contain parameters and the parameter setting is enabled. For more information, see Run flows with parameters.

**Note:** You must specify the flow-id value in the URI. If you are using a request body to specify the attributes, you must also include the flow-id in the request body in addition to providing it in the URI. #### Permissions In addition to the owner of a flow, Tableau server administrators, site administrators, and project leaders can run flows within their scope. Users with a creator or explorer license that have been granted permissions by an administrator, leader or owner for a flow may also run it. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:flows:run ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` #### Version Version 3.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400132	Invalid flow run mode	The specified flow run mode is not valid.
400	400148	Invalid parameter override value	The run-time value specified is not valid.
400	400149	Parameter override value missing	The run-time value for the parameter was not specified and is required.
403	403149	Flow cannot be run	The flow parameter setting is disabled on the site preventing the flow run.
403	403150	Flow cannot be run	The flow cannot be run because flow parameters contain parameter domain type "any" but the Allow parameters that can accept any input setting is disabled on the site.
404	404000	Site not found	The site ID in the URI is unknown.
404	404027	Flow not found	The flow ID in the URI doesn't correspond to an existing flow.
404	404043	Flow parameter not found	The parameter ID specified in the request body does not match any of the existing parameters for this flow.
405	405000	Invalid request method	Request type was not POST.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/1edc53ac-e247-4870-9fd3-6fad0ce5f84d/flows/ d00700fe-28a0-4ece-a7af-5543ddf38a82/run?flowRunMode=incremental" -X POST -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` **Example response:** ``` ``` ## Run Flow Task Runs the specified flow run task. **Note:** \- This method is unavailable if you don't have Data Management. For more information, see [Tableau Prep Conductor](https://help.tableau.com/current/online/en-us/dm_overview.htm). \- This method will fail and result in an error if your Server Administrator has disabled the **RunNow** setting for the site. For more information, see [Tableau Server Settings](https://help.tableau.com/current/server/en-us/maintenance_set.htm). This method runs the scheduled task for the flow. You must first schedule the task for the flow. You can do this using the [Create Schedule](#create_schedule) method to create the task. The Run Flow task requires you to provide a task id. To get the task-id, use the Get Flow Run Tasks method, which returns the flowRun ID. The value of the flowRun ID is what you use as the task-id. The method adds the flow run task to the backgrounder queue. Depending upon the backgrounder load, the task might not run immediately. The method returns information about the backgrounder job responsible for running the flow run task, including a job id that can be used with the [Query Job](#query_job) method to query the status of the flow run. A flow task can be initiated by a REST API call, a tabcmd command, or a job calling the task on a schedule. A REST request to start a flow task will often fail if the task has been put in the task queue in any of these ways, or is already in progress. If your request results in an error code `403102`, it means that there is already a scheduled task for this within a very close time period (seconds). In this case, if the task is currently in a suspended state, it will resume. #### URI POST /api/api-version/sites/site-id/tasks/runFlow/task-id/runNow #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that the user is a member of.
task-id	The ID of the flow run task that you want to run.

#### Request Body None #### Permissions Tableau Server users who are not server administrators or site administrators can only run the flow run tasks that they own. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:flow_tasks:run ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` #### Version Version 3.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400084	Flow run task error	The task specified is not a flow run task.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the flow.
linked-task-id	The ID of the linked task to run.

#### Request Body none #### cURL Example `curl "http://MY-SERVER/api/3.29/sites/1edc53ac-e247-4870-9fd3-6fad0ce5f84d/tasks/linked/d00700fe-28a0-4ece-a7af-5543ddf38a82/runNow -X POST -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` #### Response Code 200 #### Response Body ``` . ``` ``` { "linkedTaskJob": { "id": "765dfdfc-26ec-47ea-b53b-54419c8f6b61", "linkedTaskId": "cde24429-6217-48e5-8ff5-f5dcd6a7006b", "status": "InProgress", "createdAt": "2022-02-15T00:22:22Z" } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400153	Generic error	Unable to run the linked task for some reason other than the ones specified below.
403	403155	Linked task cannot be run	The linked task setting is disabled on the site.
404	404045	Linked task not found	The linked task ID in the URI doesn't correspond to an existing linked task.
405	405000	Invalid request method	Request type was not POST.
409	409082	Run now forbidden	Run now setting has been disabled.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Search graph nodes Search graph nodes using natural-language semantic search. **Version:** Available in Tableau Cloud September 2026 and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any authenticated user. The user can read nodes allowed by content permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** Tableau Cloud+ **Access Scope:** \`tableau:knowledge:read\` [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/v1/knowledge/nodes/search [view details](#) ## Search semantic contexts Search semantic contexts across the graph. **Version:** Available in Tableau Cloud September 2026 and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any authenticated user. The user can read nodes allowed by content permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** Tableau Cloud+ **Access Scope:** \`tableau:knowledge:read\` [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/v1/knowledge/semantic-contexts/search [view details](#) ## Search semantic contexts attached to a node Search the semantic contexts attached to a specific node. **Version:** Available in Tableau Cloud September 2026 and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any authenticated user. The user can read nodes allowed by content permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** Tableau Cloud+ **Access Scope:** \`tableau:knowledge:read\` [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) POST {server}/api/v1/knowledge/nodes/{node\_id}/semantic-contexts/search [view details](#) ## Server Info Returns the version of Tableau Server and the supported version of the REST API. #### URI GET /api/api-version/serverinfo #### Parameter Values

api-version

The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.

#### Request Body None #### Permissions This method can be called by all users and does not require authentication. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:server:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` product-version api-version ``` The response contains the following information: - build-number. The build number of your installation of Tableau Server. - product-version. The product version of your installation of Tableau Server. - api-version. The REST API version that is compatible with your version of Tableau Server. #### Version Version 2.4 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Set Custom View as Default for Users Sets the specified custom for as the default view for up to 100 specified users. Success or failure for each user is reported in the response body. **Version:** Available in API 3.21 (Tableau Cloud October 2023 / Server 2023.3) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Only Tableau administrators can set a custom view as the default view for users. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:views:update - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI POST /api/api-version/sites/site-luid/customviews/custom-view-luid/default/users #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
custom-view-luid	The LUID for the custom view being updated.

#### Request Body Copy ``` ``` Copy ``` { "users": { "user": { "id": "5c9a81df-7ec0-4752-a057-82cd2bb22c44" } }} ``` #### cURL Request Example ``` curl --location 'https://qa-near.tsi.lan/api/3.21/sites/a946d998-2ead-4894-bb50-1054a91dcab3/customviews/3321cb71-6606-4d78-8a0c-e69a7e7d2261/default/users' --header 'Accept: application/xml' --header 'X-Tableau-Auth: X4fzaa75SJqSiCjq6EI9ow|uTR4NKykLGob3VustCzOq1htrchwo0ga|a946d998-2ead-4894-bb50-1054a91dcab3' --header 'Content-Type: text/plain' --data '' ``` #### Response Code 200 #### Response Body Copy ``` ``` Copy ``` { "customViewAsUserDefaultResults": { "customViewAsUserDefaultViewResult": { "success": "true", "user": { "id": "5c9a81df-7ec0-4752-a057-82cd2bb22c44" } } }} ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403162	Unauthorized Access	The user does not have adminstrator permissions.
404	404008	Resource Not Found	A custom view with the requested LUID could not be found.
405	405000	Invalid Request Method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Sign In Signs you in as a user on the specified site on Tableau Server or Tableau Cloud. This call returns a credentials token that you use in subsequent calls to Tableau Server or Tableau Cloud. For more information about authentication, see [Signing In and Signing Out (Authentication)](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_auth.htm). **Notes:** - [SAML single sign on](https://help.tableau.com/current/server/en-us/saml_requ.htm) (SSO) authentication does not validate REST API requests. For a scenario where you want to integrate Tableau authentication into a SSO environment you will need to incorporate a REST sign in request, and then use the credentials token from its response in the header of subsequent requests. - The credentials token is valid for REST API calls and Tableau Metadata API (GraphQL) queries. You cannot use the credentials token as authentication for other operations with Tableau Server. In addition, the credentials token is good only for operations in the site that you're signed in to. You cannot sign in to one site and then use the credentials token you get back to send requests to a different site. If you do, the server returns an HTTP 403 (Forbidden) error. - (Tableau Cloud only) If multi-factor authentication (MFA) is enabled with Tableau authentication, PATs are required. You must use a PAT, instead of user name and password, to make a REST API sign in request to Tableau Cloud. Alternatively, you can use a unified access token (UAT) to sign in to Tableau Cloud. **Tableau Server** Typically, a credentials token is valid for 240 minutes. With administrator permissions on Tableau Server, you can change this timeout by using the [tsm configuration set](https://help.tableau.com/current/server/en-us/cli_configuration-set_tsm.htm) command and setting the wgserver.session.idle\_limit option. In addition, if you are a Tableau Server administrator, you can use your username and password to sign in and impersonate a specific user. You might use impersonation in order to double check or troubleshoot the impact of permissions settings for that user. **Tableau Cloud** A credentials token is valid for 120 minutes on Tableau Cloud. #### URI POST /api/api-version/auth/signin **Note:** For Tableau Cloud, the server address in the URI must contain the pod name, such as prod-ca-a or us-east-1. For example, the URI to sign in to a site in the 10ay pod would be:https://prod-ca-a.online.tableau.com/api/api-version/auth/signin. For more information, see [About the pod name](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_auth.htm#pod). #### Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.

#### Request Body ### PAT Signing in with a user's personal access token (PAT): - For Tableau Server, see [personal access token](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm). - For Tableau Cloud, see [personal access token](https://help.tableau.com/current/online/en-us/security_personal_access_tokens.htm). ``` ``` ### User name and password Signing in with a user's user name and password: ``` ``` ### Impersonating user using username and password Signing in with server administrator's username and password to impersonate a user (Tableau Server only): ``` ``` ### Impersonating user using PAT Signing in with server administrator's [personal access token](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm) (PAT) to impersonate a user (Tableau Server only): ``` ``` ### Connected apps JWT Signing in with a JSON Web Token (JWT), from a [connected app](https://help.tableau.com/current/online/en-us/connected_apps.htm) (added in Tableau Cloud June 2022 (API 3.16); Tableau Server 2022.3 (API 3.17)): ``` ``` When a JWT sign-in is used, the JWT must be configured with the scopes of the REST API methods the connected app can access. You can find the scope for a JWT-supported method in a method's properties block or references details under the **Access scope** section. These sections show the scope declaration to use in the JWT that calls that method. **Note:** Beginning in API 3.20 (June 2023) for Tableau Cloud and API 3.21 (Tableau 2023.3) for Tableau Server, the Sign In (and Sign Out) method is supported by JWT authorization using connected apps but does not require a scope to use. **About connected app errors** If you encounter issues with signing in with a JWT, the response body is appended with an additional error code that you can reference in [Troubleshoot scopes](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm#signin) (Tableau Cloud Help) or [Troubleshoot scopes](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm#signin) (Tableau Server Help). For example, in the following response body, you can reference “10084” to help troubleshoot issues with signing in to Tableau Cloud or Tableau Server using a JWT for REST API authorization. "summary": "Signin Error", "detail": "Error signing in to Tableau Cloud (10084)" ### Unified access tokens JWT Signing in with a JSON Web Token (JWT) using a unified access token (added in Tableau Cloud December 2025 (API 3.27)): XML ``` ``` JSON ``` { "credentials": { "jwt": "json-web-token", "isUat": is-uat, "site": { "contentUrl": "" } } } ``` When JWT sign-in is used, the JWT must be configured with the scopes for the REST API capabilities that should be available to the unified access token (UAT). You can find the scope for a JWT-supported method in a method's properties block. The properties block shows the scope declaration to use in the JWT that calls that method. If a scope is not listed in the method's properties block, access to that method can't be limited by a JWT. For more information about UATs, see [Unified Access Tokens](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html) in the Tableau Cloud Manager REST API Help. #### Attribute Values

personal-access-token-name	The name of the personal access token when signing in with a personal access token. The token name is available on a user’s account page on Tableau server or online.
personal-access-token-secret	The secret value of the personal access token when signing in with a personal access token. The value of the secret is available only in the dialog that appears when a user creates a personal access token as described in the Tableau Help.
username	The name of the user when signing in with username and password. The name and password in the <credentials> element can represent any user in the specified site. If the user is not an administrator, they might have limited permissions to perform subsequent operations. Note: If the server is configured to use Active Directory authentication, and if the user name is not unique across domains, you must include the domain as part of the user name (for example, domain_name\Adam).
password	The password when signing in with username and password.
json-web-token	A JSON Web Token (JWT) associated with a Tableau connected app or unified access token (Tableau Cloud only). Tableau connected apps JWT: If using Tableau connected apps, the JWT uses a shared secret provided by the Tableau connected app and signed by your external application. Depending on the method used to create the connected app, a JWT can be generated by the connected app as part of the external app's call to sign in to Tableau. The JWT must include access scopes that determine which REST methods the external app can call. Unified access tokens: Starting in December 2025, if using unified access tokens (UATs), the JWT uses a shared secret as part of the UAT configuration. Added in API 3.27, Tableau Cloud only.
is-uat	Enables JWT authorization using a unified access token (UAT) when set to true. Added in API 3.27, Tableau Cloud only.
content-url	The permanent name of the site to sign in to. The content URL appears in the URL path of Tableau content in your browser address bar after the Tableau Server URL. `mySite` is the content URL in the following example: `http://<server or cloud URL>/#/site/mySite/explore` For Tableau Server, to specify the default site, omit `contentUrl` from the `site` element, or make the `contentUrl` value an empty string (`contentUrl=""`). For Tableau Cloud, a sign-in request must have a `site` element containing a `contentUrl` with the value of an existing site. If these are missing, the sign-in request will fail.
user-to-impersonate	The LUID of a user to sign in as. For impersonation when a system administrator signs in with user name and password.

#### Permissions Any Tableau user can sign in through the REST API. A user that does not have administrator permissions will have limited permissions to perform subsequent operations. Only server administrators can sign in with username and password in order to impersonate other Tableau Server users. #### Response Code 200 #### Response Body ``` ``` An `estimatedTimeToExpiration` value is returned when you sign in using a PAT. The value represents the approximate time until the PAT will expire and need to be refreshed. The estimated time is based on regular usage of the token for authenticating calls, but actual time may be shorter if the token is unused for an extended length of time. The `estimatedTimeToExpiration` value uses the format `DAYS:HH:MM`, where: - The first segment represents **days** - The second segment represents **hours** - The third segment represents **minutes** For example, a value of `2:12:30` indicates 2 days, 12 hours, and 30 minutes until expiration. This format does _not_ represent hours:minutes:seconds. For more information, see the following: - Tableau Cloud - [About PAT expiration](https://help.tableau.com/current/online/en-us/security_personal_access_tokens.htm#about-pat-expiration) - Tableau Server - [Change personal access tokens expiry](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm#change-personal-access-tokens-expiry) #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains both username/password and a personal access token, or contains malformed XML.
401	401001	Login error	The credentials (name or password, or personal access token name or secret) are invalid for the specified site, or the site contentURL is invalid.
401	401001	Login error	Login is blocked because several requests with invalid credentials were made.
401	401001	Login error	The Administrator requires the user to update their password.
401	401001	Login error	The password has expired.
401	401009	Login error	The request body is missing or empty.
405	405000	Invalid request method	Request type was not POST. If you are signing in to a Tableau Cloud site, this error may be caused by leaving the pod name out of the server address in the URI. The error can also be caused by attempting to make a request to a SSL-protected server using HTTP, rather than HTTPS.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "https://MY-SERVER/api/3.29/auth/signin" -X POST -d @signin.xml` **Content of signin.xml:** ``` ``` **Example response:** ``` ``` ## Sign Out Signs you out of the current session. This call invalidates the authentication token that is created by a call to [Sign In](#sign_in). **Notes:** - Beginning in API 3.20 (June 2023) for Tableau Cloud and API 3.21 (Tableau 2023.3) for Tableau Server, the Sign Out (and Sign In) method is supported by JWT authorization but does not require a scope to use. For more information, see [JWT](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_authentication.htm#jwt). #### URI POST /api/api-version/auth/signout #### Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.

#### Request Body None #### Permissions Any user can call this method. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:*:* ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 204 #### Response Body None #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
405	405000	Invalid request method	Request type was not POST.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Examples `curl "http://MY-SERVER/api/3.29/auth/signout" -X POST -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` ## Switch Site Switches you onto another site without having to provide a user name and password again. This method allows an authenticated user to switch sites that they have access to. When you call this method, you must provide the current authorization token as the value of the X-Tableau-Auth header. Using the current authentication token, the method signs you in as a user on the site specified in the request payload. The method returns a new authentication token and invalidates the old one. You have the permissions of the user associated with the authorization token. By default, the token is good for 240 minutes. (You can specify a different timeout value for the token by calling the `tsm configuration set` command to change the wgserver.session.idle\_limit setting.) **Note** This method is not available on Tableau Cloud. #### URI POST /api/api-version/auth/switchSite #### Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.

#### Request Body ``` ``` #### Attribute Values

content-url

The permanent name of the site to sign in to. The content URL appears in the URL path of Tableau content in your browser address bar after the Tableau Server URL.

mySite is the content URL in the following example:

http://<server or cloud URL>/#/site/mySite/explore

For Tableau Server, to specify the default site, omit contentUrl from the site element, or make the contentUrl value an empty string (contentUrl="").

For Tableau Cloud, a sign-in request must have a site element containing a contentUrl with the value of an existing site. If these are missing, the sign-in request will fail.

#### Permissions Tableau Server users who are not server administrators can switch sites, provided that they have access to the destination site. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:sites:switch ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` #### Version Version 2.6 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401000	Unauthorized access	No authentication credentials were provided.
401	401002	Unauthorized access	Invalid authentication credentials were provided.
401	401003	Switch site error	There was a problem switching sites. The site might be unavailable or is not found.
403	403070	Cannot switch to the same site	The site specified as the destination site is also the current site.
405	405000	Invalid request method	Request type was not POST.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "https://MY-SERVER/api/3.29/auth/switchSite" -X POST -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"-d @switch_site.xml` **Content of switch\_site.xml:** ``` ``` **Example response:** ``` ``` ## Test a Webhook Tests the specified webhook. Sends an empty payload to the configured destination URL of the webhook and returns the response from the server. This is useful for testing, to ensure that things are being sent from Tableau and received back as expected. #### URI GET /api/3.6/sites//webhooks//test #### Parameter Values

site-id	The ID of the site that contains the webhook.
webhook-id	The ID of the webhook.

## Unblock dashboard extension on server - Retired in API 3.21 * * * Retired in API 3.21 (Cloud October 2023 / Server 2023.3) > > [!WARNING] > > > > In October 2023 Tableau Cloud and Tableau Server version 2023.3 releases, Tableau's REST API methods for dashboard extensions settings are retired. We recommend you replace dashboard extensions methods for enabling, listing, getting details of, and updating dashboard extensions with [Tableau extensions settings methods](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_tableau_extensions_settings.htm) that have similar functionality. * * * 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](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) DELETE {server}/api/-/settings/server/extensions/dashboard/blockListItems/{block\_list\_item\_luid} [view details](#) ## Unhide a Recommendation for a View - Deprecated in API 3.19 Unhides a view from being recommended by the server by removing it from the list of views that are dimissed for a user. > [!WARNING] > > Starting in API version 3.19 (Tableau Server 2023.1 / Cloud March 2023), this method is deprecated, will no longer be supported, and may be retired in future releases. If the unhidden view meets the criteria for being recommended, then it will be displayed on the server Home or Recommendation pages. #### URI DELETE /api/api-version/sites/site-id/recommendations/dismissals/?type=view&id=view-luid #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the group.
view-luid	The LUID of the view to be removed from the list of views hidden from recommendation for a user.

HTTP status	`error` Code	Condition	Details
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404029	Content not found	The content ID in the URI doesn't correspond to an existing content of the requested type.
404	404035	Recommendation not found	A hidden recommendation for the given content ID was not found.
405	405000	Invalid request method	Request type was not DELETE.

site-id	The ID of the site that contains the webhook to be updated.
webhook-id	The ID of the webhook.

#### Request Body

#### Attribute Values

webhook-name	This is required. A name for the webhook.
api-event-name \| webhook-source-api-event-name	You must specify one of these attribute values. The name of the Tableau event that triggers your webhook. The event name must be one of the supported events listed in the Trigger Events table. The event and webhook-source use different name values for the same event.  Recommended: Use the event attribute of the webhook to specify the triggering API event for the webhook. The webhook-source element serves the same purpose but is being deprecated in future versions of Tableau webhooks. If both events and webhook-source are specified, their events specified must match. If either are specified, with the other being NULL, then the specified event becomes the webhook trigger, whether the element containing the event name is event or webhook-source.
url	(Optional) The destination URL for the webhook. The webhook destination URL must be https and have a valid certificate.
webhook-enabled-flag	(Optional) Boolean. If true (default), the newly created webhook is enabled. If false then the webhook will be disabled.
reason-for-disablement	The reason a webhook is disabled. If isEnabled set to true, omit this parameter from your request to create a webhook, or set the value of statusChangeReason to an empty string. Providing a reason value when creating an enabled webhook will result in an error (400127). If isEnabled set to false, then unless you provide a value for statusChangeReason it will default to "Webhook disabled by user".

#### Permissions This method can only be called by server and site administrators. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:webhooks:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body

#### Errors

HTTP status	`error` Code	Condition	Details
400	400127	Bad request	statusChangeReason was provided with isEnabled = true

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Response Headers ``` Location: /api/3.29/sites/site-id/webhooks/new-webhook-id ``` ## Update analytics extension connection of site Updates the details of specified analytics extension connection for an external service to a site. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Can only be called by users with site or server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:analytics\_extensions:update\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) or [Server](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) PUT {server}/api/-/settings/site/extensions/analytics/connections/{connection\_luid} [view details](#) ## Update analytics extension for workbook Updates the analytics extension connection to external service currently used by a workbook. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can be called by users that have permissions to the specified workbook. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:analytics\_extensions:update\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) or [Server](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) PUT {server}/api/-/settings/site/extensions/analytics/workbooks/{workbook\_luid}/selected\_connection [view details](#) ## Update Authentication Configuration Update an authentication instance. **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) PUT {server}/api/-/authn-service/auth-configurations/{id} [view details](#) ## Update Bridge Pool Updates the display name of an existing Bridge pool. The pool ID and domain/Bridge client assignments are unchanged. This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PATCH /api/api-version/sites/site-luid/bridge-pools/pool-id #### URI Parameter Values

api-version	The version of the API to use. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
pool-id	The unique identifier (UUID) of the pool to update.

#### Request Body ``` ``` ``` { "edgePool": { "pool": { "name": "Updated Production Pool" } } } ``` #### Attribute Values

name	Required. New display name for the pool, 1–80 characters, unique on the site (excluding the current pool).

#### Response Code 200 #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
400	409004 / 400929	Invalid pool ID, missing name, or duplicate name	Pool ID must be valid UUID; name required, 1–80 characters, unique (excluding current pool).
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	403000	Insufficient permissions	User does not have Site Administrator role.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500	503901	Unexpected server error	An unexpected error occurred while updating the pool.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Cloud Extract Refresh Task Updates an extract refresh task on Tableau Cloud. _For Tableau Server, see [Update server schedule](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_jobs_tasks_and_schedules.htm#update_schedule)._ **Version:** Available in API 3.20 (Tableau Cloud June 2023) and later. Virtual connection support added in API 3.30. Not available for Tableau Server. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Administrators and the owner of a custom schedule for an extract refresh task can update the schedule. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:tasks:update - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI POST /api/api-version/sites/site-id/tasks/extractRefreshes/task-id #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID for the site.
task-id	The LUID of the extract refresh task. Use Get extract refresh tasks on site to find tasks by name.

#### Request Body ``` ``` ``` { "extractRefresh": { "type": "FullRefresh", "workbook": { "id": "13237fd-6365-44d5-925b-644e5281b605" } }, "schedule": { "frequency": "Daily", "frequencyDetails": { "start": "18:30:00", "end": "23:30:00", "intervals": { "interval": [ { "hours": "4" }, { "weekDay": "Sunday" }, { "weekDay": "Wednesday" } ] } } } } ``` #### Request Attributes All request attributes are **optional** to update a custom schedule for a subscription.

extractRefresh type

enumeration: The type of extract refresh being scheduled. Valid values include:

FullRefresh
IncrementalRefresh

workbook id
or datasource id
or virtualConnection id LUID: The LUID of the workbook, data source, or virtual connection that is the target of the custom schedule.

extractRefresh transactionLevel

(Optional) : Only used with a virtual connection.

Optional. DATABASE or TABLE. Default is DATABASE.

If set to DATABASE: If any table extract refresh fails, none of the extracts are updated.
If set to TABLE: If a table extract fails, only that table's extract isn't updated.

startingItemId

Only used with a virtual connection, when extractRefresh type is FullRefresh

The LUID of an extract table in the virtual connection. You may have more than one <startingItemId> element inside of a <startingItemIds> element. See Virtual Connection Example.

tableLuid

Only used with a virtual connection, when extractRefresh type is IncrementalExtract

The LUID of an extract table in the virtual connection. You may have more than one <tableLiud> element inside of a <tableLiuds> element. See Virtual Connection Example.

schedule frequency

enumeration: The scheduled frequency for triggering the extract refresh. Valid values include:

Hourly
Daily
Weekly
Monthly

frequencyDetails start time: If the schedule frequency is Daily, Weekly, or Monthly, then start is the time of day on which scheduled jobs should run. If the frequency is Hourly, then start is the beginning of the time range during which jobs should be started. The valid format is HH:MM:SS.

frequencyDetails end

time: If the schedule frequency is Hourly, or Daily with an interval of hours less than 24, then end is the time of day on which scheduled jobs should stop being run. The valid format is HH:MM:SS. Time should be specified in 5 minute increments and the difference between start and end times should be increments of 60 minutes. For example, a valid frequencyDetail would be:

<frequencyDetail start="20:45:00" end="21:45:00">
    . . . 
</frequencyDetail>
                                                

interval {interval type}

string: Defines when and how often a scheduled job executes within the time parameters set in the start and end values of the frequencyDetails of the schedule. The type and valid values for an interval expression depend on the declared frequency of the schedule as follows:

Frequency	Valid interval values
`Hourly`	The value of an interval for an `Hourly` schedule can be only one of either: `hours=“1"` The number of hours between jobs. `1` is the only valid value. `minutes=“60"` The number of minutes between jobs. `60` is the only valid value. `weekDay=“weekday"` The weekday(s) the job will be run on. Valid values are: `Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday`. For example, to schedule to run a job every hour on Sunday and Wednesday, during the time range specified in `frequencyDetails` use an interval like: Copy `<intervals> <interval hours="1"/> <interval weekDay="Sunday"/> <interval weekDay="Wednesday"/> <intervals>`
`Daily`	The value of `Daily` can have multiple `weekday` elements, but only one `hours` declaration. An `hours` interval is required. `hours=“interval"` The interval between execution of jobs on the weekday(s) specified. Valid values are `2, 4, 6, 8, 12, or 24`. Note that if the `interval` value of a daily schedule is less than `24`, a `frequencyDetail end` time must be supplied. `weekDay=“weekday"` The weekday(s) the job will be run on. Valid values are: `Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday`. For example, to schedule to run a job every 4 hours on Sunday and Wednesday, during the time range specified in `frequencyDetails` use an interval like: Copy `<intervals> <interval hours="4"/> <interval weekDay="Sunday"/> <interval weekDay="Wednesday"/> <intervals>`
`Weekly`	`weekDay=“weekday"` The day of the week the schedule should run on. You can only specify a single day for a Weekly schedule. Valid values are: `Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday.`
`Monthly`	The day(s) of the month a job should be scheduled to run on. There are two ways to define a monthly interval: Specify the day(s) using the number of the day in the month; `monthDay=“day"` The number of the day of the month. Valid values are the whole numbers `1` to `31` or `LastDay`. If you specify `monthDay` by day number then you can use multiple `interval` instances to choose for the job to run on multiple days in the month. If you use `LastDay` then only one instance of `interval` can be used in the schedule to specify the last day of the month. For example, to make a schedule that that would run a job on the first and fifteenth of each month, you would use: Copy `<intervals/> <interval monthDay="1"/> <interval monthDay="15"/> </intervals/>` Specify the day by describing which occurrence of a weekday within the month. `monthDay=“occurrence_of_weekday" Weekday=“weekday"` The occurrence of the specified weekday within the month when a job should be run. Valid values for `occurrencee_of_weekday` are `First, Second, Third, Fourth, Fifth, or LastDay`. Valid values for `weekday` are `Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday`. If the value is `lastDay` then the job will run on the last occurrence of the specified weekday in the month. For example, to make a schedule that that would run a job on the third Thursday of each month, you would use: Copy `<interval monthDay="Third" weekDay="Thursday"/>`

#### Virtual Connection Example When the target is a virtual connection, use `virtualConnection id` instead of `workbook id` or `datasource id`. The following example includes only the `` and child elements for brevity; see the primary example above for the a full request without the elements that apply only to virtual connections. _Incremental refresh of specific tables, with a table-level transaction:_ ``` b4e39d59-19c3-4380-8ea4-9bfa4ed8fb84 ``` #### cURL Request Example `` curl --location --request POST "https://10ax.online.tableau.com/api/3.29/sites/a946d998-2ead-4894-bb50-1054a91dcab3/tasks/extractRefreshes/r2345998-2ead-4894-bb50-1054a9109876" --header "Content-Type: application/xml" `--data " "` `` #### Response Code 200 #### Response Body For a virtual connection task, the response includes a `virtualConnection` element in place of `workbook` or `datasource`, a `transactionLevel` attribute, and a `startingItemIds` element if starting tables were set. ``` ``` ``` { "extractRefresh": { "id": "13237fd-6365-44d5-925b-644e5281b605", "consecutiveFailedCount": "0", "type": "IncrementalRefresh", "datasource": { "id": "0057ccac-872a-11e5-bb51-f763326b1350" } }, "schedule": { "id": "cdfe8548-84c8-418e-9b33-2c0728b2398a", "createdAt": "2023-04-06T23:43:12-0700", "updatedAt": "2023-04-06T23:43:12-0700", "frequency": "Daily", "nextRunAt": "2023-04-06T23:43:12-0700", "frequencyDetails": { "start": "18:30:00", "end": "23:30:00", "intervals": { "interval": [ { "hours": "4" }, { "weekDay": "Sunday" }, { "weekDay": "Wednesday" } ] } } } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The request did not include a valid schedule payload.
400	409004	Invalid parameter	A value in the request is invalid or missing. This includes an invalid or missing schedule or interval value, or `start` and `end` times that are not valid for the schedule. For hourly and daily schedules that use hour intervals, the difference between `start` and `end` must be a multiple of one hour. This error also includes `transactionLevel` sent for a task that is not a virtual connection task, a `startingItemIds` entry that is not a valid ID, or more `startingItemIds` entries than the maximum allowed per request.
400	400225	Duplicate table ID	`startingItemIds` contains the same table ID more than once.
400	400223	Table not found	A table ID in `startingItemIds` is not in the virtual connection's active revision.
400	400224	Table not in extract mode	A table ID in `startingItemIds` refers to a table that is in live mode.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403004	Unauthorized Access	The user is not authorized to make this request.
403	403200	Virtual connection task forbidden	The user cannot see, or cannot manage or refresh the extract of, the virtual connection that the task refreshes.
404	404026	Task not found	The task does not exist, is not an extract refresh task, or targets content that no longer exists.
404	404023	Schedule not found	The task's existing schedule could not be found while merging the new schedule values.
405	405000	Method not allowed	The site is not on Tableau Cloud, or the task refreshes a virtual connection and virtual connection custom-schedule tasks are disabled for the site.
409	409130	Task state invalid	The stored virtual connection task is in an unexpected state and must be repaired or recreated.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Column Update the description of the column. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI PUT api/_api-version_/sites/_site-id_/tables/_table-id_/columns/_column-id_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
table-id	The unique ID of the table asset.
column-id	The unique ID of the column asset.

#### Request Body ``` ``` #### Attribute Values Any combination of attributes inside the **** element is valid. Only the attributes and child elements that are included result in updates to the table. If no attributes or nested elements are included, no update is made.

new-description-value

(Optional) Custom text to describe the column.

#### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to update the column: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:columns:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response:** ``` ``` #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404032	Table not found	The requested table asset could not be found.
409	409052	Column error	An unknown table asset error occurred.
409	409057	Column update error	An unknown error occurred and the table asset could not be updated.
409	409058	Column update forbidden	A user without "write" permissions to the table asset attempted an update.
409	409066	Column not found	The requested column asset could not be found.

## Update Connected App Update a connected app. #### URI PUT api/api-version/sites/_site-id_/connected-apps/direct-trust/_client-id_ **Note:** The `connected-applications` endpoint that performed this function was deprecated in API 3.17 (Tableau Cloud October 2022 / Tableau Server 2022.3), is no longer supported and may be retired in a future release. #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
client-id	The unique ID of the connected app.

#### Request Body For Tableau Cloud and Tableau Server using API 3.23 or later ``` project_id project_id project_id ``` For Tableau Server (or Tableau Cloud) using API 3.21 or earlier ``` ``` #### Attribute Values Any combination of attributes inside the element is valid.

name	(Optional) The new name of the connected app.
enabled	(Optional) Controls whether the connected app is enabled or not. Value can be "true" or "false". If the state is not specified, the connected app is set to "false" and not enabled by default.
project_id	(Optional, embedding workflows only) The ID of the project that the connected app's access level is scoped to. To get the project ID, see Query Projects. You can specify one project, multiple projects, and all projects on a site. Single project: For Tableau Cloud (using API 3.22 or later) and Tableau Server (using API 3.23 or later), to scope the connected app's access to one project, the recommended workflow is to specify the projectIds and projectId attributes and projectId value. For Tableau Server (or Tableau Cloud) using API 3.21 or earlier, specify the projectId attribute and its value. Multiple projects: Beginning with API 3.22 (February 2024) for Tableau Cloud and API 3.23 for Tableau Server, you can specify the projectIds and projectId attributes and projectId values to scope the connected app's access to multiple projects. All projects: For Tableau Cloud (using API 3.22 or later) and Tableau Server (using API 3.23 or later), specify the projectIds attribute and do not specify values. For example, <projectIds></projectIds>. For Tableau Server (or Tableau Cloud) using API 3.21 or earlier, specify the projectId attribute and leave its value empty. For example `projectId=""`. Note: If the `projectIds` or `projectId` is not included in the request, the connected apps' access level is not updated. Note: The stand-alone projectId attribute will be retired in a future release so we recommend using projectIds attribute instead.
domainsafelist	(Optional, embedding workflows only ) A list of domains the connected app is allowed to be hosted. Specify one or more URLs, separated by spaces, using a format described in Domain allowlist rules in the Tableau Server Help or Domain allowlist rules in the Tableau Cloud Help. Important: We recommend using the domain allowlist as a security best practice to ensure Tableau content is only embedded in locations that you allow. For example: `https://tableau.com https://myco.com:552 marketing.example.com`
unrestrictedEmbedding	(Optional, embedding workflows only) Controls whether the connected app can be hosted on all domains. If "true" value is specified, the connected app can trust and connect to all domains. If "false" value is specified, the connected app can only be hosted on the domains specified in the `<domainSafelist>` attribute.

#### Permissions Tableau Server admins or Tableau Cloud site admins only. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:connected_apps_direct_trust:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response:** ``` d8a51b6c-bf70-4aaf-959b-93d2ba4897e6 2021-08-18T17:59:11Z ConnectedApp_MyCo true 9486dee1-ca98-4144-b6e0-f5c555e64796 1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e 1234de4e-5d6d-7c8c-9b0b-1a2a3f4f5e0e 2021-08-18T17:48:03Z true ``` **Notes:** - The request will return the secret associated with the connected app only if it has been previously generated. To get the secret value, see [Query Connected App Secret](#get_connectedapp_secret). - When the scope of the connected app's access is set to all projects, the request does not return the `projectId` attribute. #### Version Version 3.14 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). The resource, PUT api/api-version/sites/_site-id_/connected-apps/direct-trust/_client-id_, was added in version 3.17. The original resource, PUT api/api-version/sites/_site-id_/connected-applications/_client-id_, was deprecated in API 3.17 and will be retired in a future release. #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400109	Bad request	The request body can't be empty.
400	400143	Generic connected app error	The connected app could not be deleted for some other reason than those specified in this table.
403	403000	Admin permissions required	A non-admin user called this method and doesn't have adequate permissions to perform the action.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404041	Connected app not found	The requested connected app could not be found.

## Update custom domain settings Updates the custom domain setup for a Tableau site. **Version:** Available in API 3.26 (Tableau Cloud June 2025) and later. Not available for Tableau Server. [Versioning Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Only users with administrator permissions can update a site's custom domain settings. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:custom\_domains:update\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) PUT {server}/api/-/customdomains/settings/site/{site\_luid} [view details](#) ## Update Custom View Changes the owner or name of an existing custom view. **Version:** Available in API 3.18 (Tableau Cloud December 2022 / Server 2023.1). _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Tableau administrators can update the owner and name of a custom view. Other users can update those attributes of any custom view that they own. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:views:update - Scope added in API 3.18 (Tableau Cloud December 2022 / Tableau Server 2023.1). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/sites/site-luid/customviews/custom-view-luid #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
custom-view-luid	The LUID for the custom view being updated.

#### Request Body ``` ``` ``` { "customView": { "name": "new-name", "owner": { "id": "cdfe8548-84c8-418e-9b33-2c0728b2398a" } } } ``` #### Request Attributes

`customView name`	(Optional) string The new name of the custom view that replaces the existing one.
`owner id`	(Optional) LUID The LUID of the new owner of custom view that replaces the existing one.

#### cURL Request Example `curl -L -X PUT "https://qa-near/api/3.18/sites/a946d998-2ead-4894-bb50-1054a91dcab3/customviews/37d015c6-bc28-4c88-989c-72c0a171f7aa" -H "X-Tableau-Auth: njR9EGn0QSCpbDrUOh0IKg"wamRRyVFFUHTVwFL6OWEyOggxCwWYXuq"a946d998-2ead-4894-bb50-1054a91dcab3" -H "Content-Type: application/xml" --data-raw " "` #### Response Code 200 #### Response Body ``` ``` ``` { "customView": { "id": "37d015c6-bc28-4c88-989c-72c0a171f7aa", "name": "New name 3_2514e471-95ed-4d22-92c0-da648c23891b", "createdAt": "2016-02-03T23:35:09Z", "updatedAt": "2022-10-21T04:41:27Z", "lastAccessedAt": "2022-10-21T04:43:55Z", "shared": "false", "view": { "id": "8e33ff19-a7a4-4aa5-9dd8-a171e2b9c29f", "name": "circle" }, "workbook": { "id": "2fbe87c9-a7d8-45bf-b2b3-877a26ec9af5", "name": "marks and viz types 2" }, "owner": { "id": "cdfe8548-84c8-418e-9b33-2c0728b2398a", "name": "workgroupuser" } } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403162	Unauthorized Access	The user does not have adminstrator permissions or Read permissions for the custom view..
404	404008	Resource Not Found	A custom view with the requested LUID could not be found.
405	405000	Invalid Request Method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update dashboard extension settings of site - Retired in API 3.21 * * * Retired in API 3.21 (Cloud October 2023 / Server 2023.3) > > [!WARNING] > > > > In October 2023 Tableau Cloud and Tableau Server version 2023.3 releases, Tableau's REST API methods for dashboard extensions settings are retired. We recommend you replace dashboard extensions methods for enabling, listing, getting details of, and updating dashboard extensions with [Tableau extensions settings methods](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_tableau_extensions_settings.htm) that have similar functionality. * * * Updates the settings for dashboard extensions for the site you are signed into. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server or site administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) PUT {server}/api/-/settings/site/extensions/dashboard [view details](#) ## Update dashboard extensions settings of server - Retired in API 3.21 * * * Retired in API 3.21 (Cloud October 2023 / Server 2023.3) > > [!WARNING] > > > > In October 2023 Tableau Cloud and Tableau Server version 2023.3 releases, Tableau's REST API methods for dashboard extensions settings are retired. We recommend you replace dashboard extensions methods for enabling, listing, getting details of, and updating dashboard extensions with [Tableau extensions settings methods](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_tableau_extensions_settings.htm) that have similar functionality. * * * 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](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) PUT {server}/api/-/settings/server/extensions/dashboard [view details](#) ## Update Data in Hyper Connection Incrementally updates data (insert, update, upsert, replace and delete) in a published data source from a live-to-Hyper connection, where the data source has multiple connections. A live-to-Hyper connection has a Hyper or Parquet formatted file/database as the origin of its data. For all connections to Parquet files, and for any data sources with a single connection generally, you can use the [Update Data in Hyper Data Source](#ref_update_data_in_hyper_data_source) method without specifying the `connection-id`. A request for this method must include an `upload-session-id` for a Hyper file payload containing an upload of the most current data from the data source for your published live-to-Hyper data. Use [Initiate File Upload](#initiate_file_upload) and [Append to File Upload](#append_to_file_upload) methods to form the payload and acquire upload-session-id. For details and examples, see [Update Data in Published Live-to-Hyper Data Sources](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_how_to_update_data_to_hyper.htm). **Note:** While Hyper Update REST API methods make incremental changes much more efficient, multiple simultaneous update requests and large changes in large datasets can overwhelm Tableau server background processes. To mitigate this issue, Hyper Update requests are limited by the server configuration setting `api.server.update_uploaded_file.max_size_in_mb`. Starting in Tableau Server 2022.1 / Tableau Cloud March 2022, the default for this setting is 100MB. In previous versions, the limit was set to 10MB. Where heavy incremental update traffic is expected, we recommend you use a chunking strategy to limit the size of each update, and fine tune `max_size_in_mb` value to optimize performance for your exact conditions. #### URI PATCH /api/api-version/sites/site-id/datasources/datasource-id/connections/connection-id/data?uploadSessionId=upload-session-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the data source.
datasource-id	The ID of the data source to update.
connection-id	The ID of the connection. To determine what connections are available for a data source, call Query Data Source Connections.
upload-session-id	The upload session ID. A user-generated identifier that is unique to a request. If the server receives more than one request with the same ID within 24 hours, all subsequent requests will be treated as duplicates and ignored by the server. This can be used to guarantee idempotency of requests.

#### Request Body This method supports only JSON content-type for the request body. ``` {"actions": [ {"action": action-type", "source-schema": "source-schema-name", "source-table": "source-table-name", "target-schema": "target-schema-name", "target-table": "target-table-name", "condition": {conditional-declaration"} . . . more action definition . . .} } {. . . more actions . . .} ]} ``` #### Attribute Values

actions-type	(Required) The definition of the operation(s) to perform on the data in the target hyper file.
source-schema-name	(Optional) The name of the source database schema for the data to be updated. A value is not required unless there are multiple schemas in the database.
source-table-name	(Required) The name of the source database table containing the data to be updated.
target-schema-name	(Optional) The name of the target hyper file schema of the data to be updated from the source database. A value is not required unless there are multiple schemas in the database.
target-table-name	(Required) The name of the table containing the data to be updated in the target hyper file.
condition	(Required for `insert`, `upsert`, and `delete`)A declaration that defines a comparison operation between source and target data or between source or target data and a user provided constant. For details and examples, see Update Data in Published Live-to-Hyper Data Sources.

An `action` is an operation to be performed on specified target data. Multiple different actions can be defined as a batch in a request. The supported actions are: - `insert` - Inserts rows from a named source-table in your data source into a named target-table in your published Hyper. A simplified example is: ``` {"action": "insert", "source-table": "added_users", "target-table": "current_users"} ``` - `update` – Updates existing tuples from a named `source-table` in your data source into a named `target-table` in your published Hyper. The tuples to be updated are defined in a condition declaration. A simplified example is: ``` {"action": "update", "target-table": "my_data", "source-table": "uploaded_table", "condition": {"op": "eq", "target-col": "row_id", "source-col": "update_row_id"} } ``` - `upsert` - Updates a tuple inside the `target-table`, if such a tuple exists. If no such tuple exists, a new tuple will be inserted. The tuples to be updated are defined in a condition declaration. A simplified example is: ``` {"action": "upsert", "target-table": "my_data", "source-table": "uploaded_table", "condition": {"op": "gt", "target-col": "row_id", "source-col": "update_row_id"} } ``` - `replace` – Deletes all tuples from a `target-table` and inserts all data from a `source-table` with a matching schema. A simplified example is: ``` {"action": "replace", "source-table": "added_users", "target-table": "current_users"} ``` - `delete` – Deletes tuples from a target-table. The tuples to be deleted are defined in a condition declaration. A simplified example is: ``` {"action": "delete", "target-table": "my_extract_table", "source-table": "deleted_row_id_table", "condition": {"op": "gt", "target-col": "id", "source-col": "deleted_id"} } ``` For more information, see [Update Data in Published Live-to-Hyper Data Sources](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_how_to_update_data_to_hyper.htm). #### Permissions The user calling this method must be the data source owner and must have the overwrite permission on it. #### Request Header In addition to the typical authentication token, the following fields must be specified as part of the request header: - `content-type: application/json` - This endpoint accepts JSON only. - `RequestID` - A user-generated identifier that uniquely identifies a request. If the server receives more than one request with the same id within 24 hours, all subsequent requests will be treated as duplicates and ignored by the server. This can be used to guarantee idempotency of requests, which prevents executing the same job more than once could be caused by network anomalies or client crashes. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:hyper_data:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body The response body returns the job-id, which specifies the ID of the async job that will carry out the data operations described in the action batch. This returned "job-id" can be used to [query the status of the update job](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_jobs_tasks_and_schedules.htm#query_job) or to [cancel a scheduled job](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_jobs_tasks_and_schedules.htm#cancel_job). ``` (job-id: "scheduled-job-luid"} ``` #### Version Version 2o21.2 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed JSON.
400	400008	Invalid parameter value	A parameter in the request body is missing or invalid.
403	403062	Update data source multiple connections forbidden	A connection ID is required because the data source has multiple connections. Consider using Update Data in Hyper Connection to specify the connection. (This error does not apply to that Connection method)
403	403032	Update forbidden	A non-administrator user tried to update a data source, but the caller doesn't have Write permission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404004	Data source not found	The data source LUID in the request body doesn't correspond to an existing data source.
404	404004	Data source not found	The data source ID in the URI doesn't correspond to an existing data source.
404	404008	Operation not supported	The operation requested is not supported, the source data for the connection must be a Hyper file/database.
404	404020	Connection not found	No resource was found for the specified connection and data source. (This error does not apply to Update Data in Hyper Data Source)
405	405000	Invalid request method	Request type was not PATCH.
409	409015	Data source name conflict	The data source name in the request already belongs to the specified site. For the purpose of uniqueness checks, data source names are case-insensitive.
409	409094	Data update job already exists	A data update job for the datasource is already queued or in progress.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Data in Hyper Data Source Incrementally updates data (insert, update, upsert, replace and delete) in a published data source from a live-to-Hyper connection, where the data source has a single connection. A live-to-Hyper connection has a Hyper or Parquet formatted file/database as the origin of its data. For data sources with multiple connections, you can specify which to update using the [Update Data in Hyper Data Source](#ref_update_data_in_hyper_data_connection) method. A request for this method must include an `upload-session-id` for a Hyper file payload containing an upload of the most current data from the data source for your published live-to-Hyper data. Use [Initiate File Upload](#initiate_file_upload) and [Append to File Upload](#append_to_file_upload) methods to form the payload and acquire upload-session-id. For details and examples, see [Update Data in Published Live-to-Hyper Data Sources](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_how_to_update_data_to_hyper.htm). **Note:** While Hyper Update REST API methods make incremental changes much more efficient, multiple simultaneous update requests and large changes in large datasets can overwhelm Tableau server background processes. To mitigate this issue, Hyper Update requests are limited by the server configuration setting `api.server.update_uploaded_file.max_size_in_mb`. Starting in Tableau Server 2022.1 / Tableau Cloud March 2022, the default for this setting is 100MB. In previous versions, the limit was set to 10MB. Where heavy incremental update traffic is expected, we recommend you use a chunking strategy to limit the size of each update, and fine tune `max_size_in_mb` value to optimize performance for your exact conditions. **Working with Parquet files** \- When publishing a Parquet file to a data source through a live-to-Hyper connection, the files are converted to Hyper files. You may want to publish a copy of your original Parquet file to retain that data in its native format. \- A data source with a live-to-Hyper connection to data in a Hyper file converted from Parquet can only have a single connection. \- When incrementally updating that data from that connection, using the Update Hyper in Data Source method, the Parquet file is not converted to Hyper. #### URI PATCH /api/api-version/sites/site-id/datasources/datasource-id/data?uploadSessionId=upload-session-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the data source.
datasource-id	The ID of the data source to update.
upload-session-id	The upload session ID. A user-generated identifier that is unique to a request. If the server receives more than one request with the same ID within 24 hours, all subsequent requests will be treated as duplicates and ignored by the server. This can be used to guarantee idempotency of requests.

actions-type	(Required) The definition of the operation(s) to perform on the data in the target hyper file.
source-schema-name	(Optional) The name of the source database schema for the data to be updated. A value is not required unless there are multiple schemas in the database.
source-table-name	(Required) The name of the source database table containing the data to be updated.
target-schema-name	(Optional) The name of the target hyper file schema of the data to be updated from the source database. A value is not required unless there are multiple schemas in the database.
target-table-name	(Required) The name of the table containing the data to be updated in the target hyper file.
condition	(Required for `insert`, `upsert`, and `delete`)A declaration that defines a comparison operation between source and target data or between source or target data and a user provided constant. For details and examples, see Update Data in Published Live-to-Hyper Data Sources.

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed JSON.
400	400008	Invalid parameter value	A parameter in the request body is missing or invalid.
403	403062	Update data source multiple connections forbidden	A connection ID is required because the data source has multiple connections. Consider using Update Data in Hyper Connection to specify the connection. (This error does not apply to that Connection method)
403	403032	Update forbidden	A non-administrator user tried to update a data source, but the caller doesn't have Write permission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404004	Data source not found	The data source LUID in the request body doesn't correspond to an existing data source.
404	404004	Data source not found	The data source ID in the URI doesn't correspond to an existing data source.
404	404008	Operation not supported	The operation requested is not supported, the source data for the connection must be a Hyper file/database.
404	404020	Connection not found	No resource was found for the specified connection and data source. (This error does not apply to Update Data in Hyper Data Source)
405	405000	Invalid request method	Request type was not PATCH.
409	409015	Data source name conflict	The data source name in the request already belongs to the specified site. For the purpose of uniqueness checks, data source names are case-insensitive.
409	409094	Data update job already exists	A data update job for the datasource is already queued or in progress.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Data Quality Warning Update the warning type, status, and message of a data quality warning. **Note:** Data quality warnings and certifications can be more generally managed through the newer **Labels** methods. Tableau recommends using them to help ensure that you can manage your assets as new features are developed. Try the [Update Label](#update_label) method instead. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI PUT api/_api-version_/sites/_site-id_/dataQualityWarnings/_dataqualitywarning-id_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
dataqualitywarning-id	The unique ID of the data quality warning.

type	Type of data quality warning to apply to the asset. To specify the type, use one of the following values: DEPRECATED WARNING STALE MAINTENANCE Note: In Tableau Server 2023.1 and earlier, SENSITIVE_DATA is another type of data quality warning. Starting in Tableau Cloud June 2023 and Tableau Server 2023.3, it's a sensitivity label instead. These values are not case sensitive.
status	(Optional) Controls whether the data quality warning displays. Value can be "true" or "false". If the state is not specified, the data quality warning is set to "true" and is visible by default.
message	(Optional. Was required in Tableau Server 2023.3 and earlier.) A custom message to accompany the data quality warning. You can format the message with italics, bold text, links, images, and more. Use HTML character entities to match the special characters in the formatting guide that's normally visible as a tooltip in the UI.
severity	(Optional) Enables high visibility for the data quality warning when set to "true". Values can be "true" or "false". For more information, see the "Visibility" section of the "Set a Data Quality Warning" topic in the Server Help or Cloud Help.

#### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to update the data quality warning: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:labels:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response:** ``` ``` #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400109	Bad request	The request body can't be empty.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404029	Content not found	The requested asset could not be found.
404	404030	Data quality warning not found	The data quality warning for the requested asset could not be found.

## Update Data Source Updates the owner, project or certification status of the specified data source. **Version**: Available in API 2.0 and later. **License**: No additional license required. **Permissions**: You can update data source details if you are a Tableau administrator (Creator). Specific properties can be updated by other users depending on the type of update action and the permissions granted to the user. - Users who are not server administrators can move a data source from one project to another if they own the data source or the current (source) project, or are a project leader for the current project, and they have Write permission for the destination project. - Users can change certification status and the certification note if they are server administrators, site administrators, or project leaders for the current project. - Users can modify the name of the data source if: they have server administrator, site administrator (Creator) or Creator permissions and access to the data source with the overwrite capability. **Access Scope**: `tableau:datasources:update` - For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/sites/site-id/datasources/datasource-id **Note:** Starting in 2021.2, you can also modify (insert, update, upsert, replace, and delete) data in a published data source that is a live-to-Hyper connection. To do this, use the [Update Data in Hyper Data Source](#update_data_in_hyper_data_source) method, or for data sources with multiple connections, use the [Update Data in Hyper Connection](#update_data_in_hyper_connection) method. For more information, see [UpdateData in Published Live-to-Hyper Data Sources](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_how_to_update_data_to_hyper.htm). #### Path Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site that contains the data source.
datasource-luid	The LUID of the data source to update.

#### Request Body ``` ``` ``` { "datasource": { "name": "Sales", "isCertified": "true", "certificationNote": "This is a certification note.", "encryptExtracts": "false", "project": { "id": "56c86f04-b834-4a08-a561-86497bb4b2df" }, "owner": { "id": "20148c74-7818-4eb8-b2a1-9f3f5f582613" }, "askData": { "enablement": "true [REMOVED IN API 3.12]" } } } ``` #### Request Attributes

`datasource name`	(Optional) The new name of a the data source.
`project`	(Optional) The LUID of a project to add the data source to.
`owner`	(Optional) The LUID of a user to assign the data source to as owner.
`datasource certification-status`	(Optional) A Boolean value that indicates whether the data source is certified. To learn more about data source certification, see Use Certified and Recommended Data Sources and Tables.
`datasource certification-note`	(Optional) A note that provides more information on the certification of the data source, if applicable.
`datasource encryptExtracts`	(Optional) true to encrypt the extracts or false to not encrypt extracts. For more information, see Extract and Encryption Methods.
`askDataEnablement`	This attribute is removed in API 3.12 and later (Tableau Cloud September 2021 / Server 2021.3). (Optional) Determines if a data source allows use of Ask Data. The value can be `Enabled`, `Disabled`, or `SiteDefault`. If `enablement` is not specified, Ask Data availability for the data source is unchanged during this update. If the `askData` element is included, it must contain an `enablement` attribute. Setting the value of `enablement` to `SiteDefault` for a data source will cause its enablement to follow the site's settings for Availability of Ask Data. A value of `Enabled` or `Disabled` will override a site's settings for the data source unless the setting Always disable Ask Data is selected. In that case, Ask Data will not be available for the data source regardless of the value of `enablement`.

Any combination of the attributes inside the element is valid. Only the attributes and child elements that are included result in updates to the data source. If no attributes or nested elements are included, no update is made. If the element is included, the id attribute must be included, and any other attributes of the element are ignored. If the element is included, the id attribute must be included, and any other attributes of the owner are ignored. #### cURL Example ``` curl --location --request GET "https://MY_SERVER/api/3.16/sites/a946d998-2ead-4894-bb50-1054a91dcab3/datasources" \ --header "X-Tableau-Auth: b09KVmT7QxuLVLv1En7iMg"oxKwSGTYT0WKRes5xk3dgI4gIkG3TM8W"a946d998-2ead-4894-bb50-1054a91dcvv8" \ --header "Content-Type: application/xml" \ --data-raw " " ``` #### Response Code 200 #### Response Body ``` ``` ``` { "datasource": { "name": "Sales", "id": "75b71d2f-e8d3-42af-b654-d953659326ee", "contentUrl": "mySite", "type": "excel-direct", "createdAt": "2016-02-12T23:36:09Z", "updatedAt": "2020-12-16T15:33:03Z", "isCertified": "false", "certificationNote": "This is a certification note.", "encryptExtracts": "false", "project": { "id": "56c86f04-b834-4a08-a561-86497bb4b2df" }, "owner": { "id": "20148c74-7818-4eb8-b2a1-9f3f5f582613" }, "job": { "id": "65348c74-7818-4eb8-b2a1-9f3f5f588870" }, "askData": { "enablement": "true [REMOVED IN API 3.12]" } } } ``` The `createdAt` and `updatedAt` attribute values are returned in UTC format (YYYY-MM-DDTHH:MM:SSZ). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400008	Invalid parameter value	A user attempted to rename a datasource to a name containing only spaces, or to a name with more 255 characters.
400	400129	Invalid Ask Data enablement	The requested enablement setting in the request body does not correspond to the site configuration.
403	403027	Owner update forbidden	A non-administrator user tried to change the owner for the data source.
403	403030	Project update forbidden	A non-administrator user tried to change the project for the data source, but the caller doesn't have Write permission for the project.
403	403032	Update forbidden	A non-administrator user tried to update a data source, but the caller doesn't have Write permission.
403	403141	Update forbidden	A user attempted to update a data source that they do not have permissions to update.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	Owner not found	The owner ID in the request body doesn't correspond to an existing owner.
404	404004	Data source not found	The data source ID in the URI doesn't correspond to an existing data source.
404	404005	Project not found	The project ID in the request body doesn't correspond to an existing project.
405	405000	Invalid request method	Request type was not PUT or PATCH.
409	409015	Data source name conflict	The data source name in the request already belongs to the specified site. For the purpose of uniqueness checks, data source names are case-insensitive.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Data Source Connection Updates the server address, port, authentication type, username, or password for the specified data source connection. If the data source contains multiple connections, all the connections are updated. To update specific connections in a data source containing multiple connections, see [Update Data Source Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooks_and_views.htm#update_workbook_connections). **Version**: Available in API 2.3 and later. **License**: No additional license required. **Permissions**: Users who are server administrators or site administrators can change the connection for a data source or enable [query tagging](https://help.tableau.com/current/pro/desktop/en-us/performance_tips.htm). Users who are not server administrators can only update a data source. If they have Write (save) permission for the data source and if they have write permission for the project. **Access Scope**: `tableau:datasources:update` - Access scope introduced in API 3.16 (Tableau Cloud June 2022 / Server 2022.3) For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/sites/site-id/datasources/datasource-id/connections/connection-id #### Path Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site that contains the data source.
datasource-luid	The LUID of the data source to update.
connection-luid	The LUID of the connection to update. To determine what connections are available for a data source, call Query Data Source Connections.

#### Request Body ``` ``` ``` { "connection": { "serverAddress": "newAddress", "serverPort": "newPort", "userName": "Jane Doe", "authenticationType": "new Auth Type", "password": "xxxxxx", "embedPassword": "false", "queryTaggingEnabled": "false" } } ``` #### Request Attributes

connection serverAddress	The new server for the connection.
connection serverPort	The new port for the connection
connection authenticationType	Added in version 3.27. *The new authentication type for the connection. Standard values: `auth-user-pass`: username and password `oauth` `auth-keypair`: keypair authentication Connector-specific values: `sqlserver`: SQL Server username and password `Azure AD Password` `AD Service Principal` `username-password`: Several connectors use this value. For example, SAP HANA, SAP Sybase ASE, SAP NetWeaver Business Warehouse (BW), Denodo, and Salesforce. If you are unsure of the value for authenticationType for the target connection, there are two ways to determine the value. First, if you have a data source or workbook that is currently using the target authentication type, you can query for it using the REST API methods Query Datasource Connections or Query Workbook Connections, which returns the authentication type string in the response. Alternatively, you can inspect the `<connection>` element in the XML of a workbook or data source which is available locally. Look for the value of the `authentication` attribute of the connection.
connection userName	The new username for the connection.
connection password	The new password for the connection.
embedPassword	`True` to embed the password; otherwise, `False`.
queryTaggingEnabled	[!WARNING] Starting with API 3.23 (Tableau Cloud June 2024 / Server 2024.2), the `queryTaggingEnabled` attribute is deprecated, will no longer be supported, and may be retired in future releases. Instead, for Tableau Server, use TSM to enable query tagging for all content on a server by setting `native_api.UserInfoInGeneratedSQLEnabled` to `true`. For API 3.22 (Tableau Cloud February 2024 / Server 2024.1) and earlier: If `true`, query tagging is enabled. If `false`, query tagging is disabled. The default is `false`. For more information on query tagging, see Understand Workbook Impact on Your Database Using Query Tagging.

Any combination of the attributes inside the element is valid. If no attributes are included, no update is made. #### cURL Request Example ``` curl --location --request PUT "/api/api-version/sites/site-id/datasources/datasource-id/connections/connection-id" \ --header "Content-Type: application/json" \ --header "X-Tableau-Auth: ZOjZ-2-xRfmShEJLk3LCKQ|KVZTJA7K1YeNuuJwXSKUKSatWRn9Vbpe|11e4e373-9777-44d1-ac04-5363d6e8092e" \ --data "{ 'connection': { 'serverAddress': 'newAddress', 'serverPort': 'newPort', 'userName': 'Jane Doe', 'authenticationType': 'new Auth Type', 'password': 'xxxxxx', 'embedPassword': 'false', 'queryTaggingEnabled': 'false' }" ``` #### Response Code 200 #### Response Body ``` ``` ``` { "connection": { "id": "12ab34cd-56ef-78ab-90cd-12ef34ab56cd", "serverAddress": "database.example.com", "serverPort": "12345", "authenticationType": "new Auth Type", "userName": "jajohnson", "queryTaggingEnabled": "false" } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
403	403023	Update forbidden	A non-administrator user tried to update a data source, but the caller doesn't have Write permission.
403	403027	Owner update forbidden	A non-administrator user tried to change connection information, but the caller doesn't have Write permission.
403	403062	Unsupported operation	The data source contains multiple connections, but the URI did not include `/connections/connection-id` to indicate which connection should be updated.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404004	Data source not found	The data source ID in the URI doesn't correspond to an existing data source.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Data Source Connections Updates the server address, port, authentication type, username, or password for one or more connections in a data source. To update all connections in a given data source with the same connection information, see [Update Data Source Connection](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_data_sources.htm#update_data_source_connection). **Version**: Available in API 3.27 and later. **License**: No additional license required. **Permissions**: Users who are server administrators or site administrators can change the connection for a data source or enable [query tagging](https://help.tableau.com/current/pro/desktop/en-us/performance_tips.htm). Users who are not server administrators can only update a data source. If they have Write (save) permission for the data source and if they have write permission for the project. **Access Scope**: `tableau:datasources:update` - Access scope introduced in API 3.16 (Tableau Cloud June 2022 / Server 2022.3) For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/sites/site-id/datasources/datasource-id/connections/ #### Path Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site that contains the data source.
datasource-luid	The LUID of the data source to update.

#### Request Body ``` Luid1 Luid2 ``` ``` { "connectionLuids": [ "Luid1", "Luid2" ], "connection": { "serverAddress": "newAddress", "serverPort": "newPort", "authenticationType": "new Auth Type", "userName": "Jane Doe", "password": "xxxxxx", "embedPassword": "false", "queryTaggingEnabled": "false" } } ``` #### Request Attributes

connectionLuids	An array of connection LUIDs in the data source that you are updating.
connection serverAddress	The new server for the connection.
connection serverPort	The new port for the connection
connection authenticationType	*The new authentication type for the connection. Standard values: `auth-user-pass`: username and password `oauth` `auth-keypair`: keypair authentication Connector-specific values: `sqlserver`: SQL Server username and password `Azure AD Password` `AD Service Principal` `username-password`: Several connectors use this value. For example, SAP HANA, SAP Sybase ASE, SAP NetWeaver Business Warehouse (BW), Denodo, and Salesforce. If you are unsure of the value for authenticationType for the target connection, there are two ways to determine the value. First, if you have a data source or workbook that is currently using the target authentication type, you can query for it using the REST API methods Query Datasource Connections or Query Workbook Connections, which returns the authentication type string in the response. Alternatively, you can inspect the `<connection>` element in the XML of a workbook or data source which is available locally. Look for the value of the `authentication` attribute of the connection.
connection userName	The new username for the connection.
connection password	The new password for the connection.
embedPassword	`True` to embed the password; otherwise, `False`.
queryTaggingEnabled	[!WARNING] Starting with API 3.23 (Tableau Cloud June 2024 / Server 2024.2), the `queryTaggingEnabled` attribute is deprecated, will no longer be supported, and may be retired in future releases. Instead, for Tableau Server, use TSM to enable query tagging for all content on a server by setting `native_api.UserInfoInGeneratedSQLEnabled` to `true`. For API 3.22 (Tableau Cloud February 2024 / Server 2024.1) and earlier: If `true`, query tagging is enabled. If `false`, query tagging is disabled. The default is `false`. For more information on query tagging, see Understand Workbook Impact on Your Database Using Query Tagging.

Any combination of the attributes inside the element is valid. If no attributes are included, no update is made. #### cURL Request Example ``` curl --location --request PUT "/api/api-version/sites/site-id/datasources/datasource-id/connections/" \ --header "Content-Type: application/xml" \ --header "X-Tableau-Auth;" \ --data "{ 'connectionLuids': [ 'Luid1', 'Luid2' ], 'connection': { 'serverAddress': 'newAddress', 'serverPort': 'newPort', 'authenticationType': 'new Auth Type', 'userName': 'Jane Doe', 'password': 'xxxxxx', 'embedPassword': 'false', 'queryTaggingEnabled': 'false' } }" ``` #### Response Code 200 #### Response Body ``` ``` ``` { "connection": { "id": "12ab34cd-56ef-78ab-90cd-12ef34ab56cd", "serverAddress": "database.example.com", "serverPort": "12345", "authenticationType": "new Auth Type", "userName": "jajohnson", "queryTaggingEnabled": "false" } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
403	403023	Update forbidden	A non-administrator user tried to update a data source, but the caller doesn't have Write permission.
403	403027	Owner update forbidden	A non-administrator user tried to change connection information, but the caller doesn't have Write permission.
403	403062	Unsupported operation	The data source contains multiple connections, but the URI did not include `/connections/connection-id` to indicate which connection should be updated.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404004	Data source not found	The data source ID in the URI doesn't correspond to an existing data source.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Data Source Now Runs an extract refresh on the specified data source. **Note:** This method will fail and result in an error if your Server Administrator has disabled the **RunNow** setting for the site. For more information, see [Tableau Server Settings](https://help.tableau.com/current/server/en-us/maintenance_set.htm). **Version**: Available in API 2.8 and later. **License**: No additional license required. **Permissions**: Users who are not server administrators or site administrators can only refresh extracts for data sources if they own the data source, or if they are the project leader for the project. **Access Scope**: `tableau:tasks:run` - For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). This method runs an extract refresh for the specified data source, with no need to associate that extract refresh with a scheduled task. This method is the equivalent of selecting a data source using the Tableau Server UI, and then selecting **Refresh Extracts** from the menu (also known as a "manual refresh"), however, the REST method always runs a full refresh even if the refresh type is set to incremental. Similar to a manual refresh, if the extract is a `.tde` file, it will be converted to a `.hyper` file as a result of the refresh. To learn more about extract upgrades to the `.hyper` file format, see [Extract Upgrade to .hyper Format](https://help.tableau.com/current/server/en-us/extracting_upgrade.htm). #### URI POST /api/api-version/sites/site-id/datasources/datasource-id/refresh #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the data source.
datasource-id	The ID of the data source to refresh.

#### Request Body As of version 3.28, you can specify an incremental refresh on extracts by updating the request body as follows: ``` ``` { "extractRefresh": { "@incremental": "true" } } #### Response Code 202 #### Response Body ``` ``` ``` { "job": { "id": "job-id", "mode": "Asynchronous", "type": "RefreshExtract", "createdAt": "date-time", "extractRefreshJob": { "datasource": { "id": "datasource-id", "name": "datasource-name", "incremental"="true" } } } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401000	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403032	Update Forbidden	A non-administrator user attempted to update a data source, but the caller doesn't have sufficient permissions.
404	404000	Site not found	The site ID in the URI is unknown.
404	404004	Data source not found	The data source ID in the URI is unknown.
405	405000	Invalid request method	Request type was not POST.
409	409093	Operation already in Queue	The extract refresh job is already in the queue.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### cURL Example ``` curl "http://MY-SERVER/api/3.29/sites/1edc53ac-e247-4870-9fd3-6fad0ce5f84d/datasources/89a82d78-664f-45a1-8256-d4d2961a070b/refresh" -X POST -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" –d @empty-tsrequest.xml" ``` **Content of empty-tsrequest.xml:** ``` ``` **Example response:** ``` ``` ## Update Data-Driven Alert Update one or more settings for the specified data-driven alert; including the alert subject, frequency, and owner. #### URI PUT /api/api-version/sites/site-id/dataAlerts/data-alert-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the data-driven alert.
data-alert-id	The ID of the data-driven alert. You can obtain this ID by calling Query Data-Driven Alerts.

data-alert-subject	(Optional) The string to set as the new subject of the alert.
data-alert-frequency	(Optional) The frequency of the data-driven alert: once, frequently, hourly, daily, or weekly.
data-alert-owner-id	(Optional) The ID of the user to assign as owner of the data-driven alert.
is-public-flag	(Optional) Determines the visibility of the data-driven alert. If the flag is true, users with access to the view containing the alert can see the alert and add themselves as recipients. If the flag is false, then the alert is only visible to the owner, site or server administrators, and specific users they add as recipients. (Optional) Determines the visibility of the data-driven alert. If the flag is true, users with access to the view containing the alert can see the alert and add themselves as recipients. If the flag is false, then the alert is only visible to the owner, site or server administrators, and specific users they add as recipients.

#### Response Code 200 #### Response Body ``` ``` The createdAt and updatedAt attribute values are returned in UTC format (YYYY-MM-DDTHH:MM:SSZ). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Write forbidden	A user called this method who does not have the required permissions.
403	409030	Updating data-driven alert forbidden	The user is not authorized to update the data-driven alert.
404	409023	Resource Not Found	The data-driven alert ID specified in the URI is invalid.
404	404000	Site not found	The site ID or URL namespace in the URI doesn't correspond to an existing site.
404	404002	Resource Not Found	The user ID specified in the request body is invalid.
405	405000	Invalid request method	Request type was not PUT.

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site asset.
database-luid	The LUID of the database asset.

#### Request Body ``` ``` #### Attribute Values Any combination of attributes inside the **** element is valid. Only the attributes and child elements that are included result in updates to the database asset. If no attributes or nested elements are included, no update is made.

certification-status	(Optional) Certify or remove certification by using the following: True False
certification-note	(Optional) Custom text to accompany the certification status.
new-description-value	(Optional) Custom text to describe the database asset.
new-content-permissions	(Optional) The new permissions setting for the database. You can specify one of the following: LockedToDatabase to lock permissions so that users cannot overwrite the default permissions set for the database asset. ManagedByOwner to allow users to manage permissions for the database asset used by the content that they own. The default permissions setting is ManagedByOwner. These values are case sensitive.
new-contact-luid	(Optional) The LUID of the Tableau Server or Tableau Cloud user to associate with the database asset.

#### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to update the database asset: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:databases:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response:** ``` ``` #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
404	404000	Resource not found	The site LUID in the URI doesn't correspond to an existing site.
404	404031	Database not found	The requested database could not be found.
409	409045	Database error	An unknown database asset error occurred.
409	409050	Database update error	An unknown error occurred and the database asset could not be updated.
409	409051	Database update forbidden	A user without "write" permissions to the database asset attempted an update.

## Update Domain Among Pools Moves a domain from its current pool to a different pool. The operation is atomic (all-or-nothing); on failure the domain mapping is unchanged. This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PATCH /api/api-version/sites/site-luid/bridge-domain-maps/change-pool-assignment #### URI Parameter Values

api-version	The version of the API to use. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.

#### Request Body ``` ``` ``` { "bridgeDomain": { "existingDomainName": "example.com", "newPoolLuid": "ebae40a5-d7e4-4214-b3d5-b0715c627b71" } } ``` #### Attribute Values

existingDomainName	Required. The domain to move.
newPoolLuid	Required. The UUID of the target Bridge pool.

#### Response Code 200 #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
400	409004	Invalid domain name, invalid pool ID, domain not found, or pool not found	Domain and pool ID must be valid; domain and pool must exist on the site.
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	403000	Insufficient permissions	User does not have Site Administrator role.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500	503906	Unexpected server error	An unexpected error occurred while updating the domain.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Domain Name Updates an existing domain mapping by renaming the domain. The operation is atomic (all-or-nothing). This method is not available for Tableau Server. **Version**: Available in API 3.28 (Tableau Cloud March 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PATCH /api/api-version/sites/site-luid/bridge-domain-maps/update-domain-name #### URI Parameter Values

api-version	The version of the API to use. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.

#### Request Body ``` ``` ``` { "bridgeDomain": { "existingDomainName": "existing-domain.com", "newDomainName": "new-domain.com" } } ``` #### Attribute Values

existingDomainName	Required. The current domain name.
newDomainName	Required. The new domain name. Must not already exist in the system.

#### Response Code 200 #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
400	409004	Invalid existing/new domain name, domain not found, or new name exists	Domain names must conform to valid format; existing domain must exist; new name must not already be in use.
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	403000	Insufficient permissions	User does not have Site Administrator role.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500	503906	Unexpected server error	An unexpected error occurred while updating the domain.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update EAS Update a connected app with OAuth 2.0 trust. **Notes:** - Beginning in API version 3.22, you can register multiple EASs per site for Tableau Cloud. - Beginning in API version 3.23, Tableau Server supports site-level EAS (and multiple registrations of EASs per site). #### URI PUT api/_api-version_/sites/_site-id_/connected-apps/external-authorization-servers/_eas-id_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
eas-id	The unique ID of the registered EAS.

#### Request Body ``` ``` #### Attribute Values A combination of attributes inside the element is valid.

URL

(Optional) The entity id of your identity provider (IdP) or URL that uniquely identifies your IdP.

URI

(Optional) The JSON Web Key (JKWS) of the EAS.

name

(Optional) The name of the connected app. If the name attribute is not specified, the connected app name defaults to "External Authorization Server."

This attribute is available starting from API version 3.22 (February 2024).

#### Permissions Tableau Server admins or Tableau Cloud site admins only. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:external_authorization_servers:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body The request returns details about the EAS, including the following: - ``: The name of the connected app. - ``: The ID of the EAS. - `:` The issuer URL of the EAS. - `:` The JSON web key set (JWKS) of the EAS. **Example response:** ``` EAS_2 50bdc8cd-1aa4-48fe-a0e7-68982d85daa8 https://dev-57741098.okta.com/oauth2/aus3gd9kw7ixSfBKC5d7 https://dev-57741098.okta.com/jwks.json 2022-04-07T03:50:34Z ``` #### Version Introduced in Tableau Cloud June 2022 (API 3.16). Introduced in Tableau Server 2024.2 (API 3.23). #### Errors

HTTP status	`error` Code	Condition	Details
400	400008	Issuer URL missing	The request body contains an empty issuer URL attribute.
400	400157	Unexpected EAS error	There was an unexpected error when updating the connected app.
400	400194	Issuer URL already configured	Another connected app on the site is using the same issuer URL.
403	403000	Admin permissions required	A non-admin user called this method and doesn't have adequate permissions to perform the action.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404047	EAS not found	The requested EAS could not be found.

## Update Embedding Settings for Site Updates the embedding settings for a site. Embedding settings can be used to restrict embedding Tableau views to only certain domains. This setting impacts all embedding scenarios including Tableau Javascript API v2, Embedding API v3, and the embed code from the share dialog. For more information, see [Tableau Site Settings for Embedding](https://help.tableau.com/current/api/embedding_api/en-us/docs/embedding_api_site.html) in the Tableau Embedding API v3 Help. Beginning in version 2023.2 (June 2023) for Tableau Cloud and in version 2023.3 for Tableau Server, this setting might impact embedding scenarios that use Tableau connected apps. For more information, see the "Control where content can be embedded" section in the connected apps topics in the [Tableau Cloud Help](https://help.tableau.com/current/online/en-us/connected_apps_eas.htm#allowlist) or [Tableau Server Help](https://help.tableau.com/current/server/en-us/connected_apps_eas.htm#allowlist). #### URI PUT /api/api-version/sites/site-id/settings/embedding #### Path Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site to update.

#### Request Body ``` ``` **Example request:** ``` ``` #### Request Attribute Values

unrestricted-embedding

(Optional) Specifies whether or not embedding is restricted.

When the setting is set to true, Tableau views on this site can be embedded in any domain.

When set to false, embedding is blocked for all domains, but you can allow embedding in certain domains using the allowList attribute.

allow-list

(Optional) Specifies the domains where Tableau views on this site can be embedded. Use this setting with unrestrictedEmbedding setting to restrict embedding functionality to only certain domains.

Important: We recommend using the domain allowlist as a security best practice to ensure Tableau content is only embedded in locations that you allow.

You can use wildcards in domain names and you can also list multiple domain names separated by spaces.

#### Permissions Any Tableau Cloud or Tableau Server user can call this method. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:embedding_site_settings:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` #### Version Version 3.16 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
403	403500	The user does not have permission	Tableau Cloud: Only site administrators can run this method.

#### Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d5-e4f3-a2b1-c0d9-e8f7a6b5c4d/settings/embedding" -X PUT -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @update-sembedding-settings.xml` **Content of update-embedding-settings.xml:** ``` ``` For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update enabled state of analytics extensions on site Enables or disables analytics extensions on a site. **Version:** Available in API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server or site administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:analytics\_extensions:update\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) or [Server](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) PUT {server}/api/-/settings/site/extensions/analytics [view details](#) ## Update Flow Updates the project and/or owner of the specified flow. To change the flow owner with fewer limitations on who the new owner can be, use the [Update Flow Owner](#update_flow_owner) method instead. #### URI PUT /api/api-version/sites/site-id/flows/flow-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the flow.
flow-id	The ID of the flow to update.

#### Request Body #### Attribute Values

new-project-id	(Optional) The ID of a project to add the flow to.
new-owner-id	(Optional) The ID of a user to assign the flow to as owner. The new owner must be the user calling this method.

Any combination of the attributes inside the **** element is valid. Only the attributes and child elements that are included result in updates to the flow. If no attributes or nested elements are included, no update is made. If the **** element is included, the **id** attribute must be included, and any other attributes of the **** element are ignored. If the **** element is included, the **id** attribute must be included, and any other attributes of the owner are ignored. #### Permissions Tableau Server users who are server administrators or site administrators can change the owner for a flow. Users who are not server administrators can move a flow from one project to another if they own the flow or the current (source) project, or are a project leader for the current project, and they have Write permission for the destination project. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:flows:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` The datetime-created and datetime-updated attribute values are returned in UTC format (YYYY-MM-DDTHH:MM:SSZ). #### Version Version 3.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
403	403098	Owner update forbidden	A non-administrator user tried to change the owner for the flow.
403	403030	Project update forbidden	A non-administrator user tried to change the project for the flow, but the caller doesn't have Write permission for the project.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	Owner not found	The owner ID in the request body doesn't correspond to an existing owner.
404	404027	Flow not found	The flow ID in the URI doesn't correspond to an existing flow.
404	404005	Project not found	The project ID in the request body doesn't correspond to an existing project.
409	409041	Flow name conflict	The flow name in the request already belongs to the specified site. For the purpose of uniqueness checks, flow names are case-insensitive.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example **Example response:** ``` ``` ## Update Flow Connection Updates the server address, port, username, or password for the specified flow connection. The connection can be an input or an output connection. #### URI PUT /api/api-version/sites/site-id/flows/flow-id/connections/connection-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the flow.
flow-id	The ID of the flow to update.
connection-id	The ID of the connection to update. To determine what connections are available for a flow, call Query Flow.

#### Request Body ``` ``` #### Attribute Values Any combination of the attributes inside the **** element is valid. You will need to provide at least one attribute. If no attributes are included, this will result in an error.

serverAddress	The new server for the connection.
port	The new port for the connection.
userName	The new username for the connection.
password	The new password for the connection.
embedPassword	true to embed the password; otherwise, false.
authenticationType	Added in API 3.28. The new authentication type for the connection. Standard values: `Username Password`: username and password `oauth` `auth-keypair`: keypair authentication Connector-specific values: `sqlserver`: SQL Server username and password `Azure AD Password` `AD Service Principal` `username-password`: Several connectors use this value. For example, SAP HANA, SAP Sybase ASE, SAP NetWeaver Business Warehouse (BW), Denodo, and Salesforce. If you are unsure of the value for `authenticationType` for the target connection, there are two ways to determine the value. First, if you have a flow that is currently using the target authentication type, you can query for it using the REST API method Workbooks and Views Methods, which returns the authentication type string in the response. Alternatively, you can inspect the `<connection>` element in the XML of a flow, which is available locally. Look for the value of the `authentication` attribute of the connection.

#### Permissions Only Tableau Server users who are server administrators or Tableau Cloud site administrators can change the connection for a flow. Users who are not server administrators can update a flow only if they have Write(save) permission for the flow and if they have **Write** permission for the project. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:flow_connections:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` #### Version Version 3.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
403	403103	Update forbidden	A non-administrator user tried to update a flow, but the caller doesn't have Write permission.
403	403098	Owner update forbidden	A non-administrator user tried to change connection information for the flow, but the caller doesn't have Write permission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404027	Flow not found	The flow ID in the URI doesn't correspond to an existing flow.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Flow Connections Updates the server address, port, username, or password for one or more flow connections. The connection can be an input or an output connection. **Version**: Available in API 3.28 (Tableau Cloud April 2026 / Server 2026.2) and later. **License**: No additional license required. **Permissions**: Only users who are Tableau Server administrators or Tableau Cloud site administrators can change the connection for a flow. Users who are not Tableau Server administrators or Tableau Cloud site administrators can update a flow only if they have Write(save) permission for the flow and if they have **Write** permission for the project. **Access Scope**: `tableau:flow_connections:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/sites/site-id/flows/flow-id/connections #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the flow.
flow-id	The ID of the flow to update.

#### Request Body ``` ``` ``` { "connections": { "connection": [ { "id": "f63809db-abe9-454c-96dc-0f2f1b065a55", "serverAddress": "myco.com", "serverPort": "1234" }, { "id": "7bc5d700-bbc9-4ec3-9225-121f2846b5e7", "userName": "snguyen", "embedPassword": "false" } ] } } ``` #### Attribute Values Any combination of the attributes inside the **** element is valid. You will need to provide at least one attribute. If no attributes are included, this will result in an error.

id	The ID of the flow connection to update.
serverAddress	The new server for the connection.
port	The new port for the connection.
userName	The new username for the connection.
password	The new password for the connection.
embedPassword	true to embed the password; otherwise, false.
authenticationType	The new authentication type for the connection. Standard values: `Username Password`: username and password `oauth` `auth-keypair`: keypair authentication Connector-specific values: `sqlserver`: SQL Server username and password `Azure AD Password` `AD Service Principal` `username-password`: Several connectors use this value. For example, SAP HANA, SAP Sybase ASE, SAP NetWeaver Business Warehouse (BW), Denodo, and Salesforce. If you are unsure of the value for `authenticationType` for the target connection, there are two ways to determine the value. First, if you have a flow that is currently using the target authentication type, you can query for it using the REST API method Workbooks and Views Methods, which returns the authentication type string in the response. Alternatively, you can inspect the `<connection>` element in the XML of a flow, which is available locally. Look for the value of the `authentication` attribute of the connection.

#### cURL Request Example ``` curl "https://MY-SERVER/api/api-version/sites/site-id/flows/flow-id/connections" -X PUT -H "X-Tableau-Auth: auth-token" -H "Content-Type: application/xml" -d '' ``` #### Response Code 200 #### Response Body ``` ``` ``` { "connection": [ { "id": "f63809db-abe9-454c-96dc-0f2f1b065a55", "useOAuthManagedKeychain": "false", "embedPassword": "true", "serverAddress": "myco.com", "serverPort": "1234", "userName": "snguyen" }, { "id": "7bc5d700-bbc9-4ec3-9225-121f2846b5e7", "useOAuthManagedKeychain": "false", "embedPassword": "false", "serverAddress": "myco.com", "userName": "snguyen" } ] } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
403	403103	Update forbidden	A non-administrator user tried to update a flow, but the caller doesn't have Write permission.
403	403098	Owner update forbidden	A non-administrator user tried to change connection information for the flow, but the caller doesn't have Write permission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404027	Flow not found	The flow ID in the URI doesn't correspond to an existing flow.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Flow Owner Updates a flow's owner. If the same user owns all the flows in a linked task, this method also changes the ownership of the linked task to that user. This method overlaps in function with [Update Flow](#update_flow) method, but has fewer limitations on who the new owner can be. If you're changing the owner of a flow, Tableau recommends you use this method. **Version**: Available in API 3.27 (Tableau Cloud December 2025 / Server 2025.3) and later. **License**: Data Management or Tableau+. **Permissions**: Server administrators, site administrators, or flow owner **Access Scope**: `tableau:flows:update` - For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/sites/site-id/flows/flow-id/owner/user-id #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the flow.
flow-id	The ID of the flow.
user-id	The ID of the user.

#### Request Body None #### cURL Request Example ``` curl -X PUT "https://MY-SERVER/api/3.27/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/flows/08a7b6b5-b4ba-be3a-4d2d-1e9e59a8a7b6/owner/9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d" -H "Content-Type: application/xml" -H "X-Tableau-Auth: a1B2c3D4e5F6g7H8i9J0kL|a1B2c3D4e5F6g7H8i9J0kL1m2N3o4P5q|12345678-90ab-4cde-8f01-234567890abc" ``` #### Response Code 200 #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
403	403184	Ownership changes are disabled	On Tableau Server, a machine administrator can use TSM to to enable or disable content ownership changes. For more information, see `wgserver.change_owner.enabled` in tsm configuration set Options
403	403187	Permission denied	You must be a site administrator, a server administrator, or the flow owner to change the ownership of a flow.
404	404061	Resource not found	The flow id and/or user id can't be found.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Group Updates a group on a Tableau Cloud site or Tableau Server. **Tableau Cloud** If the Tableau Cloud site is configured to use local authentication, the method lets you update the group name. **Tableau Server** If Tableau Sever is configured to use local authentication, the method lets you update the group name. If Tableau Server is configured to use Active Directory authentication, the method synchronizes the group with Active Directory. During synchronization, the method updates the group and modifies the set of users in the group to be the same as those in Active Directory. Users in Active Directory that are not in the group on Tableau Server are added to the group, and users that are not in the Active Directory group are removed from the group. Users that are no longer in Active Directory at all are unlicensed. If the update synchronizes with Active Directory, Tableau Server can perform the update either immediately (synchronously) or by using a background job (asynchronously). If Active Directory contains a large number of users, you should perform the synchronization process as a background job so that the process doesn't time out. By default, synchronizing with Active Directory is performed immediately (synchronously). #### URI PUT /api/api-version/sites/site-id/groups/group-id PUT /api/api-version/sites/site-id/groups/group-id?asJob=asJob-value #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the group.
group-id	The ID of the group to update.
AsJob-value	A Boolean value that is used if you are importing from Active Directory. Set this value to true to synchronize with Active Directory as a background task, or set this value to false to synchronize immediately (synchronously). The default is false. Note: This parameter has no effect if the server is configured to use local authentication. This attribute is available for Tableau Server only.

#### Request Body **Updating a local group** ``` ``` When the request is to update a local group and minimumSiteRole is specified, users are granted a license using the grant license on-login mode by default. **Updating an Active Directory group** (Tableau Server only) ``` ``` When the request body contains an element, and if Tableau Server or Tableau Cloud site is configured to authenticate via Active Directory, the Update Group method synchronizes with Active Directory. If Tableau Server is configured to use local authentication, including an element has no effect. #### Attribute Values

new-group-name	The new name for the group.
AD-group-name	The name of the Active Directory group to synchronize with. This attribute is available for Tableau Server only.
AD-domain	The domain for the Active Directory group. This attribute is available for Tableau Server only.
minimum-site-role	Required if an import element or grantLicenseMode attribute are present in the request. The site role assigned to users who are imported from Active Directory (Tableau Server only) or granted a license automatically using the grant license on-sync or on-login mode. If the requested user name matches an existing user in the group, the user either retains their existing role or are granted the one specified in the request, based on the role that enables the most capabilities. This is true whether the group the user belongs to is imported from Active Directory (Tableau Server only) or local. Site roles that can be assigned, listed from the one enabling the least capabilities to the most, are as follows. Unlicensed Viewer Explorer ExplorerCanPublish Creator SiteAdministratorExplorer SiteAdministratorCreator Note: You cannot use the REST API to set a user to be a Tableau Server administrator (ServerAdministrator site role).
license-mode	Optional. The mode for automatically applying licenses for group members. When the mode is onLogin, a license is granted for each group member when they log in to a site. For local groups, the mode can be either onLogin or unset. If the attribute is omitted during an update, the group will use the license grant mode configured prior to the update. A local group configured to use onLogin can switch the mode to unset by updating the group using: `minimumSiteRole="UNLICENSED"` For groups that import an Active Directory domain (Tableau Server only), the grantLicenseMode can be updated to either onSync or onLogin. If the attribute is omitted during an update, the group will use the license grant mode configured prior to the update. The minimum role granted to users through grantLicenseMode is specified in the siteRole attribute of the import element. If that role has less permissions than an existing role assigned to the user, then the user's permissions remain unchanged.
on-demand-access	Optional. A boolean value that is used to enable on-demand access for embedded Tableau content when the Tableau Cloud site is licensed with Embedded Analytics usage-based model or capacity-based model with Cloud+ or Tableau+ edition. Set to true to enable the capability for the group or set to false to disable the capability for the group. For more information about on-demand access, see On-demand access for users in the Tableau Embedding API v3 Help. This attribute is available for Tableau Cloud only starting from API version 3.21 (October 2023).

#### Permissions This method can only be called by Tableau Server administrators or Tableau Cloud site admins. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:groups:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 (immediate update) 202 (background update) #### Response Body **Updating a local group:** ``` ``` **Updating an Active Directory group (Tableau Server only):** ``` ``` **Background update:** ``` ``` **Notes:** - If the operation is performed asynchronously, the response body contains a element that includes a job ID. You can check the status of the operation by using the [Query Job](#query_job) method, which returns status information about the job. A typical approach is to periodically call Query Job method and get the value of the progress attribute from the response body; when this value returns 100, the import process is complete. #### Version Version 3.9 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400984	Not licensed	On-demand access can't be enabled if your site is not licensed with the usage-based model or capacity-based usage model with Tableau+ or Cloud+ edition.
403	400013	Invalid site role	The value of the minimumSiteRole or siteRole attribute must be Explorer, ExplorerCanPublish, SiteAdministratorCreator, SiteAdministratorExplorer, Unlicensed, or Viewer.
403	400019	Malformed import element	If the body includes an <import> element, it must contain a source, domainName, and siteRole attribute. If any of these attributes are missing, the element is malformed. In addition, the source attribute must have a value of `ActiveDirectory`; otherwise the element is malformed.
403	403011	Active Directory not configured	The request body contains an <import> element is included, but Tableau Server is configured for local authentication.
403	403020	Imported group name update forbidden	The request body contains an <import> element and the value of the name attribute of the <group> element in the request body is different from the name of the group imported into Tableau Server as referenced by the group-id value in the URI.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404012	Group not found	The group ID in the URI doesn't correspond to an existing site.
404	404016	Domain not found	The request body includes an <import> element, but the specified domain name doesn't exist in Active Directory.
404	404017	Active Directory group not found	The request body includes an <import> element, but no group with the name specified in the <group> element exists in Active Directory.
405	405000	Invalid request method	Request type was not PUT.
409	409009	Group name conflict	The group name in the request is already in use in the specified site. For the purpose of uniqueness checks, group names are case-insensitive.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Group Set Updates a group set name on a Tableau Server or Tableau Cloud site. **Version:** Available in API 3.22 (Tableau Cloud February 2024 / Server 2024.2) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** This method can only be called by Tableau Server administrators or Tableau Cloud site admins. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** tableau:groupsets:update - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/sites/site-id/groupsets/group-set-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the group.
group-set-id	The ID of the group set to update.

#### Request Body Copy ``` ``` Copy ``` { "groupSet": { "@name": "Researchers-one" }} ``` #### Attribute Values

name	The new name for the group set.

#### Response Code 200 #### Response Body Copy ``` ``` Copy ``` { "groupSet": { "id": "group-set-id", "name": "Researchers-one", "groupCount": "2", "group": [ { "id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d", "name": "Internal" }, { "id": "9a8a7b6b-5c4c-3d2d-1e0e-9a8a7b6b5b4b", "name": "External" } ] }} ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
403	400013	Invalid site role	The value of the minimumSiteRole or siteRole attribute must be Explorer, ExplorerCanPublish, SiteAdministratorCreator, SiteAdministratorExplorer, Unlicensed, or Viewer.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	The request type wasn’t PUT.
409	409120	Group set not found.	The group set ID in the request body doesn't correspond to an existing group set.
409	409121	Group set name conflict	The group set name in the request already belongs to another group set. For the purpose of uniqueness checks, group set names are case-insensitive.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Identity Pool Update information about an identity pool. **Version:** Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** This method can only be called by users with server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) PUT {server}/api/-/authn-service/identity-pools/{uuid} [view details](#) ## Update Label Updates a label by its LUID. This method can update the label value, message, active flag, and elevated flag. You can't update the label category. If you choose a label value name that's associated with a different category, you get an error. For more information on data label objects and properties, see the [Data Labels in the REST API](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_data_labels.htm) topic. You can't update extract refresh or flow run monitoring warnings (the extract\_refresh\_failure and flow\_run\_failure label values) using this method because those warnings are set and cleared automatically, depending on their triggers. See also "How to set a monitoring quality warning" in the [Tableau Server](https://help.tableau.com/current/server/en-us/dm_dqw.htm#how-to-set-a-monitoring-quality-warning) and [Tableau Cloud](https://help.tableau.com/current/online/en-us/dm_dqw.htm#how-to-set-a-monitoring-quality-warning) Help and the quality warning trigger methods in [Metadata Methods](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_metadata.htm). All label operations except those related to the certification of data sources require Catalog to be enabled. Catalog requires a Data Management license. #### URI PUT api/api-version/sites/site-luid/labels/label-luid #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The unique LUID of the site asset.
label-luid	The unique LUID of the label asset.

#### Request Body ``` ``` #### Attribute Values

label-value-name	(Optional) The label value name. You cannot change the category when updating a label. Choosing a label value name that's associated with a different category causes an error. See Data Labels in the REST API for a list of built-in label values and categories. Choosing a monitoring quality warning value (extract_refresh_failure or flow_run_failure) causes an error.
label-message	(Optional) The message text for the label. In the web interface, this is reflected as a certification note or a data quality warning message. You can format the message with italics, bold text, links, images, and more. Use HTML character entities to match the special characters in the formatting guide that's normally visible as a tooltip in the UI.
active-flag	(Optional) Boolean. If set to true, the label becomes active. If set to false, the label becomes inactive.  If omitted, the default is true.
elevated-flag	(Optional) Boolean. If set to true, the label becomes elevated. If set to false, the label becomes not elevated.  If omitted, the default is false.

#### Permissions - To add or update a data label other than a certification label, you must have write permission on the associated asset. - To add or update a certification label, you must be an administrator, or else you must be a project leader or product owner for the project the asset is in. - To add or update a certification label for an external asset _not_ in a project, you must have the change permissions permission on the associated asset. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2024 and Tableau Server 2024.2 (API 3.23). ``` tableau:labels:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` #### Version Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400103	Generic query label error	An unknown error occurred.
400	400109	Missing payload	The request body is missing a label element.
403	403004	Invalid parameter	Operation on resource unauthorized
404	404030	Label not found	The label LUID doesn't correspond to an existing project.
409	409004	Invalid parameter	One or more values in the request body are invalid, or you are trying to change the label value to one from a different category. This error can also occur if you try to create or change a monitoring quality warning (label values extract_refresh_failure and flow_run_failure).

## Update Label Category Updates a data label category. Note that category is one property of a label value (labelValue), which is itself a property of a label on an asset. Other properties of a labelValue include name and description. These properties determine label behavior and options that users see in label dialogs. For more information on data label objects and properties, see the [Data Labels in the REST API](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_data_labels.htm) topic. A Data Management license is not required to create, update, or delete label categories, but one is required to create, update, delete, and see labels on assets. #### URI PUT api/api-version/sites/site-luid/labelCategories/label-category-name #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The unique LUID of the site asset.
label-category-name	The label category name. URL encode the label category name (as it appears in the Tableau web interface) if it has spaces or non-alphanumeric characters in it.

#### Request Body #### Attribute Values

label-category-name

The label category name.

Required, but not does not have to be different from the existing name. Must be 1-128 characters long. (In Tableau Server 2023.3 and earlier, must be 1-24 characters long.)

label-category-description

The label category description.

Required, but not does not have to be different from the existing description. Must be 1-500 characters in length.

#### Permissions Only a site or server administrator can create, update, or delete label categories. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:label_categories:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Version Introduced in Tableau Cloud October 2023 (API 3.21) / Server 2023.3 (API 3.21). #### Response Body #### Errors

HTTP status	`error` Code	Condition	Details
400	400190	Generic update label categories error	An unknown error occurred.
403	403004	Operation on resource unauthorized	You must be an administrator to create, update, or delete label values.
409	409004	Invalid parameter	The label value name in the URI must exist. URL encode the label category name (as it appears in the Tableau web interface) if it has spaces or non-alphanumeric characters in it. The category name must be 1-128 characters long. (In Tableau Server 2023.3 and earlier, the category name must be 1-24 characters long.) The category name, when stripped of spaces, dashes, and underscores, must not case insensitively match one of Tableau's built-in label categories names. The category description must be 1-500 characters in length.

## Update Labels Creates or updates labels on one or more assets. Each asset listed in the request body is updated to have a label with the specified value, message, active flag, and elevated flag. If the request body specifies a label value that is already on the asset, the label on the asset is updated to match the request body. Otherwise, a label is created and attached to the asset. **Note:** On Tableau Server 2023.3 and earlier, only one label of a category is allowed on an asset. If the request body specifies a label value with _the same category_ as a label already on the asset, the label on the asset is updated to match the request body. Otherwise, a label is created and attached to the asset. Note that the label category is not an attribute in the request body, because you do not set it explicitly. Instead you implicitly set the category by using the label value name. For example, choosing a label value name of stale means that the label value category will be warning. Also, you can't update the label category on an existing label. If you set the label value to one that's in a different category, you get an error. For more information on data label objects and properties, see the [Data Labels in the REST API](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_data_labels.htm) topic. You can't update extract refresh or flow run monitoring warnings (the extract\_refresh\_failure and flow\_run\_failure label values) using this method because those warnings are set and cleared automatically, depending on their triggers. See also "How to set a monitoring quality warning" in the [Tableau Server](https://help.tableau.com/current/server/en-us/dm_dqw.htm#how-to-set-a-monitoring-quality-warning) and [Tableau Cloud](https://help.tableau.com/current/online/en-us/dm_dqw.htm#how-to-set-a-monitoring-quality-warning) Help and the quality warning trigger methods in [Metadata Methods](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_metadata.htm). All label operations except those related to the certification of data sources require Catalog to be enabled. Catalog requires a Data Management license. #### URI PUT api/api-version/sites/site-luid/labels #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The unique LUID of the site asset.

#### Request Body ``` ``` #### Attribute Values

asset-type	The type of asset. Valid asset types are: database table column - Available in API 3.16 and later (Tableau Cloud October 2022, Server 2022.3) datasource flow virtualconnection virtualconnectiontable
asset-luid	The asset LUID.
label-value-name	The label value name. The built-in label value names are: certification warning deprecated stale maintenance sensitive _data You can also use custom label value names that an administrator creates. (Custom label values were released with Tableau Cloud June 2023 and Tableau Server 2023.3.) If the request body specifies a label value that is already on the asset, the label on the asset is updated to match the request body. Otherwise, a label is created and attached to the asset. Note: On Tableau Server 2023.3 and earlier, only one label of a category is allowed on an asset. If the request body specifies a label value with the same category as a label already on the asset, the label on the asset is updated to match the request body. Otherwise, a label is created and attached to the asset. See Data Labels in the REST API for a list of built-in label values and categories. Choosing a monitoring quality warning value (extract_refresh_failure or flow_run_failure) causes an error.
label-message	(Optional. Was required in Tableau Server 2023.3 and earlier.) The message text for the label. In the web interface, this is reflected as a certification note or a data quality warning message. You can format the message with italics, bold text, links, images, and more. Use HTML character entities to match the special characters in the formatting guide that's normally visible as a tooltip in the UI.
active-flag	(Optional) Boolean. If set to true, the label becomes active. If set to false, the label becomes inactive.  If omitted, the default is true.
elevated-flag	(Optional) Boolean. If set to true, the label becomes elevated. If set to false, the label becomes not elevated.  If omitted, the default is false.

#### Permissions - To add or update a data label other than a certification label, you must have write permission on the associated asset. - To add or update a certification label, you must be an administrator, or else you must be a project leader or product owner for the project the asset is in. - To add or update a certification label for an external asset _not_ in a project, you must have the change permissions permission on the associated asset. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2024 and Tableau Server 2024.2 (API 3.23). ``` tableau:labels:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Version Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). #### Response Body ``` ` The datetime-created and datetime-updated attribute values are returned in UTC format (YYYY-MM-DDTHH:MM:SSZ). #### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400123	Unkown error	The metric could not be updated for an unknown reason.
403	403119	Owner update forbidden	The user does not have administrator permissions to change the owner for the metric.
403	403120	Project update forbidden	The user doesn't have Write permission for the project they are trying to move the metric to.
403	403118	Name update forbidden	The user does not have administrator permissions to change the name for the metric.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	Owner not found	The owner ID in the request body doesn't correspond to an existing owner.
404	404004	Metric not found	The metrice ID in the URI doesn't correspond to an existing metric.
404	404005	Project not found	The project ID in the request body doesn't correspond to an existing project.
405	405000	Invalid request method	Request type was not PUT.
409	409015	Metric name conflict	The metric name in the request already belongs to the specified site. For the purpose of uniqueness checks, metric names are case-insensitive.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/metrics/6561daa3-20e8-407f-ba09-709b178c0b4a" -X PUT -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @update-metric.xml` **Content of update-metric.xml** ` ` **Example response body:** ` underlyingView="29dae0cd-1862-4a20-a638-e2c2dfa682d4" ` ## Update metric definition Updates a metric definition. **Version:** Available in API 3.21 (Tableau Cloud December 2023) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user can update a metric definition as long as the user has write and publish access to the data source used in the definition. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:insight\_definitions:update\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) PATCH {server}/api/-/pulse/definitions/{definition\_id} [view details](#) ## Update Mobile Security Settings for Site Updates the mobile security sections for a specified site. **Version:** Available in API 3.18 (Tableau Cloud December 2022) and later. Not available for Tableau Server. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Only Tableau server administrators can update mobile security settings for the server. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:mobile\_security\_site\_settings:read - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/sites/site-luid/settings/mobilesecuritysettings #### URI Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.

#### Request Body Copy ``` { "mobileSecuritySettingsList": { "mobileSecuritySettings": [ { "name": "mobile.security.jailbroken_device", "enabled": true, "iosConfig": { "valueList": [ "true" ], "severity": "warn" }, "androidConfig": { "valueList": [ "false" ], "severity": "critical" } }, { "name": "mobile.security.max_offline", "enabled": true "iosConfig": { "valueList": [ "14" ], "enabled": true, "severity": "critical" }, "androidConfig": { "valueList": [ "14" ], "enabled": true, "severity": "critical" }, }, { "name": "mobile.security.screenshot", "enabled": false, "androidConfig": { "valueList": [ "true" ], "enabled": true, "severity": "warn" } } ] }} ``` #### Request Attributes

mobileSecuritySettings name

(Optional)Enum. The device condition addressed by a security setting element. Supported values are:

mobile.security.jailbreak_detection
mobile.security.max_offline
Available in API 3.19 (Tableau Cloud March 2023 / Server 2023.1) and later.
mobile.security.screenshot

mobileSecuritySettings enabled (Optional) Boolean. If true, enables the Tableau mobile client to detect and respond to the condition described in the setting's name. The enabled attribute for the Android or iOS configuration element of the setting must also be true for detection on that type of device. If mobileSecuritySettings enabled = false, the Android and iOS configuration element attribute settings will be ignored.

mobileSecuritySettings androidConfig / iosConfig

(Optional)Element. Security settings specific to the platform of the mobile device hosting the Tableau client for the setting being configured. Required attributes of this element are:

valueList -
In the case of mobile.security.max_offline String - whole number. The number of days a device can be offline without requiring a security policy refresh. Minimum value is 1, default value is 14.
In other cases String - true or false. Determines if the condition of the setting is detected for the specified platform.
severity - Enum. Defines the response of the Tableau mobile client when the condition of the setting is detected.
enabled - String -true or false. On the device type being configured, if true, enables detection of the containing setting's security condition, as long as that setting's enabled attribute value is also true.
Severity level can be set for the jailbreak detection setting. The levels and the actions the Tableau client will take are as follows:
- Warn: If a detection occurs, show a dismissible blocking screen.
- Error: If a detection occurs, show a blocking screen until the issue is resolved.
- Critical: If a detection occurs, shows a blocking screen, log the user out, and close the session.
If screenshot protection is enabled a severity level is required, but regardless of which level you select the behavior of the app will be: If a screenshot is attempted, show a temporary toast without blocking the app.
Default settings for a Tableau Cloud site are:
- Jailbreak detection enabled with critical severity.
- Maximum offline time for security policy update set at 14 days with critical severity.
- Screenshot protection is enabled with warn level.

#### cURL Request Example `curl -L -X PUT "https://qa-server.tsi.lan/api/3.18/settings/mobilesecuritysettings" -H "Accept: application/json" -H "X-Tableau-Auth: ejET2rVmS2e81XiZ9G4lzQ|Iz71DR2lu3r0zHpcOAH2OoRQZlPfxACC|a905dbfd-6550-4546-908b-3e055fcc026d" --data-raw ""` #### Response Code 200 #### Response Body Copy ``` { "mobileSecuritySettingsList": { "mobileSecuritySettings": [ { "name": "mobile.security.jailbroken_device", "enabled": true, "iosConfig": { "valueList": [ "true" ], "severity": "warn" }, "androidConfig": { "valueList": [ "false" ], "severity": "critical" } }, { "name": "mobile.security.max_offline", "enabled": true "iosConfig": { "valueList": [ "14" ], "enabled": true, "severity": "critical" }, "androidConfig": { "valueList": [ "14" ], "enabled": true, "severity": "critical" }, }, { "name": "mobile.security.screenshot", "enabled": false, "androidConfig": { "valueList": [ "true" ], "enabled": true, "severity": "warn" } } ] }} ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing, incomplete, or is malformed XML. Invalid values for `enabled`, `iosConfig`, `androidConfig`, `severity`, or `enabled` attributes are possible causes.
400	400174	Mobile security settings error	An uknown mobile security settings error has occurred.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403004	Unauthorized Access	The user does not have the required administrtor permissions.
403	403157	Forbidden	Mobile security settings are not enabled on the server.
409	409004	Invalid setting	A mobile security setting `enabled`, `name` or other value is missing or malformed.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Monitoring Quality Warning Update a monitoring quality warning. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI PUT api/_api-version_/sites/_site-id_/dataQualityTriggers/_trigger-id_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
trigger-id	The unique ID of the monitoring quality warning.

#### Request Body ``` ``` #### Attribute Values

type	Type of monitoring quality warning. To specify the type, use one of the following values: EXTRACT_REFRESH FLOW_RUN These values are not case sensitive.
status	Monitoring status. Values can be "true" or "false". If set to "true", the data source is monitored for extract refresh failures or the flow is monitored for flow run failures). If an extract refresh or flow run failure occurs, the specified data quality warning is attached to the data source or flow (depending on type). The data quality warning is removed when the extract refresh or flow run is successful. For more information about monitoring quality warnings, see the monitoring quality warning section of the "Set a Data Quality Warning" topic in the Server Help or Cloud Help.
message	(Optional) A custom message for the data quality warning. You can format the message with italics, bold text, links, images, and more. Use HTML character entities to match the special characters in the formatting guide that's normally visible as a tooltip in the UI.
severity	High visibility status of the data quality warning. Values can be "true" or "false". For more information, see the "Visibility" section of the "Set a Data Quality Warning" topic in the Server Help or Cloud Help.

#### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to update a monitoring quality warning: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:labels:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response** ``` ``` #### Version Version 3.11 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400137	Generic quality warning trigger error	The monitoring quality warning could not be updated for some other reason than those specified below.
403	403004	Unauthorized operation.	Insufficient permissions to perform the operation.
409	409004	Invalid parameter	One or more values in the request body are invalid.

## Update OpenID Connect Configuration Update the Tableau Cloud site's OpenID Connect (OIDC) configuration. **Version:** Available in API 3.22 (Tableau Cloud February 2024) and later. Not available for Tableau Server._[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Tableau Cloud site admins only. **JWT Access Scope:** Not available. #### URI PUT /api/api-version/sites/site-luid/site-oidc-configuration #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.

#### Request Body Copy ``` ``` Copy ``` { "siteOIDCConfiguration": { "idpConfigurationId": "idpConfigurationId", "enabled": "enabled", "clientId": "clientId", "clientSecret": "clientSecret", "authorizationEndpoint": "authorizationEndpoint", "tokenEndpoint": "tokenEndpoint", "userinfoEndpoint": "userinfoEndpoint", "jwksUri": "jwksUri", "idpConfigurationName": "idPConfigurationName", "endSessionEndpoint": "endSessionEndpoint", "allowEmbeddedAuthentication": "allowEmbeddedAuthentication", "prompt":"prompt", "customScope":"customScope", "clientAuthentication": "clientAuthentication", "essentialAcrValues": "essentialAcrValues", "voluntaryAcrValues": "voluntaryAcrValues", "emailMapping": "emailMapping", "firstNameMapping": "firstNameMapping", "lastNameMapping": "lastNameMapping", "fullNameMapping": "fullNameMapping", "useFullName": "useFullName" }} ``` #### Request Attributes **Note:** Because partial updates are not supported therefore, you must include all the needed attributes in your request to ensure the configuration update is completed successfully.

`idpConfigurationId`	(Required) Starting in API 3.24, multiple authentication configurations can be created and enabled at the same time. Include the idpConfigurationId to identify which configuration to update. If no IdPConfigurationId is specified, the initial (default) OIDC configuration is updated if it exists. To get the idpConfigurationId value, use the List Authentication Configurations for Site method. For more information, see Authentication in the Tableau Cloud Help.
`enabled`	(Required) Controls whether the configuration is enabled or not. Value can be "true" or "false". For example "true".
`clientId`	(Required) The client ID from your IdP. For example, "0oa111usf1gpUkVUt0h1".
`clientSecret`	(Required) The client secret from your IdP.
`authorizationEndpoint`	(Required) Use the authorization endpoint from your IdP. To find the value, enter the configuration URL in a browser and obtain the user information endpoint (`authorization_endpoint`) from the details that are returned. For example, "https://myidp.com/oauth2/v1/authorize".
`tokenEndpoint`	(Required) Use the token endpoint from your IdP. To find the value, enter the configuration URL in a browser and obtain the token endpoint (`token_endpoint`) from the details that are returned. For example, "https://myidp.com/oauth2/v1/token".
`userinfoEndpoint`	(Required) Use the user information endpoint from your IdP. To find the value, enter the configuration URL in a browser and obtain the user information endpoint (`userinfo_endpoint`) from the details that are returned. For example, "https://myidp.com/oauth2/v1/userinfo".
`jwksUri`	(Required) Use the JWK set URI from your IdP. To find the value, enter the configuration URL in a browser and obtain the JWK set URI endpoint (`jwks_uri`) from the details that are returned. For example, "https://myidp.com/oauth2/v1/keys".
`idpConfigurationName`	(Optional) The name of the configuration. Starting in API 3.24, you can create and enable multiple authentication configurations. Authentication configurations that were enabled before API 3.24 are given a name and its name can't be updated. For example, "Initial OIDC". If this configuration was created after API 3.23 and no name is provided for the update, the name will stay the same. For more information, see Authentication in the Tableau Cloud Help.
`endSessionEndpoint`	(Optional) If single logout (SLO) is enabled for the site, which is done through Tableau Cloud site UI, you can specify the configuration URL or the end session endpoint from your IdP. For example, "https://myidp.com/oauth2/v1/logout".
`allowEmbeddedAuthentication`	(Optional) Controls how users authenticate when accessing embedded views. Value can be "true" or "false". Default value is "false", which authenticates users in a separate pop-up window. When set to "true", users authenticate using an inline frame (IFrame), which is less secure.
`customScope`	(Optional) Specifies a custom scope user-related value that you can use to query the IdP. For example, "openid, email, profile".
`prompt`	(Optional) Specifies whether the user is prompted for re-authentication and consent. For example, "login, consent".
`clientAuthentication`	(Optional) Token endpoint authentication method. Value can be "client_secret_basic" or "client_secret_post". Default value is "client_secret_basic".
`essentialAcrValues`	(Optional) List of essential Authentication Context Reference Class values used for authentication. For example, "phr".
`voluntaryAcrValues`	(Optional) List of voluntary Authentication Context Reference Class values used for authentication.
`emailMapping`	(Optional) Claim for retrieving email from the OIDC token. Default value is "email".
`firstNameMapping`	(Optional) Claim for retrieving first name from the OIDC token. Default value is "given_name". You can use this attribute to retrieve the user’s display name when `useFullName` attribute is set to "false".
`lastNameMapping`	(Optional) Claim for retrieving last name from the OIDC token. Default value is "family_name". You can use this attribute to retrieve the user’s display name when `useFullName` attribute is set to "false".
`fullNameMapping`	(Optional) Claim for retrieving name from the OIDC token. Default value is "name". You can use this attribute to retrieve the user’s display name when `useFullName` attribute is set to "true".
`useFullName`	(Optional) Controls what is used as the display name. Value can be "true" or "false". Default value is "false", which uses first name `(firstNameMapping` attribute) and last name (`lastNameMapping` attribute) as the user display name. When set to "true", full name (`fullNameMapping` attribute) is used as the user display name.

#### cURL Request Example `curl "https://us-west-2a.online.tableau.com/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/site-oidc-configuratioin" -X PUT -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @create-update-oidc-config.xml` **Content of create-update-oidc-config.xml:** Copy ```

" authorizationEndpoint="https://myidp.com/oauth2/v1/authorize" tokenEndpoint="https://myidp.com/oauth2/v1/token" userinfoEndpoint="https://myidp.com/oauth2/v1/userinfo" jwksUri="https://myidp.com/oauth2/v1/keys" idPConfigurationName="Initial OIDC" endSessionEndpoint="https://myidp.com/oauth2/v1/logout" customScope="openid, email, profile" prompt="login,consent" clientAuthentication="client_secret_basic" essentialAcrValues="phr" emailMapping="email" firstNameMapping="given_name" lastNameMapping="family_name" fullNameMapping="name" useFullName="false" />

``` Copy ``` { "siteOIDCConfiguration": { "idpConfigurationId":"00000000-0000-0000-0000-000000000000", "enabled":"true", "testLoginUrl="https://sso.online.tableau.com/public/testLogin?alias=080bca2d-578b-49cc-b40d-3781b36b30ee&authSetting=OIDC", "allowEmbeddedAuthentication":"false", "clientId":"0oa111usf1gpUkVUt0h1", "clientSecret":"<omit>", "authorizationEndpoint":"https://myidp.com/oauth2/v1/authorize", "tokenEndpoint":"https://myidp.com/oauth2/v1/token", "userinfoEndpoint":"https://myidp.com/oauth2/v1/userinfo", "jwksUri":"https://myidp.com/oauth2/v1/keys", "idPConfigurationName":"Initial OIDC", "endSessionEndpoint":"https://myidp.com/oauth2/v1/logout", "customScope":"openid, email, profile", "prompt":"login,consent", "clientAuthentication":"client_secret_basic", "essentialAcrValues":"phr", "emailMapping":"email", "firstNameMapping":"given_name", "lastNameMapping":"family_name", "fullNameMapping":"name", "useFullName":"false" }} ``` **Notes:** - The response hides the client secret and replaces it with `<omit>`. - You can use the testloginURL to validate the OIDC configuration. When you enter the URL in a browser, details about the configuration displays. - You can use the idpConfigurationId to assign authentication to a user using the [Add User to Site](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_users_and_groups.htm#add_user_to_site) and [Update User](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_users_and_groups.htm#update_user) methods. #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Project Updates the name, description, or project hierarchy of the specified project. You can create or update project hierarchies by specifying a parent project for the project that you are updating using this method. **Version:** Available in API 1.0 and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Only Tableau Administrators can update a project. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** tableau:projects:update - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/sites/site-id/projects/project-id PUT /api/api-version/sites/site-id/projects/project-id?publishSamples=publish-value #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the project.
project-id	The ID of the project to update.
publish-value	(Optional) A Boolean value that specifies whether to publish the sample workbooks provided by Tableau to the project when you update the project. When the publish-value is not specified in the request, or the `publishSamples` parameter is missing, no samples will be published. To publish the sample workbooks, set `publishSamples` parameter to `true`. This option is equivalent to the tabcmd command-line utility option, `publishsamples`. For more information, see tabcmd.

#### Request Body Copy ``` ``` Copy ``` { "project": { "id": "1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e", "parentProjectId": "afe6f0b8-cb10-11e7-9fd4-db8b61369aa5", "name": "Update-Project-Name", "description": "This is the new description after the project update", "contentPermissions": "ManagedByOwner", "controllingPermissionsProjectId": "1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e", "owner": { "id": "abc12e4e-5d6d-7c8c-9b0b-1a2a3f4f5e90" } }} ``` #### Attribute Values

`project id`	(Required) The LUID of the project being updated. For information about how permissions are evaluated in project hierarchies, see Project Permissions States and Defaults Windows \| Linux.
`project name`	(Optional) The new name for the project.
`project description`	(Optional) The new description for the project.
`project parentProjectId`	(Optional) The new identifier of the parent project. Use this option to create or change project hierarchies. To update a project without changing its placement in the project hierarchy, omit the parentProjectId attribute. To move a project to the top of the project hierarchy, provide an empty string ("") for the parentProjectId attribute. For information about how permissions are evaluated in project hierarchies, see Project Permissions States and Defaults.
`project contentPermissions`	(Optional) This value controls user permissions in a project, however, if the project is nested within a project with more restrictive policies, it will inherit those permissions and these settings will have no effect. The functional permissions of a project, including those it inherits, are available in value of contentPermission in the response body from a request to create, update, or query a project. LockedToProject to lock permissions so that users cannot overwrite the default permissions set for the project ManagedByOwner to allow users to manage permissions for content that they own LockedToProjectWithoutNested to lock the permissions of a parent project, but not those of its child projects. The default is ManagedByOwner. For more information, see Lock Content Permissions.
`project parentProjectId`	(Optional) The new identifier of the parent project. Use this option to create or change project hierarchies. To update a project without changing its placement in the project hierarchy, omit the parentProjectId attribute. To move a project to the top of the project hierarchy, provide an empty string ("") for the parentProjectId attribute. For information about how permissions are evaluated in project hierarchies, see Project Permissions States and Defaults.
`owner id`	The LUID of the user that owns the project.

#### cURL Example `curl --request PUT "https://myServer/api/3.21/sites/1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e/projects/ds2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e70" --header "Content-Type: application/xml" --header "X-Tableau-Auth;" --data " "` #### Response Code 200 #### Response Body Copy ``` ``` Copy ``` { "project": { "id": "1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e", "parentProjectId": "afe6f0b8-cb10-11e7-9fd4-db8b61369aa5", "name": "Update-Project-Name", "description": "This is the new description after the project update", "contentPermissions": "ManagedByOwner", "controllingPermissionsProjectId": "1f2f3e4e-5d6d-7c8c-9b0b-1a2a3f4f5e6e", "owner": { "id": "abc12e4e-5d6d-7c8c-9b0b-1a2a3f4f5e90" } }} ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400008	Bad request	The request cannot set content permissions to LockedToProjectWithoutNested for a REST API version lower than 3.8.
403	403005	Update forbidden	Attempt to rename the default project, which cannot be renamed.
403	403008	Insufficient storage on site	The samples could not be published because there is not enough storage space remaining on the server to accommodate the samples.
403	403004	Update forbidden	A non-administrative user tried to update the project, but does not have permissions to update the project.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404009	Project ID mismatch	The request body contains a project ID (which is optional) and it doesn't match the ID in the URI.
404	404005	Project not found	The project ID in the URI doesn't correspond to an existing project.
405	405000	Invalid request method	Request type was not PUT.
409	409006	Project name conflict	The project name in the request already belongs to the specified site. For the purpose of uniqueness checks, project names are case-insensitive.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Pulse user preferences Updates the signed in user's preferences for notifications channels and cadence, and for grouping and sorting followed metrics in REST responses and UI. **Version:** Available in API 3.24 (Tableau Cloud December 2024) and later. Not available for Tableau Server. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Any user that has read or connect permission to the data source used in the definition can get the details of subscriptions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** \`tableau:user\_preferences:update\`. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) PATCH {server}/api/-/pulse/user/preferences [view details](#) ## Update Routing Rule Partially updates an existing Bridge routing rule. You can change the rule's `domain`, `poolId`, and `isBlocked` flag. At least one attribute must be supplied; only the supplied attributes are changed. Project scoping is not changed here—use the Add Projects to Routing Rule and Remove Projects from Routing Rule methods. This method is not available for Tableau Server. **Version**: Available in API 3.30 (Tableau Cloud October 2026) and later. Not available for Tableau Server. **License**: No additional license required. **Permissions**: Tableau Cloud site admin. **Access Scope**: `tableau:bridge_rest_api:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PATCH /api/api-version/sites/site-luid/bridge-routing-rules/routing-rule-id #### URI Parameter Values

api-version	The version of the API to use. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
routing-rule-id	The unique identifier (UUID) of the routing rule to update.

#### Request Body ``` ``` ``` { "routingRule": { "domain": "new.example.com", "poolId": "b2c3d4e5-6f70-8192-a3b4-c5d6e7f80910" } } ``` #### Attribute Values

domain	Optional. A new domain for the rule.
isBlocked	Optional. Changes the rule between a block rule (`true`) and an allow rule (`false`).
poolId	Required when transitioning to an allow rule. The UUID of the target Bridge pool. Must be omitted when the rule is, or becomes, a block rule.

#### Response Code 200 #### Response Body Returns the updated `routingRule`, identical in shape to the Create Routing Rule response. ``` ``` ``` { "routingRule": { "id": "d9e8f7a6-b5c4-3210-fedc-ba9876543210", "domain": "new.example.com", "isBlocked": false, "poolId": "b2c3d4e5-6f70-8192-a3b4-c5d6e7f80910", "poolName": "WindowsPool", "project": [ { "id": "11111111-2222-3333-4444-555555555555", "name": "Finance", "isDeleted": false } ] } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	503909	Validation failed	Empty update (no attributes supplied), invalid routing-rule-id or `poolId` UUID, blank or invalid domain, or `poolId` missing when transitioning to an allow rule.
400	503910	Invariant violation	`poolId` supplied while the rule is, or becomes, a block rule.
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
403	503923	Permission denied	Caller is not a site administrator for the site.
404	503915	Routing rule not found	No routing rule exists with the given ID on this site.
409	503911	Duplicate routing rule	The update would collide with an existing rule for the same domain and project scope.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500	503917	Unexpected server error	An unexpected error occurred while updating the rule.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update SCIM Configuration Updates the System for Cross-domain Identity Management (SCIM) configuration on the Tableau Cloud site. You must be the user that created the SCIM configuration to update the SCIM configuration unless the creator of the SCIM configuration is no longer a member of the site. **Version**: Available in API 3.26 (Tableau Cloud August 2025) and later. **License**: No additional license required. **Permissions**: Tableau Cloud site admins only. **Access Scope**: `tableau:scim_configurations:read` - Scope added in API 3.27 (Tableau Cloud December 2025) _For more information, see_ [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_,_ [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_, [access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps_[Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm)_._ #### URI PATCH /api/api-version/sites/site-luid/scimConfigurations/scim-configuration-id #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
scim-configuration-id	The UUID of the SCIM configuration. To get the SCIM configuration UUID, see List SCIM Configurations.

#### Request Body ``` SCIM Contractors Canada d3b782da-0787-44ca-8585-6fd48dbfc658d3b782da-0787-44ca-8585-6fd48dbfc658 ``` ``` { "scimConfiguration": { "name": "SCIM Contractors Canada", "idpConfigurationId": "d3b782da-0787-44ca-8585-6fd48dbfc658d3b782da-0787-44ca-8585-6fd48dbfc658" } } ``` #### cURL Request Example ``` POST request: curl --location 'https://prod-ca-a.online.tableau.com/api/3.29/sites/0f04ea64-0d72-424a-afd8-ee7d758dc9b8/scimConfigurations \ --data '{ "scimConfiguration":{ "name": "SCIM Contractors Canada", "idpConfigurationId": "d3b782da-0787-44ca-8585-6fd48dbfc658" } }' ``` #### Attribute Values

name

(Required) Name of the SCIM configuration.

idpConfigurationId

(Required) Authentication configuration to associate with the SCIM configuration.

Starting in API 3.26, you can have multiple SCIM configurations. Include the idpConfigurationId to identify which configuration to update. If a SCIM token is associated with SCIM configuration, updating the IdPConfigurationId deletes the SCIM token. Ensure the SCIM token's secret is removed from the identity provider's (IdP's) SCIM configuration. To get the idpConfigurationId, see List Authentication Configurations for Site.

Starting in API 3.28, you can associate OIDC or Google authentication with SCIM.

#### Response Code 204 #### Response Body ``` 065693d8-436a-4738-a8f1-375953a2a888 d3b782da-0787-44ca-8585-6fd48dbfc658 false true SCIM Contractors Canada 2025-04-01 06:31:47.882 ``` ``` { "scimConfiguration": { "id": "065693d8-436a-4738-a8f1-375953a2a888", "idpConfigurationId": "d3b782da-0787-44ca-8585-6fd48dbfc658", "isApiTokenActive": false, "isOwner": true, "name": "SCIM Contractors Canada", "createdAt": "2025-04-01 06:31:47.882" } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400008	Bad Request	The content of the request body contains unsupported attributes, the SCIM configuration name already exists, or the `idpConfigurationId` is missing or not valid.
401	401002	Unauthorized Access	The authentication token provided in the request header is invalid or has expired.
403	403182	Forbidden	The SCIM configuration can only be updated by the user who created the SCIM configuration.
404	404050	Resource Not Found	The SCIM configuration does not have an associated SCIM token.
404	404057	Resource Not Found	The SCIM configuration UUID is not valid or does not exist on this site.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Server Active Directory Domain Changes the nickname or full domain name of an Active Directory domain on the server. This method is not available on Tableau Cloud. A domain nickname, also called short name, is the Windows NetBIOS domain name. You can modify the nickname for any domain the server is using. In general, you can modify the full domain name for any domain except the one that you used to sign in. However, if the user name that you are currently signed in with exists in both the current domain and the new domain, you can modify the full name for the current domain. For information about how to enable access for users from multiple domains, see [Support for multiple domains](https://help.tableau.com/current/server/en-us/users_manage_ad.htm#support-for-multiple-domains). If the domain is `local`, it's names cannot be changed. #### URI PUT /api/api-version/domains/domain-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
domain-id	The integer ID of the of the Active Directory domain being updated. Find a domain's ID using List Server Active Directory Domains.

#### Request Body ``` ``` #### Attribute Values Any combination of attributes is valid. If no attributes or nested elements are included, no update is made.

new-domain-name	A new full domain name you are using to replace the existing one.
new-domain-nickname	A new domain nickname you are using to replace the existing one.

#### Permissions This method can only be called by server administrators. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:domains:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response:** ``` ``` #### Version Version 3.11 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
404	404032	Resource not found	The requested domain ID in the URI doesn't correspond to an existing domain.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example For an Active Directory with the ID of `1045`, name of `myOldDomainName`, and a nickname of `myOldDomainNickname`: `curl "http://MY-SERVER/api/3.29/domains/f34ab56cd12ab34cd56ef78ab90cd12ef" -X PUT -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @update-domain.xml` **Content of update-domain.xml:** ``` ``` **Example response body:** ``` ``` ## Update Server Schedule Modifies settings for the specified server schedule, including the name, priority, and frequency details on Tableau Server. _For Tableau Cloud, see [Update cloud extract refresh task](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_extract_and_encryption.htm#update_cloud_extract_refresh_task) and [Update subscription](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_subscriptions.htm#update_subscription_cloud) ._ #### URI PUT /api/api-version/schedules/schedule-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
schedule-id	The ID of the schedule to update. To determine what schedules are available, call List Server Schedules.

#### Request Body ``` ``` #### Attribute Values

new-schedule-name	The new name to give to the schedule.
new-schedule-priority	An integer value between 1 and 100 that determines the default priority of the schedule if multiple tasks are pending in the queue. Lower numbers have higher priority.
new-schedule-execution-order	`Parallel` to allow jobs associated with this schedule to run at the same time, or `Serial` to require the jobs to run one after the other.
new-schedule-frequency	The granularity of the schedule. Valid values are: `Hourly`. `Hourly`. Jobs can be scheduled to run one or more times per day at intervals specified in minutes or hours. Valid intervals are 15 and 30 minutes and 2, 4, 6, 8, and 12 hours. `Daily`. Jobs can be scheduled to run once per day. `Weekly`. Jobs can be scheduled to run one or more times per week. `Monthly`. Jobs can be scheduled to run once per month on a specific day. The value you provide for schedule-frequency determines whether you must include an end-time value, and what is required in the contents of the <intervals> element.
new-state	`Active` to enable the schedule, or `Suspended` to disable it.
start-time	The time of day on which scheduled jobs should run (or if the frequency is hourly, on which they should start being run), in the format `HH:MM:SS` (for example, `18:30:00`). This value is required for all schedule frequencies. The entered time will be applied based on the time zone of your server.
end-time	If the schedule frequency is `Hourly`, the time of day on which scheduled jobs should stop being run, in the format `HH:MM:SS` (for example, `23:30:00`). Hourly jobs will occur at the specified intervals between the start time and the end time. For other schedule frequencies, this value is not required; if the attribute is included, it is ignored. The entered time will be applied based on the time zone of your server.
interval-expression	A value that specifies the interval between jobs associated with the schedule. The value you specify here depends on the value of schedule-frequency. `Hourly` The interval expression is only one of the following: `hours="interval"` where interval is `1`, `2`, `4`, `6`, `8`, or `12`, representing how many hours between jobs. `minutes="interval"` where interval is `15` or `30`, representing how many minutes between jobs. You can specify an interval in hours or minutes, but not both. `Daily` If the schedule frequency is `Daily`, no interval is specified. Any information specified in the <intervals> element is ignored. `Weekly` The interval expression is `weekDay="weekday"`, where weekday is `Sunday`, `Monday`, `Tuesday`, `Wednesday`, `Thursday`, `Friday`, or `Saturday`. You can specify multiple <interval> elements to indicate that scheduled jobs should run on multiple days during the week. Note: Updating a schedule without specifying days of the week will reset any existing weekly interval to include all 7 days. If you need the job you are updating to remain scheduled on selected days, make sure to include that information in your update request. `Monthly` The interval expression is `monthDay="day"`, where day is either the day of the month (`1`, `2`, etc.) or `LastDay`. Note: If you want to specify multiple days in the month, you can do this using the web interface. You cannot create or update such a monthly schedule using REST API.

Any combination of the attributes inside the element is valid. Only the attributes and child elements that are included result in updates to the schedule. If no attributes or nested elements are included, no update is made. #### Permissions This method can only be called by server administrators. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:schedules:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` #### Version Version 2.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400008	Invalid Parameter	One of the parameters in the request body is invalid.
400	400071	Error updating schedule	The schedule couldn't be updated for an unspecified reason.
404	404023	Schedule not found	The specified schedule doesn't correspond to an existing schedule.
405	405000	Invalid request method	Request type was not PUT.
409	409021	Schedule name conflict	The schedule name in the request already belongs to an existing schedule.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/schedules/4d652179-36bf-47e4-a9dc-e069227c72d0" -X PUT -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @update-schedule.xml` **Content of update-schedule.xml for an hourly schedule** For an hourly schedule, frequencyDetails is set to `Hourly`. Both start and end values are required. The intervals element is required, and must include 1 interval subelement that contains either an hours or a minutes attribute. Valid values for minutes are `15` or `30`. Valid values for hours are `1`, `2`, `4`, `6`, `8`, or `12`. ``` ``` **Response body** ``` version-and-namespace-settings> ``` **Note:** For additional examples of how to construct the payload for updating schedules, see [Create Schedule](#create_schedule). ## Update settings for allowed dashboard extension on site - Retired in API 3.21 * * * Retired in API 3.21 (Cloud October 2023 / Server 2023.3) > > [!WARNING] > > > > In October 2023 Tableau Cloud and Tableau Server version 2023.3 releases, Tableau's REST API methods for dashboard extensions settings are retired. We recommend you replace dashboard extensions methods for enabling, listing, getting details of, and updating dashboard extensions with [Tableau extensions settings methods](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_tableau_extensions_settings.htm) that have similar functionality. * * * 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 Cloud March 2021 / Server 2021.1) and later. [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) **Permissions:** Can only be called by users with site or server administrator permissions. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) **License:** No additional license required. **Access Scope:** Not available. [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) PUT {server}/api/-/settings/site/extensions/dashboard/safeListItems/{safe\_list\_item\_luid} [view details](#) ## Update Site Modifies settings for the specified site, including the content URL, administration mode, user quota, state (active or suspended), storage quota, whether flows are enabled, whether subscriptions are enabled, and whether revisions are enabled. **Note:** You must be signed in to a site to update it. #### URI PUT /api/api-version/sites/site-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site to update.

#### Request Body **Updating individual settings** ``` ``` **Updating the site logo** To set a new site logo, you pass a multi-part payload to the site. In addition to setting the `X-Tableau-Auth` header to the sign-in token, you must set the `Content-Type` header to `multipart/mixed` and include a boundary string. For example, the header might look like the following example: `Content-Type: multipart/mixed; boundary=az1by2cx34dw` The request body starts with the string you specify as the boundary. This is followed by two headers. You set `Content-Disposition` header to `form-data`, and then a `name` value set to `site_logo` and a `filename` value. You must also include a `Content-Type` header set to `application/octet-stream`. After the headers, you include a blank line then the binary data (not encoded). The binary data is followed by a line that includes the boundary string and the two required termination hyphens (`--`). The following example shows the request body using the boundary string that was specified in the example header earlier. \--az1by2cx34dw Content-Disposition: form-data; name="site\_logo"; filename="new-site-logo.png" Content-Type: application/octet-stream --az1by2cx34dw-- **Restoring the default site logo** To restore the default site logo, you pass a multi-part payload to the site, as you do to set the logo. However, instead of passing binary data for the image, you pass an empty image. And instead of setting the `Content-Type` header in the body to `application/octet-stream`, you set the content type to `text/plain`. The following example shows the request body using the boundary string that was specified in the example header earlier. \--az1by2cx34dw Content-Disposition: form-data; name="site\_logo"; filename="empty.txt" Content-Type: text/plain --az1by2cx34dw-- #### Attribute Values

new-site-name	(Optional) The new name of the site.
new-content-url	(Optional) The new site URL. This value can contain only characters that are valid in a URL. These characters include letters (A-Z, a-z), digits (0-9), hyphens ("-"), and underscores ("_") If you provide invalid characters, those characters are stripped from the URL and the site is created anyway. For example, if you try to set the site URL as `test.site`, it's converted to `testsite` and returned in the response. The response's site URL namespace is the authoritative source of truth for the new site URL.
new-admin-mode	(Optional) Specify ContentAndUsers to allow site administrators to use the server interface and `tabcmd` commands to add and remove users. (Specifying this option doesn't give site administrators permissions to manage users using the REST API.) Specify ContentOnly to prevent site administrators from adding or removing users. (Server administrators can always add or remove users.) Note: You cannot set adminMode to ContentOnly and also set a userQuota value. The default value is ContentAndUsers.
new-state	(Optional) Active to set the site to active mode, or Suspended to suspend the site. Default is Active.
new-storage-quota	(Optional) The new maximum amount of space for the new site, in megabytes. If you set a quota and the site exceeds it, publishers will be prevented from uploading new content until the site is under the limit again.
new-disable-subscriptions	(Optional) true to prevent users from being able to subscribe to workbooks on the specified site. Default is false.
revision-history-enabled	(Optional) true if the site maintains revisions for changes to workbooks and data sources; otherwise, false. The default is false.
revision-limit	(Optional) An integer between 2 and 10000 to indicate a limited number of revisions for content. Setting this value to -1 removes any value that was set previously, and effectively removes any limit to the number of revisions that are maintained.
allow-subscription-attachments-flag	(Optional) If true, and subscription to attachments is enabled on the server, then users can create subscriptions that send an email with images of a workbook or view in a PDF attachment. The default value is true. If subscription to attachments is disabled in the server settings, then making this value true will have no effect. Default is true.
subscribe-others-enabled-flag	(Optional) Specify true to enable and false to disable the ability for view owners to subscribe other users to a view. Default is true.
editing-flows-enabled-flag	(Optional) Specify true to enable and false to disable editing flows for a site. For more information on flows, see Enable and Configure Tableau Prep Conductor. The default is set to true, which means editing flows is enabled by default. For more information, see Implication of disabling Tableau Prep Conductor.
scheduling-flows-enabled-flag	(Optional) Specify true to enable and false to disable scheduling flows for a site. For more information on flows, see Enable and Configure Tableau Prep Conductor. The default is set to true, which means scheduling flows is enabled by default. For more information, see Implication of disabling Tableau Prep Conductor.
flows-enabled-flag	The flowsEnabled attribute is deprecated as of API 3.10.
guest-access-enabled-flag	(Optional) Specify true to enable and false to disable the ability for guests, users without specific site access permission, to access the site. Default is false.
cache-warmup-enabled-flag	This attribute was removed in API 3.19 and later. For current methods to improve Tableau performance see, View Acceleration. (Optional) Set this value to true to enable cache warm up to improve workbook load times. Set the value to false to disable cache warmup. Default is true.
commenting-enabled-flag	(Optional) Specify true to enable and false to disable the ability for user comments on views in the site. Default is true.
extractEncryptionMode	(Optional) Specify enforced, enabled, or disabled. Default is disabled. For more information, see Extract and Encryption Methods.
dataAccelerationMode	(Optional) Specify enable_selective or disabled. The default is enable_selective, which lets you update particular workbooks to turn on data acceleration using the accelerationEnabled attribute. For more information, see Data Acceleration (Retired). Tableau's View Acceleration feature and Data Acceleration-related APIs were retired in Tableau Cloud in June 2026 and in Tableau Server version 2026.2.
requestAccessEnabled	(Optional) Specify true to allow users send access request emails to content or project owners. Specify false if you don't want users to be able to request access. The default is false.
runNowEnabled	(Optional) Specify true to allow users to run flows, extract refreshes, and schedules manually. Specify false if you don't want users to be able to run flows, extract refreshes, and subscriptions manually. The default is true. If this attribute is set to false, the following methods will fail and will return an error message. Run Flow Now Run Flow Task Update Data Source Now Run Extract Refresh Task
Licensing attributes For user-based license types, the maximum number of users is set by the licenses activated on that server. For core-based licensing, there's no limit to the number of users; if you specify a maximum value, only licensed users are counted, and server administrators are excluded. The REST API enables administrators to set licensing limits below the purchased maximum with two types of license-related attributes: - User Quota - The total maximum number of licenses currently configured for a site. - Tiered Capacities - If set, the configured maximum license count for each license type (role). . An on-premises server administrator can both get and set them but if license maximums are set using one attribute kind then the value(s) of the other kind must be null. Setting values for both kinds of attributes will result in an error. For more information, see Licensing Overview.
User quota all-license-limit-total	(Optional) The maximum total number of users with Creator, Explorer, or Viewer licenses currently allowed on a site. On-premises server administrators can set `userQuota` with the following rules: The number can't exceed the number of licenses activated for the site; and if tiered capacity attributes are set, then `userQuota` will equal the sum of the tiered capacity values, and attempting to set `userQuota` will cause an error. An administrator can revert the license limit to number of activated licenses on the site, or shift control of license limits to tiered capacities values, by omitting `userQuota` from a Create Site or Update Site request, or making its value -1.
Tiered capacity attributes creator-license-limit explorer-license-limit viewer-license-limit	(Optional) The maximum number of licenses for users with the Creator, Explorer, or Viewer role, respectively, allowed on a site. On-premises server administrators can set tiered capacity attributes with the following rules: the number can't exceed the number of licenses of a given type that are activated for the site; a value must be supplied for every tiered capacity license type every time any one or more of them is set. A value of -1 removes the administrator-applied limit for a license type, and reverts the limit to the number of activated licenses configured for the role. Setting the value of a tiered capacity to -1 will not automatically increase the limit if more licenses are purchased and activated for the role in the future. To use role-specific license limits, the `userQuota` must be set to null by omitting the attribute from Create Site or Update Site request, or setting its value to -1. Attempting to set values for both tiered capacities and `userQuota` will result in an error.
data-alerts-enabled-flag	(Optional, boolean) If `true`, data alerts are enabled on the site. Default value is `true`.
commenting-mentions-enabled-flag	(Optional, boolean) If `true`, mentions for commenting are enabled. Default value is `true`.
catalog-obfuscation-enabled-flag	(Optional, boolean) If `true`, catalog obfuscation is enabled on the site. Default value is `true`.
flow-auto-save-enabled-flag	(Optional, boolean) If `true`, flow auto save is enabled on the site. Default value is `true`.
run-now-enabled-flag	(Optional, boolean) If `true`, run now for schedules is enabled which allows non-administrators to run schedules manually. Default value is `true`.
metrics-content-type-enabled-flag	(Optional, boolean) If `true`, the metrics content type is enabled on the server. Default value is `false`.
notify-site-admins-on-throttle-flag	(Optional, boolean) If `true`, site admins will be notified if their background jobs are being throttled. Default value is `false`.
authoring-enabled-flag	(Optional, boolean) If `true`, web authoring is enabled. Default value is `false`.
custom-subscription-email-enabled-flag	(Optional, boolean) If `true`, sending custom subscription email is enabled. If set to false after being set true, the current custom subscription email is voided. Default value is `false`.
custom-subscription-email	A valid custom email that will be sent if customSubscriptionEmailEnabled is set to true. Default value is `false`.
custom-subscription-footer-enabled-flag	(Optional, boolean) If `true`, a custom footer will be included on subscription and data alert emails. If set to false after being set true, the current custom subscription footer is voided. Default value is `false`.
custom-subscription-footer	A custom subscription footer that will be added to subscription and data alerts if customSubscriptionFooterEnabled is set to true. Default value is `false`.
ask-data-mode	The mode of the ask data feature on the site. Can be set to one of two values: `DisabledByDefault` - Enables creation of Ask Data lenses for all published data sources. Data sources do not have lenses created automatically. `DisabledAlways` - Disables Ask Data lenses and related content throughout the site. Preserves information about lenses and data source indexes, which are restored if Ask Data is re-enabled. Default value is `DisabledByDefault`. For more information, see Disable or Enable Ask Data for a Site.
named-sharing-enabled-flag	(Optional, boolean) If `true`, named sharing is enabled. Default value is `true`.
cataloging-enabled-flag	(Optional, boolean) If `true`, data catalog is enabled for the site. Default value is `true`.
derived-permissions-enabled-flag	(Optional, boolean) If `true`, derived permissions are enabled for the site. Default value is `false`.
user-visibility-mode	(Optional, string) When the value is `FULL` users can see the user of other site users. If the value is `LIMITED` User information on the site is not visible to other users. Default value is FULL. For more information, see User Visibility.
use-default-time-zone	(Optional, boolean) Set this to `true`, if you want the time-zone attribute use the Server time Zone at run time. This attribute is set to official IANA name. If this is set to `false`, the time-zone value must be specified.
time-zone	(Optional, string) Use this attribute to specify a time zone other than the Server time zone at run time. Only canonical names in the official IANA database are supported. You can find the list of the canonical time zone names on Wikipedia.
autoSuspendRefreshEnabled	(Optional) Tableau can automatically suspend extract refresh tasks for inactive workbooks to save resources. Specify true to enable or false to disable. Default is true.
autoSuspendRefreshInactivityWindow	(Optional) An integer between 7 and 100 to indicate the number of days to wait before automatically suspending extract refresh tasks for inactive workbooks. The default is 30.
explainDataEnabled	(Optional, boolean) Set this attribute to `false` to disable Explain Data capabilities for a site. By default, this attribute is set to `true`. For more information about this site setting, see Disable or Enable Explain Data for a Site in the Tableau Server Help.
dqwSubscriptionsEnabled	(Optional, boolean) Set this attribute to `false` to exclude data quality warnings (DQWs) from subscription emails. By default, this attribute is set to `true`. For more information about this site setting, see Disable or Enable Explain Data for a Site in the Tableau Server Help.
attribute-capture-enabled	(Optional, boolean) Set this attribute to `true` to enable user attribute functions used in embedded content to accept the passing of user attributes from a JSON Web Token (JWT) via Tableau connected apps. The user attributes are passed to Tableau at runtime to control and customize the data that can show for an authorized user. By default, this attribute is set to `false`. For more information, see Tableau Embedding API v3 Help. This attribute is available starting from API version 3.25. Starting in October 2025 (API version 3.27), you can also use this attribute to pass user information about your identity provider to Tableau Cloud. During single sign-on (SSO), user attribute functions in Tableau content can accept attributes from OIDC claims or SAML assertions. For more information, see OIDC or SAML topics in the Tableau Cloud Help.
groupAssertionsEnabled	(Optional) Set to `true` to allow assertions into group membership using session info. Set to `false` if you don't want users to be able to be asserted in to groups. The default is `false`. If this attribute is set to false, it will disable group assertions for the entire site, including the following settings: groupAssertionsSAMLEnabled groupAssertionsOIDCEnabled groupAssertionsConnectedAppsEnabled
groupAssertionsSAMLEnabled	(Optional, boolean) Set to `true` to allow assertions into group membership using SAML session info. Set to `false` if you don't want users to be able to be asserted in to groups. The default is `false`. If this attribute is set to false, it will disable group assertions for SAML sessions.
groupAssertionsOIDCEnabled	(Optional, boolean) Set to `true` to allow assertions into group membership using OIDC session info. Set to `false` if you don't want users to be able to be asserted in to groups. The default is `false`. If this attribute is set to false, it will disable group assertions for OIDC sessions.
groupAssertionsConnectedAppsEnabled	(Optional, boolean) Set to `true` to allow assertions into group membership using Connected App JWT tokens. Set to `false` if you don't want users to be able to be asserted into groups via connected apps. The default is `false`. If this attribute is set to false, it will disable group assertions for JWT connected app connections.
groupSetsEnabled	(Optional, boolean) Set to `true` to allow groups sets. Set to `false` if you don't want group sets support for the site. The default is `false`. If this attribute is set to false, it will disable group sets for the site.
recycleBinEnabled	(Optional, boolean) Set to `true` to enable the Recycle Bin. Set to `false` to disable it. The default is `true`.

Any combination of the attributes inside the element is valid. Only the attributes that are included are updated for the site. If no attributes are present, no update occurs. To update only the logo, include an empty element (``) and the logo in the multipart message. Starting in API version 2.3, you can call Update Site to upload a custom logo image for the site. (For information about custom logos, see [Custom the Name or Logo](https://help.tableau.com/current/server/en-us/help.htm#customize_namelogo.htm) in the Tableau Server Help.) To upload a logo image, you include the image in a multipart message; this is similar to how you publish a workbook or data source. You must include the following headers in the request: - `MIME-Version: 1.0` - `Content-Type: multipart/mixed; boundary=boundary-string` - `X-Tableau-auth: authentication-token` The following example shows the request body for an Update Site request that updates the site with a new logo. For this example, the boundary string has been set in the header to `6691a87289ac461bab2c945741f136e6`. The `` element can be empty if you're calling Update Site only to update the logo image. ``` --6691a87289ac461bab2c945741f136e6 Content-Disposition: name="request_payload" Content-Type: text/xml --6691a87289ac461bab2c945741f136e6 Content-Disposition: name="site_logo"; filename="MySiteLogo.png" Content-Type: application/octet-stream logo stream here --6691a87289ac461bab2c945741f136e6-- ``` To clear a custom logo image and revert to using the default logo for the site, call Update Site with a multipart message, but leave the portion of the request body blank where you would normally include the logo stream. For more information about creating multipart messages, see [Publishing Resources](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_publish.htm). #### Permissions Tableau Server: This method can only be called by server administrators. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:sites:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` Response Body Details: - userQuota, storageQuota, and tiered capacity (tierCreatorCapacity, tierExplorerCapacity, tierViewerCapacity) attributes are only present in the response body if those quotas have been set for the site being queried. #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400008	Invalid revision history limit	The value for the revision history limit isn't an integer.
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400004	Invalid administrator mode	An administrator mode parameter was provided in the request with an invalid value. The valid values are ContentOnly and ContentAndUsers.
400	400004	Invalid state	A state parameter was provided in the request with an invalid value
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type wasn't PUT.
409	409001	Site name conflict	The new site name in the request already belongs to an existing site.
409	409002	Site URL conflict	The new content URL in the request already belongs to an existing site.
409	409004	User quota and tiered capacity conflict	The request can't set both tiered capacity attributes and userQuota. One or the other must be null.
409	409004	License limit exceeded	The request can't set tiered capacity attributes or userQuota values that are larger than the number of active licenses configured for the site.
409	409004	Administrator mode or user quota conflict	The request can't set adminMode to ContentOnly and also specify a userQuota value.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d5-e4f3-a2b1-c0d9-e8f7a6b5c4d" -X PUT -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @update-site.xml` **Content of update-site.xml:** ``` ``` **Example response:** ``` ``` ## Update Subscription Modifies an existing subscription on Tableau Server. You can change the subject, server schedule, and suspension state for the subscription. Tableau Server and Tableau Cloud each have a different model for schedules and tasks. On Tableau Server, you create a schedule and add a task to it. On Tableau Cloud you create a task and define it's frequency. While the Create Subscription endpoint path and parameters are the same for both Server and Cloud, because the models are different, the request and response bodies are different. - [Tableau Server Requests](#update_subscription_server) - [Tableau Cloud Request](#update_subscription_cloud) #### URI PUT /api/api-version/sites/site-id/subscriptions/subscription-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook.
subscription-id	The ID of the subscription to update.

#### JWT Access Scope `tableau:tasks:update` _(this scope is included in the scope: `tableau:tasks`)_ This scope can be used to enable this REST method to be called from a unified access token or connected app. For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), or [Tableau Cloud connected app scopes](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) or [Tableau Server connected apps scopes](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm). _Available in API 3.20 (Tableau Cloud June 2023 / Tableau Server 2023.3._ ### Tableau Server Request Update the attributes of a subscription task on a server schedule on Tableau Server. _For Tableau Cloud, see [Tableau Cloud Request](#update_subscription_cloud)._ ``` ``` ``` { "subscription": { "subject": "subscription-subject", "attachImage": "attach-image-flag", "attachPdf": "attach-pdf-flag", "pageOrientation": "page-orientation", "pageSizeOption": "page-size-option", "suspended": "suspended-flag", "schedule": { "id": "new-schedule-id" }, "content": { "sendIfViewEmpty": "send-view-if-empty-flag" } } } ``` #### Attribute Values

new-subscription-subject	(Optional) A new subject for the subscription.
attach-image-flag	(Optional) Setting this `true` will cause the subscriber to receive mail with .png images of workbooks or views attached to it. This is the default behavior if neither `attachImage` or `attachPdf` are specified. If subscriptions to attachments are disabled in Tableau server or site settings, then making a request that sets `attachImage` to `false` will cause an error.
attach-pdf-flag	(Optional) Setting this `true` will cause the subscriber to receive mail with a .pdf file containing images of workbooks or views attached to it. If subscriptions to attachments are disabled in Tableau server or site settings, then making a request that sets `attachPdf` to `true` will cause an error.
page-orientation	(Optional) The orientation of the pages produced when attach-pdf-flag is `true`. The value can be `Portrait` or `Landscape`. If this parameter is not present the page orientation will default to `Portrait`.
page-size-option	(Optional) The type of page produced, which determines the page dimensions when attach-pdf-flag is `true`. The value can be: `A3`, `A4`, `A5`, `B5`, `Executive`, `Folio`, `Ledger`, `Legal`, `Letter`, `Note`, `Quarto`, or `Tabloid`. If this parameter is not present the page type will default to `Letter`.
suspended-flag	(Optional boolean) If `true`, the subscription is disabled, meaning it won't run until it's enabled using the Update Subscription method or Resume Subscription in the web UI. If `false`, the subscription is enabled.
new-schedule-id	(Optional) The ID of a server schedule to associate this subscription with. To determine what schedules are available, call List Server Schedules. The type of the schedule must be `Subscription`.
send-view-if-empty-flag	(Optional) Applies to views only. If `true`, an image is sent even if the view specified in a subscription is empty. If `false`, nothing is sent if the view is empty. The default value is true.

#### Permissions Tableau Server users can call this method to update any subscription that they have permission to create. For details, see [Create Server Subscription](#create_subscription). #### Response Code 200 #### Response Body ``` ``` ``` { "subscription": { "id": "subscription-id", "subject": "subscription-subject", "suspended": "suspended-flag", "pageOrientation": "page-orientation", "pageSizeOption": "page-size-option", "content": { "id": "content-id", "type": "content-type", "sendIfViewEmpty": "send-view-if-empty-flag" }, "schedule": { "id": "schedule-id", "name": "schedule-name" }, "user": { "id": "user-id", "name": "user-name" } } } ``` #### Version Version 2.3 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400067	Invalid subscription subject	The subscription subject is null or empty.
400	400069	Invalid subscription type	The subscription type is not `Workbook` or `View`.
400	400069	Invalid schedule type	The schedule type is not `Subscription`.
400	400133	Invalid data condition type	The data condition type is invalid for the subscription.
403	403065	No permissions to update subscription.	The user does not have permission to update the specified subscription.
404	404000	Site not found	The specified site doesn't correspond to an existing site.
404	404023	Schedule not found	The schedule ID in the request body doesn't correspond to an existing schedule.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ### Tableau Cloud Request Update the attributes of a subscription task and its frequency on Tableau Cloud. _For Tableau Server, see [Tableau Server Request](#update_subscription_server)._ **Version:** Available in API 3.20 (Tableau Cloud June 2023) and later. Not available for Tableau Server. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Administrators and any user with the creator role can create a custom schedule for a subscription task. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:tasks:update Access Scopes Overview: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm) #### URI PUT /api/api-version/sites/site-luid/subscriptions/task-luid #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
task-luid	The LUID of the extract refresh task. Use Query subscriptions to find task IDs by subscription subject or user.

#### Request Body ``` ``` ``` { "subscription": { "subject": "finance report", "attachImage": "true", "attachPdf": "true", "pageOrientation": "true", "pageSizeOption": "Folio", "suspended": "false", "message": "daily finance report", "content": { "id": "13237fd-6365-44d5-925b-644e5281b605", "type": "Workbook", "sendIfViewEmpty": "false" }, "user": { "id": "456" } }, "schedule": { "frequency": "Daily", "frequencyDetails": { "start": "18:30:00", "end": "23:30:00", "intervals": { "interval": [ { "hours": "4" }, { "weekDay": "Sunday" }, { "weekDay": "Wednesday" } ] } } } } ``` #### Request Attributes `subject, contentId, userId` and all `schedule` attributes are **required** to create a custom schedule for a subscription, other attributes are optional with defaults. All attributes are optional when updating a custom schedule for a subscription.

`subscription subject`	(Required to create subscription) string: A description for the subscription. This description is displayed when users list subscriptions for a site in the server environment.
`subscription attachImage`	boolean: Setting this `true` will cause the subscriber to receive mail with .png images of workbooks or views attached to it. This is the default behavior if neither `attachImage` or `attachPdf` are specified. Default is `false`. If subscriptions to attachments are disabled in Tableau server or site settings, then making a request that sets `attachImage` to `false` will cause an error.
`subscription attachPdf`	boolean: Setting this `true` will cause the subscriber to receive mail with a .pdf file containing images of workbooks or views attached to it. Default is `false`. If subscriptions to attachments are disabled in Tableau server or site settings, then making a request that sets `attachPdf` to `true` will cause an error.
`subscription pageOrientation`	enumeration: The orientation of the pages produced when attach-pdf-flag is `true`. The value can be `Portrait` or `Landscape`. If this parameter is not present the page orientation will default to `Portrait`.
`subscription pageSizeOption`	enumeration: The type of page produced, which determines the page dimensions when attach-pdf-flag is `true`. The value can be: `A3`, `A4`, `A5`, `B5`, `Executive`, `Folio`, `Ledger`, `Legal`, `Letter`, `Note`, `Quarto`, or `Tabloid`. If this parameter is not present the page type will default to `Letter`.
`subscription message`	string: The text body of the subscription email message.
`subscription suspended`	boolean: If `true`, the subscription is disabled, meaning it won't run until it's enabled using the Update Subscription method or Resume Subscription in the web UI. If `false`, the subscription is enabled.
`content id`	(Required to create subscription) LUID: The LUID of the workbook or view the user should be subscribed to.
`content type`	(Required to create subscription) enumeration: `Workbook` to create a subscription for a workbook, or `View` to create a subscription for a view.
`content sendIfViewEmpty`	boolean: Applies to views only. If `true`, an image is sent even if the view specified in a subscription is empty. If `false`, nothing is sent if the view is empty. The default value is true.
`userId`	(Required to create subscription) LUID: The LUID of the user to create the subscription for. Note: The user must have an email address defined in Tableau Server.

schedule frequency

(Required to create subscription) enumeration: The scheduled frequency for triggering the task. Valid values include:

Hourly
Daily
Weekly
Monthly

frequencyDetails end

<frequencyDetail start="20:45:00" end="21:45:00">
  . . .
</frequencyDetail>

interval {interval type}

Frequency	Valid interval values
`Hourly`	The value of an interval for an `Hourly` schedule can be only one of either: `hours="1"` The number of hours between jobs. `1` is the only valid value. `minutes="60"` The number of minutes between jobs. `60` is the only valid value. `weekDay="weekday"` The weekday(s) the job will be run on. Valid values are: `Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday`. For example, to schedule to run a job every hour on Sunday and Wednesday, during the time range specified in `frequencyDetails` use an interval like: `<intervals> <interval hours="1"/> <interval weekDay="Sunday"/> <interval weekDay="Wednesday"/> <intervals>`
`Daily`	The value of `Daily` can have multiple `weekday` elements, but only one `hours` declaration. An `hours` interval is required. `hours="interval"` The interval between execution of jobs on the weekday(s) specified. Valid values are `2, 4, 6, 8, 12, or 24`. Note that if the `interval` value of a daily schedule is less than `24`, a `frequencyDetail end` time must be supplied. `weekDay="weekday"` The weekday(s) the job will be run on. Valid values are: `Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday`. For example, to schedule to run a job every 4 hours on Sunday and Wednesday, during the time range specified in `frequencyDetails` use an interval like: `<intervals> <interval hours="4"/> <interval weekDay="Sunday"/> <interval weekDay="Wednesday"/> <intervals>`
`Weekly`	`weekDay="weekday"` The day of the week the schedule should run on. You can only specify a single day for a Weekly schedule. Valid values are: `Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday.`
`Monthly`	The day(s) of the month a job should be scheduled to run on. There are two ways to define a monthly interval: Specify the day(s) using the number of the day in the month; `monthDay="day"` The number of the day of the month. Valid values are the whole numbers `1` to `31` or `LastDay`. If you specify `monthDay` by day number then you can use multiple `interval` instances to choose for the job to run on multiple days in the month. If you use `LastDay` then only one instance of `interval` can be used in the schedule to specify the last day of the month. Specify the day by describing which occurrence of a weekday within the month. `monthDay="occurrence_of_weekday" Weekday="weekday"` The occurrence of the specified weekday within the month when a job should be run. Valid values for `occurrencee_of_weekday` are `First, Second, Third, Fourth, Fifth, or LastDay`. Valid values for `weekday` are `Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, or Saturday`. If the value is `lastDay` then the job will run on the last occurrence of the specified weekday in the month. For example, to make a schedule that that would run a job on the third Thursday of each month, you would use: `<interval monthDay="Third" weekDay="Thursday"/>`

#### cURL Request Example `curl --location --request PUT "qa-near.tsi.lan/api/3.29/sites/a946d998-2ead-4894-bb50-1054a91dcab3/subscriptions/r2345998-2ead-4894-bb50-1054a9109876" --header "Content-Type: application/xml" --data " > "` #### Response Code 200 #### Response Body ``` ``` ``` { "subscription": { "id": "789", "subject": "finance report", "attachImage": "true", "attachPdf": "true", "pageOrientation": "true", "pageSizeOption": "Folio", "message": "daily finance report", "content": { "id": "13237fd-6365-44d5-925b-644e5281b605", "type": "Workbook", "sendIfViewEmpty": "false" }, "user": { "id": "09876fd-6365-44d5-925b-644e528d5678" } }, "schedule": { "id": "54321fd-6365-44d5-925b-644e52812345", "createdAt": "2023-04-06T23:43:12-0700", "updatedAt": "2023-04-06T23:43:12-0700", "frequency": "Daily", "nextRunAt": "2023-04-06T23:43:12-0700", "frequencyDetails": { "start": "18:30:00", "end": "23:30:00", "intervals": { "interval": [ { "hours": "4" }, { "weekDay": "Sunday" }, { "weekDay": "Wednesday" } ] } } } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403004	Unauthorized Access	The user is not authorized to make this request.
404	404002	User not found	The user specified in the request could not be found.
404	404025	Subscription not found	The task for the subscription could not be found.
409	409004	invalid parameter value	The request is malformed or contains an invalid or missing schedule or interval parameter value. When the difference between `start` and `end` times are not increments of one hour, this error will result.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Table Update the table description, certify a table, or a assign a user contact to the table asset. This method is available if your Tableau Cloud site or Tableau Server is licensed with Data Management. #### URI PUT api/_api-version_/sites/_site-id_/tables/_table-id_ #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The unique ID of the site asset.
table-id	The unique ID of the table asset.

#### Request Body ```

``` #### Attribute Values Any combination of attributes inside the **** element is valid. Only the attributes and child elements that are included result in updates to the table. If no attributes or nested elements are included, no update is made.

certification-status	(Optional) Use one of the following values: true false These values are case sensitive.
certification-note	(Optional) Custom text to accompany the certification status.
new-description-value	(Optional) Custom text to describe the table asset.
new-contact-id	(Optional) The ID (not name) of the certification owner.

#### Permissions If Tableau Server or Tableau Cloud is licensed through Data Management, the following users have permissions to update the table asset: - Tableau Server admins or Tableau Cloud site admins - Authorized users who have been granted explicit permission to edit or "Write" to the asset metadata #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:tables:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body **Example response:** ```

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401000	Unauthorized access	No authorization credentials were provided.
401	401002	Unauthorized access	Invalid authorization credentials were provided.
404	404000	Resource not found	The site ID in the URI doesn't correspond to an existing site.
404	404032	Table not found	The requested table asset could not be found.
409	409052	Table error	An unknown table asset error occurred.
409	409057	Table update error	An unknown error occurred and the table asset could not be updated.
409	409058	Table update forbidden	A user without "write" permissions to the table asset attempted an update.

## Update Tableau extensions server settings Updates the settings for extensions of a server. **Version:** Available in API 3.21 ( Tableau Server 2023.3) and later. Not available for Tableau Cloud. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** This method can only be called by users with server administrator permissions. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** tableau:extensions\_server\_settings:update - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/settings/extensions #### URI Parameter Values

api-version The version of the API to use, such as 3.29. For more information, see REST API and Resource Versions.

#### Request Body Copy ``` true https://test.com ``` Copy ``` { "extensionsServerSettings": { "extensionsGloballyEnabled": "true", "blockList": "https://test.com" }} ``` #### Request Attributes

extensionsEnabled

Required. Boolean. If true extensions are allowed to run on the server. If false all extentions are disabled on the server.

blocklist

(Optional) Array. A list of domains that are not allowed to serve extensions to the Tableau Server. Domains are in the form of https://blocked_example.com

(Optional) String. The URL of the extension you want to from the server.

#### cURL Request Example `curl --location --request PUT "http://MY-SERVER/api/3.29/settings/extensions" --header "Content-Type: application/xml" --header "X-Tableau-Auth: YqB9_MHoTHO26HGsFBFEBg|bQDOIH4MsqFGvUDYTrRYh633vrZHBt6d|a946d998-2ead-4894-bb50-1054a91dcab3" --data "truehttps://test.com "` #### Response Code 200 #### Response Body Copy ``` true https://test.com ``` Copy ``` { "extensionsServerSettings": { "extensionsGloballyEnabled": "true", "blockList": "https://test.com" }} ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403000	Non-admin access forbidden	The client attempted to access an API method while signed in as a non-administrator user.
404	404000	Bad Request	The requested resource could not be found.
500	500000	Internal Server Error	The request could not be completed.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Tableau extensions site settings Updates the settings for extensions of a site. **Version:** Available in API 3.21 (Tableau Cloud June 2023 / Tableau Server 2023.3) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** This method can only be called by users with site or server administrator. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** tableau:extensions\_site\_settings:update - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/sites/site-luid/settings/extensions #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.

#### Request Body Copy ``` true false http://localhost:9123/Dynamic.html true true true true true false ``` Copy ``` { "extensionsSiteSettings": { "extensionsEnabled": true, "useDefaultSetting": false, "safeList": [ { "url": "http://localhost:9123/Dynamic.html", "fullDataAllowed": true, "promptNeeded": true } ], "allowTrusted": true, "includeSandboxed": true, "includeTableauBuilt": true, "includePartnerBuilt": false } } ``` #### Request Attributes

`extensionsEnabled`	Required. Boolean. If true, extensions are allowed to run on the site. If false, no extensions are aloowed to run on the site even if their URL is in the site safelist.
`useDefaultSetting`	(Optional) Boolean. If extensions are enabled on the server, the default settings allow extensions to run on a site, provided the extension is not specifically blocked on the server.
`safeList url`	(Optional) Array. The list of URLs of the extensions allow to run on the site. Regular expressions are supported. An extension permissions to run an a site are also dependent on the domain of the URL not being present on the server blocklist, and server and site extension enablement being `true`. Note that updating the safelist replaces the existing list with the new list. If you want to add a URL to the existing list, you must also include the existing URLs in the new list.
`safeList fullDataAllowed`	(Optional) Boolean. Set to true to allow the extension full access to the underlying data. By default, when you add an extension to the safe list, the extension only has access to the summary (or aggregated) data. Many extensions require full data access to function properly.
`safeList promptNeeded`	(Optional) Boolean. The prompt tells users details about the extension and whether the extension has access to full data. Set to true to give users the ability to allow or deny the extension from running. Set to false to hide this prompt from users, allowing the extension to run immediately.
`allowTrusted`	(Optional) Boolean. If `true`, specific categories of extensions (sandboxed, Tableau-built, or partner-built) are allowed to run by default on the site. If `false`, no extensions are allowed unless they are explicitly added to the safeList.
`includeSandboxed`	(Optional) Boolean. Valid only if `allowTrusted` is `true`. When true, sandboxed extensions are allowed to run by default. Sandboxed extensions run in a protected environment and cannot access other resources or data on the web.
`includeTableauBuilt`	(Optional) Boolean. Valid only if `allowTrusted` is `true`. When true, extensions built by Tableau are allowed to run by default.
`includePartnerBuilt`	(Optional) Boolean. Valid only if `allowTrusted` is `true`. When true, extensions built by Tableau's trusted partners are allowed to run by default.

#### cURL Request Example `curl --location --request PUT http://MY-SERVER/api/3.29/sites/a946d998-2ead-4894-bb50-1054a91dcab3/settings/extensions " --header "Content-Type: application/xml" --header "X-Tableau-Auth: YqB9_MHoTHO26HGsFBFEBg|bQDOIH4MsqFGvUDYTrRYh633vrZHBt6d|a946d998-2ead-4894-bb50-1054a91dcab3" --data "truefalsehttp://localhost:9123/Dynamic.htmltruetruetruetruetruefalse"` #### Response Code 200 #### Response Body Copy ``` true false http://localhost:9123/Dynamic.html true true true true true false ``` Copy ``` { "extensionsSiteSettings": { "extensionsEnabled": "true", "useDefaultSetting": "false", "safeList": [ { "url": "http://localhost:9123/Dynamic.html", "fullDataAllowed": true, "promptNeeded": true } ], "allowTrusted": true, "includeSandboxed": true, "includeTableauBuilt": true, "includePartnerBuilt": false } }} ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403000	Non-admin access forbidden	The client attempted to access an API method while signed in as a non-administrator user.
404	404000	Site Not Found	The site ID in the URI doesn't correspond to an existing site.
500	500000	Internal Server Error	The request could not be completed.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Tableau MCP Settings for Site Updates the current list of Tableau MCP settings for a specified site. **Version**: Available in API 3.29 (Tableau Cloud June 2026 / Server 2026.2) and later. **License**: No additional license required. **Permissions**: Server administrators and site administrators. **Access Scope**: `tableau:mcp_site_settings:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). For more information about configuring the Tableau MCP settings for a site, see [Site settings for Tableau MCP](https://tableau.github.io/tableau-mcp/docs/configuration/mcp-config/site-settings). #### URI PUT /api/api-version/sites/site-id/settings/mcp #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site.

#### Request Body ``` mcp-settings-key mcp-settings-value mcp-settings-key mcp-settings-key mcp-settings-value ``` ``` { "mcpSiteSettings": { "settings": [ { "key": "mcp-settings-key", "value": "mcp-settings-value" }, { "key": "mcp-settings-key" }, { "key": "mcp-settings-key", "value": "mcp-settings-value" } ] } } ``` #### Attribute Values

key	(Required) String. Specifies which setting to add, modify, or remove.
value	(Optional) String. Provides the value associated with the key. If this property is omitted, then the associated key will be removed from the current Tableau MCP settings for the given site.

#### Response Code 200 #### Response Body ``` INCLUDE_TOOLS datasource,search-content INCLUDE_TAGS sales,marketing,reviews DISABLE_METADATA_API_REQUESTS true MAX_RESULT_LIMITS query-datasource:1000 ``` ``` { "mcpSiteSettings": { "settings": [ { "key": "INCLUDE_TOOLS", "value": "datasource,search-content" }, { "key": "INCLUDE_TAGS", "value": "sales,marketing,reviews" }, { "key": "DISABLE_METADATA_API_REQUESTS", "value": "true" }, { "key": "MAX_RESULT_LIMITS", "value": "query-datasource:1000" } ] } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	409004	Invalid parameter	The mcpSiteSettings entity is empty; the settings key is null, missing, or invalid; or site LUID format is invalid.
401	401002	Invalid authentication credentials	Missing or invalid authentication credentials.
401	403001	Missing authentication token	Authentication token not provided.
403	403000	Insufficient permissions	User isn't an administrator
403	403010	Site mismatch	Authenticated user's site does not match the site LUID in the request.
403	403157	Feature disabled	Feature not enabled.
403	N/A	Insufficient OAuth scope	The user lacks the required OAuth scope.
404	404000	Site not found	A site with the specified LUID does not exist.
500	500000	Internal server error	Unknown server error.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update User Modifies information about the specified user. **Tableau Server** If Tableau Server is configured to use local authentication, you can update the user's name, email address, password, or site role. If Tableau Server is configured to use Active Directory for authentication, you can change the user's display name (full name), email address, and site role. However, if you synchronize the user with Active Directory, the display name and email address will be overwritten with the information that's in Active Directory. **Tableau Cloud** For Tableau Cloud, you can update the site role for a user, but you cannot update or change a user's password, user name (email address), or full name. #### URI PUT /api/api-version/sites/site-id/users/user-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the user.
user-id	The ID of the user to update.

#### Request Body ``` ``` ``` { "user": { "fullName":"new-full-name", "email":"new-email", "password":"new-password", "siteRole":"new-site-role", "authSetting":"new-auth-setting", "identityPoolName":"identity-pool-name", "idpConfigurationId":"idp-configuration-id", "language":"language", "locale":"locale" } } ``` #### Attribute Values Any combination of the elements inside the element is valid. Only those elements present will result in updates to their values for the user. If no elements are present, the update will not take effect.

new-full-name	(Optional) The new name for the user. Users can change names without affecting the groups they belong to. Tableau Server only. Not available in Tableau Cloud.
new-email	(Optional) The new email address for the for the Tableau Server user. Starting in API 3.26 (July 2025), the email address where the Tableau Cloud user can receive notifications. If no value is provided, Tableau Cloud uses the `username` value to send notifications to.
new-password	(Optional) The new password for the user. Tableau Server only. Not available in Tableau Cloud.
new-site-role	The new site role to assign to the user. You can assign the following roles: Creator, Explorer, ExplorerCanPublish, ServerAdministrator, SiteAdministratorExplorer, SiteAdministratorCreator, Unlicensed, or Viewer. Note: Only a user in the ServerAdministrator site role can use the REST API to add or remove another user from the ServerAdministrator site role. Users in the ServerAdministrator site role can only be moved to the Creator site role if one or more Creator licenses have been activated on the server; otherwise these users can only be moved to the Publisher site role. This method only supports the ServerAdministrator site role in API 2.8 and later.
new-auth-setting	(Optional) The authentication type for the user. Tableau Server The authSetting attribute only applies when updating users on sites with site-specific SAML-enabled settings. Tableau Cloud The ability to create and enable multiple authentication methods simultaneously was introduced in API 3.25 (January 2025). As a result of this capability, consider the following: For Tableau with MFA (or Tableau) authentication: To assign Tableau with MFA authentication (or Tableau authentication if still available for your site), you can use the authSetting or idpConfigurationId attribute, but not both. For SAML and OIDC-based authentication: For new configurations: To assign SAML or OIDC-based authentication, whose configurations were created during or after January 2025, you must use the idpConfigurationId attribute for assigning user authentication. Skip to idp-configuration-id. For existing configurations: To assign SAML and OIDC-based authentication, whose configurations that Tableau has automatically prefixed with "Initial" (such as "Initial SAML," "Initial Google," "Initial OIDC," or "Initial Salesforce"), you can continue to use the authSetting attribute for assigning user authentication. Alternatively, you can use the idpConfigurationId attribute for assigning user authentication. Do not use both. Notes: In cases where both attributes are supported, you can use the authSetting attribute or the idpConfigurationId attribute, but not both. If neither authSetting nor idpConfigurationId attribute is specified, then `TableauIdWithMFA` (or in some cases `ServerDefault` if that option is still available for your site) is the authentication assigned to the user. If you see "Unspecified" as the authentication method for the user in Tableau Cloud or if the user is unable to sign in, use the idpConfigurationId attribute instead. For more information, see When adding users to Tableau Cloud via Rest API, the user's authentication method is listed as "Unspecified" and the user gets error "Remote IdP entity descriptor is not configured" on login attempt knowledge article or skip to idp-configuration-id. You can assign the following values for the authSetting attribute: `SAML` - The user signs in using the identity provider (IdP) configured for the site. For Tableau Cloud configuration, see Enable SAML Authentication on a Site. For Tableau Server, see Configure Site-Specific SAML. `OpenID` - Tableau Cloud only: The user signs in using Google, Salesforce or OpenID Connect provider credentials. `OpenID` corresponds to Google, Salesforce, or OIDC authentication configuration in Tableau Cloud authentication settings. `TableauIDWithMFA` - Tableau Cloud only: The user signs in using a combination of TableauID credentials and a registered verification method. For more information, see About multi-factor authentication and Tableau Cloud. `ServerDefault` - The user signs in using the default authentication method that's set for the server. For Tableau Cloud, if Tableau hasn't updated your site to require Tableau with MFA yet, you can continue to use this authentication type on a temporary basis. The `ServerDefault` value corresponds to TableauID in authentication settings. For Tableau Server, the SAML Server help page describes default authentication options.
identity-pool-name	(Optional, Tableau Server only) When identity pools are configured, the name of the identity pool. Starting in API 3.19, include the identity pool name when identity pools are configured and you need to add a user to an identity pool that uses the local identity store and OIDC authentication. For more information, see Identity Pools Methods.
idp-configuration-id	(Optional, Tableau Cloud only) The configuration to assign for user authentication. Added in API 3.25 (January 2025). To find the idpConfigurationId attribute value, use the List Authentication Configurations for Site method. Notes: In cases where both attributes are supported, you can use the idpConfigurationId attribute or the authSetting attribute, but not both. If neither idpConfigurationId nor authSetting attribute is specified, then `TableauIdWithMFA` (or in some cases `ServerDefault` if that option is still available for your site) is the authentication assigned to the user.
language	(Optional, Tableau Cloud only) Language of the user. Starting in API 3.28 (March 2026), you can set the user's default language in Tableau Cloud to one of the supported languages (ISO 639-1). You can assign one of the following values: de, en_GB, en, es, fr_CA, fr, it, nl, pt, sv, th, ja, zh, zh_TW, or ko.
locale	(Optional, Tableau Cloud only) Locale of the user. Starting in API 3.28 (March 2026), you can set the user's default locale to one of the supported locales. You can assign one of the following values: ar_SA, ar_AE, ar_BH, ar_DZ, ar_EG, ar_IQ, ar_JO, ar_KW, ar_LB, ar_LY, ar_MA, ar_OM, ar_QA, ar_SD, ar_SY, ar_TN, ar_YE, be_BY, bg_BG, ca_ES, cs_CZ, da_DK, de_DE, de_AT, de_CH, de_LU, el_GR, el_CY, en_US, en_AU, en_CA, en_GB, en_IE, en_IN, en_MT, en_NZ, en_PH, en_SG, en_ZA, es_ES, es_AR, es_BO, es_CL, es_CO, es_CR, es_DO, es_EC, es_GT, es_HN, es_MX, es_NI, es_PA, es_PE, es_PR, es_PY, es_SV, es_US, es_UY, es_VE, et_EE, fi_FI, fr_FR, fr_BE, fr_CH, fr_LU, fr_CA, ga_IE, he_IL, hi_IN, hr_HR, hu_HU, id_ID, is_IS, it_IT, it_CH, ja_JP, ko_KR, lt_LT, lv_LV, mk_MK, ms_MY, mt_MT, nl_NL, nl_BE, no_NO, pl_PL, pt_BR, pt_PT, ro_RO, ru_RU, sk_SK, sl_SI, sq_AL, sr_RS, sr_BA, sr_ME, sv_SE, th_TH, tr_TR, uk_UA, vi_VN, zh_CN, zh_HK, zh_SG, or zh_TW.

#### Permissions This method can only be called by server administrators or site administrators. In addition, site administrators have some limitations in what changes they can make to users: - Site administrators cannot set the fullName value. - On Tableau Server, site administrators can change the email and password values only if the caller is a site administrator for all sites that the user is a member of. On Tableau Cloud, you cannot change a user's email or password. - Site administrators can change the siteRole value only if the site is configured to allow site administrators to add and remove site users. Site administrators on Tableau Cloud can change the siteRole value because they have permission to add and remove site users. Starting in API 3.26 (July 2025), site administrators can update a user's email address that is different from the user's username. This email address is for receiving notifications only. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:users:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400000	Invalid email address	The email attribute does not contain a valid email address.
400	400003	Bad request	The user authentication setting `ServerDefault` is not supported for you site. Try again using `TableauIDWithMFA` instead.
400	400012	Bad request	The user cannot be assigned the Unlicensed role because they are still a member of a group that has a minimum site role set.
400	400217	Unsupported language	The specified language is not valid or not supported.
400	400218	Unsupported locale	The specified locale is not valid or not supported.
403	403009	Licensing update on self forbidden	A user cannot update their own licensing role.
403	403009	Guest update forbidden	The Guest user is a special user and cannot be updated.
400	400013	Invalid site role	The value of the siteRole attribute must be Creator, Explorer, ExplorerCanPublish, ServerAdministrator, SiteAdministratorExplorer, SiteAdministratorCreator, Unlicensed, or Viewer.
403	403193	Forbidden	A non-administrator user called this method or doesn't have permissions to update language for the user.
403	403194	Forbidden	A non-administrator user called this method or doesn't have permissions to update locale for the user.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user.
405	405000	Invalid request method	Request type was not PUT.
409	409000	User conflict	The user with the specified name is already registered on the site in the same domain.
409	409014	Licensing conflict	The request is attempting to update the user to a licensing role that has insufficient capacity.
500	500109	Internal language error	The language request could not be completed.
500	500110	Internal locale error	The locale request could not be completed.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update User Notification Preferences Updates user notifications preferences to enabled or disabled on the specified site. For more information about notifications, see [Manage Your Account Settings](https://help.tableau.com/current/pro/desktop/en-us/useracct.htm#change-notification-settings). #### URI PATCH /api/api\_version/sites/site-id/settings/notifications #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the user.

#### Request Body ``` ``` #### Attribute Values

enabled-flag	(Required, boolean) If `true`, the specified site notifications will be on. If `false`, the specified site notifications will be off.
channel	(Required, string) Specifies the channel that the notification preferences are to be updated (turned on or off). Valid channels are: email, in_app, and slack.
notification-type	Specifies the notification type for which the notification preferences are to be updated (turned on or off). Valid notification types are: comments, webhooks, prepflow, share, dataalerts,and extractrefresh.

#### Permissions This method can only be called by a Server Administrator, a Site Administrator Creator, or a Site Administrator Explorer. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:user_notifications:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code - 200: The request was successful - 207: One or more of the updates in the request resulted in an error. See details in the the response body. #### Response Body ``` Success Success ``` #### Version Version 3.15 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403004	Invalid Permissions	Invalid permission to update site user notification settings.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	The request type was not PATCH.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example response ``` Success Success ``` ## Update Virtual Connection Updates a virtual connection's name, owner, project, or certification status. **Version:** Available in API 3.23 (Tableau Cloud June 2024 / Tableau Server 2024.2) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** Requires [Tableau Data Management](https://help.tableau.com/current/online/en-us/dm_overview.htm). **Permissions:** You must have the Overwrite permission for the virtual connection and your site role must be at least Creator. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:virtual\_connections:update - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/sites/site-id/virtualconnections/virtualconnection-id #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID for the site.
virtualconnection-id	The LUID for the virtual connection.

#### Request Body _(Use the icon in the top right corner to copy the text.)_ ``` ``` _(Use the icon in the top right corner to copy the text.)_ ``` { "virtualConnection": { "name": "virtualconnection-name", "isCertified": "certified-flag", "certificationNote": "certification-message", "project": { "id": "project-id" }, "owner": { "id": "owner-id" } } } ``` #### Request Attributes

virtualconnection-name	The name of the virtual connection.
certification-flag	Boolean. If true, the virtual connection is certified. If false, it won't.
certification-message	The certification label's message.
project-id	The LUID of the project the virtual connection is located in.
owner-id	The LUID of the user that owns the virtual connection.

Request attributes that are different from the virtual connection's current properties result in updating the virtual connection. #### cURL Request Example _(Use the icon in the top right corner to copy the text.)_ ``` curl --request PUT 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3' --data @data.xml ``` **Contents of data.xml.** _(Use the icon in the top right corner to copy the text.)_ ``` ``` #### Response Code 200 #### Response Body ``` ``` ``` { "virtualConnection": { "project": { "id": "project-id" }, "owner": { "id": "owner-id" }, "id": "virtualconnection-id", "isCertified": certified-flag, "name": "virtualconnection-id" } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400203	Generic error	An unknown error occurred.
403	403004	User not authorized to change virtual connection	Check to make sure the user has the required permissions.
403	403176	User not authorized to change virtual connection's owner	Check to make sure the user has the required permissions.
403	403177	User not authorized to move assets into the target project.	Check to make sure the user has the required permissions.
403	403178	User not authorized to move the virtual connection	Check to make sure the user has the required permissions.
404	404049	Virtual connection not found	Check the virtual connection LUID.
409	409124	A virtual connection with the chosen name already exists in the project.	Try a different virtual connection name.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Virtual Connection Database Connections Updates the server address, port, username, or password for the specified database connection in a virtual connection. **Version:** Available in API 3.18 (Tableau Cloud December 2022 / Server 2023.1) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** Requires [Tableau Data Management](https://help.tableau.com/current/online/en-us/dm_overview.htm). **Permissions:** Users who are administrators or have the site role of Creator or higher can update a database connection. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope**: tableau:virtualconnectionconnections:update - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/sites/site-id/virtualconnections/virtual-connection-id/connections/connection-id/modify #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID for the site that contains the virtual connection.
virtual-connection-id	The LUID for the virtual connection that includes the database connections.
connection-id	The ID of the database connection. To determine what connections are in a virtual connection, call List Virtual Connection Database Connections.

#### Request Body ```

``` ``` { "connection": { "serverAddress": "server-address", "serverPort": "port-number", "userName": "test", "password": "password" }} ``` #### Request Attributes

`connection serverAddress`	The new server for the database connection.
`connection serverPort`	The new port for the database connection
`connection userName`	The new username for the database connection.
`connection password`	The new password for the database connection.

#### cURL Request Example `curl --location --request PUT "https://MY_SERVER/api/3.18/sites/a946d998-2ead-4894-bb50-1054a91dcab3/virtualconnections/26bc30d8-90d6-4af1-922d-ac285e7b08fb/connections/26bc30d8-90d6-4af1-922d-ac285e7b08fb"` #### Response Code 200 #### Response Body Copy ```

``` Copy ``` { "virtualConnectionConnections": { "connection": { "id": "connection-id", "serverAddress": "server-address", "serverPort": "port-number", "userName": "connection-user-name", "password": "password" } }} ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized	The authentication token provided in the request header was invalid or has expired.
403	403004	Operation unauthorized	The user isn’t authorized to perform the task.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Virtual Connection Now Runs an extract refresh on the specified virtual connection. This method identifies and refreshes only the tables in the virtual connection that are configured as extracts; live tables are ignored. No additional input is required from the caller. **Note:** This method will fail and result in an error if your Server Administrator has disabled the **RunNow** setting for the site. For more information, see [Tableau Server Settings](https://help.tableau.com/current/server/en-us/maintenance_set.htm). **Version**: Available in API 3.30 and later. **License**: Data Management, Enterprise, Server+, Cloud+, or Tableau+ Bundle. **Permissions**: Users who are not server administrators or site administrators can only refresh extracts for virtual connections if they own the virtual connection, or if they are the project leader for the project. **Access Scope**: `tableau:tasks:run` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI POST /api/api-version/sites/site-id/virtualconnections/virtualconnection-id/refresh #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The LUID for the site.
virtualconnection-id	The LUID for the virtual connection to refresh.

#### Request Body The request body is an empty tsRequest element. ``` ``` ``` {} ``` #### cURL Request Example _(Use the icon in the top right corner to copy the text.)_ ``` curl --request POST 'http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/virtualconnections/12ab34cd-56ef-78ab-90cd-12ef34ab56cd/refresh' --header 'Content-Type: application/xml' --header 'X-Tableau-Auth: HvZMqFFfQQmOM4L-AZNIQA|5fI6T54OPK1Gn1p4w0RtHv6EkojWRTwq|a946d998-2ead-4894-bb50-1054a91dcab3' --data '' ``` #### Response Code 202 #### Response Body ``` ``` ``` { "job": { "id": "job-id", "mode": "Asynchronous", "type": "RefreshExtract", "createdAt": "date-time", "extractRefreshJob": { "virtualConnection": { "id": "virtualconnection-id", "name": "virtualconnection-name" } } } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	403180	Full refresh not allowed.	A full refresh extract operation is not allowed for the virtual connection.
400	403181	Incremental refresh not allowed.	The request specified an incremental refresh, but an incremental refresh extract operation is not allowed for the virtual connection.
400	409090	No extract-eligible tables.	The virtual connection has no active revision or no extract-eligible tables. Live tables are not refreshed.
403	403199	User not authorized to refresh the virtual connection.	The user must have either the Manage Extract or the Allow Extract Refresh permission on the virtual connection.
403	409082	Run Now is disabled for the site.	Enable Run Now for the site, then try the request again.
404	404049	Virtual connection not found.	Check the virtual connection LUID.
405	405000	Method not allowed.	Direct virtual connection extract refresh is not enabled for this site.
409	409093	Operation already in queue.	An extract refresh job for the virtual connection is already in the queue.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Work Copy Elements Updates columns, field descriptions, or table descriptions on a work copy. Returns HTTP 200 when every element is updated. The success body omits the elements that succeeded. A column update may set at most one of `caption`, `type`, or `role`. An unknown `type` or `role` is HTTP 400 with error code `400008`. Setting more than one of those fields is HTTP 400 with no numeric sub-code. If any element fails, the HTTP status is the status of the first failure and the body lists only the failed elements. **Version**: Available in API 3.30 (Tableau Cloud October 2026 / Server 2026.3) and later. **License**: Data Management or Tableau+. **Permissions**: Users who are not server administrators or site administrators can call this method only if they have Connect, Write (save), and VizqlDataApiAccess (API Access) permissions for the data source that the work copy was created from (either explicitly or implicitly). **Access Scope**: `tableau:datasources:update` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/tds/sites/site-luid/workcopy/workcopy-luid #### URI Parameter Values

api-version	The version of the API to use. These TDS Edit methods are available in API 3.30 and later. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site in the URI. This handler does not bind the path variable — the service uses the authenticated user's site LUID (`authUser.getSiteLuid()`).
workcopy-luid	The LUID of the work copy. Must be a UUID (8-4-4-4-12 hexadecimal digits), matching `[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}`.

#### Request Body ``` Column Sales Total Sales FieldDescription Sales Total sales amount, revised. ``` ``` { "tdsElementList": [ { "elementType": "Column", "name": "Sales", "column": { "caption": "Total Sales" } }, { "elementType": "FieldDescription", "name": "Sales", "description": "Total sales amount, revised." } ] } ``` #### Attribute Values

tdsElementList[]	Required. Elements to update. Must contain at least one element. An empty or missing list is HTTP 400 with error code `400008`.
tdsElementList[].elementType	Optional. Element type sent to the TDS service. For this operation, use `Column`, `FieldDescription`, or `TableDescription`. Any other value is forwarded and reported as a per-element failure.
tdsElementList[].name	Required. Element name.
tdsElementList[].column	Used when `elementType` is `Column`. At most one of `caption`, `type`, and `role` may be set — setting more than one is HTTP 400 with no numeric sub-code. A column with none of them set is a no-op update.
tdsElementList[].column.caption	Optional. The caption to set.
tdsElementList[].column.role	Optional. An accepted `FieldRole` constant other than `FIELD_ROLE_UNKNOWN` or `UNRECOGNIZED` — either of those is rejected as HTTP 400 with error code `400008`.
tdsElementList[].column.type	Optional. An accepted `FieldType` constant other than `FIELD_TYPE_UNKNOWN` or `UNRECOGNIZED` — either of those is rejected as HTTP 400 with error code `400008`.
tdsElementList[].description	Used when `elementType` is `FieldDescription` or `TableDescription`. Description text to set. When `description` is null, the field is left unset so the TDS service can report a per-element failure instead of HTTP 500.

tdsElementResult[]	Failed elements only. Omitted on full success, including omitted rather than returned as an empty array.
tdsElementResult[].elementType	Required. Element type of the failed element, copied from the request.
tdsElementResult[].name	Required. Name of the failed element, copied from the request.
tdsElementResult[].status	Required. Failure status for this element.
tdsElementResult[].status.code	Required (within `status`). The translated HTTP status for this element (200, 400, 401, 403, 404, 409, 500, or 503). Not a Tableau 6-digit error sub-code.
tdsElementResult[].status.message	Optional. Error message from the TDS service.

#### Errors

HTTP status	`error` Code	Condition	Details
400	400008	Missing tdsElementList	`tdsElementList` is missing or empty. The list is required and must contain at least one element.
400	400008	Invalid column type or role	`type` or `role` is not an accepted field type or role. `FIELD_TYPE_UNKNOWN`, `FIELD_ROLE_UNKNOWN`, and `UNRECOGNIZED` are rejected. The accepted names are not in the staged sources.
400		Column update sets more than one field	A column update may set at most one of `caption`, `type`, or `role`.
400		Invalid work copy LUID	The work copy LUID in the URI is not a UUID (8-4-4-4-12 hexadecimal digits).
400		Per-element invalid argument	One or more elements were rejected as invalid. The body lists only the failed elements, and each `status.code` is the HTTP status 400.
400		Unmapped per-element gRPC status	The TDS service returned a status that maps to HTTP 400. The body lists only the failed elements.
401	401000 / 401002	Missing or invalid authentication	No authentication token provided, or token is expired or invalid.
401		Per-element unauthenticated	The TDS service rejected an element as unauthenticated. The body lists only the failed elements.
403	403004	Data Management Bundle not licensed	On Tableau Server the TDS Edit API requires a Data Management Bundle license. The call is rejected when that license is absent.
403	403004	Unable to resolve tenant	On Tableau Cloud the subscription could not be checked because the tenant id for the site could not be retrieved.
403	403004	No cloud entitlements	On Tableau Cloud no entitlements were found for the tenant. The TDS Edit API requires a Tableau+ subscription.
403	403004	Subscription not entitled	On Tableau Cloud the site edition is not Tableau+. The TDS Edit API requires a Tableau+ subscription.
403		Per-element permission denied	The TDS service rejected an element because permission was denied. The body lists only the failed elements.
404		Per-element not found	One or more elements were not found. The body lists only the failed elements. This is not error code 404065, which the read methods return for a missing named element.
405	405000	Method not allowed	The HTTP method is not supported for this resource.
409		Per-element already exists	One or more elements already exist. The body lists only the failed elements.
429	429000	Rate limit exceeded	Too many requests sent in a given time period.
500		Per-element internal error	The TDS service failed while editing an element. The body lists only the failed elements.
503		Per-element unavailable	The TDS service was unavailable while editing an element. The body lists only the failed elements.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Workbook Modifies an existing workbook, allowing you to change the owner or project that the workbook belongs to and whether the workbook shows views in tabs. Updated workbooks can optionally be marked to appear in the recently viewed list. You can manage [Data Freshness Policy](https://help.tableau.com/current/online/en-us/data_freshness_policy.htm) for a workbook, and enable [View Acceleration](https://help.tableau.com/current/online/en-us/data_acceleration.htm) for views in a workbook. **Version:** Available in API 2.0 (Tableau Cloud and later). Data acceleration and data freshness policy setting update are added in API 3.22 (Tableau Cloud February 2024 / Server 2024.2). _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** Users who are Tableau administrators can change a workbook's owner. Users who are not server administrators can update a workbook only if they have **Write** permission for the workbook and for the project. Tableau server and site administrators can change the `dataAccelerationConfig accelerationEnable` setting for a workbook. Workbook owners can change the setting if the [site is configured to enable acceleration by owners](https://help.tableau.com/current/server/en-us/data_acceleration.htm). Both administrators and workbook owners can change dataFreshnessPolicy settings. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** tableau:workbooks:update - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/sites/site-id/workbooks/workbook-id PUT /api/api-version/sites/site-id/workbooks/workbook-id?includeViewAccelerationStatus=include-view-acceleration-status-flag #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook.
workbook-id	The ID of the workbook to update.
include-view-acceleration-status-flag	Query parameter is optional. Boolean: If `includeViewAccelerationStatus=true` then the list of views and the acceleration status of each view will be returned.

#### Request Body Copy ``` ``` Copy ``` { "workbook": { "name": "Finance", "showTabs": "false", "recentlyViewed": "false", "encryptExtracts": "false", "description": "The finance workbook.", "project": { "id": "3d6e8174-8cdf-43ec-94dd-0a1fd3662e47" }, "owner": { "id": "ca6b9ee-1d85-465b-abc2-f200ae2443b9" }, "views": { "view": { "id": "22e48174-8cdf-43ec-94dd-0a1fd366gh78" } }, "dataAccelerationConfig": { "accelerationEnabled": "false", "accelerateNow": "false" }, "dataFreshnessPolicy": { "option": "FreshAt", "freshAtSchedule": { "frequency": "weekly", "time": "08:15:00", "timezone": "America/Los_Angeles", "intervals": { "interval": { "weekDay": "Monday" } } } } }} ``` Notes on [Data Freshness Policy](https://help.tableau.com/current/online/en-us/data_freshness_policy.htm) and [View Acceleration](https://help.tableau.com/current/server/en-us/data_acceleration.htm): - Data Freshness Policy and View Acceleration are independent features. - If a policy is set without view acceleration for a workbook, then only [query caching](https://help.tableau.com/current/online/en-us/data_freshness_policy.htm#understand-data-freshness-for-query-caches) for the workbook will be affected by the policy. - If a workbook has a data freshness policy configured, then updating the workbook to turn on view acceleration will not impact the policy unless the update explicitly changes that. - If a workbook has accelerated views enabled, but does not have a data freshness policy explicitly set for it, data will be refreshed on the site default cadence of every 12 hours. - On Tableau Cloud, view acceleration is limited to 12 refreshes per day, per view. If data freshness policy for a workbook is set to refresh data more frequently than every 2 hours, refreshes for a view after the 12th one will not trigger the computation that accelerates that view until the first refresh of the next day. - The preceding example shows the `freshAt` data freshness policy option. The `freshEvery` option is illustrated in the following Attribute Values section. #### Attribute Values

workbook name (Optional) New name for the workbook being updated.

workbook showTabs (Optional) Specify true to have the updated workbook show views in tabs; otherwise, false. The default is false.

workbook recentlyViewed (Optional) Set this value to true to have the updated workbook show in the site's recently viewed list. The default is false. Once the flag is set to true, setting it to false will have no effect. When enough views or workbooks have populated the recently viewed list, the oldest item will fall off the list and its recently-viewed-flag will revert to false.

workbook encryptExtracts (Optional) true to encrypt the extracts or false to not encrypt extracts. For more information, see Extract and Encryption Methods.

workbook description (Optional) Starting in API 3.20, the new description for the updated workbook.

project id (Optional) The LUID of a project to assign the workbook to.

owner id (Optional) The LUID of a user to assign the workbook to as owner.

dataAccelerationConfig accelerationEnable (Optional) Boolean: If true, accelerate the specified view(s). Default is false. Tableau's View Acceleration feature and Data Acceleration-related APIs were retired in Tableau Cloud in June 2026 and in Tableau Server version 2026.2.

dataAccelerationConfig accelerateNow

(Optional) Boolean: If true, make view acceleration available as soon as possible. Default is false. Tableau's View Acceleration feature and Data Acceleration-related APIs were retired in Tableau Cloud in June 2026 and in Tableau Server version 2026.2.

Note, the view object in the response (visible by using the ?includeViewAccelerationStatus=true query parameter) contains the accelerationStatus attribute, which can have the following values:

Off - Accelerate now is not enabled.
Pending - Accelerate now is enabled, but backgrounder processes are still running to make the acceleration available.
On Acceleration is enabled.

view id (Optional) LUID: The LUID of a view being accelerated. If no views are listed in the request then all views in the workbook will be accelerated.

dataFreshnessPolicy option

(Optional) Enum: The data freshness policy mode for scheduling refreshment of the workbook data specified in the request. A valid value is one of:

SiteDefault - Use the default scheduling policy: refresh the data every 12 hours).
AlwaysLive - Refresh as the data changes.
FreshAt - Define a detailed cadence for refreshing the data.
FreshEvery- Define an interval between data refreshes.

freshAtSchedule frequency

(Optional) Enum: The interval of workbook data refresh. A valid value is one of:

Day
Week
Month

freshAtSchedule time (Optional) Time in HH:MM:SS: The time of day that workbook data will be refreshed, in increment of 15 minutes. Minutes must end in 00, 15, 30, or 45. for instance time="10:30:00".

freshAtSchedule timeZone (Optional) Timezone string in IANA format: The timezone of the fresh at schedule time. For instance, timezone="America/Los_Angeles". If no timezone is provided, then the local timezone of the Tableau server is used."

freshAtSchedule intervals interval

A value that specifies the interval between refreshes of view acceleration data. The value you specify here depends on the value specified in freshAtSchedule frequency.

Day

If the schedule frequency is Daily, no interval is specified. Any information specified in the <intervals> element is ignored.

Week

The interval expression is weekDay="weekday", where weekday is Sunday, Monday, Tuesday, Thursday, Friday, or specify multiple <interval> elements to indicate that scheduled jobs should run on multiple days during the week.

Month

The interval expression is monthDay="day", where day is either the day of the month (1, 2, etc.) or LastDay.

freshEverySchedule frequency

(Optional) Enum: The time unit used for the cadence of view acceleration data refreshes. The count of the specified unit that occurs between refreshes is determined by freshEverySchedule value. A valid value is one of:

Minutes
Hours
Days
Weeks

freshEverySchedule value (Optional) Integer: The quantity of frequency units between view acceleration data refreshes. For instance, to specify a refresh every 4 hours, the dataFreshnessPolicy would look like:

XML JSON

Copy

<dataFreshnessPolicy option="FreshEvery">
  <freshEverySchedule 
  frequency="hours" 
  value="4" />
  </dataFreshnessPolicy>

Copy

"dataFreshnessPolicy": {
  "option": "FreshEvery",
  "freshEverySchedule": {
  "frequency": "hours",
  "value": 4"
  }
}

With the exception of `dataFreshnessPolicy options`, any combination of the elements inside the element is valid. Only the attributes and child elements that are included result in updates to the data source. If no attributes or nested elements are included, no update is made. The `dataFreshnessPolicy option` can only be one of listed options, and the elements of a specified option are required for that option to be updated. If the element is included, the id attribute must be included; other attributes of the element are ignored. If the element is included, the id attribute must be included; other attributes of the element are ignored. #### cURL Example `curl --location --request PUT "https://myServer/api/3.22/sites/d76ee955-ccc7-4333-ab3b-25ad2f8b1aa8/workbooks/c75aaa17-727f-48f8-80d1-1e66c30497c5" \ --header "Content-Type: application/xml" \ --header "X-Tableau-Auth: vZg2soQ2TuiULoJgZ60h_A|JIfSgwAzBQ2QfSVS1PSsHvD9uynKLzWz|d76ee955-ccc7-4333-ab3b-25ad2f8b1aa8" \ --header "Cookie: AWSALBAPP-0=AAAAAAAAAADyQT+tw75WkCZpVc/icDu7+3QFC+j4W5jpddfTbd8p8kxx5cx5slxbi2jSYvaAa0RBfxXvQ3tTjfZGHnt3ORMP5y79bEWR/lBKRMbJpRVYfI4jV32tGCld6NPtpgwYogFxZBo=; AWSALBAPP-1=_remove_; AWSALBAPP-2=_remove_; AWSALBAPP-3=_remove_; hid=uw2a-hap01" \ --data " "` #### Response Code 200 #### Response Body Copy ``` ``` Copy ``` { "workbook": { "name": "Finance", "showTabs": "false", "recentlyViewed": "false", "encryptExtracts": "false", "description": "The finance workbook.", "project": { "id": "3d6e8174-8cdf-43ec-94dd-0a1fd3662e47" }, "owner": { "id": "ca6b9ee-1d85-465b-abc2-f200ae2443b9" }, "views": { "view": { "id": "22e48174-8cdf-43ec-94dd-0a1fd366gh78" } }, "dataAccelerationConfig": { "accelerationEnabled": "false", "accelerateNow": "false" }, "dataFreshnessPolicy": { "option": "FreshAt", "freshAtSchedule": { "frequency": "weekly", "time": "08:15:00", "timezone": "America/Los_Angeles", "intervals": { "interval": { "day": "Monday" } } } } }} ``` The datetime-created and datetime-updated attribute values are returned in UTC format (YYYY-MM-DDTHH:MM:SSZ). A response for the `dataFreshnessPolicy` segment with the `FreshEvery` option configured for weekly refreshes, would look like:

XML JSON

Copy

<dataFreshnessPolicy option="FreshEvery">
  <freshEverySchedule 
  frequency="Weeks" 
  value="1" />
  </dataFreshnessPolicy>

Copy

"dataFreshnessPolicy": {
  "option": "FreshEvery",
  "freshEverySchedule": {
  "frequency": "Weeks",
  "value": 1"
  }
}

#### Version Version 2.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400036	Bad request	View acceleration is enabled, but the workbook loads too quickly to make use of it, or the view has never been accessed by a user.
403	403025	Project update forbidden	A non-administrator user tried to change the workbook project, but the caller doesn't have Write permission for the target project.
403	403027	Owner update forbidden	A non-administrator user tried to change the workbook owner.
403	403027	Update forbidden	A non-administrator user tried to change the workbook, but the caller doesn't have Write permission for the workbook.
403	403004	Update forbidden	A non-administrative user tried to update the workbook, but does not have permissions to publish the updated workbook to the project.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	Owner not found	The owner ID in the request body doesn't correspond to an existing user.
404	404005	Project not found	The project ID in the URI doesn't match the project ID provided in the request body.
404	404006	Workbook not found	The workbook ID in the URI doesn't correspond to an existing workbook.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Workbook Connection Updates the server address, port, authentication type, username, or password for the specified workbook connection. If the workbook contains multiple connections to the same data source type, all the connections are updated. To update specific connections in a workbook containing multiple connections, see [Update Data Source Connections](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooks_and_views.htm#update_workbook_connections). **Version:**Available in API 2.0 (Tableau Cloud and later). **License:** No additional license required. **Permissions:** Users who are not server administrators or site administrators can update permissions only for a workbook for which they have the **Write** capability (either explicitly or implicitly). Only users with administrator permissions can enable or disable query tagging. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **Access Scope**: `tableau:workbooks:update` - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/sites/site-id/workbooks/workbook-id/connections/connection-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook.
workbook-id	The ID of the workbook to update.
connection-id	The ID of the connection to update.

#### Request Body ``` ``` ``` { "connection": { "serverAddress": "server-address", "serverPort": "port", "authenticationType": "auth-type", "userName": "connection-username", "password": "connection-password", "embedPassword": "embed-password", "queryTaggingEnabled": "query-tagging-enabled" } } ``` #### Attribute Values Any combination of the attributes inside the element is valid. If no attributes are included, no update is made.

serverAddress	The new server for the connection.
port	The new port for the connection.
authenticationType	Added in version 3.27. *The new authentication type for the connection. Standard values: `auth-user-pass`: username and password `oauth` `auth-keypair`: keypair authentication Connector-specific values: `sqlserver`: SQL Server username and password `Azure AD Password` `AD Service Principal` `username-password`: Several connectors use this value. For example, SAP HANA, SAP Sybase ASE, SAP NetWeaver Business Warehouse (BW), Denodo, and Salesforce. If you are unsure of the value for authenticationType for the target connection, there are two ways to determine the value. First, if you have a data source or workbook that is currently using the target authentication type, you can query for it using the REST API methods Query Datasource Connections or Query Workbook Connections, which returns the authentication type string in the response. Alternatively, you can inspect the `<connection>` element in the XML of a workbook or data source which is available locally. Look for the value of the `authentication` attribute of the connection.
userName	The new username for the connection.
password	The new password for the connection.
embedPassword	`True` to embed the password; otherwise, `False`.
queryTaggingEnabled	[!WARNING] Starting with API 3.23 (Tableau Cloud June 2024 / Server 2024.2), the `queryTaggingEnabled` attribute is deprecated, will no longer be supported, and may be retired in future releases. Instead, for Tableau Server, use TSM to enable query tagging for all content on a server by setting `native_api.UserInfoInGeneratedSQLEnabled` to `true`. For API 3.22 (Tableau Cloud February 2024 / Server 2024.1) or earlier: If `true`, query tagging is enabled. If `false`, query tagging is disabled. The default is `false`. For more information on query tagging, see Understand Workbook Impact on Your Database Using Query Tagging.

#### cURL Request Example ``` curl --location --request PUT "/api/api-version/sites/site-id/workbooks/workbook-id/connections/connection-id" \ --header "Content-Type: application/xml" \ --header "X-Tableau-Auth;" \ --data "{ 'connection': { 'serverAddress': 'server-address', 'serverPort': 'port', 'authenticationType': 'auth-type', 'userName': 'connection-username', 'password': 'connection-password', 'embedPassword': 'embed-password', 'queryTaggingEnabled': 'query-tagging-enabled' } }" ``` #### Response Code 200 #### Response Body ``` ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
403	403029	Update forbidden	A non-administrator user tried to update the workbook connection, but the caller doesn't have Write permission.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404006	Workbook not found	The workbook ID in the URI doesn't correspond to an existing workbook.
404	404020	Connection not found	The connection ID in the URI doesn't correspond to an existing connection.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Workbook Connections Updates the server address, port, authentication type, username, or password for one or more connections in a data source. To update all connections in a given data source with the same connection information, see [Update Workbook Connection](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooks_and_views.htm#update_workbook_connection). **Version**: Available in API 3.27 and later. **License**: No additional license required. **Permissions**: Users who are server administrators or site administrators can change the connection for a data source or enable [query tagging](https://help.tableau.com/current/pro/desktop/en-us/performance_tips.htm). Users who are not server administrators can only update a data source. If they have Write (save) permission for the data source and if they have write permission for the project. **Access Scope**: `tableau:datasources:update` - Access scope introduced in API 3.16 (Tableau Cloud June 2022 / Server 2022.3) For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/sites/site-id/workbooks/workbook-id/connections #### Path Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID of the site that contains the data source.
workbook-id	The ID of the workbook to update.

connectionLuids	An array of connection LUIDs in the workbook that you are updating.
serverAddress	The new server for the connection.
serverPort	The new port for the connection
authenticationType	*The new authentication type for the connection. Standard values: `auth-user-pass`: username and password `oauth` `auth-keypair`: keypair authentication Connector-specific values: `sqlserver`: SQL Server username and password `Azure AD Password` `AD Service Principal` `username-password`: Several connectors use this value. For example, SAP HANA, SAP Sybase ASE, SAP NetWeaver Business Warehouse (BW), Denodo, and Salesforce. If you are unsure of the value for authenticationType for the target connection, there are two ways to determine the value. First, if you have a data source or workbook that is currently using the target authentication type, you can query for it using the REST API methods Query Datasource Connections or Query Workbook Connections, which returns the authentication type string in the response. Alternatively, you can inspect the `<connection>` element in the XML of a workbook or data source which is available locally. Look for the value of the `authentication` attribute of the connection.
userName	The new username for the connection.
password	The new password for the connection.
embedPassword	`True` to embed the password; otherwise, `False`.
queryTaggingEnabled	[!WARNING] Starting with API 3.23 (Tableau Cloud June 2024 / Server 2024.2), the `queryTaggingEnabled` attribute is deprecated, will no longer be supported, and may be retired in future releases. Instead, for Tableau Server, use TSM to enable query tagging for all content on a server by setting `native_api.UserInfoInGeneratedSQLEnabled` to `true`. For API 3.22 (Tableau Cloud February 2024 / Server 2024.1) and earlier: If `true`, query tagging is enabled. If `false`, query tagging is disabled. The default is `false`. For more information on query tagging, see Understand Workbook Impact on Your Database Using Query Tagging.

#### cURL Request Example ``` curl --location --request PUT "/api/api-version/sites/site-id/workbooks/workbook-id/connections" \ --header "Content-Type: application/xml" \ --header "X-Tableau-Auth;" \ --data "{ 'connectionLuids': [ 'Luid1', 'Luid2' ], 'connection': { 'serverAddress': 'newAddress', 'serverPort': 'newPort', 'authenticationType': 'new Auth Type', 'userName': 'Jane Doe', 'password': 'xxxxxx', 'embedPassword': 'false', 'queryTaggingEnabled': 'false' } }" ``` #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:workbooks:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` ``` { "connection": { "id": "12ab34cd-56ef-78ab-90cd-12ef34ab56cd", "serverAddress": "database.example.com", "serverPort": "12345", "authenticationType": "new Auth Type", "userName": "jajohnson", "queryTaggingEnabled": "false" } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
403	403023	Update forbidden	A non-administrator user tried to update a data source, but the caller doesn't have Write permission.
403	403027	Owner update forbidden	A non-administrator user tried to change connection information, but the caller doesn't have Write permission.
403	403062	Unsupported operation	The data source contains multiple connections, but the URI did not include `/connections/connection-id` to indicate which connection should be updated.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404004	Data source not found	The data source ID in the URI doesn't correspond to an existing data source.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Workbook Now Refreshes the specified workbook. This method refreshes the specified workbook, with no need to associate the workbook refresh with a scheduled task. This method is the equivalent of selecting a workbook using the Tableau Server UI, and then selecting **Refresh Extracts** from the menu (also known as a "manual refresh"). **Note:** This method will fail and result in an error if your Server Administrator has disabled the **RunNow** setting for the site. For more information, see [Tableau Server Settings](https://help.tableau.com/current/server/en-us/maintenance_set.htm). #### URI POST /api/api-version/sites/site-id/workbooks/workbook-id/refresh #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook.
workbook-id	The ID of the workbook to refresh.

#### Request Body As of version 3.28, you can specify an incremental refresh on extracts by updating the request body as follows: ``` ``` #### Permissions Tableau Server users who are not server administrators or site administrators can only refresh workbooks if they own the workbook, or if they are the project leader for the project. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:tasks:run ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 202 #### Response Body ``` ``` #### Version Version 2.8 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401000	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403032	Update Forbidden	A non-administrator user attempted to query workbook views, but the caller doesn't have sufficient permissions.
403	403004	Update forbidden	A non-administrative user tried to update the workbook, but does not have permissions to publish the updated workbook to the project.
404	404000	Site not found	The site ID in the URI is unknown.
404	404006	Resource not found	The workbook ID in the URI is unknown.
405	405000	Invalid request method	Request type was not POST.
409	409093	Operation already in Queue	The extract refresh job is already in the queue.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/1edc53ac-e247-4870-9fd3-6fad0ce5f84d/workbooks/5de9cc53-b17d-45af-804d-49144b39f29f/refresh" -X POST -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -H "Content-Type: application/xml" –d @empty-tsrequest.xml"` **Content of empty-tsRequest.xml:** ``` ``` **Example response:** ``` ``` ## Update Workbook Thumbnail Images Updates a workbook's thumbnail images. The method adds a task to the backgrounder queue. Depending upon the length of the queue, the task might not run immediately. The method returns information about the backgrounder job responsible for running the task, including the `job id` that can be used with the [Query Job](#query_job) method. **Version**: Available in API 3.27 (Tableau Cloud December 2025 / Server 2025.3) and later. **License**: No additional license required. **Permissions**: Server administrators, site administrators, or workbook owner **Access Scope**: `tableau:tasks:run` - For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/sites/site-id/workbooks/workbook-id/refreshThumbnails #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the workbook.
workbook-id	The ID of the workbook.

#### Request Body None #### cURL Request Example ``` curl -X PUT "https://MY-SERVER/api/3.27/sites/12ab34cd-56ef-78ab-90cd-12ef34ab56cd/workbooks/08a7b6b5-b4ba-be3a-4d2d-1e9e59a8a7b6/refreshThumbnails" -H "X-Tableau-Auth: a1B2c3D4e5F6g7H8i9J0kL|a1B2c3D4e5F6g7H8i9J0kL1m2N3o4P5q|12345678-90ab-4cde-8f01-234567890abc" ``` #### Response Code 202 #### Response Body ``` ``` ``` { "job": { "thumbnailsRefreshJob": { "workbook": { "id": "workbook-id", "name": "workbook-name" } }, "id": "job-id", "mode": "Asynchronous", "type": "RefreshThumbnails", "createdAt": "date-time" } } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Generic error	An unknown error occurred. The content of the request body may be missing or incomplete, or may contain malformed XML.
403	403179	Permissions error	The user calling the method isn't a site administrator, server administrator, or owner of the workbook.
404	404006	Workbook not found	The workbook LUID is invalid, or the user doesn't have permission to read the workbook.
500	500000	Internal server error	The server was unable to create the job.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Upload Data Source Encrypted Keychain Uploads the encrypted version of the embedded credentials. This method will only work if the credentials are encrypted with the latest public key used to link the source Tableau Server with the destination Tableau Cloud or Tableau Server site. Before you use this method, you must create public and private keys for resources with embedded credentials. For more information, see [Migrate Workbooks and Data Sources with Embedded Credentials](https://help.tableau.com/current/server/en-us/cmt-migration_embedded_credentials.htm). **Version:** Available in API 3.23 (Tableau Cloud June 2024/ Tableau Server 2024.2) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** This method can only be called by Tableau Cloud and Tableau Server admins. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** tableau:embedded\_credentials:upload - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/sites/site-luid/datasources/datasource-luid/applykeychain #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
datasource-luid	The LUID of the data source to download the encrypted keychain from.

`associatedUserLuidMapping`	(Required) The user IDs from the source site mapped to destination site user IDs.
`encryptedKeychainList`	(Required) List of encrypted keychains from the source Tableau Server.
`encryptedKeychain`	(Required) Encrypted keychain from the source Tableau Server.

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403054	Unauthorized Access	A non-administrator user attempted to get data source revision information, but the caller doesn't have sufficient permissions.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404004	Data source not found	The data source ID in the URI doesn't correspond to an existing data source.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Upload Flow Encrypted Keychain Uploads the encrypted version of the embedded credentials of a flow. This method will only work if the credentials are encrypted with the latest public key used to link the source Tableau Server with the destination Tableau Cloud or Tableau Server site. **Version**: Available in API 3.25 (Tableau Cloud February 2025 / Tableau Server 2025.1) and later. **License**: No additional license required. **Permissions**: This method can only be called by Tableau Cloud site and Tableau Server administrators. **Access Scope**: tableau:embedded\_credentials:upload - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/sites/site-luid/flows/flow-luid/applyKeychain #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
flow-luid	The LUID of the flow to upload the encrypted keychain from.

#### Request Body ``` BADsJ5lBKho2Tdqqbo7txS8IyGlBu9LiRyb8etCHJLhBUurgIRHk3g5AeMQg6KHBw+6nwNIDEd65MKi76DLd5aIMhQC5aLCR4NE7R2gp7JbxLo+nOMGnfDQm5XekJVpLQGfY53GIX52ED2iTfOQ0yRNbnPV4djT0z23rosG0gpmqXV/GlBu9LiRyb8wx8RisnZdvv+SAlv222jVhksX1w5A6HB3Bs45BeWfpwrOnHwnNoWUGwHuu4iGlyE7m65RlATZN+fvDGOFN1zU2lXaSZyWqRKiWkD+oGlBu9LiRyb8Gz7RnesKvH6QEL9sT8cXA1ZOEA531xNAv9rjazEP5BssIdA1GcJ5J7zar5xxC68qm3cz3MkndyqWXZrf0vWPgwysUHEpWn60oDG/8/xG6c0Eigh4gwE+dA+NF1GlBu9LiRyb8+AzJ7vatf95LDwAuRT43G3Q+WApx9qBPXco15pKjwy00rHPgn4cRtu+unwh6d3gIh6AbK6X++U/vV/Ktpe31lSZmV8eHPeTNfdCrGOT9ozZhF5oKGlBu9LiRyb8tf1YcXawh3bvtZxg9d8a2mKNXDeaF+uJrpI43aFa4KrJKdfvDpq2k0aJhL1QNxWSFBYw0tPJX/rhKAeOHHY2K44Wh5JNWwL+x1uYap93IK303sJ1GlBu9LiRyb8UhfIW7o5iUtbYWrpCvVwubZLf4U5Y= 2BADsJ5lBKho2Tdqqbo7txS8IyGlBu9LiRyb8etCHJLhBUurgIRHk3g5AeMQg6KHBw+6nwNIDEd65MKi76DLd5aIMhQC5aLCR4NE7R2gp7JbxLo+nOMGnfDQm5XekJVpLQGfY53GIX52ED2iTfOQ0yRNbnPV4djT0z23rosG0gpmqXV/GlBu9LiRyb8wx8RisnZdvv+SAlv222jVhksX1w5A6HB3Bs45BeWfpwrOnHwnNoWUGwHuu4iGlyE7m65RlATZN+fvDGOFN1zU2lXaSZyWqRKiWkD+oGlBu9LiRyb8Gz7RnesKvH6QEL9sT8cXA1ZOEA531xNAv9rjazEP5BssIdA1GcJ5J7zar5xxC68qm3cz3MkndyqWXZrf0vWPgwysUHEpWn60oDG/8/xG6c0Eigh4gwE+dA+NF1GlBu9LiRyb8+AzJ7vatf95LDwAuRT43G3Q+WApx9qBPXco15pKjwy00rHPgn4cRtu+unwh6d3gIh6AbK6X++U/vV/Ktpe31lSZmV8eHPeTNfdCrGOT9ozZhF5oKGlBu9LiRyb8tf1YcXawh3bvtZxg9d8a2mKNXDeaF+uJrpI43aFa4KrJKdfvDpq2k0aJhL1QNxWSFBYw0tPJX/rhKAeOHHY2K44Wh5JNWwL+x1uYap93IK303sJ1GlBu9LiRyb8UhfIW7o5iUtbYWrpCvVwubZLf4U5Y= ``` ``` { "tsRequest": { "associatedUserLuidMapping": { "userLuidPair": { "sourceSiteUserLuid": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d", "destinationSiteUserLuid": "9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d" } }, "encryptedKeychainList": [ "BADsJ5lBKho2Tdqqbo7txS8IyGlBu9LiRyb8etCHJLhBUurgIRHk3g5AeMQg6KHBw+6nwNIDEd65MKi76DLd5aIMhQC5aLCR4NE7R2gp7JbxLo+nOMGnfDQm5XekJVpLQGfY53GIX52ED2iTfOQ0yRNbnPV4djT0z23rosG0gpmqXV/GlBu9LiRyb8wx8RisnZdvv+SAlv222jVhksX1w5A6HB3Bs45BeWfpwrOnHwnNoWUGwHuu4iGlyE7m65RlATZN+fvDGOFN1zU2lXaSZyWqRKiWkD+oGlBu9LiRyb8Gz7RnesKvH6QEL9sT8cXA1ZOEA531xNAv9rjazEP5BssIdA1GcJ5J7zar5xxC68qm3cz3MkndyqWXZrf0vWPgwysUHEpWn60oDG/8/xG6c0Eigh4gwE+dA+NF1GlBu9LiRyb8+AzJ7vatf95LDwAuRT43G3Q+WApx9qBPXco15pKjwy00rHPgn4cRtu+unwh6d3gIh6AbK6X++U/vV/Ktpe31lSZmV8eHPeTNfdCrGOT9ozZhF5oKGlBu9LiRyb8tf1YcXawh3bvtZxg9d8a2mKNXDeaF+uJrpI43aFa4KrJKdfvDpq2k0aJhL1QNxWSFBYw0tPJX/rhKAeOHHY2K44Wh5JNWwL+x1uYap93IK303sJ1GlBu9LiRyb8UhfIW7o5iUtbYWrpCvVwubZLf4U5Y=", "2BADsJ5lBKho2Tdqqbo7txS8IyGlBu9LiRyb8etCHJLhBUurgIRHk3g5AeMQg6KHBw+6nwNIDEd65MKi76DLd5aIMhQC5aLCR4NE7R2gp7JbxLo+nOMGnfDQm5XekJVpLQGfY53GIX52ED2iTfOQ0yRNbnPV4djT0z23rosG0gpmqXV/GlBu9LiRyb8wx8RisnZdvv+SAlv222jVhksX1w5A6HB3Bs45BeWfpwrOnHwnNoWUGwHuu4iGlyE7m65RlATZN+fvDGOFN1zU2lXaSZyWqRKiWkD+oGlBu9LiRyb8Gz7RnesKvH6QEL9sT8cXA1ZOEA531xNAv9rjazEP5BssIdA1GcJ5J7zar5xxC68qm3cz3MkndyqWXZrf0vWPgwysUHEpWn60oDG/8/xG6c0Eigh4gwE+dA+NF1GlBu9LiRyb8+AzJ7vatf95LDwAuRT43G3Q+WApx9qBPXco15pKjwy00rHPgn4cRtu+unwh6d3gIh6AbK6X++U/vV/Ktpe31lSZmV8eHPeTNfdCrGOT9ozZhF5oKGlBu9LiRyb8tf1YcXawh3bvtZxg9d8a2mKNXDeaF+uJrpI43aFa4KrJKdfvDpq2k0aJhL1QNxWSFBYw0tPJX/rhKAeOHHY2K44Wh5JNWwL+x1uYap93IK303sJ1GlBu9LiRyb8UhfIW7o5iUtbYWrpCvVwubZLf4U5Y=" ] } } ``` #### Request Attributes

`associatedUserLuidMapping`	(Required) The user IDs from the source site mapped to destination site user IDs.
`userLuidPair`	(Required) The user IDs needed to map source site flow owner to destination site flow owner.
`sourceSiteUserLuid`	(Required) The user ID of the flow owner from the source site; an attribute of the `associatedUserLuidMapping` element.
`destinationSiteUserLuid`	(Required) The user ID of the flow owner on the destination site; an attribute of the `associatedUserLuidMapping` element.
`encryptedKeychainList`	(Required) List of encrypted keychains from the source Tableau Server.
`encryptedKeychain`	(Required) Encrypted keychain from the source Tableau Server. You can get this value by calling the Download Flow Encrypted Keychain method.

#### cURL Request Example ``` curl --location "https://myserver/api/3.25/sites/7a2f773d-4a9f-496e-afc6-a60517cb1b86/flows/1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d/applyKeychain" -X PUT --header "Content-Type: application/xml" --header "X-Tableau-Auth: nbQAstTxTHuBlcMlXZ3QKg|LXn5aiYcffck999kgpOPrQft5JkvRsYg|7a2f773d-4a9f-496e-afc6-a60517cb1b86" --data "BADsJ5lBKho2Tdqqbo7txS8IyGlBu9LiRyb8etCHJLhBUurgIRHk3g5AeMQg6KHBw+6nwNIDEd65MKi76DLd5aIMhQC5aLCR4NE7R2gp7JbxLo+nOMGnfDQm5XekJVpLQGfY53GIX52ED2iTfOQ0yRNbnPV4djT0z23rosG0gpmqXV/GlBu9LiRyb8wx8RisnZdvv+SAlv222jVhksX1w5A6HB3Bs45BeWfpwrOnHwnNoWUGwHuu4iGlyE7m65RlATZN+fvDGOFN1zU2lXaSZyWqRKiWkD+oGlBu9LiRyb8Gz7RnesKvH6QEL9sT8cXA1ZOEA531xNAv9rjazEP5BssIdA1GcJ5J7zar5xxC68qm3cz3MkndyqWXZrf0vWPgwysUHEpWn60oDG/8/xG6c0Eigh4gwE+dA+NF1GlBu9LiRyb8+AzJ7vatf95LDwAuRT43G3Q+WApx9qBPXco15pKjwy00rHPgn4cRtu+unwh6d3gIh6AbK6X++U/vV/Ktpe31lSZmV8eHPeTNfdCrGOT9ozZhF5oKGlBu9LiRyb8tf1YcXawh3bvtZxg9d8a2mKNXDeaF+uJrpI43aFa4KrJKdfvDpq2k0aJhL1QNxWSFBYw0tPJX/rhKAeOHHY2K44Wh5JNWwL+x1uYap93IK303sJ1GlBu9LiRyb8UhfIW7o5iUtbYWrpCvVwubZLf4U5Y=2BADsJ5lBKho2Tdqqbo7txS8IyGlBu9LiRyb8etCHJLhBUurgIRHk3g5AeMQg6KHBw+6nwNIDEd65MKi76DLd5aIMhQC5aLCR4NE7R2gp7JbxLo+nOMGnfDQm5XekJVpLQGfY53GIX52ED2iTfOQ0yRNbnPV4djT0z23rosG0gpmqXV/GlBu9LiRyb8wx8RisnZdvv+SAlv222jVhksX1w5A6HB3Bs45BeWfpwrOnHwnNoWUGwHuu4iGlyE7m65RlATZN+fvDGOFN1zU2lXaSZyWqRKiWkD+oGlBu9LiRyb8Gz7RnesKvH6QEL9sT8cXA1ZOEA531xNAv9rjazEP5BssIdA1GcJ5J7zar5xxC68qm3cz3MkndyqWXZrf0vWPgwysUHEpWn60oDG/8/xG6c0Eigh4gwE+dA+NF1GlBu9LiRyb8+AzJ7vatf95LDwAuRT43G3Q+WApx9qBPXco15pKjwy00rHPgn4cRtu+unwh6d3gIh6AbK6X++U/vV/Ktpe31lSZmV8eHPeTNfdCrGOT9ozZhF5oKGlBu9LiRyb8tf1YcXawh3bvtZxg9d8a2mKNXDeaF+uJrpI43aFa4KrJKdfvDpq2k0aJhL1QNxWSFBYw0tPJX/rhKAeOHHY2K44Wh5JNWwL+x1uYap93IK303sJ1GlBu9LiRyb8UhfIW7o5iUtbYWrpCvVwubZLf4U5Y=" ``` #### Response Code 200 #### Response Body None #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized access	The authentication token provided in the request header was invalid or has expired.
403	403054	Unauthorized access	A non-administrator user attempted to get data source revision information, but the caller doesn't have sufficient permissions.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404004	Data source not found	The data source ID in the URI doesn't correspond to an existing data source.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Upload User Credentials Uploads user credentials to a site on a destination Tableau Cloud or Tableau Server. Before you use this method, you must create public and private keys for resources with embedded credentials. For more information, see [Migrate Workbooks and Data Sources with Embedded Credentials](https://help.tableau.com/current/server/en-us/cmt-migration_embedded_credentials.htm). **Version:** Available in API 3.23 (Tableau Cloud June 2024/ Tableau Server 2024.2) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** This method can only be called by Tableau Cloud and Tableau Server admins. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** tableau:oauth\_credentials:upload - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/sites/site-luid/users/user-luid/uploadSavedCreds #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
user-luid	The LUID of the user whose credentials you want to upload.

`associatedUserLuidMapping`	(Required) The user IDs from the source site mapped to destination site user IDs.
`encryptedKeychainList`	(Required) List of encrypted keychains from the source Tableau Server.

#### cURL Request Example ``` curl --location --request GET "https://example.com/api/3.24/sites/a946d998-2ead-4894-bb50-1054a91dcab3/users/6ae4a163-d073-4ab2-9668-954bab4b029e/uploadSavedCreds" --header "Content-Type: application/json" --data " BADsJ5lBKho2Tdqqbo7txS8IyGlBu9LiRyb8etCHJLhBUurgIRHk3g5AeMQg6KHBw+6nwNIDEd65MKi76DLd5aIMhQC5aLCR4NE7R2gp7JbxLo+nOMGnfDQm5XekJVpLQGfY53GIX52ED2iTfOQ0yRNbnPV4djT0z23rosG0gpmqXV/GlBu9LiRyb8wx8RisnZdvv+SAlv222jVhksX1w5A6HB3Bs45BeWfpwrOnHwnNoWUGwHuu4iGlyE7m65RlATZN+fvDGOFN1zU2lXaSZyWqRKiWkD+oGlBu9LiRyb8Gz7RnesKvH6QEL9sT8cXA1ZOEA531xNAv9rjazEP5BssIdA1GcJ5J7zar5xxC68qm3cz3MkndyqWXZrf0vWPgwysUHEpWn60oDG/8/xG6c0Eigh4gwE+dA+NF1GlBu9LiRyb8+AzJ7vatf95LDwAuRT43G3Q+WApx9qBPXco15pKjwy00rHPgn4cRtu+unwh6d3gIh6AbK6X++U/vV/Ktpe31lSZmV8eHPeTNfdCrGOT9ozZhF5oKGlBu9LiRyb8tf1YcXawh3bvtZxg9d8a2mKNXDeaF+uJrpI43aFa4KrJKdfvDpq2k0aJhL1QNxWSFBYw0tPJX/rhKAeOHHY2K44Wh5JNWwL+x1uYap93IK303sJ1GlBu9LiRyb8UhfIW7o5iUtbYWrpCvVwubZLf4U5Y= " ``` #### Response Code 200 #### Response Body None. #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403054	Unauthorized Access	A non-administrator user attempted to get data source revision information, but the caller doesn't have sufficient permissions.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404002	User not found	The user ID in the URI doesn't correspond to an existing user.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Upload Workbook Encrypted Keychain Uploads the encrypted version of the embedded credentials. This method will only work if the credentials are encrypted with the latest public key used to link the source Tableau Server with the destination Tableau Cloud or Tableau Server site. Before you use this method, you must create public and private keys for resources with embedded credentials. For more information, see [Migrate Workbooks and Data Sources with Embedded Credentials](https://help.tableau.com/current/server/en-us/cmt-migration_embedded_credentials.htm). **Version:** Available in API 3.23 (Tableau Cloud June 2024/ Tableau Server 2024.2) and later. _[Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)_ **License:** No additional license required. **Permissions:** This method can only be called by Tableau Cloud and Tableau Server admins. _[Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)_ **JWT Access Scope:** tableau:embedded\_credentials:upload - Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). - For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI PUT /api/api-version/sites/site-luid/workbooks/workbook-luid/applyKeychain #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-luid	The LUID for the site.
workbook-luid	The LUID of the workbook to download the encrypted keychain from.

`associatedUserLuidMapping`	(Required) The user IDs from the source site mapped to destination site user IDs.
`encryptedKeychainList`	(Required) List of encrypted keychains from the source Tableau Server.
`encryptedKeychain`	(Required) Encrypted keychain from the source Tableau Server.

#### cURL Request Example ``` curl --location 'https://example.org/api/3.24/sites/7a2f773d-4a9f-496e-afc6-a60517cb1b86/workbooks/1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d/applykeychain' \ -X PUT \ --header 'Content-Type: application/xml' \ --header 'X-Tableau-Auth: nbQAstTxTHuBlcMlXZ3QKg|LXn5aiYcffck999kgpOPrQft5JkvRsYg|7a2f773d-4a9f-496e-afc6-a60517cb1b86' \ --data ' BADsJ5lBKho2Tdqqbo7txS8IyGlBu9LiRyb8etCHJLhBUurgIRHk3g5AeMQg6KHBw+6nwNIDEd65MKi76DLd5aIMhQC5aLCR4NE7R2gp7JbxLo+nOMGnfDQm5XekJVpLQGfY53GIX52ED2iTfOQ0yRNbnPV4djT0z23rosG0gpmqXV/GlBu9LiRyb8wx8RisnZdvv+SAlv222jVhksX1w5A6HB3Bs45BeWfpwrOnHwnNoWUGwHuu4iGlyE7m65RlATZN+fvDGOFN1zU2lXaSZyWqRKiWkD+oGlBu9LiRyb8Gz7RnesKvH6QEL9sT8cXA1ZOEA531xNAv9rjazEP5BssIdA1GcJ5J7zar5xxC68qm3cz3MkndyqWXZrf0vWPgwysUHEpWn60oDG/8/xG6c0Eigh4gwE+dA+NF1GlBu9LiRyb8+AzJ7vatf95LDwAuRT43G3Q+WApx9qBPXco15pKjwy00rHPgn4cRtu+unwh6d3gIh6AbK6X++U/vV/Ktpe31lSZmV8eHPeTNfdCrGOT9ozZhF5oKGlBu9LiRyb8tf1YcXawh3bvtZxg9d8a2mKNXDeaF+uJrpI43aFa4KrJKdfvDpq2k0aJhL1QNxWSFBYw0tPJX/rhKAeOHHY2K44Wh5JNWwL+x1uYap93IK303sJ1GlBu9LiRyb8UhfIW7o5iUtbYWrpCvVwubZLf4U5Y= ' ``` #### Response Code 200 #### Response Body None. #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
401	401002	Unauthorized Access	The authentication token provided in the request header was invalid or has expired.
403	403054	Unauthorized Access	A non-administrator user attempted to get data source revision information, but the caller doesn't have sufficient permissions.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
404	404006	Workbook not found	The workbook ID in URI doesn't correspond to an existing workbook.
405	405000	Invalid request method	Request type was not PUT.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Validate Uploaded Workbook Validates a Tableau workbook (TWB) file that already exists in temporary storage on Tableau Cloud or Tableau Server. The TWB is validated against the TWB XSD schema and verifies that it can be loaded in Tableau. **Version**: Available in API 3.29 (Tableau Cloud June 2026 / Server 2026.2) and later. **License**: No additional license required. **Permissions**: Any authenticated user. **Access Scope**: `tableau:workbooks:create` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). Use this method to validate a TWB file that's already been stored using the file upload REST API ([Initiate File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_publishing.htm#initiate_file_upload) and [Append to File Upload](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_publishing.htm#append_to_file_upload)). Provide the upload session ID as a query parameter to validate the uploaded file. The validation performs both syntactic validation (verifying the TWB conforms to the TWB XSD schema) and semantic validation (verifying the content can be interpreted by Tableau). For more information about the officially supported TWB XSD schema, see the [tableau-document-schemas](https://github.com/tableau/tableau-document-schemas) repository on GitHub. #### URI POST /api/api-version/sites/site-id/workbooks/validateUploadedWorkbook?uploadSessionId=upload-session-id #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site.
upload-session-id	The upload session ID returned from the Initiate File Upload endpoint.

#### Request Header This method can only return a JSON-formatted response. Set the HTTP `Accept` request header appropriately: `Accept: application/json` #### Request Body None #### cURL Example ``` curl --location --request POST 'https://example.com/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/workbooks/validateUploadedWorkbook?uploadSessionId=12345:12ab34cd56ef78ab90cd12ef34ab56cd-0:0' --header 'X-Tableau-Auth: aBcDeFgHiJkLmNoPqRsTuV|1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p|12345678-1234-5678-9abc-def012345678' --header 'Accept: application/json' ``` #### Response Code 200 #### Response Body A validation response that returns a 200 response code, zero validation errors, and zero or more validation warnings indicates successful validation. Warnings are advisory, and won't prevent a workbook from loading in Tableau. Details about the validation warnings are returned in the response body as JSON. ``` { "timestamp": "2026-06-10T14:32:18.456Z", "uploadId": "12345:12ab34cd56ef78ab90cd12ef34ab56cd-0:0", "warnings": [ { "severity": "WARNING", "message": "Unknown map source is used", "line": 245, "column": 18, "elementName": "map" } ] } ``` #### Errors

HTTP status	Condition	Details
400	Missing uploadSessionId parameter	The required `uploadSessionId` parameter isn't present in the querystring.
404	Resource not found	The `uploadSessionId` parameter couldn't be found.
422	Unprocessable entity	The TWB validation task completed, but detected errors. See the response body for detailed validation information.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Validation errors A validation response that returns zero or more validation errors indicates failed validation. Unlike validation warnings, validation errors _will_ prevent a workbook from loading in Tableau. Details about the validation errors and warnings are returned in the response body as JSON. Example response: { "timestamp": "2026-06-10T14:32:18.456Z", "errors": \[ { "severity": "ERROR", "message": "Missing required closing tag for element", "line": 127, "column": 5, "elementName": "preferences" } \], "warnings": \[ { "severity": "WARNING", "message": "Unknown map source is used", "line": 245, "column": 18, "elementName": "map" } \] } ## Validate Workbook Validates a Tableau workbook (TWB) file against the TWB XSD schema and verifies that it can be loaded in Tableau. **Version**: Available in API 3.29 (Tableau Cloud June 2026 / Server 2026.2) and later. **License**: No additional license required. **Permissions**: Any authenticated user. **Access Scope**: `tableau:workbooks:read` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). This endpoint validates TWB file content without storing it on Tableau Cloud or Tableau Server. The validation performs both syntactic validation (verifying the TWB conforms to the TWB XSD schema) and semantic validation (verifying the content can be interpreted by Tableau). For more information about the officially supported TWB XSD schema, see the [tableau-document-schemas](https://github.com/tableau/tableau-document-schemas) repository on GitHub. #### URI POST /api/api-version/sites/site-id/workbooks/validateWorkbook #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site.

#### Request Header This method can only return a JSON-formatted response. Set the HTTP `Accept` request header appropriately: `Accept: application/json` #### Request Body The request body is the TWB, sent as multipart form data. **Note:** The request body can't be a TWBX (packaged workbook). **Option 1: Use a code library or client that can assemble the request** - Most clients and code libraries can automatically create a multipart request that's appropriate for sending the TWB. In such cases, you only need to provide: - the `name` parameter and its value, `tableau_workbook` - the `filename` parameter and its value, the TWB filename - the TWB file **Option 2: Manually assemble the request** - Manually assembling the request has specific requirements: Set a `Content-Type` request header indicating the body is `multipart/form-data` or `multipart/mixed`, and define the `boundary` string. (A boundary string is a unique string that won't occur in the request body outside of its use as a delimiter.) Example: `Content-Type: multipart/form-data; boundary=12ab34cd-56ef-78ab-90cd-12ef34ab56cd` Build the request body - begin with the boundary string defined in the request header, prepended by "--" ; - add an inline `Content-Disposition` header that indicates `form-data` encoding, sets `name` equal to `tableau_workbook`, and sets `filename` equal to a string ending in `.twb`; - conclude with the boundary string defined in the request header, prepended by "--" and appended by "--". Example: (The placeholder `{workbook-xml}`represents the raw TWB XML.) ``` --12ab34cd-56ef-78ab-90cd-12ef34ab56cd Content-Disposition: form-data; name="tableau_workbook"; filename=superstore.twb {workbook-xml} --12ab34cd-56ef-78ab-90cd-12ef34ab56cd-- ``` For more information on sending the TWB using a multipart request, see the concepts covered in the "Uploading the file in parts" section of [Publishing Resources](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_publish.htm#uploading-the-file-in-parts), or search the Internet using terms like **multipart** and **HTTP**. #### cURL Example (The placeholder `{path-to-twb}`represents the local path to the TWB file.) ``` curl --location 'https://example.com/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/workbooks/validateWorkbook' --header 'X-Tableau-Auth: aBcDeFgHiJkLmNoPqRsTuV|1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p|12345678-1234-5678-9abc-def012345678' --header 'Accept: application/json' --form 'tableau_workbook=@"{path-to-twb}"' ``` #### Response Code 200 #### Response Body A validation response that returns a 200 response code, zero validation errors, and zero or more validation warnings indicates successful validation. Warnings are advisory, and won't prevent a workbook from loading in Tableau. Details about the validation warnings are returned in the response body as JSON. Example response: ``` { "timestamp": "2026-06-10T14:32:18.456Z", "warnings": [ { "severity": "WARNING", "message": "Unknown map source is used", "line": 245, "column": 18, "elementName": "map" } ] } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400		Missing required parameter	The required `tableau_workbook` parameter isn't present in the request.
400		Invalid file type or content	The file is not a valid TWB file or does not contain TWB XML content, or the "filename" parameter doesn't end with ".twb".
406	406000	No acceptable response	This method can only return a JSON response. Use the `Accept: application/json` header.
422		Unprocessable entity	The TWB validation task completed, but detected errors. See the response body for detailed validation information.

For more information, see [Handling Errors](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Validation errors A validation response that returns zero or more validation errors indicates failed validation. Unlike validation warnings, validation errors _will_ prevent a workbook from loading in Tableau. Details about the validation errors and warnings are returned in the response body as JSON. Example response: { "timestamp": "2026-06-10T14:32:18.456Z", "errors": \[ { "severity": "ERROR", "message": "Missing required closing tag for element", "line": 127, "column": 5, "elementName": "preferences" } \], "warnings": \[ { "severity": "WARNING", "message": "Unknown map source is used", "line": 245, "column": 18, "elementName": "map" } \] } ## Validate Workbook and Upload Validates a Tableau workbook (TWB) file against the TWB XSD schema and verifies that it can be loaded in Tableau. If validation succeeds, this method stores the TWB in a temporary location on Tableau Cloud or Tableau Server for further use. **Version**: Available in API 3.29 (Tableau Cloud June 2026 / Server 2026.2) and later. **License**: No additional license required. **Permissions**: Any authenticated user. **Access Scope**: `tableau:workbooks:create` For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). The validation performs both syntactic validation (verifying the TWB conforms to the TWB XSD schema) and semantic validation (verifying the content can be interpreted by Tableau). For more information about the officially supported TWB XSD schema, see the [tableau-document-schemas](https://github.com/tableau/tableau-document-schemas) repository on GitHub. #### URI POST /api/api-version/sites/site-id/workbooks/validateWorkbookAndUpload #### URI Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site.

#### Request Header This method can only return a JSON-formatted response. Set the HTTP `Accept` request header appropriately: `Accept: application/json` #### Request Body The request body is the TWB, sent as multipart form data. **Note:** The request body can't be a TWBX (packaged workbook). **Option 1: Use a code library or client that can assemble the request** - Most clients and code libraries can automatically create a multipart request that's appropriate for sending the TWB. In such cases, you only need to provide: - the `name` parameter and its value, `tableau_workbook` - the `filename` parameter and its value, the TWB filename - the TWB file **Option 2: Manually assemble the request** - Manually assembling the request has specific requirements: Set a `Content-Type` request header indicating the body is `multipart/form-data` or `multipart/mixed`, and define the `boundary` string. (A boundary string is a unique string that won't occur in the request body outside of its use as a delimiter.) Example: `Content-Type: multipart/form-data; boundary=12ab34cd-56ef-78ab-90cd-12ef34ab56cd` Build the request body - begin with the boundary string defined in the request header, prepended by "--" ; - add an inline `Content-Disposition` header that indicates `form-data` encoding, sets `name` equal to `tableau_workbook`, and sets `filename` equal to a string ending in `.twb`; - conclude with the boundary string defined in the request header, prepended by "--" and appended by "--". Example: (The placeholder `{workbook-xml}`represents the raw TWB XML.) ``` --12ab34cd-56ef-78ab-90cd-12ef34ab56cd Content-Disposition: form-data; name="tableau_workbook"; filename=superstore.twb {workbook-xml} --12ab34cd-56ef-78ab-90cd-12ef34ab56cd-- ``` For more information on sending the TWB using a multipart request, see the concepts covered in the "Uploading the file in parts" section of [Publishing Resources](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_publish.htm#uploading-the-file-in-parts), or search the Internet using terms like **multipart** and **HTTP**. #### cURL Example (The placeholder `{path-to-twb}`represents the local path to the TWB file.) ``` curl --location 'https://example.com/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/workbooks/validateWorkbookAndUpload' --header 'X-Tableau-Auth: aBcDeFgHiJkLmNoPqRsTuV|1a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p|12345678-1234-5678-9abc-def012345678' --header 'Accept: application/json' --form 'tableau_workbook=@"{path-to-twb}"' ``` #### Response Code 200 #### Response Body A validation response that returns a 200 response code, zero validation errors, and zero or more validation warnings indicates successful validation. Warnings are advisory, and won't prevent a workbook from loading in Tableau. Details about the validation warnings are returned in the response body as JSON. ``` { "timestamp": "2026-06-10T14:32:18.456Z", "uploadId": "12345:12ab34cd56ef78ab90cd12ef34ab56cd-0:0", "warnings": [ { "severity": "WARNING", "message": "Unknown map source is used", "line": 245, "column": 18, "elementName": "map" } ] } ``` #### Errors

HTTP status	`error` Code	Condition	Details
400		Missing required parameter	The required `tableau_workbook` parameter isn't present in the request.
400		Invalid file type or content	The file is not a valid TWB file or does not contain TWB XML content, or the "filename" parameter doesn't end with ".twb".
406	406000	No acceptable response	This method can only return a JSON response. Use the `Accept: application/json` header.
422		Unprocessable entity	The TWB validation task completed, but detected errors. See the response body for detailed validation information.