REST API

With the Tableau Server REST API you can manage and change Tableau Server, Tableau Cloud site, and Prep Conductor resources programmatically, using HTTP. The API gives you simple access to the functionality behind Tableau data sources, projects, workbooks, site users, sites, flows, and more. You can use this access to create your own custom applications or to script interactions with Tableau resources.

LEARN
Get Started Tutorial
make REST requests to your Server or Online site using Postman or cURL

FIND
All Methods List
ctrl-f search for methods and parameters by name

INTEGRATE
Tableau Server Client (Python)(Link opens in a new window) - call Server and Online site APIs from your existing processes

JOIN
Tableau Developer Program(Link opens in a new window) - forums, events, and a free Tableau Cloud sandbox for learning and prototyping

Method Categories

Analytics Extensions Settings Methods

Add analytics extension connection to site	Adds an analytics extensions 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.
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 in API 3.22

Retired in API 3.22 (Cloud February 2024 / Server 2024.2) In February 2024, Tableau's Ask Data and Metrics features and their REST API methods will be retired in Tableau Cloud and Tableau Server version 2024.1. 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.
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).
Revoke Administrator Personal Access Tokens - Not available for Tableau Cloud.	Revokes all personal access tokens(Link opens in a new window) (PATs) created by server administrators.
Revoke Personal Access Token - Not available for Tableau Server.	Revoke a personal access token (PAT).
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.
Switch Site - Not available for Tableau Cloud.	Switches you onto another site without having to provide a user name and password again.

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 - Not available for Tableau Server.	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 - Not available for Tableau Server.	Query all external authorization servers (EASs) registered to a site.
List Connected Apps	Query all connected apps configured on a site.
List Registered EAS - Not available for Tableau Server.	Query an external authorization server (EAS) registered to a site.
Register EAS - Not available for Tableau Server.	Register an external authorization server (EAS) to a site.
Update Connected App	Update a connected app.
Update EAS - Not available for Tableau Server.	Update a registered external authorization server (EAS).

Content Exploration Methods

Get batch content usage statistics - Not available for Tableau Server.	Gets usage statistics for multiple content items.
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.
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.

Dashboard Extensions Settings Methods

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

Data Sources Methods

Add Tags to Data Source	Adds one or more tags to the specified data source.
Delete Data Source	Deletes the specified data source from a site.
Delete Tag from Data Source	Deletes a tag from the specified data source.
Download Data Source	Downloads a data source in `.tdsx` format.
Download Data Source Revision	Downloads a specific version of a data source prior to the current one in `.tdsx` format.
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.
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.
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, username, or password for the specified data source connection.
Update Data Source Now	Runs an extract refresh on the specified data source.

Extract and Encryption Methods

Create an Extract for a Data Source	Create an extract for a data source in a site.
Create Cloud Extract Refresh Task - Not available for Tableau Server.	Creates a custom schedule for an extract refresh on Tableau Cloud.
Create Extracts for Embedded Data Sources in a Workbook	Create extracts for all embedded data sources of a workbook.
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.
Delete Extract Refresh Task	Deletes the specified extract refresh task on Tableau Server or Tableau Cloud.
Delete Extracts of Embedded Data Sources from a Workbook	Delete all extracts of embedded data sources in a workbook.
Delete the Extract from a Data Source	Delete the extract of a data source in a site.
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.
Get Extract Refresh Task	Returns information about the specified extract refresh task.
List Extract Refresh Tasks in Server Schedule - Not available for Tableau Cloud.	source file = query_extract_refresh_tasks.flsnp
List Extract Refresh Tasks in Site	source file = get_extract_refresh_tasks.flsnp
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.
Run Extract Refresh Task	Runs the specified extract refresh task.
Update Cloud extract refresh task - Not available for Tableau Server.	Updates a custom schedule for 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	Retired in API 3.22 (Cloud February 2024 / Server 2024.2)
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.
Delete Flow from Favorites	Deletes the specified flow from the user's favorites.
Delete Project from Favorites	Deletes the specified project from the user's favorites.
Delete View from Favorites	Deletes the specified view from user's favorites.
Delete Workbook from Favorites	Deletes a workbook from a user's favorites.
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.
Add Flow Task to Schedule	Adds a task to run a flow to an existing schedule.
Cancel Flow Run	Cancels a flow run that is in progress.
Delete Flow	Deletes a flow.
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.
Get Flow Run	Gets a flow run.
Get Flow Run Task	Returns information about the specified flow run task.
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.
Get Linked Tasks - Available only with a Data Management license.	Returns a list of scheduled linked tasks for a site.
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 Flow Permissions	Returns a list of permissions for the specific flow.
Query Flows for a Site	Returns the flows on a site.
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	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 owner, project, of the specified flow.
Update Flow Connection	Updates the server address, port, username, or password for the specified flow connection.

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. For more information, see Step 2: Set up an identity store in the Tableau Server Help. Note: This identity store is in addition to the identity store you configured during Tableau Server setup.
Create Authentication Configuration - Not available for Tableau Cloud.	Create an instance of OpenID Connect (OIDC) authentication. For more information, see Step 3: Set up authentication in the Tableau Server Help.
Create Identity Pool - Not available for Tableau Cloud.	Create an identity pool. For more information, see Step 4: Create an identity pool in the Tableau Server Help.
Delete Authentication Configuration - Not available for Tableau Cloud.	Delete an authentication instance.
Delete Identity Pool - Not available for Tableau Cloud.	Delete an identity pool. Important: In Tableau Server, move users to
Delete Identity Store - Not available for Tableau Cloud.	Delete an identity store. Important: You cannot delete the identity store you configured during Tableau Server setup.
Get Identity Pool - Not available for Tableau Cloud.	Get information about an identity pool.
List Authentication Configurations - Not available for Tableau Cloud.	List information about all authentication instances.
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. Note: The request body must specify all the required and desired parameters, not jus the parameters you want to update.
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 custom extract refresh schedule.
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.
Cancel Job	Cancels a job specified by job ID.
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 Server Schedule - Not available for Tableau Cloud.	Returns detailed information about the specified server schedule on Tableau Server.
List Server Schedules - Not available for Tableau Cloud.	Returns a list of flows, extract and subscription server schedules on Tableau Server.
Query Job	Returns status information about an asynchronous process that is tracked using a job.
Query Jobs	Returns a list of active jobs on the specified site.
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 .

