Your AI team, working in Tableau

Tableau is a visual analytics platform transforming the way we use data to solve problems

Start your company

What your team can do in Tableau

436 tools to work with, connected with an API key.

Add Analytics Extension Connection to Site

Add an external analytics service connection to the signed-in Tableau site. Requires server or site administrator permissions and REST API 3.11 or later. On Tableau Cloud, enable SSL and authentication. Credentials must be set in Tableau, not supplied to this action; for authentication-required creation, finish credential setup in Tableau. Host paths require Server 2022.1 / Cloud April 2022 or later. No additional license required. Returned passwords are omitted.

Add Collection Items

Add items to a Tableau collection on the signed-in site. Inspect errors for per-item failures even after HTTP success; response is the impacted item count. Requires REST API 3.28+ (Cloud February 2026 / Server 2026.2). Administrators can modify collections on sites they administer; other users must own the collection. No additional license is required.

Add Collection Permissions

Add Read permissions for one or more users or groups on a collection on the signed-in Tableau site. Requires REST API 3.12 or later and server administrator, site administrator, or collection owner access. Already granted or denied permissions for a grantee are ignored; this does not replace existing rules.

Add Data Quality Warning

Add a data quality warning to an asset on the signed-in Tableau site. Requires Data Management, REST API 3.5+, and administrator or explicit asset metadata Write permission. Column assets require API 3.16+. On Cloud February 2024 and Server 2024.2 and earlier, an existing manual warning causes an error. Message is required on Server 2023.3 and earlier. Tableau recommends the newer Update Labels method for evolving label features.

Add Data Source Permissions

Add permissions to a data source for one or more users or groups on the signed-in Tableau site. Requires REST API 2.0 or later and administrator access or ChangePermissions permission on the data source. Already granted or denied capabilities are ignored; existing permission rules are not replaced.

Add Data Source to Favorites

Add a data source to a user's favorites on the signed-in Tableau site. An existing favorite with the same label is unchanged; a different label overwrites the original favorite. Non-administrators can update only their own favorites and need Read permission on the data source. Requires REST API 2.3 or later.

Add Data Source to Server Schedule

Add an extract refresh task for a data source to an existing Tableau Server schedule on the signed-in site (REST API 2.8+). Requires a server/site administrator, the data source owner, or its project leader. Server only; for Tableau Cloud use Create Cloud Extract Refresh Task.

Add Database Permissions

Add permissions for users or groups on a database asset on the signed-in Tableau site. Requires REST API 3.5 or later, Tableau Data Management, and a database associated with a published data source. Administrators or users with ChangePermissions on the asset metadata can call this action. Capabilities already granted or denied for a grantee are ignored; existing rules are not replaced.

Add Default Database Permissions

Add default permission capabilities for users or groups on table assets in a database on the signed-in Tableau site. Requires REST API 3.5 or later, Data Management, and administrator rights or ChangePermissions on the asset metadata. Existing granted or denied capabilities are ignored, not replaced. For databases in projects, use project default permissions instead: database defaults are not evaluated. Locked database defaults apply to existing and new indexed tables; unlocked database defaults apply only to newly indexed tables.

Add Default Permissions

Add default permission rules for a content type in a project for users or groups. New resources inherit these rules; locked project permissions also apply to existing child content. Requires server administrator or ProjectLeader permission. Requires REST API 2.1+, or 3.23+ for virtual connections. Database and table defaults require Tableau Catalog.

Add Domain to Pool

Associate a root domain or subdomain with an existing user-created Bridge pool on the signed-in Tableau Cloud site. Each domain can belong to only one pool at a time; adding a domain already in the pool returns an error. Requires Cloud site administrator permissions and REST API 3.28+ (March 2026); unavailable on Tableau Server. No additional license required. Returns no data.

Add Flow Permissions

Add flow permissions for one or more users or groups on the signed-in Tableau site. Requires REST API 3.3 or later and administrator access or permission to set permissions on the flow. Already granted or denied capabilities for a grantee are ignored; this does not replace existing rules.

Add Flow Task to Server Schedule

Add a flow run task to an existing Flow-type Tableau Server schedule on the signed-in site, including all current and future output steps. Requires API 3.3+, Data Management, and enabled Tableau Prep Conductor. Administrators, flow owners, or project leaders can add the task. Supports optional parameter overrides. Server only: retired for Tableau Cloud in API 3.22; use Create Cloud Flow Task there.

Add Group to Group Set

Add an existing group to a group set on the connected account's signed-in Tableau site. Requires Tableau Server administrator or Tableau Cloud site administrator permissions and REST API 3.22+ (Cloud February 2024 / Server 2024.2+). Returns no data on success.

Add or Update Monitoring Quality Warning on Content

Create or update monitoring for extract data source refresh failures or flow run failures on one or more assets on the signed-in Tableau site. Each asset has at most one monitoring warning; existing monitoring is updated. A failure attaches the warning and a successful refresh or run removes it. Requires REST API 3.11+, Data Management, and administrator or explicit asset metadata Write permission.

Add Project Permissions

Add permissions to a project for one or more users or groups on the signed-in Tableau site. Requires REST API 2.0 or later. Requires server/site administrator access, ChangePermissions (API 2.0), or ProjectLeader (API 2.1+) permission on the project. ProjectLeader cannot be denied. This sets project permissions, not default permissions for child content.

Add Projects to Routing Rule

Add project filtering conditions to an existing Bridge allow routing rule on the signed-in Tableau Cloud site, narrowing its scope to the listed projects. Projects must exist on the site and must not already be associated with the rule. Block rules are rejected. Requires Cloud REST API 3.30+ (October 2026) and site administrator privileges. Not available on Tableau Server. Returns the updated rule.

Add Table Permissions

Add permissions for users or groups on a table asset on the signed-in Tableau site. Requires REST API 3.5 or later, Tableau Data Management, and a table associated with a published data source. Administrators or users with ChangePermissions on the asset metadata can call this action. Capabilities already granted or denied for a grantee are ignored; existing rules are not replaced.

Add Tags to Column

Add one or more tags to a Tableau column asset on the signed-in site. Requires Data Management licensing and administrator access or explicit asset metadata Write permission. Available in REST API 3.9 and later.

Add Tags to Data Source

Add tags to a Tableau data source on the connected account's signed-in site. Existing tags are retained; duplicate tags are ignored. An empty list adds no tags but still requires permission. Returns both existing and new tags. Requires administrator access or Read permission on the data source. Available in REST API 1.0 and later.

Add Tags to Database

Add one or more tags to a Tableau database asset on the connected account's signed-in site. Requires Data Management licensing and either administrator access or explicit Write permission on the asset metadata. Returns the database tags supplied by Tableau. Available in REST API 3.9 and later.

Add Tags to Table

Add one or more tags to a Tableau table on the connected account's signed-in site. Requires REST API 3.9 or later and Data Management licensing. Requires a Tableau Server administrator, Tableau Cloud site administrator, or explicit edit/Write permission on the asset metadata. Returns the tags reported by Tableau.

Add Tags to View

Add tags to a Tableau view on the connected account's signed-in site. Existing tags are retained; duplicate tags are ignored. An empty list adds no tags but still requires permission. Returns both existing and new tags. Requires administrator access or Read permission on the view. Available in REST API 1.0 and later.

Add Tags to Virtual Connection

Add tags to a Tableau virtual connection on the signed-in site. Requires REST API 3.23 or later (Tableau Cloud June 2024 / Tableau Server 2024.2), Tableau Data Management, View permission on the virtual connection, and at least the Explorer site role. Returns the tags supplied by Tableau after the update.

Add Tags to Workbook

Add tags to a Tableau workbook on the connected account's signed-in site. Existing tags are retained; duplicate tags are ignored. An empty list adds no tags but still requires permission. Returns both existing and new tags. Requires administrator access or Read permission on the workbook. Available in REST API 1.0 and later.

Add User to Data-Driven Alert

Add a user to a data-driven alert's recipient list in the signed-in site. Requires Tableau REST API 3.2+ (Cloud or Server 2018.3+) and a server administrator, site administrator, or the owner of the specified alert. Returns the added user.

Add User to Group

Add an existing site user to a group on the signed-in Tableau site, or bulk add users with REST API 3.21+. Requires REST API 2.0+ and server or site administrator permissions. Supply exactly one of user_id or user_ids. A user already in the group causes a conflict. Search results may lag behind the mutation.

Add User to Identity Pool

Add an existing user on the signed-in site to an identity pool so they can sign in using that pool. Requires Tableau Server administrator permissions and REST API 3.19 or later. Not available for Tableau Cloud.

Add User to Site

Add a user to the signed-in Tableau site and assign a site role. Requires server administrator or site administrator permissions. On Cloud, name must be the sign-in email and Tableau sends an invitation. On locally authenticated Server, follow with Update User to set full name, password, and email. Inspect the returned site_role: license limits can cause successful creation as Unlicensed. Search results may lag behind creation.

Add View Permissions

Add view (sheet) permissions for one or more users or groups on the signed-in Tableau site. Requires REST API 3.2 or later and server/site administrator access or permission to set permissions on the parent workbook. The parent workbook must have showTabs set to Hide (configure with Update Workbook). Already granted or denied capabilities for a grantee are ignored; this does not replace existing rules.

Add Virtual Connection Permissions

Add permissions to a virtual connection for one or more users or groups on the signed-in Tableau site. Requires REST API 3.23 or later and administrator access or ChangePermissions permission on the virtual connection. Already granted or denied capabilities for a grantee are ignored; this does not replace existing rules.

Add Virtual Connection to Server Schedule

Add a virtual connection extract refresh task to an existing Tableau Server schedule on the signed-in site. Requires REST API 3.30+ and Data Management, Enterprise, Server+, Cloud+, or Tableau+ Bundle licensing. Only extract tables are refreshed; live tables are ignored. Administrators, virtual connection owners, or project leaders can add the task. Supports transaction level, incremental refresh, and selecting extract tables. Server only; for Tableau Cloud use Create Cloud Extract Refresh Task.

Add Work Copy Elements

Add field or table descriptions to a Tableau work copy on the signed-in site. Cannot add Column elements. Successful elements are omitted from the response; a failure reports only failed elements, and other additions may already have succeeded. Do not blindly retry a failed batch. Requires REST API 3.30+ (Cloud October 2026 / Server 2026.3), Data Management or Tableau+, and administrator access or Connect, Write (save), and VizqlDataApiAccess permissions on the original data source.

Add Workbook Permissions

Add workbook permissions for one or more users or groups on the signed-in Tableau site. Requires REST API 2.0 or later and administrator access or permission to set workbook permissions. Capabilities already granted or denied for a grantee are ignored; existing rules are not replaced.

Add Workbook to Server Schedule

Add a workbook extract refresh task to an existing matching schedule on Tableau Server (API 2.8+). Not available on Tableau Cloud. Requires workbook ownership, project leadership, or administrator permissions. Legacy data acceleration requires an administrator and API 3.8–3.15; acceleration is retired in Server 2026.2.

Append to File Upload

Append one file block to a previously initiated upload on the signed-in Tableau site. Requires REST API 2.0+ and publishing rights for non-administrators. Repeat for each block, then use Publish Data Source, Publish Flow, or Publish Workbook to commit. The operation reference limits files to 10,000 blocks. sequence_id (API 3.27+) orders blocks and enables parallel uploads; otherwise blocks use arrival order. Does not automatically retry appends.

Batch Add or Update Data Quality Certifications

Create or update certifications for one or more content or asset items on the signed-in Tableau site. Each item can have only one certification; an existing certification is updated with the supplied values. Requires REST API 3.13+, Data Management, and administrator or explicit asset metadata Write permission. Tableau recommends the newer Update Labels method for evolving label features.

Batch Add or Update Data Quality Warnings

Add or update the same data quality warning on multiple assets on the signed-in Tableau site. Requires REST API 3.12+, Data Management, and administrator or explicit asset metadata Write permission. Column assets require API 3.16+. Tableau recommends the newer Update Labels method for evolving label features.

Batch Add Tags

Add multiple tags to mixed Tableau content and assets on the signed-in site: databases, tables, columns, data sources, workbooks, and flows. Requires Data Management licensing and administrator access or explicit asset metadata Write permission. Available in REST API 3.9 and later.

Batch Create Pulse Subscriptions

Create multiple subscriptions to a Tableau Pulse metric for users and/or groups. Available only on Tableau Cloud with REST API 3.21 or later, not Tableau Server. Requires read or connect permission to the data source used in the definition.

Batch Delete Data Quality Warnings

Delete data quality warnings from multiple assets on the signed-in Tableau site. Requires REST API 3.12+, Data Management, and administrator or explicit asset metadata Write permission. Column assets require API 3.16+. Tableau recommends the newer Delete Labels method for evolving label features. Returns no data on success.

Batch Delete Tags

Delete multiple tags from mixed Tableau content and assets on the signed-in site: databases, tables, columns, data sources, workbooks, and flows. Requires REST API 3.9+, Data Management licensing, and administrator access or explicit asset metadata Write permission. Returns no data on success.

Batch Get Pulse Subscriber CountsReads only

Get unique-user subscriber counts for Tableau Pulse metrics specified as comma-separated LUIDs. Each user is counted once per metric, including members of subscribed groups and individual followers. Available on Tableau Cloud REST API 3.21 or later; unavailable on Tableau Server. Requires read or connect permission on the metric definition's data source.

Batch Get Pulse SubscriptionsReads only

Get a batch of Tableau Pulse subscriptions, including followers, metric IDs, and creation/update times. Requires read or connect permission on the definition's data source. Tableau Cloud API 3.21+ only; unavailable on Tableau Server. The provider's operation specification does not declare the subscription-ID selection parameter, so this action currently exposes no batch-selection input.

Batch List Metric Definitions (Many)Reads only

Retrieve Tableau Pulse metric definitions by an array of LUIDs using the POST batch lookup optimized for large batches. Returns visible definitions and per-item errors; inspect errors for partial failures. Any user can call this, but only metrics they have permission to view are returned. Tableau Cloud only, REST API 3.24+; unavailable on Tableau Server. This is a read operation and does not create definitions.

Batch List Metrics (Many)Reads only

Retrieve Tableau Pulse metrics by an array of LUIDs using POST for large batches that could exceed URL limits. Returns only metrics the signed-in user can view, plus per-metric errors; inspect errors for partial failures. Requires read or connect access to the definition's data source. Tableau Cloud REST API 3.26 or later only; unavailable on Tableau Server. This read operation does not create metrics.

Batch Update Collections

Batch update Tableau collection names, descriptions, or owners on the signed-in site. Inspect errors and response for partial failures even after HTTP success. Requires REST API 3.28+ (Cloud February 2026 / Server 2026.2). Administrators can update collections on sites they administer; other users can update only collections they own. No additional license is required.

Batch Update Schedule State

Activate or suspend selected schedules, or all schedules on the entire Tableau Server with update_all=true (across sites; supplied IDs are ignored). Requires server administrator access and REST API 3.27+ (Server 2025.3+); unavailable on Tableau Cloud. Returns only schedules whose state changed. When suspending all schedules for maintenance, retain the returned LUIDs and reactivate only those afterward: activating all can enable schedules intentionally suspended beforehand.

Block Domain

Block or unblock a domain for every Bridge pool on the signed-in Tableau Cloud site. Blocking takes precedence over pool assignments, prevents adding the domain to any pool, and may terminate existing connections from that domain. Set is_blocked=false to unblock. Requires REST API 3.28+ (March 2026) and site administrator permissions; unavailable on Tableau Server. No additional license is required. Returns no data on success.

Cancel Flow Run

Cancel an in-progress flow run on the signed-in Tableau site. Requires REST API 3.10 or later. Server and site administrators may cancel runs; other users must have initiated the run or created its scheduled task, and have Run Flow Now permission. Already completed runs cannot be canceled. Returns no data on success.

Cancel Job

Cancel a queued or in-progress job on the signed-in Tableau site. Requires a server or site administrator and REST API 3.1 or later. Supports extract refreshes (including Bridge), subscriptions, flow runs, and thumbnail jobs. Completed jobs cannot be canceled. Returns no data on success.

Configure Identity Store

Configure a new local identity store to provision users, in addition to the store configured during Tableau Server setup. The name must be unique. Requires server administrator permissions and Tableau Server 2023.1 / REST API 3.19 or later. Not available for Tableau Cloud; new Active Directory or LDAP stores are not supported.

Create an Extract for a Data Source

Create an extract for a data source on the signed-in Tableau site, optionally requesting encryption. Requires REST API 3.5+ and a server/site administrator, the data source owner, or an owner/leader of its project. File-based and other unsupported data sources cannot be extracted. Returns an asynchronous job; use Query Job to check completion.

Create Bridge Pool

