REST API

With the Tableau Server REST API you can manage and change Tableau Server, Tableau Online 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.

Getting Started icon
LEARN
Get Started Tutorial
make REST requests to your Server or Online site using Postman or cURL
Findd icon
FIND
All Methods List
ctrl-f search for methods and parameters by name
Integrate icon
INTEGRATE
Tableau Server Client (Python)(Link opens in a new window) - call Server and Online site APIs from your existing processes
Join icon
JOIN
Tableau Developer Program(Link opens in a new window) - forums, events, and a free Tableau Online sandbox for learning and prototyping

Method Categories

Analytics Extensions Settings Methods
Add analytics extension connection to site Adds a connection to an external service for analytics extensions on this site.
Delete analytics extension connection Deletes a specific connection to an external service for analytics extensions on this site.
Enable/disable analytics extensions on server 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 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.
Update analytics extension connection Updates a specific connection to an external service for analytics extensions on this site.
Update enabled state of analytics extensions on site Enables or disables analytics extensions on a site.
Authentication Methods
Revoke Administrator Personal Access Tokens
- Not available for Tableau Online.
Revokes all personal access tokens(Link opens in a new window) (PATs) created by server administrators.
Sign In Signs you in as a user on the specified site on Tableau Server or Tableau Online.
Sign Out Signs you out of the current session.
Switch Site
- Not available for Tableau Online.
Switches you onto another site without having to provide a user name and password again.
Dashboard Extensions Settings Methods
Allow dashboard extension on site Adds a dashboard extension to the safe list the site you are signed into.
Block dashboard extension on server 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 Gets the details of a specific dashboard extension on the blocked list of a server.
List blocked dashboard extensions on server Lists the dashboard extensions on the blocked list of a server.
List dashboard extension settings of server Lists the dashboard extension settings of a server.
List dashboard extension settings of site Lists the dashboard extension settings of the site you are signed into.
Lists allowed dashboard extensions on site Lists the dashboard extensions on the safe list of the site you are signed into.
Unblock dashboard extension on server 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 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 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.
Update Data in Hyper Connection Modifies defined portions of published live-to-Hyper data from a specified data source.
Update Data in Hyper Data Source Modifies defined portions of published live-to-Hyper data from a specified data source.
Data-Driven Alerts Methods
Add User to Data-Driven Alert Adds a specified user to the recipients list for a data-driven alert.
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.
Query Data-Driven Alert Details Returns details on a specified data-driven alert, including the recipients of the alert.
Query Data-Driven Alerts Returns a list of data-driven alerts in use on the specified site.
Update Data-Driven Alert Update one or more settings for the specified data-driven alert; including the alert subject, frequency, and owner.
Extract and Encryption Methods
Create Extracts for Embedded Data Sources in a Workbook Create extracts for all embedded data sources of a workbook.
Create an Extract for a Data Source Create an extract for a data source in a site.
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 an extract refresh task.
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.
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.
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 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.
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 User Returns the flows that the specified user owns in addition to those that the user has Read (view) permissions for.
Query Flows for a Site Returns the flows on a site.
Run Flow Now Runs the specified flow.
Run Flow Task Runs the specified flow run 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.
Jobs, Tasks, and Schedules Methods
Add Data Source to Schedule Adds a task to refresh a data source to an existing schedule.
Add Workbook to Schedule Adds a task to refresh or accelerate a workbook to an existing schedule.
Cancel Job Cancels a job specified by job ID.
Create Schedule Creates a new schedule on Tableau Server.
Delete Data Acceleration Task Deletes a data acceleration task.
Delete Extract Refresh Task Deletes an extract refresh task.
Delete Schedule Deletes the specified schedule.
Get Data Acceleration Tasks in a Site Returns a list of data acceleration tasks for the site.
Get Extract Refresh Task Returns information about the specified extract refresh task.
Get Extract Refresh Tasks in a Schedule Returns a list of the extract refresh tasks for a specified schedule on the specified site.
Get Extract Refresh Tasks in a Site Returns a list of extract refresh tasks for the site.
Get Schedule Returns detailed information about the specified schedule.
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.
Query Schedules Returns a list of flows, extract and subscription schedules.
Run Extract Refresh Task Runs the specified extract refresh task.
Update Schedule Modifies settings for the specified schedule, including the name, priority, and frequency details.
Metadata Methods
Add (or Update) Data Quality Certifications
- Available only with the Data Management Add-on.
Create or update one or more data quality certifications for different content and asset items.
Add (or Update) Quality Warning Trigger
- Available only with the Data Management Add-on.
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 the Data Management Add-on.
Create and apply a data quality warning to a database, table, published data source, or flow.
Add Database Permissions
- Available only with the Data Management Add-on.
Add permissions to a database asset.
Add Default Database Permissions
- Available only with the Data Management Add-on.
Applying default permissions to a database functions as a permissions template for the database's children table assets.
Add Table Permissions
- Available only with the Data Management Add-on.
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 Warnings
- Available only with the Data Management Add-on.
Add or update multiple data quality warnings (DQWs) for different content and asset items.
Batch Add Tags
- Available only with the Data Management Add-on.
Add multiple tags to items that are different content and asset types.
Batch Delete Data Quality Warnings
- Available only with the Data Management Add-on.
Permanently remove multiple data quality warning (DQW) items from different content and asset types.
Batch Delete Tags
- Available only with the Data Management Add-on.
Delete multiple tags from items that are different content and asset types.
Delete Data Quality Certification by ID
- Available only with the Data Management Add-on.
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 the Data Management Add-on.
Permanently remove all data quality certifications from multiple content or asset items.
Delete Data Quality Warning by Content
- Available only with the Data Management Add-on.
Permanently remove the data quality warning from the database, table, published data source, or flow.
Delete Data Quality Warning by ID
- Available only with the Data Management Add-on.
Permanently remove a data quality warning.
Delete Database Permissions
- Available only with the Data Management Add-on.
Permanently remove the permissions applied to a database asset.
Delete Default Database Permissions
- Available only with the Data Management Add-on.
Permanently remove the default permissions on a database asset.
Delete Quality Warning Trigger by ID
- Available only with the Data Management Add-on.
Permanently remove a quality warning trigger using the quality warning trigger ID.
Delete Quality Warning Triggers by Content
- Available only with the Data Management Add-on.
Permanently remove all quality warning triggers for one or more data sources or flows, or both.
Delete Table Permissions
- Available only with the Data Management Add-on.
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.
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 Get information about the data quality warning for the database, table, published data source, or flow.
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 the Data Management Add-on.
Permanently remove the column from a table asset.
Remove Database
- Available only with the Data Management Add-on.
Permanently remove the database asset.
Remove Table
- Available only with the Data Management Add-on.
Permanently remove the table asset.
Update Column
- Available only with the Data Management Add-on.
Update the description of the column.
Update Data Quality Warning
- Available only with the Data Management Add-on.
Update the warning type, status, and message of a data quality warning.
Update Database
- Available only with the Data Management Add-on.
Update the database description, certify a database, or assign a contact (must be a Tableau Server or Tableau Online user) to the database asset.
Update Quality Warning Trigger
- Available only with the Data Management Add-on.
Update a quality warning trigger.
Update Table
- Available only with the Data Management Add-on.
Update the table description, certify a table, or a assign a user contact to the table asset.
Metrics Methods
Delete Metric Deletes a specified metric from a site.
Get Metric Returns the details of the specified metric.
List Metrics for Site Returns the metrics configured for a site.
Update Metric Updates the owner, project, suspended status, or name of the specified metric.
Permissions Methods
Add Data Source Permissions Adds permissions to the specified data source for a Tableau Server user or group.
Add Default Permissions Adds default permission capabilities granted to a user or group, for metric, flow, workbook, data source, data role, or lense resources in a project.
Add Project Permissions Adds permissions to the specified project for a Tableau Server user or group.
Add View Permissions Adds permissions to the specified view (also known as a sheet) for a Tableau Server user or group.
Add Workbook Permissions Adds permissions to the specified workbook for a Tableau Server user or group.
Add Workbook to Schedule Adds a task to refresh or accelerate a workbook to an existing schedule.
Delete Data Source Permission Removes the specified data source permission for the specified group or user.
Delete Default Permission Removes default permission capabilities granted to a user or group, for metric, flow, workbook, data source, data role, or lense resources in a 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 Workbook Permission Deletes the specified permission from the specified workbook for a group or user.
Query Data Source Permissions Returns a list of permissions for a specific data source.
Query Default Permissions Returns details of default permission capabilities granted to users and groups for metric, flow, workbook, data source, data role, or lense resources in a project.
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 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 Online.
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 Online.
Changes the nickname or full domain name of an Active Directory domain on the server.
Site Methods
Create Site
- Not available for Tableau Online.
Creates a site on Tableau Server.
Delete Site Deletes the specified site.
Get Data Acceleration Report for a Site Returns a report about data acceleration for the 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 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 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.
Delete Subscription Deletes the specified subscription.
Query Subscription Returns information about the specified subscription.
Query Subscriptions Returns a list of all the subscriptions on the specified site.
Update Subscription Modifies an existing subscription, allowing you to change the subject, schedule, and suspension state for the subscription.
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 and assigns the user to the specified site.
Create Group Creates a group.
Delete Group Deletes the group on a specific 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.
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.
Update User Modifies information about the specified user.
Webhooks Methods
Create a Webhook Creates a new webhook for a site.
Delete a Webhook Deletes the specified webhook.
Get a Webhook Returns information about the specified webhook.
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.
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 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 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 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 Downloads a specific version of a workbook in .twb or .twbx format.
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 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.
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 Returns information about the specified workbook, including information about views and tags.
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.
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 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!