Metadata Methods

Add (or Update) Quality Warning Trigger - Available only with a Data Management license.	Create or update one or more quality warning triggers to monitor and display alerts for the following events: refresh failures on extract data sources and flow run failures on flows.
Add Data Quality Warning - Available only with a Data Management license.	Create and apply 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 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.
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 (DQWs) for different content and asset items.
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.	Permanently remove multiple data quality warning (DQW) items from different content and asset types.
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.	Permanently remove a data quality certification from a content or asset item using the data quality certification ID.
Delete Data Quality Certifications by Content - Available only with a Data Management license.	Permanently remove all data quality certifications from multiple content or asset items.
Delete Data Quality Warning by Content - Available only with a Data Management license.	Permanently remove the data quality warning from the database, table, column, published data source, flow, virtual connection, or virtual connection table.
Delete Data Quality Warning by ID - Available only with a Data Management license.	Permanently remove a data quality warning.
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.
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.
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.
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 Database Permissions	Get information about the permissions on a database asset.
Query Databases	Get information about all database assets for a site.
Query Default Database Permissions	Get the default permissions applied to the database asset and its children tables.
Query Quality Warning Trigger	Get information about a quality warning trigger.
Query Table	Get information about a table asset.
Query Table Permissions	Get information about the permissions on 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 content permissions, or assign a contact (must be a Tableau Server or Tableau Cloud user) to the database asset.
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 Quality Warning Trigger - Available only with a Data Management license.	Update a quality warning trigger.
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 in API 3.22

Retired in API 3.22 (Cloud February 2024 / Server 2024.2) In February 2024, Tableau's Ask Data and Metrics features and their REST API methods will be retired in Tableau Cloud and Tableau Server version 2024.1. 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.
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.
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.
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.
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.

Permissions Methods

Add Ask Data Lens Permissions - Retired in API 3.22	Retired in API 3.22 (Cloud February 2024 / Server 2024.2)
Add Data Source Permissions	Adds permissions to the specified data source for a user or group.
Add Default Permissions	Adds default permission rules for workbook, data source, data role, lens, flow, and metric resources in a project for a user or group.
Add Project Permissions	Adds permissions to the specified project for a user or group.
Add View Permissions	Adds permissions to the specified view (also known as a sheet) for a user or group.
Add Workbook Permissions	Adds permissions to the specified workbook for a user or group.
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	Retired in API 3.22 (Cloud February 2024 / Server 2024.2)
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, and metric resources in a project for a user or group.
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 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.
Query Data Source Permissions	Returns a list of permissions for a specific data source.
Query Default Permissions	Returns details of default permission rules granted to users and groups for workbook, data source, data role, lens, flow, or metric resources in a project for a user or group.
Query Project Permissions	Returns information about the set of permissions allowed or denied for groups and users in a project.
Query View Permissions	Returns a list of permissions for the specific view.
Query Workbook Permissions	Returns a list of permissions for the specific workbook.

Projects Methods

Create Project	Creates a project on the specified site.
Delete Project	Deletes the specified project on a specific site.
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.

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.
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 Workbook	Publishes a workbook on the specified site.

Revisions Methods

Download Data Source Revision	Downloads a specific version of a data source prior to the current one in `.tdsx` format.
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.
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.
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.

Site Methods

Create Site - Not available for Tableau Cloud.	Creates a site on Tableau Server.
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.
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.
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.
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.
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.

Subscriptions Methods

Create Subscription	Creates a new, unsuspended subscription to a view or workbook for a specific user on Tableau Server and Tableau Cloud.
Delete Subscription	Deletes the specified subscription on Tableau Server or Tableau Cloud.
Get Subscription	source file = query_subscription.flsnp
List Subscriptions	source file = query_subscriptions.flsnp
Update Subscription	Modifies an existing subscription on Tableau Server.

Users and Groups Methods

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 Tableau Server or Tableau Cloud site.
Delete Group	Deletes the group on a specific site.
Delete Users from Site with CSV	Creates a job to remove a list of users, specified in a .csv file, from a site.
Get Groups for a User	Gets a list of groups of which the specified user is a member.
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.
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 User from Group	Removes a user from the specified group.
Remove User from Site	Removes a user from the specified site.
Update Group	Updates a group on a Tableau Server or Tableau Cloud site.
Update User	Modifies information about the specified user.

Virtual Connections Methods

List Virtual Connection Database Connections - Available only with a Data Management license.	Returns a list of database connections found in the specified virtual connection and information about them.
List Virtual Connections - Available only with a Data Management license.	Returns a list of available virtual connection names and IDs.
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.

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 Workbook	Deletes a workbook.
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.
Download Workbook	Downloads a workbook in `.twb` or `.twbx` format.
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 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 Image	Downloads a .png format image file of a specified custom view.
Get Recommendations for Views	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	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.
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	Returns an image 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.
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.
Unhide a Recommendation for a View	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.
Update Workbook Connection	Updates the server address, port, username, or password for the specified workbook connection.
Update Workbook Now	Refreshes the specified workbook.

Thanks for your feedback!

Tableau REST API Help

REST API

Method Categories