Create an empty Bridge pool with a site-unique name on the signed-in Tableau Cloud site. Requires REST API 3.28+ (March 2026) and site administrator permissions; unavailable on Tableau Server. No additional license is required. After one successful POST (201, no body), performs one read-after-create List Bridge Pools request to resolve the provider ID and name by a unique exact name match. Returns created=true even if the lookup fails or the pool is not visible yet, with null pool_id/name, lookup_status and an informative note. In that case use List Bridge Pools later; do not retry creation.

Create Cloud Extract Refresh Task

Create a custom extract refresh schedule on the signed-in Tableau Cloud site (API 3.20+). Targets a workbook, data source, or virtual connection (API 3.30+). Not available on Tableau Server. Requires an administrator or Creator role. Virtual connections require Data Management, Enterprise, Server+, Cloud+, or Tableau+ Bundle.

Create Cloud Flow Task

Create a scheduled flow task on the signed-in Tableau Cloud site. Requires REST API 3.22+, Data Management, and enabled Tableau Prep Conductor. Not available on Tableau Server. Caller must be an administrator, flow owner, or project leader. Returns the created task and schedule; does not wait for a flow run.

Create Collection

Create a Tableau collection on the signed-in site, optionally with a description. If the name already exists for the user, Tableau appends a number. Requires REST API 3.28+ (Cloud February 2026 / Server 2026.2). Administrators can call this for sites they administer; other users can create their own collections. No additional license required.

Create Connected App

Create a direct-trust Tableau connected app on the signed-in site using PAT or password authentication. Requires Tableau Server admin or Tableau Cloud site admin and REST API 3.17+. Optionally restrict embedding domains and projects. Multiple project scoping requires Cloud API 3.22+ or Server API 3.23+. Apps default to disabled. Does not create an app secret.

Create Data Driven Alert

Create a data driven alert on a view with a single data axis in the signed-in site. Tableau Cloud only, REST API 3.20+; unavailable on Tableau Server. Requires Administrator, Creator, or Explorer role and permission to the view. Provide exactly one view or custom view LUID and the underlying worksheet name. The returned id may be numeric rather than a REST LUID; resolve the REST LUID with LIST_DATA_DRIVEN_ALERTS_ON_SITE before GET/DELETE if no luid is returned.

Create Extracts for Embedded Data Sources in a Workbook

Queue extract creation for all or selected data sources of a workbook on the signed-in Tableau site, optionally requesting encryption. Returns an asynchronous job without waiting for completion. Requires REST API 3.5+, an administrator, workbook owner, or project owner/leader. Fails if the site RunNow setting is disabled or a data source cannot be extracted. Workbook extracts remain specific to the workbook.

Create Group

Create a local group on the signed-in Tableau site, or import an Active Directory group on Tableau Server synchronously or as a background job. Requires REST API 3.9+ and Tableau Server administrator or Tableau Cloud site administrator permissions. Search results may lag behind creation. On-demand embedded access requires Cloud API 3.21+ and eligible licensing.

Create Group Set

Create an empty named group set on the signed-in Tableau site. Requires REST API 3.22+ (Cloud February 2024 / Server 2024.2+) and Tableau Server administrator or Tableau Cloud site administrator permissions. Add groups separately after creation; this action cannot populate the group set. Names are unique case-insensitively.

Create Identity Pool

Create an identity pool using existing authentication and identity store instance IDs. The name must be unique and is visible to users at sign-in. Requires server administrator permissions and Tableau Server 2023.1 / REST API 3.19 or later. Not available for Tableau Cloud.

Create Label Category

Create a data label category on the signed-in Tableau site (REST API 3.21+, Cloud October 2023 / Server 2023.3). Requires a site or server administrator. Data Management is not required for category creation, but is required to manage and see labels on assets. Server 2023.3 and earlier restrict names to 24 characters.

Create Metric

Create a Tableau Pulse metric for an existing definition on the connected Tableau Cloud site. Requires REST API 3.21 or later and read or connect access to the definition's data source. Not available on Tableau Server.

Create Metric Definition

Create a Tableau Pulse metric definition on the connected Tableau Cloud site. Requires REST API 3.21 or later and write and publish access to the source data source. Not available on Tableau Server. Point-in-time temporality cannot use running totals.

Create Metric Tag for User

Create a tag for a Tableau Pulse metric for the signed-in user. Tags affect Pulse views only for that user. Requires permission to view the metric. Tableau Cloud only, REST API 3.25 (March 2025) or later; unavailable on Tableau Server.

Create or Update Label Value

Create a data label value by name or update the value with that name on the signed-in Tableau site. Requires a site or server administrator, Cloud REST API 3.20+ (June 2023) or Server 3.21+ (2023.3). Category must already exist and cannot change on update. To rename, use Update labelValue. Data Management is not required for label values but is required to manage and see labels on assets. Server 2023.3 and earlier limit names to 24 characters.

Create Project

Create a Tableau project on the connected PAT's signed-in site, optionally under a parent project, with an owner, content permission policy, and sample workbooks. Requires REST API 1.0 or later and appropriate Tableau project-creation permissions. Search results may lag behind creation.

Create Routing Rule

Create a Bridge routing rule on the signed-in Tableau Cloud site. Allow a domain through a target Bridge pool, optionally limited to projects, or block the domain. Requires REST API 3.30+ (October 2026), site administrator privileges and Bridge enabled on the site. Not available on Tableau Server. Returns the created rule.

Create SCIM Configuration

Create a SCIM configuration on the signed-in Tableau Cloud site and associate it with an existing authentication configuration. Requires a Cloud site administrator and REST API 3.26+; SAML is supported from 3.26, OIDC or Google from 3.28. Configure site authentication first. This creates the SCIM association, not an authentication configuration or a SCIM bearer token; token activation is reported separately. Each invocation signs in using the connected PAT or username/password to obtain a REST session, then sends one creation request without retrying the mutation.

Create Semantic Context

Create a graph-wide business preference carrying one or more statements in Tableau Knowledge. Set is_global to true (the tool default). Requires a Creator role and content permissions on Tableau Cloud+ September 2026 or later; unavailable on Tableau Server. Uses independent Knowledge API v1 regardless of the classic REST sign-in version. Returns the created preference and stored statement IDs.

Create Server Schedule

Create a server-wide schedule on Tableau Server (REST API 2.3+). Requires server administrator permissions; not supported on Tableau Cloud. Flow schedules require Tableau Prep Conductor. DataAcceleration was retired in Server 2026.2. Newly created schedules may not immediately appear in search results.

Create Site

Create a Tableau Server site. Requires a server administrator; not available on Tableau Cloud. Supply a name and content URL, optionally configure quotas, subscriptions, flows, security, and other site settings. Search indexing can lag behind creation; inspect the returned site LUID and normalized content URL.

Create Subscription

Create a classic email subscription to a workbook or view for a user on the signed-in Tableau site. Tableau Server (API 2.3+) uses an existing Subscription-type schedule inside subscription; Tableau Cloud (API 3.20+) uses a top-level custom schedule. Not a Pulse subscription. The user needs an email address and Read permission. Administrators, project leaders, and content owners can subscribe other users within their permissions; non-owners can subscribe themselves. Cloud custom schedules require an administrator, Creator, or Explorer role. New subscriptions may not immediately appear in search.

Create Tableau MCP Settings for Site

Replace the entire current list of Tableau MCP settings for the signed-in site. Requires server or site administrator permissions and REST API 3.29+ (Tableau Cloud June 2026 / Tableau Server 2026.2 or later). No additional license is required. Existing settings are replaced, not merged.

Create Webhook

Create a webhook in the signed-in Tableau site (REST API 3.6+). Requires a server or site administrator. Specify a supported API trigger event and an HTTPS destination with a valid certificate. Deliveries use POST; the webhook is enabled by default unless is_enabled is false.

Create Work Copy

Create a work copy of a published Tableau data source on the signed-in site and return its LUID. Requires REST API 3.30 or later (Cloud October 2026 / Server 2026.3) and Data Management or Tableau+. Non-administrators need Connect, Write (save), and VizqlDataApiAccess permissions. Composable and Semantic Data Model data sources are unsupported. The maximum open work copy limit can prevent creation.

Decrypt Extracts in a Site

Decrypt ALL .hyper extracts across the connected account's entire signed-in Tableau Server site (SITE-WIDE scope), removing their encryption at rest. Requires a Tableau Server administrator and REST API 3.5 or later. Depending on extract count and size, this can consume significant server resources; consider running outside normal business hours. Returns no data on HTTP 200; does not verify individual extract decryption completion.

Delete All Recycle Bin Contents

Permanently delete all contents of the signed-in site's Recycle Bin. This cannot be undone: administrators delete all content in the site's Recycle Bin; other users delete only content they own. This does not move active content into the Recycle Bin. Optionally run asynchronously with as_job=true and use Query Job to check completion. Requires an enabled Recycle Bin and REST API 3.29 or later (Tableau Cloud June 2026 / Server 2026.2). No additional license required.

Delete Analytics Extension Connection From Site

Delete a specific analytics extension connection for an external service from the signed-in Tableau site. Requires site or server administrator permissions. Available in REST API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. No additional license required. Returns no data on success.

Delete Authentication Configuration

Delete an authentication instance by its integer ID on Tableau Server 2023.1 (REST API 3.19) or later. Requires server administrator permissions; unavailable on Tableau Cloud. No additional license is required. Returns no data on success.

Delete Bridge Client

Permanently remove a Bridge client from the signed-in Tableau Cloud site. This operation is irreversible: pool assignments are revoked, and the client must be re-registered to reconnect. Data sources and scheduled refreshes using the client will be affected; use unassigned status for temporary deactivation. Requires REST API 3.28+ (March 2026) and site administrator permissions; unavailable on Tableau Server. No additional license is required. Returns no data on success.

Delete Bridge Pool

Permanently delete a Bridge pool and all its associated domain mappings from the signed-in Tableau Cloud site. Move all assigned Bridge clients out of the pool first. Reserved system pools cannot be deleted. This operation is irreversible and makes the pool ID invalid. Requires REST API 3.28+ (March 2026) and site administrator permissions; unavailable on Tableau Server. No additional license is required. Returns no data on success.

Delete Collection Permission

Remove one specified Allow or Deny Read permission for a user or group on a collection in the signed-in Tableau site. Requires a server administrator, site administrator, or collection owner and REST API 3.12 or later. Returns no data on success.

Delete Collections

Delete one or more Tableau collections on the signed-in site. One ID selects single deletion; multiple IDs select batch deletion. Inspect errors and response for partial failures: HTTP success does not mean every collection was deleted. Requires REST API 3.28+ (Cloud February 2026 / Server 2026.2). Administrators may delete collections on sites they administer; other users may delete only collections they own. No additional license is required.

Delete Connected App

Permanently delete a direct-trust connected app and all its associated secrets from the signed-in Tableau site. Requires Tableau Server administrator or Tableau Cloud site administrator permissions and REST API 3.17+ for the direct-trust endpoint. Returns no data on success.

Delete Custom Domain Settings

Delete the custom domain setup for a specified Tableau Cloud site. Requires administrator permissions and REST API 3.26+ (June 2025). Unavailable on Tableau Server. No additional license required. Returns an optional site LUID; a successful HTTP 204 response may be empty.

Delete Custom View

Delete a custom view from the connected account's signed-in Tableau site. Tableau administrators can delete any custom view; other users can delete their own custom views. Requires REST API 3.18+ (Tableau Cloud December 2022 / Server 2023.1). No additional license is required. Returns no data on success.

Delete Data Quality Certification by ID

Delete a data quality certification by its LUID from the signed-in Tableau site. Requires Data Management licensing and Tableau Server admin, Tableau Cloud site admin, or explicit asset metadata edit/Write permission. Requires REST API 3.13+. Tableau recommends the newer Delete Label method for ongoing label management. Returns no data on success.

Delete Data Quality Certifications by Content

Delete data quality certifications from one or more assets on the signed-in Tableau site. Requires REST API 3.13+, Data Management licensing, and Tableau Server admin, Tableau Cloud site admin, or explicit asset metadata edit/Write permission. Tableau recommends the newer Delete Labels method for evolving label features. Returns no data on success.

Delete Data Quality Warning by Content

Delete the data quality warnings from an asset on the signed-in Tableau site. Requires Data Management and administrator or explicit asset metadata Write permission. Requires REST API 3.5+; column assets require 3.16+. Returns no data on success. Tableau recommends the newer Delete Labels method for evolving label features.

Delete Data Quality Warning by ID

Delete a data quality warning by its LUID from the signed-in Tableau site. Requires REST API 3.5+, Data Management licensing, and Tableau Server administrator, Tableau Cloud site administrator, or explicit asset metadata Write permission. Tableau recommends the newer Delete Label method for evolving label features. Returns no data on success.

Delete Data Source

Delete a Tableau data source from the connected account's signed-in site. Also deletes its associated data connection. Workbooks using this data source are retained but will no longer work properly. Requires administrator privileges or Read (view) and Delete permissions on the data source, and REST API 2.0 or later. Returns no data on success.

Delete Data Source from Favorites

Remove a data source from a user's favorites on the signed-in Tableau site, without deleting the data source. Non-administrators can update only their own favorites and need Read permission on the data source. Requires REST API 2.3 or later. Returns no data on success; Tableau may return a not-found error for a data source that is not a favorite.

Delete Data Source Permission

Delete one specified Allow or Deny capability permission for a user or group on a data source in the signed-in Tableau site. Requires administrator privileges or permission to delete permissions on the data source and REST API 2.0 or later. Returns no data on success.

Delete Data-Driven Alert

Delete a data-driven alert from the connected account's signed-in Tableau site. Requires a server or site administrator, or an owner or recipient of the alert. Available in REST API 3.2+ (Tableau Cloud / Tableau Server 2018.3+). No additional license is required. Returns no data on success.

Delete Database Permissions

Remove one explicit Allow or Deny capability for a user or group from a Tableau database asset on the signed-in site. Requires REST API 3.5 or later, Data Management licensing, and an asset associated with a published data source. The caller must be a server/site administrator or have ChangePermissions on the asset metadata. Locked assets cannot be changed. Returns no data on success.

Delete Default Database Permissions

Permanently remove one Allow or Deny default capability for a user or group on a database asset in the signed-in Tableau site. Newly indexed child tables will no longer receive that default permission. Requires REST API 3.5 or later, Data Management licensing, and administrator rights or explicit Write permission on the asset metadata. For databases in projects, database defaults are not evaluated; use project default permissions instead. Returns no data on success.

Delete Default Permission

Remove one default Allow or Deny capability for a user or group on a content type in a Tableau project. Newly added content no longer inherits that rule; if permissions are locked to the project, existing child content is also affected. Requires server administrator or ProjectLeader permission and REST API 2.1+, or 3.23+ for virtual connections. Database and table defaults require Tableau Catalog. Returns no data on success.

Delete Domain

Remove a Bridge domain mapping from the signed-in Tableau Cloud site. The domain is disassociated from any pool and can be re-added later. Deleting a blocked domain unblocks it. Deletion is immediate: existing connections may be terminated and Bridge clients from the domain lose access until it is re-added to a pool. Requires Cloud site administrator permissions and REST API 3.28+ (March 2026); unavailable on Tableau Server. No additional license required. Returns no data on success.

Delete Extract from Data Source

Delete the extract from a data source on the signed-in Tableau site. Requires REST API 3.5 or later and a server/site administrator, the data source owner, or an owner/leader of its project. File-based and other unsupported data source forms can be rejected. Returns no data on success.

Delete Extract Refresh Task

Delete an extract refresh task from the connected account's signed-in Tableau site. On Tableau Cloud this also deletes the task's custom schedule; on Tableau Server it removes the item from the shared schedule without deleting the schedule. Requires administrator privileges or Read and Delete permissions on the task. Requires REST API 3.6+; virtual connection support requires 3.30+. Returns no data on success.

Delete Extracts from Virtual Connection

Delete all extracts from a virtual connection on the signed-in Tableau site, changing it from extract to live mode. Individual tables cannot be targeted. Requires REST API 3.30+ and a Data Management, Enterprise, Server+, Cloud+, or Tableau+ Bundle license. The caller must be a server/site administrator, the virtual connection owner, or an owner/leader of its project. Returns no data on success.

Delete Extracts of Embedded Data Sources from a Workbook

Delete all extracts of embedded data sources in a workbook on the signed-in Tableau site. Requires REST API 3.5 or later and a server/site administrator, data source owner, or owner/leader of the data source's project. This operation can consume significant server resources; consider running outside normal business hours. Returns no data on success.

Delete Flow

Delete a flow from the connected account's signed-in Tableau site. Also deletes its associated connections, output and input steps, scheduled tasks, and run history. Requires administrator privileges or Read (view) and Delete permissions for the flow, and REST API 3.3 or later. Returns no data on success.

Delete Flow Permission

Delete one specified Allow or Deny capability permission for a user or group on a flow in the signed-in Tableau site. Requires administrator privileges or ChangePermissions on the flow and REST API 3.3 or later. Returns no data on success.

Delete Group

Delete a group from the connected account's signed-in Tableau site. Users are not deleted, but lose membership in this group and permissions previously assigned to it. Requires a site administrator and REST API 2.1 or later. The All Users group cannot be deleted. Returns no data on success.

Delete Group Set

Delete a group set from the connected account's signed-in Tableau site. Users are not deleted, but lose group set membership and permissions previously assigned to the group set no longer apply. Requires Tableau Server administrator or Tableau Cloud site administrator permissions and REST API 3.22+ (Cloud February 2024 / Server 2024.2+). Returns no data on success.

Delete Identity Pool

Delete an identity pool on Tableau Server 2023.1 (REST API 3.19) or later. Requires server administrator permissions; unavailable on Tableau Cloud. Move users to another identity pool first: users cannot sign in unless they belong to an identity pool. No additional license is required. Returns no data on success.

Delete Identity Store

Delete an identity store on Tableau Server 2023.1 (REST API 3.19) or later. Requires server administrator permissions; unavailable on Tableau Cloud. The identity store configured during Tableau Server setup cannot be deleted. No additional license is required. Returns no data on success.

Delete Label

Delete a data label by LUID on the signed-in Tableau site. Cannot delete automatically managed extract_refresh_failure or flow_run_failure monitoring warnings. Non-certification labels require write permission on the asset. Certification labels require an administrator, project leader, or product owner; external assets outside a project require change permissions. Catalog and a Data Management license are required except for data source certification. Available on Cloud June 2022 (API 3.16+) and Server 2022.3 (API 3.17+). Returns no response fields.

Delete Label Category

Delete an existing custom data label category on the signed-in Tableau site. Built-in categories cannot be deleted. Requires a site or server administrator. No Data Management license is required for category deletion (one is required to manage and see labels on assets). Available on Tableau Cloud October 2023 / Server 2023.3 with REST API 3.21+. Returns no documented response fields.

Delete Labels

Delete data labels on one or more assets on the signed-in Tableau site, optionally limited to comma-separated categories. Cannot delete automatically managed extract_refresh_failure or flow_run_failure warnings. Non-certification labels require asset write permission. Certification requires administrator, project leader or product owner privileges; external assets outside projects require change permissions. Catalog and Data Management are required except for data source certification. Available on Cloud API 3.16+ and Server API 3.17+. Returns no response fields.

Delete labelValue

Delete a label value on the signed-in Tableau site. A customized built-in label value is reverted to its built-in defaults instead of deleted; assets using it reflect those defaults. Requires a site or server administrator. No Data Management license is required to delete label values (one is required to manage and see labels on assets). Available on Cloud June 2023 (REST API 3.20+) and Server 2023.3 (3.21+). Returns no documented response fields.

Delete Metric Definition

Delete a Tableau Pulse metric definition and all related metrics and their subscriptions. Requires write and publish access to the definition's data source. Available only on Tableau Cloud, REST API 3.21 or later; not available on Tableau Server. Returns no data on success.

Delete Metric Tag

Delete the specified tag from a Tableau Pulse metric. Anyone can request this operation, but users see results only for metrics they have permission to view. Available only on Tableau Cloud, REST API 3.25 (March 2025) or later, not Tableau Server. No additional license required. Returns no data on success.

Delete Project

Delete a Tableau project on the connected PAT's signed-in site. Also deletes all Tableau assets inside the project, including workbooks, data sources, project view options, and rights. External assets such as databases and tables are not deleted. Requires a server or site administrator and REST API 1.0 or later. Default projects cannot be deleted. Returns no data on success.

Delete Project from Favorites

Remove a project from a user's favorites on the signed-in Tableau site. Leaves the project itself intact. If the project is not a favorite, this call has no effect. Non-administrators can update only their own favorites. Requires REST API 3.1 or later. Returns no data on success.

Delete Project Permission

Remove one Allow or Deny project capability for a user or group on the signed-in Tableau site. Requires REST API 2.0 or later. The caller must be a server/site administrator or have ChangePermissions (API 2.0) or ProjectLeader (API 2.1+) permission for the project. Returns no data on success.

Delete Pulse Metric

Delete a Tableau Pulse metric. A definition's default metric cannot be deleted individually; attempting this returns HTTP 400. Requires write and publish access to the data source used in the definition. Available only on Tableau Cloud, REST API 3.21 or later, not Tableau Server. Returns no data on success.

Delete Pulse Subscription

Delete a specified Tableau Pulse subscription to a metric. Requires read or connect permission to the data source used in the metric definition. Available only on Tableau Cloud, REST API 3.21 or later, not Tableau Server. Returns no data on success.

Delete Quality Warning Trigger by ID

Permanently remove a quality warning trigger by its LUID from the signed-in Tableau site. Requires REST API 3.11+, Data Management licensing, and Tableau Server administrator, Tableau Cloud site administrator, or explicit asset metadata Write permission. Returns no data on success.

Delete Quality Warning Triggers by Content

Permanently remove all quality warning triggers from one or more data sources or flows on the signed-in Tableau site. Each call targets one content type. Requires REST API 3.10+, Data Management, and administrator or explicit asset metadata Write permission. Returns no data on success.

Delete Recycle Bin Content Item

Permanently delete a specified content item from the signed-in site's Recycle Bin. This is permanent deletion, not moving content into the Recycle Bin, and cannot be undone. Supports workbooks, datasources, flows, and projects. Administrators can delete any Recycle Bin content; other users can delete only content they own. Requires Recycle Bin to be enabled and REST API 3.29 or later (Tableau Cloud June 2026 / Server 2026.2). Returns no data on success.

Delete Routing Rule

Permanently delete a Bridge allow or block routing rule from the signed-in Tableau Cloud site. Deletion is immediate: the domain is no longer routed or blocked by this rule. A nonexistent rule returns an error. Requires REST API 3.30+ (October 2026) and site administrator permissions. Not available on Tableau Server. No additional license is required. Returns no data on success.

Delete SCIM Configuration

Permanently remove a SCIM configuration and its associated SCIM token from the signed-in Tableau Cloud site. Requires a Cloud site administrator and REST API 3.26+. You must be the configuration's creator unless the creator is no longer a member of the site. After deletion, also remove the SCIM token's secret from the identity provider's SCIM settings; this action does not change those settings. Returns no data on success (HTTP 204). Each invocation signs in with the connected PAT or username/password to obtain a REST session, then sends one deletion request without retrying the mutation.

Delete Semantic Context

Delete a business preference created and managed in Tableau Knowledge, along with its statements. Idempotent: absent, hidden, or non-business-preference nodes return empty success without deletion. Visible Tableau-managed business preferences cannot be deleted and return a conflict. Requires Creator role, content permissions, and Tableau Cloud+ September 2026 or later; unavailable on Tableau Server. Uses independent Knowledge API v1 regardless of the classic REST sign-in version.

Delete Server Schedule

Delete the specified schedule on Tableau Server. Requires server administrator permissions and REST API 2.3 or later. Unavailable on Tableau Cloud; use Delete Extract Refresh Task or Delete Subscription there. Returns no data on success.

Delete Server Session

Delete the specified existing Tableau Server session, terminating that session; typically used to manage embedded Tableau session lifecycles. Requires server administrator permissions and REST API 3.9 or later. Unavailable on Tableau Cloud. Uses the connected account to sign in for authorization, then deletes the session identified by session_id, not automatically the new REST authentication session. Returns no data when Tableau confirms HTTP 204. The deletion is not automatically retried.

Delete Site

Permanently delete an entire Tableau Server site and its site-wide content. This is destructive, not removal of a user or an individual workbook. Requires a server administrator signed in to a site; unavailable on Tableau Cloud. The default Tableau Server site cannot be deleted. Explicitly select the target by LUID, name, or content URL. Synchronous success returns no job; asynchronous deletion (REST API 3.18+) returns a job to track with Query Job, not completion.

Delete Subscription

Delete a subscription on the connected account's signed-in Tableau Server or Tableau Cloud site. Users can delete subscriptions they had permission to create. Requires REST API 2.3 or later. Returns no data on success.

Delete Table Permissions

Permanently remove one explicit Allow or Deny capability permission for a user or group on a table asset in the signed-in Tableau site. Requires REST API 3.5 or later, Data Management, and a table associated with a published data source. Requires a server or site administrator, or explicit ChangePermissions on the asset metadata. Returns no data on success.

Delete Tag from Column

Delete one tag from a Tableau column asset on the signed-in site. Requires Data Management licensing and server/site administrator access or explicit asset metadata Write permission. Available in REST API 3.9 and later. Returns no data on success.

Delete Tag from Data Source

Delete one tag from a Tableau data source on the connected account's signed-in site. Users who are not server administrators, site administrators, or data source owners must be project leaders or have originally added the tag. Available in REST API 1.0 and later. Returns no data on success.

Delete Tag from Database

Delete one tag from a Tableau database asset on the connected account's signed-in site. Requires Data Management licensing and either server/site administrator access or explicit Write permission on the asset metadata. Available in REST API 3.9 and later. Returns no data on success.

Delete Tag from Table

Delete one tag from a Tableau table on the connected account's signed-in site. Requires REST API 3.9 or later and Data Management licensing. Requires a Tableau Server administrator, Tableau Cloud site administrator, or explicit edit/Write permission on the asset metadata. Returns no data on success.

Delete Tag from View

Delete one tag from a Tableau view on the connected account's signed-in site. Users who are not server administrators, site administrators, or workbook owners must be project leaders or have originally added the tag. Available in REST API 1.0 and later. Returns no data on success.

Delete Tag from Virtual Connection

Delete one tag from a Tableau virtual connection on the connected account's signed-in site. Requires REST API 3.23 or later (Tableau Cloud June 2024 / Tableau Server 2024.2), Tableau Data Management, View permission on the virtual connection, and at least the Explorer site role. Returns no data on success.

Delete Tag from Workbook

Delete one tag from a Tableau workbook on the connected account's signed-in site. Users who are not server administrators, site administrators, or workbook owners must be project leaders or have originally added the tag. Available in REST API 1.0 and later. Returns no data on success.

Delete User from Data-Driven Alert

Remove a specified user from the recipients list of a data-driven alert in the connected account's signed-in Tableau site. Requires a server or site administrator, or the owner of the alert. Available in REST API 3.2+ (Tableau Cloud / Tableau Server 2018.3+). No additional license is required. Returns no data on success.

Delete Users from Site with CSV

Upload a CSV file to create an asynchronous job removing the listed users from the signed-in Tableau site. Requires server or site administrator permissions and REST API 3.15+. Returns the job for tracking on HTTP 201, or no data on HTTP 204. A queued job does not confirm that users have been removed; check its status separately. The mutation is not automatically retried.

Delete View

Delete a view from a workbook on the connected account's signed-in Tableau site. Deleting the only view in a workbook also deletes the workbook. Requires administrator privileges or Read (view) and Delete permissions for the view. Available in REST API 3.27+ (Tableau Cloud December 2025 / Server 2025.3). Returns no data on success.

Delete View from Favorites

Remove a view from a user's favorites on the signed-in Tableau site. Leaves the view itself intact. If the view is not a favorite, this call has no effect. Non-administrators can update only their own favorites. Requires REST API 2.0 or later. Returns no data on success.

Delete View Permission

Remove one explicit Allow or Deny capability for a user or group from a Tableau view (sheet) on the signed-in site. Requires REST API 3.2 or later and server/site administrator status or ChangePermissions on the view. The parent project must not have locked permissions, and the parent workbook must have tabs disabled so the view does not inherit its permissions. Returns no data on success.

Delete Virtual Connection

Delete a virtual connection from the connected account's signed-in Tableau site. Requires Tableau Data Management, Delete permission for the virtual connection, a site role of at least Creator, and REST API 3.23 (Cloud June 2024 / Server 2024.2) or later. Returns no data on success.

Delete Virtual Connection Permission

Remove one specified Allow or Deny capability permission for a user or group on a virtual connection in the signed-in Tableau site. Requires REST API 3.23 or later and administrator privileges or Delete permission on the virtual connection (explicit or implicit). Returns no data on success.

Delete Webhook

Delete a webhook from the connected account's signed-in Tableau site. Requires a server or site administrator and Tableau REST API 3.6 or later. Returns no data on success.

Delete Work Copy Elements

Delete named columns, field descriptions, or table descriptions from a Tableau work copy on the signed-in site. Returns confirmation only when all elements succeed. Failures list only failed elements; other deletions may already have succeeded. Requires REST API 3.30+ (Cloud October 2026 / Server 2026.3), Data Management or Tableau+, and administrator access or Connect, Write (save), and VizqlDataApiAccess permissions on the original data source.

Delete Workbook

Delete a Tableau workbook from the connected account's signed-in site. Also deletes all associated assets, including views and data connections. Requires administrator privileges or Read (view) and Delete permissions on the workbook, and REST API 2.0 or later. Returns no data on success.

Delete Workbook from Favorites

Remove a workbook from a user's favorites on the signed-in Tableau site. Leaves the workbook itself intact. If the workbook is not a favorite, this call has no effect. Non-administrators can update only their own favorites. Requires REST API 2.0 or later. Returns no data on success.

Delete Workbook Permission

Delete one specified Allow or Deny capability permission for a user or group on a workbook in the signed-in Tableau site. Requires administrator privileges or ChangePermissions on the workbook and REST API 2.0 or later. Returns no data on success.

Download Data SourceReads only

Download a published Tableau data source as a .tdsx file from the signed-in site. Optionally omit its extract to reduce download size. Non-administrators require ExportXml permission on the data source. Requires REST API 2.0 or later.

Download Data Source RevisionReads only

Download a historical revision of a Tableau data source as a .tdsx file from the signed-in site. Requires version history enabled and REST API 2.3 or later. Site administrators can download revisions; other users need ExplorerCanPublish, Read/Write/Download permissions on the data source, and Save permission on its project. Use DOWNLOAD_DATA_SOURCE for the current version.

Download FlowReads only

Download a Tableau flow from the signed-in site as a .tfl or .tflx file. Requires REST API 3.3+ and administrator access or download permission on the flow.

Download View Crosstab ExcelReads only

Download a view's summary-level crosstab as an Excel (.xlsx) file from the signed-in site. Dashboards export only their first view; story dashboards are unsupported. Optionally filter by workbook fields and set the maximum cache age. Non-administrators need Read and ExportData permissions on both the workbook and view. Requires REST API 3.9 or later.

Download Virtual ConnectionReads only

Download a Tableau virtual connection as a packaged .tvcx file from the signed-in site. Extracts are always included and encrypted extracts are decrypted before packaging. Requires REST API 3.30+ and Data Management, Enterprise, Server+, Cloud+, or Tableau+ Bundle licensing. Requires Overwrite permission and at least the Creator site role, or site/server administrator access.

Download Virtual Connection as JSONReads only

Retrieve a Tableau virtual connection's JSON schema and project/owner metadata on the signed-in site. Returns a typed JSON response whose content property contains serialized JSON, not a .tvcx file. Requires REST API 3.23 or later, Tableau Data Management, Overwrite permission on the virtual connection, and at least the Creator site role.

Download Virtual Connection Revision as JSONReads only

Retrieve the JSON representation of an earlier virtual connection revision on the signed-in Tableau site. Returns metadata and a content string containing serialized JSON, not a .tvcx file. Use List Virtual Connection Revisions to find the revision number. Requires REST API 3.23 or later, Tableau Data Management, Overwrite permission on the virtual connection, and at least the Creator site role.

Download WorkbookReads only

Download a Tableau workbook as a .twb or .twbx file from the signed-in site. Optionally omit its extract to reduce download size. Non-administrators require ExportXml permission on the workbook. Downloaded content, including data and filter values, is readable by anyone who opens the file. Requires REST API 2.0 or later.

Download Workbook PDFReads only

Download a PDF of workbook sheets the connected user can view on the signed-in site. Requires REST API 3.4+, enabled Download Images/PDF, and Read and ExportImage permissions. Only the default tab is exported unless Show sheets in tabs is enabled. Results may be cached; max_age controls cache freshness.

Download Workbook PowerPointReads only

Download a workbook as a PowerPoint (.pptx) with images of sheets the user can view. Requires REST API 3.8+, enabled PowerPoint exports and Download Images/PDF permissions. Non-administrators need Read and ExportImage on the workbook and included views. If Show sheets in tabs is disabled, only the default tab appears. Results may be cached; use max_age to limit cache age.

Download Workbook RevisionReads only

Download a historical Tableau workbook revision as a .twb or .twbx file from the signed-in site. Requires version history enabled and REST API 2.3 or later. Site administrators can download revisions; other users need ExplorerCanPublish, Read/Write/Download permissions on the workbook, and Save permission on its project. Optionally omit extracts. Use DOWNLOAD_WORKBOOK for the current revision. Downloaded content, including data and filter values, is readable by anyone who opens the file.

