About Tableau Help: In an effort to align with one of our core company values, equality, we have changed terminology to be more inclusive where possible
Tableau Server 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
Concepts-Tableau Server REST API: This section provides background information about how to use the Tableau Server REST API and how it works
Using SSL-Tableau Server REST API: As a security measure, you should make API calls to Tableau Server using the HTTPS protocol (SSL or TLS)—that is, using an encrypted channel between your client and Tableau Server
Mapping ConnectionType Names: Using the Tableau Server REST API, you can access connection information used by data sources, workbooks, and flows
Data Acceleration: Important changes for Tableau View Acceleration and Data Acceleration Tableau's View Acceleration feature and Data Acceleration APIs are retired
Data Labels in the REST API: Data Labels, described in the "Data Labels" topic of the Tableau Cloud and Tableau Server help, can be extensively controlled through the REST API
Handling Errors-Tableau Server REST API: If a request results in an error, the server returns an HTTP status code that indicates the general nature of the error
REST API Example Requests: This topic illustrates the structure of REST API requests by showing the raw HTTP, including both headers and the body (as appropriate)
Using Fields in the REST API: You can control the type and amount of data that gets returned from requests to the following REST API endpoints:
Fundamentals-Tableau Server REST API: Tableau Server provides an application programming interface (API) that lets you programmatically manage users, workbooks, data connections, and other resources on the server
Permissions-Tableau Server REST API: Users who call REST API methods must have permission to perform the task represented by each method that they call
Using Pulse Generate Insight Brief: This topic provides supplemental information about how to use the Generate insight brief REST API to make the most of the Enhanced Q&A (Discover) features of the Tableau AI stack
Testing-Tableau Server REST API: Usually, you make REST API calls to Tableau Server by writing a program in Python, Ruby, Java, C#, or other programming language that supports HTTP requests
REST API and Resource Versions: Classic REST endpoints: The more than 150 REST endpoints that let you programmatically take many of the actions available in the user interface of Tableau Cloud, on-premise Tableau Server, Tableau Prep and more
Ask Data Lens Methods - Retired: 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
Authentication Methods: Using the authentication methods of the Tableau REST API you can:
Bridge Methods: Using the Bridge methods of the Tableau REST API you can:
Collections Methods: Collections REST API endpoints enable you to retrieve and manipulate Tableau collections programmatically
Connected App Methods: Connected app-specific methods were introduced in Tableau 2021
Data Sources Methods: Using the data sources methods of the Tableau Server REST API you can:
Extract and Encryption Methods: Extracts are saved subsets of data that you can use to improve performance, or to take advantage of Tableau functionality not available or supported in your original data)
Favorites Methods: Using the favorites methods of the Tableau Server REST API you can:
Flow Methods: Using the flow methods of the Tableau Server REST API you can do the operations listed in the following categories:
Identity Pools Methods: Identity pools are an identity management tool that uses provisioning and authentication information to enable user access to Tableau Server
Jobs, Tasks, and Schedules Methods: Using the jobs, tasks, and schedules methods of the Tableau Server REST API you can do the operations listed in the following categories:
Metadata Methods: Metadata methods have been released incrementally beginning with Tableau version 2019
Notifications Methods: Notification methods consists of data-driven alerts, user notification preferences, and webhooks
OpenID Connect Methods: Using the OpenID Connect (OIDC) methods of the Tableau REST API you can:
Permissions Methods: Using the permissions methods of the Tableau REST API you can:
Projects Methods: Projects are sets of workbooks, data sources, and flows whose members inherit the project's permissions
Publishing Methods: Using the publishing methods of the Tableau Server REST API you can:
Pulse Methods: With Tableau Pulse, Tableau Cloud users can follow metrics and use guided exploration to understand more about their data
Recycle Bin Methods: The Recycle Bin methods of the Tableau REST API allow you to manage Recycle Bin content on your site
Revisions Methods: Using the revisions methods of the Tableau Server REST API you can:
Server Methods: Using the server method of the Tableau Server REST API you can:
Site Methods: Using the site methods of the Tableau Server REST API you can:
Subscriptions Methods: Using the subscriptions methods of the Tableau Server REST API you can do the operations listed in the following category:
Tableau Extensions Settings Methods: Tableau extensions settings control which dashboard extensions are allowed to run on a Tableau Server, and on a site on Server or Cloud
Users and Groups Methods: Using the groups and users methods of the Tableau REST API you can do the operations listed in the following categories:
Virtual Connections Methods: Virtual connections are a centralized way to share access to databases and tables, allowing for convenient reuse
Workbooks and Views Methods: Using the workbooks and views methods of the Tableau Server REST API you can do the operations listed in the following categories:
