# tableau Api Tableau REST API (rest_api) ## Content - [Full documentation](/tableau/next/en-us/api/rest_api/llms-full.txt) - [About Tableau Help](/tableau/next/en-us/api/rest_api/REST/about-tableau-help.md): In an effort to align with one of our core company values, equality, we have changed terminology to be more inclusive where possible - [Analytics Extensions Settings Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_analytics_extensions_settings.md): Enable and configure analytics extensions on sites and, for on premise installations, on servers - [Ask Data Lens Methods - Retired](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_ask_data_lens.md): 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](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_authentication.md): Using the authentication methods of the Tableau REST API you can: - [Authentication-Tableau Server REST API](/tableau/next/en-us/api/rest_api/REST/rest_api_concepts_auth.md): The Tableau REST API requires that you send a credentials token with each request - [Bridge Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_bridge.md): Using the Bridge methods of the Tableau REST API you can: - [Collections Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_collections.md): Collections REST API endpoints enable you to retrieve and manipulate Tableau collections programmatically - [Concepts-Tableau Server REST API](/tableau/next/en-us/api/rest_api/REST/rest_api_concepts.md): This section provides background information about how to use the Tableau Server REST API and how it works - [Connected App Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_connected_app.md): Connected app-specific methods were introduced in Tableau 2021 - [Content Exploration Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_content_exploration.md): Content exploration methods enable you to view: - [Custom Domain Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_custom_domain.md): Custom domains allow your Tableau Cloud site to use a subdomain of your top level domain - [Dashboard Extensions Settings Methods - Retired](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_dashboard_extensions_settings.md): In October 2023 Tableau Cloud and Tableau Server version 2023 - [Data Acceleration](/tableau/next/en-us/api/rest_api/REST/rest_api_concepts_data_acceleration.md): 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](/tableau/next/en-us/api/rest_api/REST/rest_api_concepts_data_labels.md): Data Labels, described in the "Data Labels" topic of the Tableau Cloud and Tableau Server help, can be extensively controlled through the REST API - [Data Sources Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_data_sources.md): Using the data sources methods of the Tableau Server REST API you can: - [Extract and Encryption Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_extract_and_encryption.md): 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](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_favorites.md): Using the favorites methods of the Tableau Server REST API you can: - [Filtering and Sorting in the Tableau REST API](/tableau/next/en-us/api/rest_api/REST/rest_api_concepts_filtering_and_sorting.md): You can filter and sort the data that gets returned from requests to the following REST API endpoints: - [Flow Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_flow.md): Using the flow methods of the Tableau Server REST API you can do the operations listed in the following categories: - [Fundamentals-Tableau Server REST API](/tableau/next/en-us/api/rest_api/REST/rest_api_concepts_fundamentals.md): Tableau Server provides an application programming interface (API) that lets you programmatically manage users, workbooks, data connections, and other resources on the server - [Get Started Tutorial Part 1: Tools, REST Basics, and Sign In](/tableau/next/en-us/api/rest_api/REST/rest_api_get_started_tutorial_part_1.md): This is part 1 of a 3-part tutorial to help you get started using the Tableau Server REST API - [Get Started Tutorial Part 2: Create a Project and Publish a Workbook to it](/tableau/next/en-us/api/rest_api/REST/rest_api_get_started_tutorial_part_2.md): This is Part 2 of a 3-part tutorial to help you get started using the Tableau Server REST API - [Get Started Tutorial Part 3: Create a User Group and Give it Permissions](/tableau/next/en-us/api/rest_api/REST/rest_api_get_started_tutorial_part_3.md): This is part 3 of a 3-part tutorial to help you get started using the Tableau Server REST API - [Get Started Tutorial: Introduction and Set Up](/tableau/next/en-us/api/rest_api/REST/rest_api_get_started_tutorial_intro.md): This is the introduction to a 3-part tutorial on the basics of using the Tableau Server REST API to manage your resources - [Handling Errors-Tableau Server REST API](/tableau/next/en-us/api/rest_api/REST/rest_api_concepts_errors.md): If a request results in an error, the server returns an HTTP status code that indicates the general nature of the error - [Identifying Resources Using LUIDs-Tableau Server REST API](/tableau/next/en-us/api/rest_api/REST/rest_api_concepts_luid.md): Resources on Tableau Server typically have a friendly name, such as "Default" for a site name, "Developers" for a group, and "Adam" for a user - [Identity Pools Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_identity_pools.md): 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](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_jobs_tasks_and_schedules.md): Using the jobs, tasks, and schedules methods of the Tableau Server REST API you can do the operations listed in the following categories: - [Mapping ConnectionType Names](/tableau/next/en-us/api/rest_api/REST/rest_api_concepts_connectiontype.md): Using the Tableau Server REST API, you can access connection information used by data sources, workbooks, and flows - [Metadata Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_metadata.md): Metadata methods have been released incrementally beginning with Tableau version 2019 - [Metrics Methods - Retired](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_metrics.md): Retired in API 3 - [Mobile Settings Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_mobile_settings.md): Using the mobile settings methods of the Tableau REST API you can: - [Notifications Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_notifications.md): Notification methods consists of data-driven alerts, user notification preferences, and webhooks - [OpenID Connect Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_openid_connect.md): Using the OpenID Connect (OIDC) methods of the Tableau REST API you can: - [Paging Results-Tableau Server REST API](/tableau/next/en-us/api/rest_api/REST/rest_api_concepts_paging.md): REST API methods that might return a large number of individual elements support pagination - [Permissions Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_permissions.md): Using the permissions methods of the Tableau REST API you can: - [Permissions-Tableau Server REST API](/tableau/next/en-us/api/rest_api/REST/rest_api_concepts_permissions.md): Users who call REST API methods must have permission to perform the task represented by each method that they call - [Projects Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_projects.md): Projects are sets of workbooks, data sources, and flows whose members inherit the project's permissions - [Publishing Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_publishing.md): Using the publishing methods of the Tableau Server REST API you can: - [Publishing Resources-Tableau Server REST API](/tableau/next/en-us/api/rest_api/REST/rest_api_concepts_publish.md): You can use the REST API to programmatically publish (upload) workbooks and data sources to the server - [Pulse Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_pulse.md): With Tableau Pulse, Tableau Cloud users can follow metrics and use guided exploration to understand more about their data - [Recycle Bin Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_recycle_bin.md): The Recycle Bin methods of the Tableau REST API allow you to manage Recycle Bin content on your site - [Reference-Tableau Server REST API](/tableau/next/en-us/api/rest_api/REST/rest_api_ref.md): Using the Tableau Server REST API, you can manage and change Tableau Server resources programmatically, via HTTP - [Requirements-Tableau Server REST API](/tableau/next/en-us/api/rest_api/REST/rest_api_requ.md): The REST API is permanently enabled for Tableau Cloud - [REST API and Resource Versions](/tableau/next/en-us/api/rest_api/REST/rest_api_concepts_versions.md): 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 - [REST API Example Requests](/tableau/next/en-us/api/rest_api/REST/rest_api_concepts_example_requests.md): This topic illustrates the structure of REST API requests by showing the raw HTTP, including both headers and the body (as appropriate) - [Revisions Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_revisions.md): Using the revisions methods of the Tableau Server REST API you can: - [Samples-Tableau Server REST API](/tableau/next/en-us/api/rest_api/REST/rest_api_samples.md): To help you use the REST API, Tableau provides samples written in Python and in Java - [Server Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_server.md): Using the server method of the Tableau Server REST API you can: - [Site Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_site.md): Using the site methods of the Tableau Server REST API you can: - [Subscriptions Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_subscriptions.md): 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/next/en-us/api/rest_api/REST/rest_api_ref_tableau_extensions_settings.md): Tableau extensions settings control which dashboard extensions are allowed to run on a Tableau Server, and on a site on Server or Cloud - [Tableau Help](/tableau/next/en-us/api/rest_api/help.md) - [Tableau Knowledge Graph Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_tableau_knowledge_graph.md): Read and write the per-site Tableau Knowledge Graph - [Tableau MCP Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_tableau_mcp.md): Using the Tableau MCP methods of the REST API you can: - [Tableau REST API OpenAPI Endpoints](/tableau/next/en-us/api/rest_api/REST/TAG/index.md) - [Tableau Server REST API](/tableau/next/en-us/api/rest_api/REST/rest_api.md): With the Tableau Server REST API you can manage and change Tableau Server, Tableau Cloud site, and Prep Conductor resources programmatically, using HTTP - [Testing-Tableau Server REST API](/tableau/next/en-us/api/rest_api/REST/rest_api_concepts_testing.md): 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 - [Understand Workbook Impact on Your Database Using Query Tagging](/tableau/next/en-us/api/rest_api/REST/rest_api_how_to_query_tagging.md): Query tagging enables Tableau Server administrators to trace the specific Tableau activity that sends queries to their databases - [Update Data in Published Live-to-Hyper Data Sources](/tableau/next/en-us/api/rest_api/REST/rest_api_how_to_update_data_to_hyper.md): You can modify (insert, update, upsert, replace, and delete) data in a published data source that has a live-to-Hyper connection - [Updated Site Roles in REST API 3.0 and Later](/tableau/next/en-us/api/rest_api/REST/rest_api_concepts_new_site_roles.md): Starting with the 2018 - [Users and Groups Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_users_and_groups.md): Using the groups and users methods of the Tableau REST API you can do the operations listed in the following categories: - [Using Fields in the REST API](/tableau/next/en-us/api/rest_api/REST/rest_api_concepts_fields.md): You can control the type and amount of data that gets returned from requests to the following REST API endpoints: - [Using Pulse Generate Insight Brief](/tableau/next/en-us/api/rest_api/REST/rest_api_concepts_pulse_brief.md): 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 - [Using SSL-Tableau Server REST API](/tableau/next/en-us/api/rest_api/REST/rest_api_concepts_SSL.md): 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 - [Virtual Connections Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_virtual_connections.md): Virtual connections are a centralized way to share access to databases and tables, allowing for convenient reuse - [What's New-Tableau Server REST API](/tableau/next/en-us/api/rest_api/REST/rest_api_whats_new.md): This topic summarizes changes made to the REST API for Tableau Server and Tableau Cloud - [Workbooks and Views Methods](/tableau/next/en-us/api/rest_api/REST/rest_api_ref_workbooks_and_views.md): Using the workbooks and views methods of the Tableau Server REST API you can do the operations listed in the following categories: - [XML Schema-Tableau Server REST API](/tableau/next/en-us/api/rest_api/REST/rest_api_concepts_schema.md): REST API methods that require data in the body of the request pass the data as an XML block