Enable or Disable Analytics Extensions on Server

Enable or disable analytics extensions server-wide on Tableau Server. Requires server administrator permissions and REST API 3.11 (Tableau Server 2021.1) or later. Not available for Tableau Cloud. No additional license required.

Encrypt Extracts in a Site

Encrypt ALL .hyper extracts at rest across the connected account's entire signed-in Tableau Server site (SITE-WIDE scope). Requires a Tableau Server administrator and REST API 3.5 or later. Depending on extract count and size, this can consume significant server resources; consider running outside normal business hours. Returns no data on HTTP 200; does not verify individual extract encryption completion.

Generate Basic Insight Bundle

Generate a Tableau Pulse basic insight bundle from metric metadata and configuration on the connected Tableau Cloud site. Returns grouped insights, summaries, facts and visualizations; inspect has_errors and group/insight errors for partial failures. Requires REST API 3.24 or later; unavailable on Tableau Server. The user needs read or connect access to the definition's data source.

Generate Breakdown Insight Bundle

Generate Tableau Pulse BAN and breakdown insight groups for a metric on the connected Tableau Cloud site. Supply metric configuration and identity in bundle_request.input and optional analysis/presentation settings in bundle_request.options. Returns grouped insights, summaries, visualizations and partial errors. Requires REST API 3.26 or later; unavailable on Tableau Server. The user needs read or connect access to the definition's data source.

Generate Current Metric Value Insight Bundle

Generate a Tableau Pulse insight bundle containing the current aggregated metric value (BAN) on the connected Tableau Cloud site. Supply metric identity and configuration in bundle_request.input, with optional analysis and presentation settings in bundle_request.options. Returns grouped insights, summaries and visualizations; inspect has_errors and nested errors for partial failures. Requires REST API 3.21 or later; unavailable on Tableau Server. The user needs read or connect access to the definition's data source.

Generate Detail Insight Bundle

Generate a Tableau Pulse detail insight bundle for a metric on the connected Tableau Cloud site. Supply metric configuration and identity in bundle_request.input and optional analysis and presentation settings in bundle_request.options. Returns grouped insights, summaries, visualizations and partial errors. Requires REST API 3.21 or later; unavailable on Tableau Server. The user needs read or connect access to the definition's data source. Each call counts as an analytical impression under usage-based licensing.

Generate Exploration Insight Bundle

Generate Tableau Pulse BAN, anchor and followup insight groups for a metric on the connected Tableau Cloud site. Supply metric identity and configuration in bundle_request.input and optional analysis/presentation settings in bundle_request.options. Returns grouped insights, summaries, facts, visualizations and partial errors. Requires REST API 3.26 or later; unavailable on Tableau Server. The user needs read or connect access to the definition's data source. No additional license is required.

Generate Insight Brief

Generate a Tableau Pulse insight brief from a user question and metric context on the connected Tableau Cloud site. Send conversation history in messages, with metrics from the same data source. Returns Markdown/HTML, source insights, refined metric context and follow-up questions. Requires REST API 3.26 or later; unavailable on Tableau Server. The user needs read or connect access to the definition's data source.

Generate Metric Card ImageReads only

Generate a PNG image of a Tableau Pulse metric card from supplied metric metadata, springboard visualization and insights. Optionally include alerts, data source labels and rendering settings. Stateless; does not fetch bundle data. Requires Tableau Cloud REST API 3.29+; unavailable on Tableau Server. Any user may call; no additional license required.

Generate Springboard Insight Bundle

Generate a Tableau Pulse springboard insight bundle from metric metadata and configuration on the connected Tableau Cloud site. Supply bundle_request.input and optional bundle_request.options. Returns grouped insights, summaries, facts and visualizations; inspect has_errors and group/insight errors for partial failures. Requires REST API 3.21 or later; unavailable on Tableau Server. The user needs read or connect access to the definition's data source.

Get a WebhookReads only

Get a webhook's configuration, triggering event, delivery destination, enabled state, and owner by LUID on the signed-in Tableau site. Requires server administrator permissions and REST API 3.6 or later.

Get Batch Content Usage StatisticsReads only

Get usage statistics for multiple Tableau content items, including mixed content types. Returns usage counts and per-item errors in one batch response. Administrators can access content they administer; other users must own the content or have Read permission. Requires Tableau Cloud REST API 3.17+; unavailable on Tableau Server. No additional license required.

Get Bridge ClientReads only

Retrieve one Bridge client's connection status, pool assignment, version, and ownership on the signed-in Tableau Cloud site. Requires Cloud site administrator permissions and REST API 3.28+ (March 2026). Unavailable on Tableau Server. No additional license is required.

Get CollectionReads only

Get a Tableau collection's details by LUID, including ownership, visibility, favorite status, and item counts. Requires REST API 3.28+ (Cloud February 2026 / Server 2026.2). Administrators can access collections on sites they administer; other users can access collections they own. No additional license is required.

Get Connected AppReads only

Get one direct-trust connected app by client ID on the signed-in Tableau site, including embedding restrictions and previously generated secret metadata (not its value). Requires Tableau Server administrator or Tableau Cloud site administrator permissions and REST API 3.17 or later.

Get Content SuggestionsReads only

Get autocomplete suggestions matching input terms, optionally restricting content types and prioritizing recently viewed content. Only objects accessible to the signed-in user are suggested. Requires REST API 3.19+ (Cloud March 2023 / Server 2023.1); no additional license is required. Returns a single response with the requested suggestion limit.

Get Current Analytics Extension For WorkbookReads only

Get the name, service type, and connection LUID of the analytics extension currently selected by a Tableau workbook on the signed-in site. Requires permissions to the workbook and Tableau REST API 3.11 or later. No additional license is required.

Get Current SessionReads only

Return the Tableau site and user identity established by the connected PAT, including their LUIDs and the user's current site role.

Get Custom Domain NameReads only

Get the custom domain for a Tableau Cloud site, if provisioned. Available in REST API 3.26+ (June 2025); unavailable on Tableau Server. Any member of the associated site can call this operation. No additional license is required.

Get Custom Domain SettingsReads only

Get a Tableau Cloud site's custom domain settings, provisioning status, and TLS certificate timestamps. Requires administrator permissions and REST API 3.26+ (June 2025). Not available for Tableau Server. No additional license required.

Get Custom ViewReads only

Get details of one Tableau custom view by LUID on the signed-in site. Requires administrator access or Read permission for the custom view and REST API 3.18 or later.

Get Custom View DataReads only

Render a custom view on the signed-in Tableau site as summary-level CSV data, returned as a file reference. Optionally filter by fields in the underlying workbook. For dashboards, only the first view's data is returned; detail-level data is unavailable. Non-administrators need Read and Export data permissions on the underlying view. Requires REST API 3.23 (Cloud December 2024 / Server 2024.3) or later. Tableau Cloud limits concurrent long-running export/download requests to 20.

Get Custom View ImageReads only

Download an image of a custom view on the signed-in site, optionally filtered by workbook fields. Returns PNG by default; SVG and the explicit format parameter require REST API 3.29+. Images may be cached; max_age controls freshness. Requires REST API 3.18+. Tableau administrators can download images; other users need Publish permission for the custom view.

Get Custom View PDFReads only

Download a custom view rendered as a PDF on the signed-in site. Requires REST API 3.23+ (Cloud December 2024 / Server 2024.3+) and administrator access or Read and Export image permissions for the view. Results can be cached; max_age controls freshness. Supports workbook field filters, page size, orientation, and rendered image dimensions.

Get Data SourceReads only

Return one published Tableau data source by LUID on the signed-in site, including its project, owner, tags, certification, extract, and Ask Data settings when available. Non-administrators need Connect permission on the data source.

Get Data Source RevisionsReads only

Get one page of revision history for a published Tableau data source on the signed-in site. Requires REST API 2.3 or later and site version history enabled. Site administrators can read revisions; other users need ExplorerCanPublish, Read/Write/Download on the data source, and Write on its project. Deleted revisions cannot be downloaded. Use pagination metadata and page_number to retrieve additional pages.

Get Data-Driven AlertReads only

Get details and recipients of a data-driven alert by LUID on the signed-in Tableau site. Available only on Tableau Cloud with REST API 3.20 or later; not available on Tableau Server. Requires permission to access the alert's view.

Get Databases and Tables from ConnectionReads only

Look up database and table assets using a base64-encoded connection element from data source or workbook XML on the signed-in Tableau site. Does not support embedded database assets. Requires REST API 3.13+ and administrator or derived permissions; with Data Management, explicit asset Read permission also permits access. Returns asset IDs, not database rows.

Get Domain MappingReads only

Retrieve all Bridge domain mappings for the signed-in Tableau Cloud site, including ALLOWED or BLOCKED status and pool assignment. Requires a Cloud site administrator and REST API 3.28+ (March 2026); unavailable on Tableau Server. No additional license is required. Returns the complete collection without pagination.

Get Embedding Settings for a SiteReads only

Get embedding settings for the signed-in Tableau Cloud or Tableau Server site, including whether embedding is unrestricted. Any user can call this method. Requires REST API 3.16 or later. Returns one site's settings without pagination.

Get Enabled State of Analytics Extensions on ServerReads only

Get whether analytics extensions are enabled on the Tableau server. Requires server administrator permissions and REST API 3.11+ (Tableau Server 2021.1+). Not available for Tableau Cloud. No additional license is required. This server-wide read takes no parameters.

Get Enabled State of Analytics Extensions on SiteReads only

Get whether analytics extensions are enabled or disabled for the signed-in Tableau site. Requires server or site administrator permissions and REST API 3.11+ (Tableau Cloud March 2021 / Server 2021.1+). No additional license is required.

Get Extract Refresh TaskReads only

Get a scheduled extract refresh task for a data source, workbook, or virtual connection on the signed-in site. Server returns a named schedule; Cloud returns frequency details. Non-administrator Server users can access only tasks they own. Requires REST API 2.6 or later; virtual connections require 3.30 or later.

Get Favorites for UserReads only

Get one page of a user's favorite projects, data sources, views, workbooks, and flows on the signed-in Tableau site. Deleted content returns only its favorite label. Non-administrators can retrieve only their own favorites. Use page_number and page_size for pagination. Requires REST API 2.5+; favorite projects require 3.1+.

Get Flow RunReads only

Get a Tableau flow run's status, progress, timestamps, background job, and parameter overrides on the signed-in site. Requires REST API 3.10+ and permission to view the associated flow. Returns the current state without waiting for completion.

Get Flow Run TaskReads only

Get the configuration, schedule, flow, and parameters of a scheduled flow run task on the signed-in site. This reads a scheduled task, not a run's job status. Non-administrator Tableau Server users can access only tasks they own. Requires Tableau REST API 3.3 or later.

Get Flow Run TasksReads only

List scheduled flow tasks on the signed-in site, including schedules, flows, and parameter values. On Tableau Server, non-administrators see only tasks for flows they own. Requires REST API 3.3 or later.

Get Flow RunsReads only

Get flow runs on the signed-in Tableau site, optionally filtered by user, flow, progress, or timestamps. Requires REST API 3.10 or later. This operation does not document pagination parameters.

Get Graph Health SuggestionsReads only

Read Tableau Knowledge Graph health, coverage metrics, and suggested improvements. Optionally scope to a PDS subtree or filter suggestions by severity/type. Filters affect suggestions and summary, not score, metrics, or stats; limit truncates lists without changing summary. Requires Tableau Cloud+ September 2026 or later; unavailable on Tableau Server. Any authenticated user can read nodes permitted by content permissions. Uses independent Knowledge API v1 regardless of the classic REST sign-in version.

Get Group SetReads only

Get a group set's ID, name, group count, and member groups by LUID on the signed-in Tableau site. Requires REST API 3.22+ (Cloud February 2024 / Server 2024.2+) and Tableau Server administrator or Tableau Cloud site administrator permissions.

Get Groups for a UserReads only

Return one page of groups that a specified user belongs to on the signed-in Tableau site. Requires server administrator or site administrator permissions and REST API 3.7 or later. Pass the returned continuation cursor to retrieve another page.

Get Identity PoolReads only

Get an identity pool's authentication and identity-store configuration by ID. Requires Tableau Server 2023.1 / REST API 3.19 or later and server administrator permissions. Not available for Tableau Cloud. No additional license is required.

Get Knowledge NodeReads only

Get a Tableau Knowledge Graph node by its exact ID, including type-specific properties, business preferences, and optionally outgoing connected nodes. Unknown IDs return 404, not an empty result. Omit graph_id to use the site's active graph. Requires Tableau Cloud+ from September 2026 and content read permissions; unavailable on Tableau Server. Uses independent Knowledge API v1 regardless of the classic REST version used for sign-in.

Get LabelReads only

Get a data label by LUID on the signed-in Tableau site. Requires read permission on the associated asset. Label operations other than data source certification require Catalog enabled with a Data Management license. Available in Tableau Cloud June 2022 (REST API 3.16+) and Server 2022.3 (3.17+).

Get Label ValueReads only

Get one label value's properties by name on the signed-in Tableau site. Any logged-in user can view label values. Available in Cloud June 2023 (REST API 3.20+) and Server 2023.3 (3.21+). Data Management is not required for label values, but is required to see labels on assets.

Get LabelsReads only

Retrieve data labels on one or more assets on the signed-in Tableau site, optionally limited by comma-separated categories. This read uses POST with a content list. Requires read permission on every asset; any asset error fails the entire request. Except for data source certifications, Catalog must be enabled with a Data Management license. Available in Cloud June 2022 (REST API 3.16+) and Server 2022.3 (3.17+).

Get Linked TaskReads only

Get information about one scheduled linked task on the signed-in Tableau site. All Tableau users can view linked task information, but flow details are visible only for flows the connected user has permission to access. Requires REST API 3.15 or later.

Get Linked TasksReads only

List scheduled linked tasks on the signed-in Tableau site, including schedules and ordered flow task steps. All Tableau users can view linked tasks, but flow details depend on their flow permissions. Linked tasks must be enabled on the site or server. Requires REST API 3.15 or later.

Get Metadata SuggestionReads only

Generate AI description suggestions for workbooks, data sources, or tables on the signed-in site, based on asset metadata. Does not apply descriptions to assets. Repeated requests generate alternative suggestions. Review generated text before using it. Requires Tableau Cloud with Tableau+, REST API 3.23+ (June 2024), and Overwrite permission on each asset. Not available on Tableau Server.

Get Metric DefinitionReads only

Get a Tableau Pulse metric definition by LUID, optionally including its default metric or a specified number of metrics. Requires Tableau Cloud REST API 3.21+; unavailable on Tableau Server. Any user can call this, but only definitions and metrics they can view are returned.

Get Mobile Security Settings for ServerReads only

Get the server's mobile security settings, including iOS and Android configuration values, enabled flags, and severities. Requires a Tableau server or site administrator and mobile security settings enabled on the server. Available in REST API 3.19 and later; no additional license required.

Get Mobile Security Settings for SiteReads only

Get mobile security settings and their iOS and Android configurations for the signed-in Tableau Cloud site. Requires server or site administrator permissions and REST API 3.18+ (December 2022). Not available on Tableau Server. No additional license is required. Returns all settings without pagination.

Get Node Downstream ImpactReads only

Get assets that transitively depend on a Knowledge Graph node, up to 10 steps deep, to assess the impact of changing it. Excludes the node itself. Optionally select a graph; otherwise uses the site's active primary graph. Requires Tableau Cloud+ September 2026 or later and content read permissions; unavailable on Tableau Server. Uses independent Knowledge API v1 regardless of the classic REST version used for sign-in.

Get Node LineageReads only

Get a node's lineage and dependency neighborhood up to 10 steps in both directions, returning nodes and connecting edges allowed by content permissions. An unknown node returns an empty graph. Omit graph_id to use the site's active graph. Requires Tableau Cloud+ from September 2026; unavailable on Tableau Server. Uses Knowledge API v1 independently of the classic REST sign-in version.

Get or Create Metric

Return a matching Tableau Pulse metric in an existing definition, or create it if absent. Returns whether a new metric was created. Tableau Cloud only, REST API 3.21 or later; requires read or connect access to the definition's data source. Not available on Tableau Server.

Get Pulse MetricReads only

Get the details of a Tableau Pulse metric by its LUID, including its definition ID, goals, filters, measurement period, comparisons, and tags. Requires Tableau Cloud REST API 3.21 or later; unavailable on Tableau Server.

Get Pulse SubscriptionReads only

Get a Tableau Pulse metric subscription by its LUID, including its follower, metric ID, and creation/update times. Requires read or connect permission on the metric definition's data source. Available on Tableau Cloud REST API 3.21 or later; unavailable on Tableau Server.

Get Recently Viewed for SiteReads only

Get up to 24 views and workbooks most recently created, updated, or accessed by the signed-in user on the connected Tableau site. Results may take several minutes to reflect an access. Non-administrators see only content they own or can read. No pagination. Requires REST API 3.5 or later.

Get Recycle Bin Content ItemReads only

Return information about a deleted Tableau content item on the signed-in site's Recycle Bin by content type and LUID. Requires REST API 3.29 or later (Cloud June 2026 / Server 2026.2) and an enabled Recycle Bin. Administrators can view any item; other users can view only items they own.

Get Registered EASReads only

Get one external authorization server (EAS) registered to the signed-in Tableau site by EAS ID. Returns its ID, name, issuer URL and creation timestamp. Requires Tableau Server administrator or Tableau Cloud site administrator permissions. Available on Tableau Cloud API 3.16+ and Tableau Server API 3.23+ (Server 2024.2).

Get Routing RuleReads only

Retrieve one Bridge routing rule by UUID from the signed-in Tableau Cloud site, including its domain, block status, target pool and project scope. Requires a Cloud site administrator and REST API 3.30+ (October 2026). Not available on Tableau Server. A rule absent from this site returns a not-found error.

Get Routing RulesReads only

Get all Bridge routing rules for the signed-in Tableau Cloud site, including allow and block rules distinguished by isBlocked. Use returned rule IDs before updating or deleting rules. Requires site administrator permissions and REST API 3.30+ (October 2026). Not available on Tableau Server. No additional license is required. Returns the complete collection without pagination.

Get SCIM ConfigurationReads only

Get a System for Cross-domain Identity Management (SCIM) configuration by UUID on the signed-in Tableau Cloud site, including its identity provider association, token activity, ownership, name, and creation time. Obtain the UUID from List SCIM Configurations. Requires a Cloud site administrator and REST API 3.26 or later. Not available on Tableau Server.

Get Server InfoReads only

Return the connected Tableau deployment's product, build, and supported REST API versions. This public endpoint checks deployment compatibility but does not validate the PAT.

Get Server ScheduleReads only

Get detailed information about one server-wide schedule by LUID on Tableau Server (REST API 3.8+). Not available on Tableau Cloud. Requires permission to schedule extract refreshes, or site or server administrator permissions. Newly created resources may not immediately appear in queries while the search index updates.

Get Site EntitlementsReads only

Get Pulse feature entitlements for the signed-in Tableau Cloud site. Each enabled flag indicates whether that feature is enabled. Requires Tableau Cloud REST API 3.21+; unavailable on Tableau Server. Any user can call this for a site they can view; no additional license is required.

Get SubscriptionReads only

Get a classic view or workbook content subscription by LUID on the signed-in Tableau site, including its recipient, attachment options and schedule. This is not a Tableau Pulse subscription. Available on Tableau Server REST API 2.3+ and Tableau Cloud REST API 3.20+. Administrators can read subscriptions within their administrative scope; other users can read only their own. Newly created subscriptions may not immediately appear due to search indexing.

Get Tableau MCP Settings for SiteReads only

Get all Tableau MCP settings for the signed-in site, including included tools, tags, and result limits. Any authenticated user can call this method; no additional license is required. Requires REST API 3.29+ (Tableau Cloud June 2026 or Tableau Server 2026.2+) and an enabled MCP feature. Returns settings without pagination.

Get Usage Statistics for Content ItemReads only

Get usage counts for a Tableau content item by content type and LUID, including total uses and uses in the last two weeks, month, three months, and twelve months. Requires Tableau Cloud REST API 3.17+ (December 2022); unavailable on Tableau Server. Administrators can read statistics for content they administer; other users must own the content or have at least Read permission. No additional license is required.

Get User Notification PreferencesReads only

Get notification preferences for the signed-in Tableau site, optionally filtered by channel and notification type. Requires a Server Administrator, Site Administrator Creator, or Site Administrator Explorer and REST API 3.15+. Returns the complete matching collection without pagination.

Get User Personal SpaceReads only

Get the currently authenticated user's Personal Space details on the signed-in Tableau site, including its LUID, owner LUID, and read-only state. Only the owner can retrieve it; Personal Space must be enabled for the site. Requires REST API 3.13 or later; no additional license is required.

Get Users in GroupReads only

Return one page of users in a group on the signed-in Tableau site. Only server administrators and site administrators can call this method. Pass next_cursor to retrieve subsequent pages. Requires REST API 2.0 or later.

Get ViewReads only

Get details of one Tableau view by LUID on the signed-in site, optionally including usage statistics. Non-administrators must own the view or have Read permission. Requires REST API 3.0 or later.

Get WorkbookReads only

Return one Tableau workbook by LUID, including its project, owner, tags, views, and freshness settings when available.

Get Workbook Downgrade InfoReads only

List features impacted and their severity when exporting a Tableau workbook to an older release. Does not export or modify the workbook. Requires REST API 3.5 or later. Site administrators can access workbooks on their site; other users need permissions to the workbook. Supply the target Tableau release in product_version.

Get Workbook RevisionsReads only

Get one page of revision history for a Tableau workbook on the signed-in site. Requires REST API 2.3 or later and site version history enabled. Site administrators can read revisions; other users need ExplorerCanPublish, Read/Write/Download on the workbook, and Write on its project. Deleted revisions cannot be downloaded. Use pagination metadata and page_number to retrieve additional pages.

Import Users to Site from CSV

Upload a CSV file and create an asynchronous job importing users, roles and authorization settings into the signed-in Tableau site. Requires REST API 3.15+ and Tableau Server admin or Tableau Cloud site admin permissions. Cloud may email invitations to imported users. Optional authentication overrides use an XML multipart payload; CSV settings take precedence. Returns the job, not completed import results. The mutation is not automatically retried.

Initiate File Upload

Initiate a file upload on the signed-in Tableau site and return its upload session ID. Requires REST API 2.0+ and administrator or site publishing rights. Sends no file data. Use Append to File Upload to send blocks, then Publish Data Source, Publish Flow, or Publish Workbook to commit the upload.

List Analytics Extension Connections of WorkbookReads only

List basic details of each analytics extension connection available to a Tableau workbook, including connection LUID, name, and service type. Requires permissions to the specified workbook and REST API 3.11+ (Tableau Cloud March 2021 / Server 2021.1+). No additional license is required. Returns the complete list; this endpoint has no pagination parameters.

List Analytics Extension Connections on SiteReads only

List the signed-in Tableau site's analytics extension connections for external services, including connection LUID, title, and service type. Requires server or site administrator permissions and REST API 3.11+ (Tableau Cloud March 2021 / Server 2021.1+). No additional license is required. Returns the complete list; this endpoint has no pagination parameters.

List Authentication Configurations for SiteReads only

List all authentication configurations on the signed-in Tableau Cloud site, including enabled states and identity provider configuration IDs for assigning user authentication. Requires a Tableau Cloud site administrator and REST API 3.24 or later. Not available on Tableau Server.

List Bridge ClientsReads only

List Bridge clients on the signed-in Tableau Cloud site, including status, pool assignment, and ownership. Optionally filter by exactly one of poolId, onlyDefaultPool, or onlyUnassigned. Requires Cloud site administrator permissions and REST API 3.28+ (March 2026); unavailable on Tableau Server. No additional license or pagination parameters are required.

List Bridge PoolsReads only

List all Bridge pools and their allowed or blocked domain mappings on the signed-in Tableau Cloud site. Requires site administrator permissions and REST API 3.28+ (March 2026); unavailable on Tableau Server. No additional license is required. Returns the complete collection without pagination.

List Collection ItemsReads only

List one page of items in a Tableau collection with optional filtering and sorting. Requires REST API 3.28+ (Cloud February 2026 / Server 2026.2). Administrators can call this for sites they administer; other users for collections they own. No additional license is required. Use page_number to retrieve subsequent pages and inspect moreItems and pagination.

List Collection PermissionsReads only

List all permission rules for a collection on the signed-in Tableau site, including collection ownership, user and group grantees, and capabilities. Requires server administrator, site administrator, or collection owner access and REST API 3.12+. Returns all rules without pagination.

List CollectionsReads only

List one page of Tableau collections with optional filtering and sorting. Requires REST API 3.28+ (Cloud February 2026 / Server 2026.2). Administrators can list collections on sites they administer; other users can list collections they own. No additional license is required. Use page_number to retrieve subsequent pages and inspect moreItems and pagination.

List Connected AppsReads only

List all direct-trust connected apps configured on the signed-in Tableau site, including enablement, project restrictions, domain restrictions and generated secret metadata (not secret values). Requires Tableau Server administrator or Tableau Cloud site administrator permissions and REST API 3.17 or later. No pagination or filters are supported.

List Custom ViewsReads only

Return one page of custom views on the signed-in Tableau site. Requires API 3.18+ (Cloud December 2022 / Server 2023.1). Administrators see all custom views; non-administrators normally see their own. Filtering by viewId or workbookId may expose additional views according to Write/WebAuthoring permissions and site user visibility.

List Data Source ConnectionsReads only

List all connections for a published Tableau data source on the signed-in site, including connection types, server addresses, and authentication settings when available. Requires Read permission on the data source; query-tagging settings are visible only to administrators.

List Data Source PermissionsReads only

List all permission capabilities and user/group grantees for a data source on the signed-in Tableau site. Requires REST API 2.0+. Non-administrators need Read (view) permission on the data source, explicitly or implicitly. Returns all rules without pagination.

List Data SourcesReads only

List published data sources visible to the connected PAT on its signed-in Tableau site, with optional filtering and sorting, one page at a time.

List Data-Driven Alerts on SiteReads only

List one page of data-driven alerts on the signed-in Tableau site, optionally filtered by viewId:eq:<view-luid>. Includes owners, views and alert frequency. Requires REST API 3.2+ on Tableau Cloud or Server, and a server administrator, site administrator or alert owner. Pass next_cursor to continue.

List Database PermissionsReads only

List explicit permission capabilities and user or group grantees on a database asset on the signed-in Tableau site. Requires REST API 3.5+, Data Management licensing, and a database associated with a published data source. Available to server/site administrators or users with ChangePermissions on the asset metadata. Returns all rules without pagination; no explicit permissions yields an empty list.

List Default Database PermissionsReads only

Get the default permissions applied to a database asset and its child tables on the signed-in Tableau site. Requires REST API 3.5+, Data Management licensing, and a database associated with a published data source. Available to server/site admins or users with Write permission on the asset metadata. For databases in a project these defaults are not evaluated for table permissions; query the project's default permissions instead. Returns all rules without pagination.

List Default PermissionsReads only

List a project's default user and group permission rules for workbooks, data sources, data roles, flows, virtual connections, databases, or tables on the signed-in Tableau site. Requires server administrator or ProjectLeader permission. Requires REST API 2.1+, or 3.23+ for virtual connections. Database and table defaults require Tableau Catalog. Returns all rules without pagination.

List Edges Around a NodeReads only

List Tableau Knowledge Graph edges connected to an anchor identified by node_id or a natural-language query. node_id takes precedence when both are supplied. Optionally filter by edge type and direction or select a graph. Returns the resolved anchor and edges with their direction and connected node. Requires Tableau Cloud+ September 2026 or later; unavailable on Tableau Server. Any authenticated user can read nodes allowed by content permissions. Uses independent Knowledge API v1 regardless of the classic REST version used for sign-in.

List Extract Refresh Tasks in Server ScheduleReads only

Return one page of extract refresh tasks for a server schedule on the signed-in site. Tableau Server only; not available on Tableau Cloud. Requires a server administrator or site administrator and REST API 2.2+. Site administrators see only their signed-in site's tasks. Obtain schedule_id from List Server Schedules. Virtual connection targets are supported from API 3.30.

List Extract Refresh Tasks in SiteReads only

List extract refresh tasks for data sources, workbooks, and virtual connections on the signed-in site. Server returns named schedules; Cloud returns schedule frequency details. Non-administrator Server users see only tasks they own. Requires REST API 2.6 or later; virtual connections require 3.30 or later.

List Flow PermissionsReads only

List permission capabilities and grantees for a flow on the signed-in Tableau site. Requires server administrator or site administrator access and REST API 3.3+. Returns all rules without pagination.

List Followed Metrics GroupsReads only

Get the signed-in user's followed Tableau Pulse metrics, optionally grouped and sorted. Omitted grouping and sorting use existing user preferences; otherwise the default is most recently followed in descending order in a single group. Returns groups and per-metric errors. Requires Tableau Cloud REST API 3.23 or later; unavailable on Tableau Server. Time-range grouping requires API 3.24 or later.

List Group SetsReads only

List one page of group sets on the signed-in Tableau site with optional filtering and sorting. Requires REST API 3.22+ (Cloud February 2024 / Server 2024.2+) and Tableau Server administrator or Tableau Cloud site administrator permissions. Newly created resources may be absent until search indexing completes. Pass next_cursor to continue.

List GroupsReads only

List groups the connected PAT is permitted to see on its signed-in Tableau site, with optional filtering and sorting, one page at a time.

List Identity PoolsReads only

List all identity pools and their authentication and identity-store configuration. Requires Tableau Server 2023.1 / REST API 3.19 or later and server administrator permissions. Not available for Tableau Cloud. No additional license is required.

List Identity StoresReads only

List all identity store instances used to provision users, including their IDs, names, types, and timestamps. Requires Tableau Server 2023.1 / REST API 3.19 or later and server administrator permissions. Not available for Tableau Cloud. No additional license is required.

List JobsReads only

List active asynchronous jobs the connected PAT is permitted to see on its signed-in Tableau site, optionally narrowed with a Tableau filter expression, one page at a time.

List Knowledge GraphsReads only

List knowledge graphs on the signed-in Tableau site, including IDs, names, descriptions, lifecycle status, timestamps, and the primary graph flag. Use an ID as graph_id for graph-scoped operations; an empty list means the site has no graphs. Available to authenticated users on Tableau Cloud+ from September 2026; not available on Tableau Server. Uses the independent Knowledge API v1, regardless of the classic REST version used for sign-in.

List Knowledge SourcesReads only

List data sources and workbooks connected to a Tableau Knowledge Graph. Optionally select a graph or filter by node type (typically PDS or WORKBOOK); unknown node types return an empty list. Any authenticated user can read nodes allowed by content permissions. Requires Tableau Cloud+ September 2026 or later; unavailable on Tableau Server. Uses independent Knowledge API v1 regardless of the classic REST version used for sign-in.

List Label Categories on SiteReads only

List all data label categories on the signed-in Tableau site. Any logged-in user can view their site's categories. Requires REST API 3.21+ (Cloud October 2023 / Server 2023.3). Returns the complete collection; no pagination parameters are supported.

List Label Values on SiteReads only

List all label values on the signed-in Tableau site, optionally filtered by category or internal status. Any logged-in user can view these values; no Data Management license is required. Available in Cloud June 2023 (REST API 3.20+) and Server 2023.3 (3.21+). This lists label definitions, not labels applied to assets. The documented operation has no pagination.

List Metric Definition Measurement PeriodsReads only

Evaluate measurement periods for a supplied Tableau Pulse metric definition. Returns period configurations, range information, and per-period errors. Requires Tableau Cloud API 3.25 or later and site or server administrator permissions; unavailable on Tableau Server. Custom calendars override fiscal time settings.

List Metric Definition TagsReads only

List one page of Tableau Pulse metric definition tags and the number of definitions using each tag. Filter by tag value, definition name, or data-source LUID. Only returns definitions and metrics the signed-in user can view. Pass next_page_token as page_token to continue. Tableau Cloud only, API 3.29+ (August 2026); not available on Tableau Server. No additional license required.

List Metric DefinitionsReads only

List one page of Tableau Pulse metric definitions visible to the signed-in user. Optionally select a metric LUID, filter by metric name, or include related metrics. Pass next_page_token as page_token to continue. Tableau Cloud only, API 3.21+. Sorting and number_of_metrics options require API 3.24+.

List Metrics in DefinitionReads only

List one page of Tableau Pulse metrics in a metric definition, returning only metrics the signed-in user can view. Optionally filter or sort the results. Pass next_page_token as page_token to continue. Requires Tableau Cloud REST API 3.21 or later; unavailable on Tableau Server.

List Personal Access TokensReads only

List a user's personal access token metadata, without secrets, on the signed-in Tableau Cloud site. Requires REST API 3.21 or later; unavailable on Tableau Server. Any Cloud user can list their own PATs. To list another user's PATs, be a site administrator on all sites that user belongs to. No pagination parameters are supported.

List Project PermissionsReads only

List allowed and denied capabilities for users and groups in a project on the signed-in Tableau site. Requires server administrator or site administrator access and REST API 2.0+. Returns project permissions, not default permissions for child content. This operation is not paginated.

List ProjectsReads only

List projects visible to the connected PAT on its signed-in Tableau site, with optional filtering and sorting, one page at a time.

List Pulse SubscriptionsReads only

List one page of Tableau Pulse metric subscriptions on the signed-in site. Filter by metric_id, user_id, or both; omit both to list site subscriptions. Pass next_page_token as page_token to continue. Requires read or connect permission on the metric definition's data source. Tableau Cloud API 3.21+ only; unavailable on Tableau Server.

List Pulse User PreferencesReads only

Get Tableau Pulse notification channels and cadence, digest metric filter, and followed-metric grouping and sorting preferences. Omit user_id for the signed-in user or supply a user LUID. Requires read or connect permission on the data source used in the metric definition. Available on Tableau Cloud API 3.24 or later; not available on Tableau Server.

List Recommended MetricsReads only

Get personalized groups of recommended Tableau Pulse metrics for the signed-in user. Only metrics the user can view are returned. Requires read or connect access to the data source used in the metric definition. Available on Tableau Cloud REST API 3.26 or later; unavailable on Tableau Server.

List Recycle Bin Content by TypeReads only

List one page of deleted workbooks, datasources, flows or projects in the signed-in site's Recycle Bin, with optional filtering and sorting. Administrators see all content; other users see only content they own. Requires enabled Recycle Bin and REST API 3.29+ (Tableau Cloud June 2026 / Server 2026.2). No additional license required. Pass next_cursor to continue.

List Registered External Authorization ServersReads only

List all external authorization servers (EASs) registered to the signed-in Tableau site, including their names, IDs, issuer URLs and creation timestamps. Requires Tableau Server administrator or Tableau Cloud site administrator permissions. Available on Tableau Cloud from API 3.16 and Tableau Server from API 3.23 (2024.2). No filters or pagination are supported.

List SCIM ConfigurationsReads only

List System for Cross-domain Identity Management (SCIM) configurations on the signed-in Tableau Cloud site, including identity provider configuration IDs, token activity, ownership, names, and creation timestamps. Requires a Cloud site administrator and REST API 3.26 or later. Not available on Tableau Server. Returns all configurations without pagination.

List Server Active Directory DomainsReads only

List Active Directory domains in use on the Tableau server, including their integer IDs, full domain names, and nicknames. With local authentication, returns only the local domain. Requires server administrator permissions and REST API 3.11 or later.

List Server SchedulesReads only

List one page of extract, subscription and flow schedules on Tableau Server, including frequency, priority, state and run timestamps. Not available on Tableau Cloud. Requires REST API 2.2+ and a user able to schedule extract refreshes, a site administrator or a server administrator. Pass next_cursor to continue.

List Site AlertsReads only

List one page of Tableau Pulse alerts for the signed-in user on the connected site. Requires a site the user administers. Tableau Cloud only, API 3.25+; not available on Tableau Server. Pass next_page_token as page_token to continue.

List SubscriptionsReads only

List one page of classic view or workbook subscriptions on the signed-in Tableau site, including recipients, attachment options and Server or Cloud schedules. Not Tableau Pulse subscriptions. Administrators see subscriptions within their administrative scope; other users see only their own. Requires Tableau Server REST API 2.3+ or Tableau Cloud REST API 3.20+. Newly created resources may be absent until search indexing completes. Pass next_cursor to continue.

List Table PermissionsReads only

List explicit permission capabilities and user or group grantees on a table asset on the signed-in Tableau site. Requires REST API 3.5+, Data Management licensing, and a table associated with a published data source. Available to server/site administrators or users with ChangePermissions on the asset metadata. Returns all rules without pagination; when explicit permissions are absent, returns the parent asset reference and an empty rule list.

List Tableau Extensions Server SettingsReads only

List server-wide Tableau extension settings, including whether extensions are globally enabled and the block list. Requires server administrator permissions and REST API 3.21+ (Tableau Server 2023.3+). Not available for Tableau Cloud. No additional license is required. Takes no parameters; no pagination.

List Tableau Extensions Site SettingsReads only

List extension settings for the signed-in Tableau site, including the safe list and trusted, sandboxed, Tableau-built and partner-built extension settings. Available to any authenticated user on Tableau Cloud or Server with REST API 3.21+ (Cloud June 2023 / Server 2023.3+). No additional license is required. Takes no parameters; no pagination.

List UsersReads only

List users the connected PAT is permitted to see on its signed-in Tableau site, with optional filtering and sorting, one page at a time.

List Users with Custom View as DefaultReads only

List users whose default view is the specified Tableau custom view on the signed-in site. Only Tableau administrators can call this method. Requires REST API 3.21 (Cloud October 2023 / Server 2023.3) or later. Returns the provider's pagination metadata; this operation documents no pagination query parameters.

List View PermissionsReads only

List all permission capabilities and user/group grantees for a view on the signed-in Tableau site. Requires server or site administrator access, or Read (view) permission on the view, and REST API 3.2+. Includes the parent project when locked project defaults determine permissions. This operation is not paginated.

List ViewsReads only

List views visible to the connected PAT on its signed-in Tableau site, with optional filtering, sorting, and usage statistics, one page at a time.

List Virtual Connection Database ConnectionsReads only

List one page of database connections in a virtual connection on the signed-in Tableau site. Returns database types, server addresses, ports, and configured usernames. Requires Data Management, REST API 3.18 or later, and administrator access or explicit/implicit Connect (view) permission on the virtual connection.

List Virtual Connection PermissionsReads only

List all user and group permission capabilities for a virtual connection on the signed-in Tableau site. Requires REST API 3.23 or later and administrator access or Read (View) permission on the virtual connection, explicitly or implicitly. Includes the parent project when locked project defaults determine permissions. This operation is not paginated.

List Virtual Connection RevisionsReads only

List one page of revisions for a virtual connection on the signed-in Tableau site. Requires REST API 3.23 or later, Tableau Data Management, enabled site version history, Overwrite permission on the virtual connection and at least Creator site role. Use pagination metadata and page_number to retrieve additional pages.

List Virtual ConnectionsReads only

List one page of available virtual connections on the signed-in Tableau site, optionally sorted. Requires Tableau Data Management and REST API 3.18 or later. By default all users can view virtual connections.

List WebhooksReads only

List all webhooks on the signed-in Tableau site, including triggering events, delivery destinations, enabled states and owners. Requires server or site administrator permissions and REST API 3.6 or later.

List Workbook PermissionsReads only

List all permission capabilities and user/group grantees for a workbook on the signed-in Tableau site. Requires server administrator or site administrator access and REST API 2.0+. Includes the parent project when locked project defaults determine permissions. This operation is not paginated.

List WorkbooksReads only

List workbooks visible to the connected PAT on its signed-in Tableau site, with optional filtering and sorting, one page at a time.

Move Bridge Client

Atomically move a Bridge client on the signed-in Tableau Cloud site to an existing named pool, the default pool, or unassigned status. Specify exactly one operation. Unassigning temporarily deactivates the client without deleting it. Requires Cloud site administrator permissions and REST API 3.28+ (March 2026); unavailable on Tableau Server. No additional license required. Returns no data on success.

Move Database

Move 1–1000 databases to a project on the signed-in Tableau site, optionally leaving their tables in place. Cannot remove databases from all projects. Requires Data Management and Tableau Catalog, read/changeHierarchy permissions on moved databases and tables, and write permission on the target project. Available in Cloud June 2022 (API 3.16) / Server 2022.3 (API 3.17). A failed batch may have partially moved resources: inspect warnings and verify state before retrying. Returns no data when every resource moved.

Move Table

Move 1–1000 tables to a project on the signed-in Tableau site. Cannot remove tables from all projects or move tables in embedded databases. Requires Data Management and Tableau Catalog, read/changeHierarchy permissions on tables, and write permission on the target project. Available in Cloud June 2022 (API 3.16) / Server 2022.3 (API 3.17). A failed batch may have partially moved resources: inspect warnings and verify state before retrying. Returns no data when every table moved.

Organize Favorites

Move items to organize a user's Tableau favorites on the signed-in site. Non-administrators can organize only their own favorites; server and site administrators can organize another user's favorites. Requires REST API 3.8 or later. Returns no data on success.

Publish Data Source

Publish a Tableau data source on the signed-in site using a file up to 64 MB or commit a previously uploaded multipart upload session. Create, overwrite, append matching extracts, or replace existing data. Requires publishing permission and REST API 2.0+. Asynchronous publication returns a job ID; query the job to verify completion. Configure data-source connection credentials in Tableau; this action does not accept or embed connection credentials.

Publish Flow

Publish a Tableau flow on the signed-in site using a .tfl/.tflx file up to 64 MB or commit a previously uploaded session. For session publication, first use Initiate File Upload and Append to File Upload, then supply the upload session ID and flow type here. Requires REST API 3.3+, a publishing site role and destination project publishing permissions; overwriting also requires flow write permission. No additional license required. Publication is not automatically retried. Configure flow connection credentials in Tableau; this action accepts only nonsecret connection server and port overrides and does not set or embed connection credentials.

Publish Virtual Connection

Publish a virtual connection on the signed-in site from an unmodified downloaded JSON schema (REST API 3.23+) or a .tvcx file/upload session (3.30+). Supports overwriting an existing connection. JSON defaults to draft; files always publish active. Requires Data Management and a Creator-or-higher site role with Overwrite permission, or administrator privileges. Publication is not automatically retried.

Publish Work Copy

Publish an existing Tableau work copy as a new data source on the signed-in site. Requires REST API 3.30 or later (Cloud October 2026 / Server 2026.3), Data Management or Tableau+, and administrator access or Connect, Write (save), and VizqlDataApiAccess permissions on the source data source. Returns the new data source LUID.

Publish Workbook

Publish a Tableau workbook on the signed-in site using a .twb/.twbx file up to 64 MB or commit a previously uploaded session. Optionally overwrite, hide named sheets, configure connections, or publish asynchronously. Requires publishing permission on the destination project and REST API 2.0+. Query the returned job to verify asynchronous completion. Configure data-source credentials in Tableau before publishing; this action does not accept connection credentials.

Pulse Create Subscription

Create a subscription to a Tableau Pulse metric for a user or group. Available only on Tableau Cloud with REST API 3.21 or later, not Tableau Server. Requires read or connect permission to the data source used in the definition.

Pulse Update Metric

Update a Tableau Pulse metric's specification or target and threshold goals. Available only on Tableau Cloud with REST API 3.21 or later, not Tableau Server. Requires write and publish access to the definition's data source.

Query All Quality Warning Triggers by ContentReads only

Get all quality warning triggers for a data source or flow on the signed-in Tableau site. Requires REST API 3.11+. With Data Management, administrators and users with derived or explicit asset Read permissions can query; otherwise requires derived permissions or administrator status. No query or pagination parameters.

Query Column in a TableReads only

Get metadata for one column in a Tableau table asset on the signed-in site, not its data values. Requires REST API 3.5+ and administrator access or derived permissions; with Data Management, explicit Read (view) permission also permits access.

Query Columns in a TableReads only

Get column asset metadata for a table on the signed-in Tableau site, including names, remote types, parent table IDs, and site IDs. Returns metadata, not table rows. Requires REST API 3.5+. Access depends on administrator, derived, or explicit Read permissions and Data Management licensing. The documented operation has no query or pagination parameters.

Query Data Quality Certification by IDReads only

Get a data quality certification by its LUID on the signed-in Tableau site. Requires REST API 3.13+. With Data Management, administrators and users with derived or explicit asset Read permissions can query certifications; otherwise, administrators and users with derived permissions can query them. Tableau recommends the newer Get Label method for evolving label features.

Query Data Quality Certifications by ContentReads only

Get all data quality certifications for a database, table, published data source, virtual connection, or virtual connection table on the signed-in Tableau site. Requires REST API 3.13+. With Data Management, administrators and users with derived or explicit Read permissions can query; otherwise access requires derived permissions or administrator status. No query or pagination parameters. Tableau recommends the newer Get Labels method for evolving label features.

Query Data Quality Warning by ContentReads only

Get data quality warnings for a database, table, column, published data source, flow, virtual connection, or virtual connection table on the signed-in Tableau site. With Data Management, administrators and users with derived or explicit Read permissions can query; otherwise access requires derived permissions or administrator status. Column assets require REST API 3.16+. No query or pagination parameters. Tableau recommends the newer Get Labels method for evolving label features.

Query Data Quality Warning by IDReads only

Get a specific data quality warning by its LUID on the signed-in Tableau site. Requires REST API 3.5+. With Data Management, administrators and users with derived or explicit asset Read permissions can query warnings; without it, administrators and users with derived permissions can query them. Tableau recommends the newer Get Label method for evolving label features.

Query DatabaseReads only

Get one database asset on the signed-in Tableau site, including connection type, certification, contact, location, and tags when returned. Requires REST API 3.5+. With Data Management, administrators and users with derived or explicit Read (view) permissions can query the asset; otherwise administrator access or enabled derived permissions are required.

Query DatabasesReads only

Return one page of database assets on the signed-in Tableau site. Requires REST API 3.5 or later and administrator, derived, or explicit Read permissions as permitted by the site's Data Management licensing.

Query FlowReads only

Return one Tableau flow on the signed-in site, including its project, owner, output steps, tags, and parameters when enabled and present. Requires REST API 3.3+ and administrator access or Read (view) permission on the flow. Newly created flows may not appear immediately while Tableau updates its search index.

Query Flow ConnectionsReads only

Return all data connections for a Tableau flow on the signed-in site, including connection types, server addresses, usernames, and whether passwords are embedded. Requires REST API 3.3+ and administrator access or Read (view) permission on the flow.

Query Flows for a SiteReads only

Return one page of flows on the signed-in Tableau site, optionally filtered and sorted. Non-administrators see only flows they can view. Requires REST API 3.3 or later.

Query Flows for UserReads only

Return one page of flows owned by or readable by a specified user on the signed-in Tableau site. Results depend on caller permissions; administrators can see all matching flows. Newly created flows may be delayed by search indexing. Requires REST API 3.3 or later.

Query JobReads only

Get current status, progress, finish code, and notes for a Tableau asynchronous job on the signed-in site. Requires a server or site administrator and REST API 2.0+. For site deletion jobs (API 3.18+), a server administrator must connect to the default site. Does not wait for completion; finish codes depend on job type.

Query Quality Warning TriggerReads only

Get a quality warning trigger by its LUID on the signed-in Tableau site. Requires REST API 3.11+. With Data Management, administrators and users with derived or explicit asset Read permissions can query triggers; without it, administrators and users with derived permissions can query them.

Query SiteReads only

Get information and settings for the signed-in Tableau site, optionally including user count and storage usage. Requires a server or site administrator. Omit selectors to use the signed-in site LUID, or select that same site by LUID, name, or content URL. Newly created resources may take time to appear in queries.

Query SitesReads only

Return one page of Tableau Server sites accessible to the caller. Available to all users; non-administrators receive only site id, name, and content URL. Not available on Tableau Cloud. New resources may not immediately appear while the search index updates.

Query TableReads only

Get metadata for one Tableau table asset on the signed-in site. Requires REST API 3.5+ and administrator access or derived permissions; with Data Management, explicit Read (view) permission also permits access. Returns asset metadata, not the table's data rows.

Query TablesReads only

Get information about table assets visible on the signed-in Tableau site, including names, embedded and certification flags, and site IDs. Requires REST API 3.5+. Access depends on administrator, derived, or explicit Read permissions and the site's Data Management licensing. The documented operation provides no pagination parameters.

Query User On SiteReads only

Return information about one user on the signed-in Tableau site. Server and site administrators can query users; a non-administrator's access to their own information depends on site visibility settings. Requires REST API 2.0+. Newly created users may not appear immediately while Tableau updates its search index.

Query View DataReads only

Render a view from the signed-in Tableau site as summary-level CSV data, returned as a file reference. Optionally filter by fields in the underlying workbook data. For dashboards, only the first view's data is returned. Detail-level data is unavailable through this endpoint. Non-administrators need Read permission on the view. Requires REST API 2.8 or later; Tableau Cloud limits concurrent long-running export/download requests to 20.

Query View ImageReads only

Download an image of a view on the signed-in site, optionally filtered by workbook fields. Returns PNG by default; SVG requires REST API 3.29+. Dimensions require API 3.23+. Images may be cached; max_age controls freshness. Non-administrators need Read permission. Requires API 2.5+ and the server's sheet_image.enabled setting.

Query View PDFReads only

Download a specified view rendered as a PDF on the signed-in site. Requires REST API 2.8+ and Read permission for non-administrators. Results can be cached; max_age controls freshness. Supports workbook field filters, page size, orientation, and rendered image dimensions.

Query View Preview ImageReads only

Download the PNG thumbnail image for a view in a specified workbook on the signed-in site. Non-administrators need Read (view) permission. Newly created views may not appear until Tableau updates its search index.

Query Views for WorkbookReads only

Return all visible views for a workbook on the signed-in Tableau site, optionally including total view counts. Requires administrator access or Read (view) permission on the views. Newly created resources may not appear until Tableau updates its search index.

Query Workbook ConnectionsReads only

Return all data connections for a Tableau workbook on the signed-in site, including connection types, server addresses, and authentication settings when available. Requires REST API 2.0+ and administrator access or Read (view) permission on the workbook. Query-tagging settings are returned only for administrators.

Query Workbook Preview ImageReads only

Download the PNG thumbnail image for a workbook on the signed-in site, usually showing its first sheet. Non-administrators need Read (view) permission for the workbook and at least one view; Tableau may select another permitted view as the preview. Newly created resources may not appear until the search index updates.

Query Workbooks for UserReads only

Return one page of workbooks owned by or readable by a specified user on the signed-in Tableau site. Results depend on caller permissions; server and site administrators see all matching workbooks. Newly created resources may be delayed by search indexing.

Read Data Source ElementsReads only

Read columns, field descriptions, or table descriptions from a published Tableau data source on the signed-in site. Optionally name one element; otherwise returns all elements of the selected type. Inspect each record's error even on success. Requires API 3.30+ (Cloud October 2026 / Server 2026.3+), Data Management or Tableau+, and administrator access or Connect, Write (save), and VizqlDataApiAccess permissions.

Read Work Copy ElementsReads only

Read columns, field descriptions, or table descriptions from a Tableau work copy on the signed-in site. Optionally name one element (missing names return 404). Inspect each result's error field: individual read failures retain HTTP 200. Requires REST API 3.30+ (Cloud October 2026 / Server 2026.3), Data Management or Tableau+, and administrator access or Connect, Write (save), and VizqlDataApiAccess permissions on the original data source.

Reencrypt Extracts in a Site

Reencrypt ALL .hyper extracts at rest with new encryption keys across the connected account's entire signed-in Tableau Server site (SITE-WIDE scope), including the default site when the connection signs into it. Cannot target an individual workbook, data source, or extract. Requires a Tableau Server administrator and REST API 3.5 or later. Depending on extract count and size, this can consume significant server resources; consider running outside normal business hours. Returns no data on HTTP 200; does not verify individual extract reencryption completion. Does not automatically retry.

Remove Collection Items

Remove items from a Tableau collection without deleting the underlying content. Inspect errors for partial failures, even on HTTP success. Requires REST API 3.28+ (Cloud February 2026 / Server 2026.2). Administrators may modify collections on sites they administer; other users may modify only collections they own. No additional license is required.

Remove Column

Permanently remove a column metadata asset from a table in Tableau Catalog on the signed-in site. This removes Catalog metadata; it does not delete the physical source column or its data. Requires a Tableau Cloud site or Tableau Server licensed with Data Management and administrator access or explicit edit (Write) permission on the asset metadata. Available in REST API 3.5 and later. Returns no data on success.

Remove Current Analytics Extension Connection For Workbook

Remove the currently used analytics extension connection to an external service from the specified Tableau workbook. The connection remains configured and available for further usage by the workbook. Requires permissions to the workbook. Available in REST API 3.11 (Tableau Cloud March 2021 / Server 2021.1) and later. No additional license required. Returns no data on success.

Remove Data Source Revision

Permanently remove a specific Tableau data source revision from the signed-in site. The removed revision remains listed as deleted but can no longer be downloaded. The head revision cannot be removed. Requires REST API 2.3 or later and enabled version history. Administrators can remove revisions; other users need ExplorerCanPublish, Read/Write/Download on the data source, and Write on its project. Returns no data on success.

Remove Database

Permanently remove a database asset from Tableau Catalog on the signed-in site. Removes the Catalog metadata asset; does not delete the underlying physical database or its data. Requires a Tableau Cloud site or Tableau Server licensed with Data Management and administrator access or explicit edit (Write) permission on the asset metadata. Available in REST API 3.5 and later. Returns no data on success.

Remove Group from Group Set

Remove a group from a group set on the connected account's signed-in Tableau site. Removes the membership, without deleting the group or group set. Requires Tableau Server administrator or Tableau Cloud site administrator permissions and REST API 3.22+ (Cloud February 2024 / Server 2024.2+). Returns no data on success.

Remove OpenID Connect Configuration

Disable and clear OIDC configuration on the signed-in Tableau Cloud site. Before removal, set users authenticating with OIDC to a different authentication type; otherwise they will be unable to sign in to Tableau Cloud. Requires a Tableau Cloud site admin and REST API 3.22+; not available on Tableau Server. An optional configuration ID requires 3.24+. Without an ID on 3.24+, removes the initial (default) configuration only; if absent, nothing is removed. No additional license is required. Returns no data on HTTP 200 success.

Remove Projects from Routing Rule

Remove one or more project filtering conditions from an existing Bridge allow rule on the signed-in Tableau Cloud site, broadening its scope. Block rules are rejected. Requires a Cloud site administrator and REST API 3.30+ (October 2026). Not available on Tableau Server. Returns the updated routing rule.

Remove Table

Permanently remove a table metadata asset from Tableau Catalog on the signed-in site. This removes Catalog metadata; it does not drop the physical source table or delete its data. Requires a Tableau Cloud site or Tableau Server licensed with Data Management and administrator access or explicit edit (Write) permission on the asset metadata. Available in REST API 3.5 and later. Returns no data on success.

Remove User from Group

Remove one user or bulk remove users from a group on the connected account's signed-in Tableau site. Does not delete users from the site. Requires a server or site administrator. Supply user_id for single removal (API 2.0+) or user_ids for bulk removal (API 3.21+). Returns no data on success.

Remove User from Identity Pool

Remove a user from a specified identity pool on the connected account's signed-in Tableau site. Requires Tableau Server REST API 3.19 or later and server administrator permissions; unavailable on Tableau Cloud. No additional license is required. Returns no data on success.

Remove User from Site

Remove a user from the connected account's signed-in Tableau site. Requires a server or site administrator. Content ownership must first be reassigned, or a server administrator can transfer it using map_assets_to. Subscriptions alone do not prevent removal. Removing the user from their last site deletes the user. Returns no data on success. Available in REST API 1.0 and later.

Remove Workbook Revision

Permanently remove a specific Tableau workbook revision from the signed-in site. The removed revision remains listed as deleted but can no longer be downloaded. The head revision cannot be removed. Requires REST API 2.0 or later and enabled version history. Administrators can remove revisions; other users need ExplorerCanPublish, Read/Write/Download on the workbook, and Write on its project. Returns no data on success.

Reorder Collection Items

Reorder items in a Tableau collection. Requires REST API 3.28+ (Cloud February 2026 / Server 2026.2). Administrators can reorder collections on sites they administer; other users must own the collection. No additional license is required.

Replace Content Permissions

Replace existing permissions for a data source, flow, project, view, or workbook on the signed-in Tableau site with multiple user/group permission sets. This replaces existing rules rather than adding to them. Requires REST API 3.23 or later and server/site administrator access or ChangePermissions on the content.

Replace Project Default Permissions

Replace a project's default permissions for the selected content type on the signed-in Tableau site. Defaults apply to new content and, when permissions are locked to the project, existing child content. Database and table resources require Tableau Catalog enabled. Requires REST API 3.23 or later and server administrator, project owner/leader, or effective ChangePermissions rights. Returns an empty object on success; Tableau returns no response body.

Restore Recycle Bin Content Item

Restore a workbook, data source, flow, or project from the signed-in site's Recycle Bin to a destination project. Administrators can restore any item; other users can restore only content they own. The caller also needs Publish permission on the destination project. Requires REST API 3.29 or later (Tableau Cloud June 2026 / Server 2026.2) and an enabled Recycle Bin. Returns no data on success.

Run Extract Refresh Task

Queue an existing scheduled extract refresh task on the signed-in Tableau site and return its backgrounder job. Requires API 2.6+; virtual connections require 3.30+. Non-administrators on Tableau Server can run only tasks they own. Fails if RunNow is disabled or the task is already queued or in progress. Does not wait for completion; use Query Job with the returned job ID.

Run Flow Now

Run a Tableau flow on the signed-in site and return its asynchronous job without waiting for completion. Requires API 3.3+, Data Management, and the site RunNow setting. Runs all output steps in full mode unless specified otherwise; supports parameter overrides. Owners, administrators, project leaders, and permitted Creator or Explorer users can run flows. Queued or in-progress tasks may reject a new run; running a suspended task resumes its job.

Run Flow Task

Queue an existing scheduled Tableau flow run task on the signed-in site and return its asynchronous backgrounder job. Use Query Job to check completion. Requires API 3.3+, Data Management, and the site's RunNow setting enabled. Schedule the flow first and obtain its task ID from Get Flow Run Tasks. Non-administrator Tableau Server users can run only tasks they own. An already queued or running task may reject the request with 403102; a suspended task may resume. The mutation is not automatically retried.

Run Linked Task Now

Run all steps of an existing linked task on the signed-in Tableau site and return its job without waiting for completion. Requires REST API 3.15+, Data Management, enabled linked tasks, and the site RunNow setting. Administrators and project leaders can run tasks within their scope; other users must own the task or have permission to run every included flow. Step failures stop or continue according to the linked task's configured behavior.

Search ContentReads only

Search one page across Tableau content types, restricted to objects the signed-in user can access. Requires REST API 3.16+ (Cloud June 2022 / Server 2022.3); no additional license required. Supply page and repeat the search parameters for subsequent pages; inspect pageIndex, total, next, and prev.

Search Graph NodesReads only

Search Tableau Knowledge Graph nodes using natural-language semantic similarity. Optionally filter by node type, data-source subtree, graph, or score threshold. Returns ranked nodes and matched business preferences. Requires Tableau Cloud+ September 2026 or later; unavailable on Tableau Server. Any authenticated user can read nodes permitted by content permissions. Uses independent Knowledge API v1 regardless of the classic REST version used for sign-in.

Search Semantic ContextsReads only

Search business preferences across a Tableau Knowledge Graph, returning both user-managed and Tableau-managed semantic contexts. Only is_global currently filters results; query, kind, and limit are accepted but ignored by the provider. Requires Tableau Cloud+ September 2026 or later; unavailable on Tableau Server. Any authenticated user can read preferences allowed by content permissions. Uses independent Knowledge API v1 regardless of the classic REST sign-in version.

Search Semantic Contexts Attached to a NodeReads only

Read user-managed and Tableau-managed business preferences applying to a Knowledge Graph node. An unknown node returns an empty list. Request-body filters are accepted but currently ignored; the node path selects results. Requires Tableau Cloud+ September 2026 or later, unavailable on Tableau Server. Any authenticated user can read nodes allowed by content permissions. Uses independent Knowledge API v1 regardless of the classic REST sign-in version.

Set Custom View as Default for Users

Set a Tableau custom view as the default for 1–100 specified users on the signed-in site. Only Tableau administrators can call this method. Requires REST API 3.21 (Cloud October 2023 / Server 2023.3) or later. Returns per-user success or failure; inspect every result because a successful HTTP request can contain individual failures.

Sign Out

Sign out the ephemeral Tableau session prepared specifically for this action, invalidating its Sign In authentication token. This action first signs in using the connected account, then signs out that new session. It does not disable the personal access token (PAT) or Composio connection, or sign out persistent global sessions or sessions used by other actions. Any user can call it. Returns no data when Tableau confirms HTTP 204.

Switch Site

Switch this action's temporary Tableau Server session to another accessible site and return only typed site/user metadata, without authentication tokens. First signs in using the connected account; switching invalidates that temporary session's old token. Does not rewrite the Composio connection or persist the destination site for later calls: subsequent actions sign in to the connection's configured site again. The destination must differ from the current site. Available on Tableau Server REST API 2.6 and later; unavailable on Tableau Cloud.

Test a Webhook

Send an empty test payload to an existing webhook's configured destination on the signed-in Tableau site and return the destination server's response. This GET causes an outbound callback; inspect webhookTestResult.status for delivery success and do not blindly retry after failure. Requires a server or site administrator and REST API 3.6 or later.

Update Analytics Extension Connection of Site

Update an external analytics service connection on the signed-in Tableau site using PAT authentication. Requires site or server administrator permissions and REST API 3.11 or later. Configure external service secret credentials directly in Tableau; this action does not accept passwords, client secrets, or private keys. On Cloud, enable SSL and authentication. Host paths require Server 2022.1 / Cloud April 2022 or later. No additional license required. Returned passwords are omitted.

Update Analytics Extension for Workbook

Update the external analytics extension connection used by a workbook on the signed-in Tableau site. Requires permissions to the specified workbook and REST API 3.11 (Cloud March 2021 / Server 2021.1) or later. No additional license required. Returns the connection mapping.

Update Bridge Pool

Rename an existing Bridge pool on the signed-in Tableau Cloud site. The pool ID, domain assignments, and Bridge client assignments are unchanged. Requires REST API 3.28+ (March 2026) and site administrator permissions; unavailable on Tableau Server. No additional license is required. Returns no data on success.

Update Cloud Extract Refresh Task

Update an existing extract refresh task and its custom schedule on the signed-in Tableau Cloud site. Requires REST API 3.20 or later; virtual connections require 3.30. Administrators or the custom schedule owner can update it. Omitted attributes retain their existing values. Not available on Tableau Server. Does not run the refresh immediately.

Update Column

Update a Tableau column asset's description on the signed-in site. Only a supplied description is changed; an empty update makes no changes. Requires Data Management, REST API 3.5+, and Server/site administrator access or explicit Write permission on the asset metadata.

Update Connected App

Update a direct-trust connected app on the signed-in Tableau site. Requires Server admin or Cloud site admin and API 3.17+. WARNING: omitting enabled defaults it to false, disabling the app. Omitted project restrictions are preserved; empty project_ids allows all projects. project_ids requires Cloud API 3.22+ or Server API 3.23+. Returns existing secret metadata, not its value.

Update Custom View

Change the name or owner of an existing Tableau custom view on the signed-in site. Requires REST API 3.18+ (Cloud December 2022 / Server 2023.1). Administrators can update any custom view; other users can update custom views they own. Omitted attributes remain unchanged.

Update Data in Hyper Connection

Queue an atomic insert/update/upsert/replace/delete batch for a published live-to-Hyper connection, including data sources with multiple connections. Requires Tableau 2021.2 or later, a completed Hyper upload session, and the data source owner with overwrite permission. Returns a job ID without waiting for completion. Payloads are single-use; RequestID deduplicates requests within 24 hours.

Update Data in Hyper Data Source

Queue an atomic batch of insert, update, upsert, replace, or delete operations in a published single-connection live-to-Hyper data source on the signed-in site. Requires Tableau 2021.2 or later, data source ownership and overwrite permission, and a completed Hyper payload upload. Each upload is consumed once. Returns a job ID, not completion. Use the connection-specific endpoint for multi-connection data sources. Parquet payloads are not converted to Hyper by this operation.

Update Data Quality Warning

Update a data quality warning's required type and optional display status, message, and severity on the signed-in Tableau site. Requires REST API 3.5+, Data Management, and administrator or explicit asset metadata Write permission. Message is required on Server 2023.3 and earlier. Tableau recommends the newer Update Label method for evolving label features.

Update Data Source

Update a Tableau data source's name, project, owner, certification, or extract encryption on the signed-in site. Requires REST API 2.0 or later and appropriate administrator, ownership, project-leader, or write permissions for the changed properties. Omitted fields remain unchanged; no supplied changes makes no update. This updates metadata, not rows in a Hyper data source.

Update Data Source Connection

Update the server, port, authentication type, username, or password-embedding setting of a published Tableau data source connection on the signed-in site. Credentials must be set in Tableau. Requires REST API 2.3+ and administrator or applicable data source and project Write permissions. Omitted attributes remain unchanged; no attributes makes no update. Query tagging is unsupported from API 3.23; authentication type requires API 3.27+.

Update Data Source Connections

Update nonsecret database server, port, authentication type, username, or settings for selected connections in a Tableau data source on the signed-in site. Set credentials directly in Tableau; this tool does not update passwords, client secrets, or private keys. Requires REST API 3.27 or later. Server/site administrators can update connections; other users need Write (save) permission on the data source and write permission on its project. Omitted attributes remain unchanged; empty connection attributes make no update. Query tagging is deprecated and unsupported.

Update Data Source Now

Queue an extract refresh for a Tableau data source on the signed-in site without a scheduled task, and return its asynchronous job. Requires API 2.8 or later. Defaults to a full refresh; API 3.28+ supports incremental refresh when requested. Administrators, the data source owner, or its project leader can refresh it. Fails if the site RunNow setting is disabled or a refresh is already queued. Refreshing a legacy .tde extract converts it to .hyper. Does not wait for completion.

Update Data-Driven Alert

Update a data-driven alert's subject, frequency, visibility, or owner on the signed-in Tableau site. Omitted settings remain unchanged. Requires REST API 3.2+ on Tableau Cloud or Server, and server administrator, site administrator, or alert-owner permissions.

Update Database

Update a database asset's description, certification, permissions mode, or contact on the signed-in Tableau site. Requires REST API 3.5+, Data Management licensing, and administrator or explicit asset Write permissions. Only supplied fields change; with no changes supplied, no update is made.

Update Domain Among Pools

Move an existing domain from its current Bridge pool to a different pool on the signed-in Tableau Cloud site. The operation is atomic: on failure the domain mapping is unchanged. Requires REST API 3.28+ (March 2026) and site administrator permissions; unavailable on Tableau Server. No additional license is required. Returns no data on success.

Update Domain Name

Rename an existing Bridge domain mapping on the signed-in Tableau Cloud site. The operation is atomic (all-or-nothing). The existing domain must exist and the new domain name must not already exist in the system. Requires REST API 3.28+ (March 2026) and site administrator permissions; unavailable on Tableau Server. No additional license is required. Returns no data on success.

Update Embedding Settings for Site

Update embedding restrictions on the signed-in Tableau Cloud or Server site. Allow all domains or restrict embedding to a space-separated domain allowlist, including wildcards. Affects JavaScript API v2, Embedding API v3, and share-dialog embed code. Requires REST API 3.16+. Tableau Cloud requires a site administrator.

Update Enabled State of Analytics Extensions on Site

Enable or disable analytics extensions on the signed-in Tableau site. Requires server or site administrator permissions and REST API 3.11 (Cloud March 2021 / Server 2021.1) or later. No additional license required.

Update Flow

Update a Tableau flow's project and/or owner on the signed-in site. Requires REST API 3.3 or later. Owner changes require a server or site administrator, and the new owner must be the calling user; use Update Flow Owner for fewer owner limitations. Non-server-administrators moving a flow must own the flow or source project, or lead the source project, and have Write permission on the destination project. Omitted fields remain unchanged; supplying neither makes no update.

Update Flow Connection

Update a Tableau flow input or output connection's server, port, username, authentication type, or password embedding setting on the signed-in site. Configure connection credentials directly in Tableau; this action does not accept passwords, client secrets, or private keys. Requires REST API 3.3+; authentication type requires 3.28+. Supply at least one attribute; omitted attributes remain unchanged. Requires administrator privileges or applicable flow Write(save) and project Write permissions.

Update Flow Connections

Update server, port, username, authentication type, or password-embedding settings for one or more input or output connections of a Tableau flow on the signed-in site. Configure database passwords, client secrets, and private keys directly in Tableau; this action does not accept them. Requires REST API 3.28+ (Tableau Cloud April 2026 or Server 2026.2+). Requires server/cloud site administrator privileges or applicable flow Write(save) and project Write permissions. Omitted connection attributes remain unchanged; each connection must include at least one attribute to update.

Update Flow Owner

Change a flow's owner on the signed-in Tableau site. Recommended over Update Flow for ownership changes because it has fewer limitations on the new owner. Requires REST API 3.27 or later, Data Management or Tableau+, and a server administrator, site administrator, or flow owner. If the same user owns all flows in a linked task, also changes that linked task's ownership to that user. Returns no data on success.

Update Group

Rename a local Tableau group or synchronize a Server Active Directory group on the signed-in site. Requires Server administrator or Cloud site administrator permission and REST API 3.9+. Directory synchronization changes membership and may unlicense removed directory users. Set as_job for a background synchronization and monitor the returned job with Query Job.

Update Group Set

Rename a group set on the signed-in Tableau site, preserving its membership. Requires REST API 3.22+ (Cloud February 2024 / Server 2024.2+) and Tableau Server administrator or Tableau Cloud site administrator permissions. Group set names are unique case-insensitively.

Update Identity Pool

Update an identity pool's name, sign-in description, or enabled state. The name must be unique. Requires server administrator permissions and Tableau Server 2023.1 / REST API 3.19 or later. Not available for Tableau Cloud.

Update Label

Update a data label by LUID on the signed-in Tableau site. Supports value, message, active and elevated; category cannot change. Monitoring warnings extract_refresh_failure and flow_run_failure cannot be updated. Requires write permission on the asset; certification labels require administrator, project leader or product owner privileges (change permissions for external assets outside projects). Catalog and Data Management are required except for data source certification. Available on Cloud API 3.16+ and Server API 3.17+.

Update Label Category

Update the name and description of an existing data label category on the signed-in Tableau site (REST API 3.21+, Cloud October 2023 / Server 2023.3). Requires a site or server administrator. Data Management is not required for categories, but is required to manage and see labels on assets. Server 2023.3 and earlier restrict names to 24 characters.

Update Label Value

Update or rename an existing data label value on the signed-in Tableau site. Requires a site or server administrator, Cloud REST API 3.20+ (June 2023) or Server 3.21+ (2023.3). Supply its current name in label_value_name and desired name in name. Category must match the existing category and cannot change. Data Management is not required for label values, but is required to manage and see labels on assets. Server 2023.3 and earlier limit updated names to 24 characters.

Update Labels

Create or update the same data label on one or more assets on the signed-in Tableau site. An existing label with that value is updated; otherwise a label is created. On Server 2023.3 and earlier, only one label per category is allowed. Category derives from value and cannot be changed. Monitoring warnings cannot be updated. Requires asset write permission; certification requires administrator, project leader or product owner privileges (change permissions for external assets outside projects). Catalog and Data Management are required except for data source certification. Introduced in Cloud API 3.16 and Server API 3.17.

Update Metric Definition

Update a Tableau Pulse metric definition's name, description, calculation, comparisons, goals, insight settings, formatting, links or tags. Available on Tableau Cloud with REST API 3.21 or later, not Tableau Server. Requires write and publish access to the definition's data source. Point-in-time temporality cannot use running totals; set is_running_total to false.

Update Mobile Security Settings for Site

Update mobile security rules on the signed-in Tableau Cloud site, including jailbreak detection, maximum offline days, and screenshot protection. Requires administrator permissions and REST API 3.18+; maximum offline time requires 3.19+. Not available on Tableau Server. No additional license is required. Platform detection requires both the setting and platform enabled flags.

Update Monitoring Quality Warning

Update an existing monitoring quality warning by its LUID on the signed-in Tableau site. Monitor extract refresh or flow run failures: failures attach the warning and successful refreshes or runs remove it. Requires REST API 3.11+, Data Management, and administrator or explicit asset metadata Write permission.

Update Project

Update a Tableau project's name, description, hierarchy, owner, or content permission policy on the connected PAT's signed-in site, optionally publishing sample workbooks. Requires a Tableau administrator and REST API 1.0 or later. Omitted attributes are unchanged; an empty parent_project_id moves the project to the top level.

Update Pulse User Preferences

Update Tableau Pulse notification channels, digest cadence and metric selection, and grouping and sorting of followed metrics. Defaults to the signed-in user. Available on Tableau Cloud with REST API 3.24 or later; not Tableau Server.

Update Routing Rule

Partially update a Bridge routing rule on the signed-in Tableau Cloud site. Supply at least one of domain, pool_id, or is_blocked; omitted attributes remain unchanged. Transitioning to an allow rule requires pool_id; block rules must omit it. Project scope is unchanged: use Add Projects to Routing Rule or Remove Projects from Routing Rule instead. Requires Cloud REST API 3.30+ (October 2026) and site administrator privileges. Not available on Tableau Server. Returns the updated rule.

Update SCIM Configuration

Update the name and authentication association of an existing SCIM configuration on the signed-in Tableau Cloud site (REST API 3.26+). Requires a Cloud site administrator who created the configuration, unless its creator is no longer a site member. Both name and authentication configuration ID are required. Changing idpConfigurationId deletes any associated SCIM token: remove that token's secret from the identity provider's SCIM configuration. OIDC or Google authentication associations require API 3.28+. Signs in using the connected PAT or username/password, then sends one PATCH without retrying the mutation. HTTP 204 can return no configuration details.

Update Semantic Context

Partially update a user-managed business preference in Tableau Knowledge. Only supplied body fields change; statements replaces the entire stored set. Tableau-managed SEMANTIC_CONTEXT_EXTERNAL preferences cannot be updated. Requires Creator role, content permissions, and Tableau Cloud+ September 2026 or later; unavailable on Tableau Server. Uses independent Knowledge API v1 regardless of the classic REST sign-in version.

Update Server Active Directory Domain

Change an Active Directory domain's full name or NetBIOS nickname on Tableau Server (REST API 3.11+). Requires a server administrator; unavailable on Tableau Cloud. The local domain cannot be renamed. Changing the full name of the signed-in domain requires the signed-in username to exist in both domains. Omitting both replacement attributes makes no update.

Update Server Schedule

Modify a server-wide schedule on Tableau Server (REST API 2.3+). Requires server administrator permissions; unavailable on Tableau Cloud. Only supplied attributes change. Updating a weekly schedule without days resets its interval to all seven days; include selected days to preserve them. Monthly schedules support only one day through REST.

Update Site

Update selected Tableau site settings. Only supplied non-null attributes change; an empty settings object performs no update. Requires sign-in to a site and, on Tableau Server, server-administrator permissions. Supports settings updates, not multipart custom-logo upload or reset. Retired Ask Data, legacy Metrics, cache warmup, and data acceleration settings are excluded.

Update Subscription

Update a classic workbook/view email subscription on the signed-in Tableau site. Change subject, attachments, suspension, or schedule; omitted attributes are retained. Server API 2.3+ uses subscription.schedule with an existing Subscription-type schedule. Cloud API 3.20+ uses a top-level custom schedule and supports recipient/content/message updates; all custom-schedule update attributes are optional. Cloud custom schedules require an administrator or Creator. Server users can update subscriptions they may create. This does not update Tableau Pulse subscriptions.

Update Table

Update a Tableau table asset's description, certification status or note, and user contact on the signed-in site. Only supplied fields are changed; an empty update makes no changes. Requires Data Management, REST API 3.5+, and Server/site administrator access or explicit Write permission on the asset metadata.

Update Tableau Extensions Server Settings

Update server-wide Tableau extension settings: enable or disable extensions and optionally set blocked extension domains. Requires server administrator permissions and REST API 3.21+ (Tableau Server 2023.3+). Not available for Tableau Cloud. No additional license is required.

Update Tableau Extensions Site Settings

Update extension settings for the signed-in Tableau site. Requires site or server administrator permissions and REST API 3.21+ (Cloud June 2023 / Server 2023.3+). No additional license required. The safelist replaces the entire existing list; include existing URLs to retain them. Trusted category flags apply only when allowTrusted is true. Server blocklists and extension enablement still apply.

Update Tableau MCP Settings for Site

Add, modify, or remove Tableau MCP settings on the signed-in site. Omit an entry's value to remove its key; values are strings. Returns the current settings after the update. Requires site or server administrator permissions, an enabled MCP feature, and REST API 3.29+ (Tableau Cloud June 2026 / Server 2026.2+). No additional license required.

Update User

Modify a user's profile, site role, or authentication selection on the signed-in Tableau site. Set credentials and passwords directly in Tableau; this action does not accept or update them. Requires a server or site administrator; site administrators have attribute and site-role restrictions. Cloud cannot change full names, and email changes are notification-only starting in API 3.26. Only supplied fields are updated; omitting all fields has no effect. Identity pools require Server API 3.19+, authentication configuration IDs Cloud API 3.25+, and language/locale Cloud API 3.28+.

Update User Notification Preferences

Enable or disable notification preferences on the signed-in Tableau site. Requires a Server Administrator, Site Administrator Creator, or Site Administrator Explorer and REST API 3.15+. Returns individual update outcomes; HTTP 207 indicates partial failure. Does not retry updates.

Update Virtual Connection

Update a Tableau virtual connection's name, owner, project, or certification on the signed-in site. Requires REST API 3.23 or later, Tableau Data Management, Overwrite permission on the virtual connection, and at least the Creator site role. Omitted attributes remain unchanged.

Update Virtual Connection Database Connections

Update the server address, port, or username for one database connection in a Tableau virtual connection on the signed-in site. Set database passwords and other secret credentials directly in Tableau. Requires REST API 3.18+, Tableau Data Management, and an administrator or Creator-or-higher site role. Supply at least one nonsecret attribute; omitted attributes remain unchanged.

Update Virtual Connection Now

Run an asynchronous extract refresh on a virtual connection on the signed-in Tableau site. Only extract tables are refreshed; live tables are ignored. Requires REST API 3.30+ and Data Management, Enterprise, Server+, Cloud+, or Tableau+ Bundle licensing. Non-administrators must own the virtual connection or lead its project and have extract refresh permission. Fails if Run Now is disabled or a refresh is already queued. Returns the job without waiting; use Query Job with its ID to check completion.

Update Webhook

Modify an existing webhook in the signed-in Tableau site (REST API 3.8+). Requires a server or site administrator. Supply the webhook LUID, name, and supported API trigger event; optionally change the HTTPS delivery destination or enabled state and disablement reason. Uses the recommended event attribute.

Update Work Copy Elements

Update column captions, types, roles, or field/table descriptions on a Tableau work copy on the signed-in site. Each column update may set at most one property. Full success returns no element records; partial failure raises an error listing only failed elements, while other elements may already have succeeded. Does not publish the work copy. Requires REST API 3.30+ (Cloud October 2026 / Server 2026.3), Data Management or Tableau+, and administrator access or Connect, Write (save), and VizqlDataApiAccess permissions on the original data source.

Update Workbook

Update a Tableau workbook's name, project, owner, tabs, extract encryption, description or freshness policy on the signed-in site. Requires REST API 2.0+ and workbook/project Write permission; owner changes require an administrator. Omitted fields stay unchanged; no fields makes no update. Legacy view acceleration retired in Cloud June 2026 and Server 2026.2.

Update Workbook Connection

Update a Tableau workbook connection's server, port, authentication type, database username, or password embedding setting on the signed-in site. Configure database passwords, client secrets, and private keys directly in Tableau; this action does not accept credential secrets. Requires REST API 2.0+ and administrator access or workbook Write capability. If multiple connections use the same data source type, all are updated. Omitted attributes remain unchanged; no attributes makes no update. Authentication type requires API 3.27+. Query tagging is unsupported from API 3.23 and requires administrator permissions on earlier versions.

Update Workbook Connections

Update server address, port, authentication type, username, or password-embedding preference for selected connections in a Tableau workbook on the signed-in site. Configure database passwords, client secrets, and private keys directly in Tableau; this action does not accept or update those secrets. Applies the same attributes to all supplied connection LUIDs. Requires REST API 3.27+ (Cloud December 2025 / Server 2025.3+) and administrator or applicable content/project Write permissions. Omitted attributes remain unchanged; empty attributes make no update. The legacy queryTaggingEnabled attribute is deprecated and unsupported since API 3.23.

Update Workbook Now

Queue an extract refresh for a workbook on the signed-in Tableau site without a scheduled task and return its asynchronous job. Requires API 2.8 or later; API 3.28+ supports the incremental option. Requires an administrator, workbook owner, or project leader. Fails if the site RunNow setting is disabled or the refresh is already queued. Does not wait for completion.

Update Workbook Thumbnail Images

Queue a background job to refresh a workbook's thumbnail images on the signed-in Tableau site. Requires REST API 3.27+ (Cloud December 2025 / Server 2025.3+) and server administrator, site administrator, or workbook owner permissions. Returns a job ID for Query Job; the refresh may not run immediately.

Validate Uploaded WorkbookReads only

Validate an already uploaded Tableau TWB file against the TWB XSD schema and Tableau's semantic checks on the signed-in site. Supply the upload session ID from Initiate File Upload after uploading the file with Append to File Upload. Requires REST API 3.29+ (Cloud June 2026 / Server 2026.2+) and any authenticated user. Returns advisory warnings on success; validation errors fail with diagnostic details. Does not publish the workbook.

Validate WorkbookReads only

Validate a TWB workbook against Tableau's XSD and check that Tableau can load it, without storing it. Requires REST API 3.29+ (Cloud June 2026 / Server 2026.2+) and any authenticated user. Packaged TWBX files are unsupported. Returns valid=false and detailed errors for HTTP 422 validation failures; warnings are advisory.

Validate Workbook and Upload

Validate an unpackaged Tableau TWB workbook against the TWB XSD and verify it can load in Tableau. Successful validation stores the workbook temporarily on the signed-in site and returns uploadId with advisory warnings. Does not publish the workbook. TWBX is unsupported. Requires REST API 3.29+ (Cloud June 2026 / Server 2026.2+) and any authenticated user; no additional license. Validation errors fail with diagnostic details. Upload is not automatically retried.

More in Analytics

See them all β†’

Your company, run by an AI team

Start your company

BRAINER

Continue to B.R.A.I.N.E.R.

Continue with Google or your email.

or