--- schema_version: "1" id: 8e853cf43c0cd9e99648f077a7b71456d586e8b10c7bca5bdb390e8b85a5dfe2 title: Site Methods collection: tableau version: next locale: en-us portal_url: https://docs.salesforce.com/tableau/next/en-us/api/rest_api/REST/rest_api_ref_site.md canonical_url: https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_ref_site.htm source_site: help.tableau.com content_type: documentation content_hash: 5752880389c9d99095035c14b2fb9725e7dd63e45dc01c38b3d811d7471e8f9d description: "Using the site methods of the Tableau Server REST API you can:" --- [Skip to main content](#main-content) # Site Methods Using the site methods of the Tableau Server REST API you can: - List sites on a server or get details of a specific site - Create, update, or delete a site - List views in a site - List authentication configurations on a site (Tableau Cloud only) This functionality relates to the UI elements and concepts described at: [Sites Overview](https://help.tableau.com/current/server-linux/en-us/sites_intro.htm). ## Use Postman Our Postman collection of requests enables you to construct, send, and examine HTTP requests to the Tableau Server or Tableau Cloud API without writing initial code. Postman is a free online app used by many developers for prototyping API calls, investigating issues, and generating request code in a variety of languages. [Postman: Sites](https://www.postman.com/salesforce-developers/salesforce-developers/folder/fon10lz/sites) ## Create Site Creates a site on Tableau Server. To make changes to an existing site, call [Update Site](#update_site). This method isn’t available for Tableau Cloud. For more information, see [Work with Sites](https://help.tableau.com/current/server/en-us/help.htm#sites_intro.htm) and [Add or Edit Sites](https://help.tableau.com/current/server/en-us/help.htm#sites_add.htm) in the Tableau Server documentation. **Note**: After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. #### URI POST /api/api-version/sites #### Request Body ``` ``` #### Attribute Values

site-name	The name of the site.
content-url	The subdomain name of the site's URL. This value can contain only characters that are upper or lower case alphabetic characters, numbers, hyphens (-), or underscores (_). If you provide unsupported special characters, Tableau creates the site content URL by omitting those characters from the string. For example, if you provide the site URL as "test.site", Tableau converts it to "testsite" and returns this new URL in the response.
admin-mode	(Optional) Specify ContentAndUsers to allow site administrators to use the server interface and `tabcmd` commands to add and remove users. (Specifying this option doesn’t give site administrators permissions to manage users using the REST API.) Specify ContentOnly to prevent site administrators from adding or removing users. (Server administrators can always add or remove users.) Note: You can’t set adminMode to ContentOnly and also set userQuota. The default value is ContentAndUsers.
storage-quota	(Optional) The maximum amount of space for the new site, in megabytes. If you set a quota and the site exceeds it, publishers will be prevented from uploading new content until the site is under the limit again.
disable-subscriptions	(Optional) Specify true to prevent users from being able to subscribe to workbooks on the specified site. The default is false.
editing-flows-enabled-flag	(Optional) Specify true to enable and false to disable editing flows for a site. For more information on flows, see Enable and Configure Tableau Prep Conductor. The default is set to true, which means editing flows is enabled by default. For more information, see Implication of disabling Tableau Prep Conductor.
scheduling-flows-enabled-flag	(Optional) Specify true to enable and false to disable scheduling flows for a site. For more information on flows, see Enable and Configure Tableau Prep Conductor. The default is set to true which means scheduling flows is enabled by default. For more information, see Implication of disabling Tableau Prep Conductor.
flows-enabled-flag	The flowsEnabled attribute is deprecated as of API version 3.10.
allow-subscription-attachments-flag	(Optional) If true, and subscription to attachments is enabled on the server, then users can create subscriptions that send an email with images of a workbook or view in a PDF attachment. The default value is true. If subscription to attachments is disabled in the server settings, then making this value true will have no effect. Default is true.
guest-access-enabled-flag	(Optional) Specify true to enable and false to disable the ability for guests, users without specific site access permission, to access the site. Default is false.
cache-warmup-enabled-flag	This attribute is removed in API 3.19 and later (Tableau Cloud September 2021). For current methods to improve Tableau performance see, View Acceleration. (Optional) Set this value to true to enable cache warm up to improve workbook load time. Set the value to false to disable cache warmup. Default is true.
commenting-enabled-flag	(Optional) Specify true to enable and false to disable the ability for user comments on views in the site. Default is true.
revision-history-enabled	(Optional) true if the site maintains revisions for changes to workbooks and data sources; otherwise, false. The default is false.
num-revision-limit	(Optional) An integer between 2 and 10000 to indicate a limited number of revisions for content. Setting this value to -1 removes any value that was set previously, and effectively removes any limit to the number of revisions that are maintained.
subscribe-others-enabled-flag	(Optional) Specify true to enable and false to disable the ability for view owners to subscribe other users to a view. Default is true.
extractEncryptionMode	(Optional) Specify enforced, enabled, or disabled. Default is disabled. For more information, see Extract and Encryption Methods.
requestAccessEnabled	(Optional) Specify true to allow users send access request emails to content or project owners. Specify false if you don’t want users to be able to request access. The default is false.
runNowEnabled	(Optional) Specify true to allow users to run flows, extract refreshes, and schedules manually. Specify false if you don’t want users to be able to run flows, extract refreshes, and subscriptions manually. The default is true. If this attribute is set to false, the following methods will fail and will return an error message. Run Flow Now Run Flow Task Update Data Source Now Run Extract Refresh Task
Licensing attributes For user-based license types, the maximum number of users is set by the licenses activated on that server. For core-based licensing, there’s no limit to the number of users; if you specify a maximum value, only licensed users are counted, and server administrators are excluded. The REST API enables administrators to set licensing limits below the purchased maximum with two types of license-related attributes: - User Quota - The total maximum number of licenses currently configured for a site. - Tiered Capacities - If set, the configured maximum license count for each license type (role). Online administrators can get these attributes. An on-premises server administrator can both get and set them but if license maximums are set using one attribute kind then the value(s) of the other kind must be null. Setting values for both kinds of attributes will result in an error. For more information, see Licensing Overview.
User quota all-license-limit-total	(Optional) The maximum total number of users with Creator, Explorer, or Viewer licenses currently allowed on a site. On-premises server administrators can set `userQuota` with the following rules: The number can't exceed the number of licenses activated for the site; and if tiered capacity attributes are set, then `userQuota` will equal the sum of the tiered capacity values, and attempting to set `userQuota` will cause an error. An administrator can revert the license limit to number of activated licenses on the site, or shift control of license limits to tiered capacities values, by omitting `userQuota` from a Create Site or Update Site request, or making its value -1.
Tiered capacity attributes creator-license-limit explorer-license-limit viewer-license-limit	(Optional) The maximum number of licenses for users with the Creator, Explorer, or Viewer role, respectively, allowed on a site. On-premises server administrators can set tiered capacity attributes with the following rules: the number can't exceed the number of licenses of a given type that are activated for the site; a value must be supplied for every tiered capacity license type every time any one or more of them is set. A value of -1 removes the administrator-applied limit for a license type, and reverts the limit to the number of activated licenses configured for the role. Setting the value of a tiered capacity to -1 will not automatically increase the limit if more licenses are purchased and activated for the role in the future. To use role-specific license limits, the `userQuota` must be set to null by omitting the attribute from Create Site or Update Site request, or setting its value to -1. Attempting to set values for both tiered capacities and `userQuota` will result in an error.
data-alerts-enabled-flag	(Optional, boolean) If `true`, data alerts are enabled on the site. Default value is `true`.
commenting-mentions-enabled-flag	(Optional, boolean) If `true`, mentions for commenting are enabled. Default value is `true`.
catalog-obfuscation-enabled-flag	(Optional, boolean) If `true`, catalog obfuscation is enabled on the site. Default value is `true`.
flow-auto-save-enabled-flag	(Optional, boolean) If `true`, flow auto save is enabled on the site. Default value is `true`.
run-now-enabled-flag	(Optional, boolean) If `true`, run now for schedules is enabled which allows non-administrators to run schedules manually. Default value is `true`.
metrics-content-type-enabled-flag	(Optional, boolean) If `true`, the metrics content type is enabled on the server. Default value is `true`.
notify-site-admins-on-throttle-flag	(Optional, boolean) If `true`, site admins will be notified if their background jobs are being throttled. Default value is `false`.
authoring-enabled-flag	(Optional, boolean) If `true`, web authoring is enabled. Default value is `true`.
custom-subscription-email-enabled-flag	(Optional, boolean) If `true`, sending custom subscription email is enabled. If set to false after being set true, the current custom subscription email is voided. Default value is `false`.
custom-subscription-email	A valid custom email that will be sent if customSubscriptionEmailEnabled is set to true. Default value is `false`.
custom-subscription-footer-enabled-flag	(Optional, boolean) If `true`, a custom footer will be included on subscription and data alert emails. If set to false after being set true, the current custom subscription footer is voided. Default value is `false`.
custom-subscription-footer	A custom subscription footer that will be added to subscription and data alerts if customSubscriptionFooterEnabled is set to true. Default value is `false`.
ask-data-mode	The mode of the ask data feature on the site. Can be set to one of two values: `DisabledByDefault` - Enables creation of Ask Data lenses for all published data sources. Data sources do not have lenses created automatically. `DisabledAlways` - Disables Ask Data lenses and related content throughout the site. Preserves information about lenses and data source indexes, which are restored if Ask Data is re-enabled. Default value is `DisabledByDefault`. For more information, see Disable or Enable Ask Data for a Site.
named-sharing-enabled-flag	(Optional, boolean) If `true`, named sharing is enabled. Default value is `true`.
cataloging-enabled-flag	(Optional, boolean) If `true`, data catalog is enabled for the site. Default value is `true`.
derived-permissions-enabled-flag	(Optional, boolean) If `true`, derived permissions are enabled for the site. Default value is `false`.
user-visibility-mode	(Optional, string) When the value is `FULL` users can see the user of other site users. If the value is `LIMITED` User information on the site is not visible to other users. Default value is FULL. For more information, see User Visibility.
use-default-time-zone	Optional, boolean) Set this to `true`, if you want the time-zone attribute use the Server time Zone at run time. This attribute is set to the official IANA name. If this is set to `false`, the time-zone value must be specified.
time-zone	(Optional, string) Use this attribute to specify a time zone other than the Server time zone at run time. Only canonical names in the official IANA database are supported. You can find the list of the canonical time zone names on Wikipedia.
autoSuspendRefreshEnabled	(Optional) Tableau can automatically suspend extract refresh tasks for inactive workbooks to save resources. Specify true to enable or false to disable. Default is true.
autoSuspendRefreshInactivityWindow	(Optional) An integer from 7 through 100 to indicate the number of days to wait before automatically suspending extract refresh tasks for inactive workbooks. The default is 30.
explainDataEnabled	(Optional, boolean) Set this attribute to `false` to disable Explain Data capabilities for a site. By default, this attribute is set to `true`. For more information about this site setting, see one of the following topics: For Tableau Cloud, see Disable or Enable Explain Data for a Site. For Tableau Server, see Disable or Enable Explain Data for a Site.
dqwSubscriptionsEnabled	(Optional, boolean) Set this attribute to `false` to exclude data quality warnings (DQWs) from subscription emails. By default, this attribute is set to `true`. For more information about this site setting, see one of the following topics: For Tableau Cloud, see Disable or Enable Explain Data for a Site. For Tableau Server, see Disable or Enable Explain Data for a Site.
groupAssertionsEnabled	(Optional, boolean) Set to `true` to allow assertions into group membership using session info. Set to `false` if you do not want users to be able to be asserted in to groups. The default is `false`. If this attribute is set to false, it will disable group assertions for the entire site, including the following settings: groupAssertionsSAMLEnabled groupAssertionsOIDCEnabled groupAssertionsConnectedAppsEnabled
groupAssertionsSAMLEnabled	(Optional, boolean) Set to `true` to allow assertions into group membership using SAML session info. Set to `false` if you don’t want users to be able to be asserted in to groups. The default is `false`. If this attribute is set to false, it will disable group assertions for SAML sessions.
groupAssertionsOIDCEnabled	(Optional, boolean) Set to `true` to allow assertions into group membership using OIDC session info. Set to `false` if you don’t want users to be able to be asserted in to groups. The default is `false`. If this attribute is set to false, it will disable group assertions for OIDC sessions. Note: This parameter only applies to Tableau Cloud.
groupAssertionsConnectedAppsEnabled	(Optional, boolean) Set to `true` to allow assertions into group membership using Connected App JWT tokens. Set to `false` if you don’t want users to be able to be asserted in to groups via connected apps. The default is `false`. If this attribute is set to false, it will disable group assertions for JWT connected app connections.
groupSetsEnabled	(Optional, boolean) Set to `true` to allow groups sets. Set to `false` if you don’t want group sets support for the site. The default is `false`. If this attribute is set to false, it will disable group sets for the site.
recycleBinEnabled	(Optional, boolean) Set to `true` to enable the Recycle Bin. Set to `false` to disable it. The default is `true`.

#### Permissions This method can only be called by server administrators. #### Required scope for JWT authorization Introduced in Tableau Server 2022.3 (API 3.17). ``` tableau:sites:create ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 201 #### Response Body ``` ``` Response Body Details: - userQuota, storageQuota, and tiered capacity (tierCreatorCapacity, tierExplorerCapacity, tierViewerCapacity) attributes are only present in the response body if those quotas have been set for the site being queried. #### Response Headers Location: /api/3.29/sites/new-site-id #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad request	The content of the request body is missing, incomplete, or contains malformed XML.
400	400000	Invalid storage quota	The storage quota value wasn’t a positive number.
400	400000	Invalid user quota	The user quota value wasn’t a positive number.
400	400013	Invalid administrator mode	The user provided an administrator mode that isn’t ContentOnly or ContentAndUsers. Note: An empty string or all whitespace is invalid.
405	405000	Invalid request method	Request type was not POST.
409	409001	Site name conflict	The site name in the request already belongs to an existing site.
409	409002	Site URL conflict	The content URI in the request already belongs to an existing site.
409	409004	User quota and tiered capacity conflict	The request cannot set both tiered capacity attributes and userQuota. One or the other must be null.
409	409004	License limit exceeded	The request cannot set tiered capacity attributes or userQuota values that are larger than the number of active licenses configured for the site.
409	409004	Administrator mode or user quota conflict	The request cannot set adminMode to ContentOnly and also specify a userQuota value.

For more information, see [Handling Errors](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/" -X POST -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @create-site.xml` **Content of create-site.xml:** ``` ``` **Response body:** ``` ``` ## Delete Site Deletes the specified site. You can specify the site to delete by using the site ID, the site name, or the content URL. You use the key query string parameter to indicate how you are specifying the site, as shown in the URIs. Beginning in API version 3.18, you can delete a site asynchronously, which allows you to track the site deletion progress. This method is not available for Tableau Cloud. **Note**: You must have previously called the [Sign In](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_ref_authentication.htm#sign_in) method and signed in to a site in order to delete the site. When you call this method, you must include the authentication token that you got back when you signed into the site. #### URI **Delete site** DELETE /api/api-version/sites/site-id DELETE /api/api-version/sites/site-name?key=name DELETE /api/api-version/sites/content-url?key=contentUrl **Delete site asynchronously** (beginning in API 3.18) DELETE /api/api-version/sites/async-delete/site-id DELETE /api/api-version/sites/async-delete/site-name?key=name DELETE /api/api-version/sites/async-delete/content-url?key=contentUrl #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site to delete.
site-name	The name of the site to delete. If you specify a site name, you must also include the parameter `key=name`.
content-url	The permanent name of the site to sign in to. The content URL appears in the URL path of Tableau content in your browser address bar after the Tableau Server URL. `mySite` is the content URL in the following example: `http://<server or cloud URL>/#/site/mySite/explore`

#### Request Body None #### Permissions This method can only be called by server administrators. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:sites:delete ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code **Delete site** 204 **Delete site asynchronously** (beginning in API 3.18) 201 #### Response Body **Delete site** None **Delete site asynchronously** (beginning in API 3.18) ``` ``` The `` element returns the following attributes: - job-id is a unique identifier for the job. You can use the value of this attribute to check the status of the delete job by passing it to the [Query Job](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_ref_jobs_tasks_and_schedules.htm#query_job) method. - mode has the value of `Asynchronous`. - type has the value of `SiteDelete`. - progress is set to `0` when the asynchronous delete job is created, and then changes to `100` when the job is complete. This value indicates percentage of job progress. - createdAt provides a complete date and time that indicates when asynchronous delete was initiated. - finishCode is set to `1` when the asynchronous delete job is created, and then changes to `0` when the job is complete. #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
403	403002	Deletion not allowed.	An attempt was made to delete the default Tableau Server site.
404	404000	Site not found	The specified site doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not DELETE.

For more information, see [Handling Errors](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### cURL Request Example **Delete site** `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d5-e4f3-a2b1-c0d9-e8f7a6b5c4d" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` `curl "http://MY-SERVER/api/3.29/sites/marketing-site?key=contentUrl" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` The response contains no body (data) for a successful delete operation. The HTTP response code is 204 if the delete operation succeeded. **Delete site asynchronously** (beginning in API 3.18) `curl "http://MY-SERVER/api/3.29/sites/async-delete/9a8b7c6d5-e4f3-a2b1-c0d9-e8f7a6b5c4d" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` `curl "http://MY-SERVER/api/3.29/sites/async-delete/marketing-site?key=contentUrl" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` `curl "http://MY-SERVER/api/3.29/sites/async-delete/marketing-site-name?key=name" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` The responses above will return the job ID for a successful delete operation. You can use the value to check the status of the delete job by passing it to the [Query Job](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_ref_jobs_tasks_and_schedules.htm#query_job) method. ## Get Data Acceleration Report for a Site Returns a report about data acceleration for the site. It lets you compare page load times for before and after data acceleration is enabled. This method is not available for Tableau Cloud. **Important changes for Tableau View Acceleration and Data Acceleration** Tableau's View Acceleration feature and Data Acceleration APIs are retired. These features were retired in Tableau Cloud in June 2026 and in Tableau Server version 2026.2. #### URI GET /api/api-version/sites/site-id/dataAccelerationReport #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the task.

#### Request Body None #### Permissions This method can only be called by server administrators and site administrators. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:data_acceleration_reports:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` #### Attribute Values

sheetURI	The URI of the sheet in the workbook.
unacceleratedSessionCount	The number of sessions that were created to load the workbook sheet before it was accelerated. For example, if you loaded it 7 times in a row, the session is reused so the count will still be 1. Generally, the more data you compare, the better the comparison is. Note: If sheets were loaded but never accelerated, they are not shown.
averageUnAcceleratedPLT	The average page load time for the sheet before it was accelerated.
acceleratedSessionCount	The number of sessions that were created to load the workbook sheet after it was accelerated.
averageAcceleratedPLT	The average page load time for the sheet after it was accelerated.

#### Version In Tableau Server 2020.2 (API 3.8) through 2021.4 (API 3.15) data acceleration is supported. **Important changes for Tableau View Acceleration and Data Acceleration** Tableau's View Acceleration feature and Data Acceleration APIs are retired. These features were retired in Tableau Cloud in June 2026 and in Tableau Server version 2026.2. For more information, see [REST API and Resource Versions](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	40500	Invalid requests method	Request type was not GET

For more information, see [Handling Errors](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/dataAccelerationReport" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"` **Example response:** ``` ... ``` ## Get Embedding Settings for a Site Returns the current embedding settings for a specific site. Embedding settings can be used to restrict embedding Tableau views to only certain domains. This setting impacts all embedding scenarios including, Tableau Javascript API v2, Embedding API v3, and the embed code from the share dialog. For more information, see the [Tableau Site Settings for Embedding](https://help.tableau.com/current/api/embedding_api/en-us/docs/embedding_api_site.html) topic in the Tableau Embedding v3 Help. Beginning in version 2023.2 (June 2023) for Tableau Cloud and in version 2023.3 for Tableau Server, this setting might impact embedding scenarios that use Tableau connected apps. For more information, see the “[Control where content can be embedded](https://help.tableau.com/current/online/en-us/connected_apps_eas.htm#allowlist)” section in the connected apps topic in the Tableau Cloud Help. #### URI GET /api/api-version/sites/site-id/settings/embedding #### Path Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the views.

#### Request Body None #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:embedding_site_settings:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Permissions Any Tableau Cloud or Tableau Server user can call this method. #### Response Body ```

``` ##### Example Response ``` ``` #### Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/settings/embedding" -X GET -H "X-Tableau-Auth:1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d"` #### Version API version 3.16 and later. #### Errors

HTTP status	`error` Code	Condition	Details
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Get Recently Viewed for Site Gets the details of the views and workbooks on a site that have been most recently created, updated, or accessed by the signed in user. The 24 most recently viewed items are returned, though it may take some minutes after being viewed for an item to appear in the results. #### URI GET /api/api-version/sites/site-id/content/recent #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the views and workbooks.

#### Request Body None #### Permissions Users who are not server administrators or site administrators, the method returns only the views and workbooks that the user owns or has **Read** permissions for (either explicitly or implicitly). #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:content:read ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` The value of view-url-name is the name of the view in its URL. For example, if a view named `View 1` shows the URL `https://MY_SERVER/#/site/MY_SITE/views/VIEW_1` in your browser address bar, then the the view-url-name would be `VIEW_1`. Modifying the name (display name) of a view will not impact the view-url-name (path element of the view's URL). #### Version Version 3.5 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl -X GET "https://qa-windows/api/3.5/sites/cd24a433-b66c-46cd-a4af-6cde73db9ee1/content/recent" -H "X-Tableau-Auth: pI8NzKb-S5-Jqiatds8jrQ|GKUYlgHjuHSPSVfS38plFpH31UkHGtNl"` **Example response:** ``` ``` The response for users without administrative permissions contains only the site id, name, and content-url attributes. #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400006	Invalid page number	The page number parameter is not an integer, is less than one, or is greater than the final page number for the sites at the requested page size.
400	400007	Invalid page size	The page size parameter is not an integer, or is less than one.
403	403014	Page size limit exceeded	The specified page size is larger than the maximum page size.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example ``` curl "http://MY-SERVER/api/3.29/sites?pageSize=1&pageNumber=1" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" ``` **Example response:** ``` ``` ## Query Views for Site Returns all the views for the specified site, optionally including usage statistics. **Note**: After you create a resource, the server updates its search index. If you make a query immediately to see a new resource, the query results might not be up to date. **Version**: Available in API 2.2 and later. **License**: No additional license required. **Permissions**: For users who are not server administrators or site administrators, the method returns only the views that the user owns or has Read permissions for (either explicitly or implicitly). **Access Scope**: `tableau:content:read` - For more information, see [Versions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm), [Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm), [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud), and access scopes for [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows,](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### URI GET /api/api-version/sites/site-id/views GET /api/api-version/sites/site-id/views?includeUsageStatistics=get-usage-information GET /api/api-version/sites/site-id/views?pageSize=page-size&pageNumber=page-number GET /api/api-version/sites/site-id/views?includeUsageStatistics=get-usage-information&pageSize=page-size&pageNumber=page-number GET /api/api-version/sites/site-id/views?filter=filter-expression GET /api/api-version/sites/site-id/views?sort=sort-expression GET /api/api-version/sites/site-id/views?fields=field-expression #### Parameter Values

api-version	The version of the API to use, such as `2.2`. For more information, see REST API and Resource Versions.
site-id	The ID of the site that contains the views.
get-usage-information	(Optional) true to return usage statistics. The default is false.
page-size	(Optional) The number of items to return in one response. The minimum is 1. The maximum is 1000. The default is 100. For more information, see Paginating Results.
page-number	(Optional) The offset for paging. The default is 1. For more information, see Paginating Results.
filter-expression	(Optional) Fields and operators that you can use to filter results. For more information, see Filter expressions.
sort-expression	(Optional) Field and direction to sort results. For more information, see Sorting.
field-expression	(Optional) An expression that lets you specify the set of available fields to return. You can qualify the return values based upon predefined keywords such as `_all_` or `_default_`, and you can specify individual fields for the workbooks or other supported resources. You can include multiple field expressions in a request. For more information, see Using Fields in the REST API.

**Note**: The filter and sort parameters can be combined with each other and with paging parameters and fields parameters using an ampersand (**`&`**). #### Request Body None #### cURL Request `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/views" -X GET -H "X-Tableau-Auth:1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d"` #### Response Code 200 #### Response Body ``` ``` ``` { "pagination": { "pageNumber": "1", "pageSize": "100", "totalAvailable": "2" }, "views": [ { "id": "1f1e1d1c-2b2a-2f2e-3d3c-3b3a4f4e4d4c", "name": "Economic Indicators", "contentUrl": "Finance/sheets/EconomicIndicators", "workbook": { "id": "1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d" }, "owner": { "id": "9f9e9d9c-8b8a-8f8e-7d7c-7b7a6f6d6e6d" } }, { "id": "9a8a7b6b-5c4c-3d2d-1e0e-9a8a7b6b5b4b", "name": "Investing in the Dow", "contentUrl": "Finance/sheets/InvestingintheDow", "workbook": { "id": "59a8a7b6-be3a-4d2d-1e9e-08a7b6b5b4ba" }, "owner": { "id": "9f8e7d6c5-b4a3-f2e1-d0c9-b8a7f6e5d4c" } } ] } ``` The element is included in the response only if the method has `includeUsageStatistics=true` in the URI. #### Errors

HTTP status	`error` Code	Condition	Details
400	400006	Invalid page number	The page number parameter is not an integer, is less than one, or is greater than the final page number for data sources at the requested page size.
400	400007	Invalid page size	The page size parameter is not an integer, or is less than one.
400	400008	Invalid parameter value	The includeUsageStatistics was provided with a value other than true or false.
403	403004	Read forbidden	A non-administrator user attempted to query workbook views, but the caller doesn't have Read permission.
403	403014	Page size limit exceeded	The specified page size is larger than the maximum page size.
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type was not GET.

For more information, see [Handling Errors](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Embedding Settings for Site Updates the embedding settings for a site. Embedding settings can be used to restrict embedding Tableau views to only certain domains. This setting impacts all embedding scenarios including Tableau Javascript API v2, Embedding API v3, and the embed code from the share dialog. For more information, see [Tableau Site Settings for Embedding](https://help.tableau.com/current/api/embedding_api/en-us/docs/embedding_api_site.html) in the Tableau Embedding API v3 Help. Beginning in version 2023.2 (June 2023) for Tableau Cloud and in version 2023.3 for Tableau Server, this setting might impact embedding scenarios that use Tableau connected apps. For more information, see the "Control where content can be embedded" section in the connected apps topics in the [Tableau Cloud Help](https://help.tableau.com/current/online/en-us/connected_apps_eas.htm#allowlist) or [Tableau Server Help](https://help.tableau.com/current/server/en-us/connected_apps_eas.htm#allowlist). #### URI PUT /api/api-version/sites/site-id/settings/embedding #### Path Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site to update.

#### Request Body ``` ``` **Example request:** ``` ``` #### Request Attribute Values

unrestricted-embedding

(Optional) Specifies whether or not embedding is restricted.

When the setting is set to true, Tableau views on this site can be embedded in any domain.

When set to false, embedding is blocked for all domains, but you can allow embedding in certain domains using the allowList attribute.

allow-list

(Optional) Specifies the domains where Tableau views on this site can be embedded. Use this setting with unrestrictedEmbedding setting to restrict embedding functionality to only certain domains.

Important: We recommend using the domain allowlist as a security best practice to ensure Tableau content is only embedded in locations that you allow.

You can use wildcards in domain names and you can also list multiple domain names separated by spaces.

#### Permissions Any Tableau Cloud or Tableau Server user can call this method. #### Access Scope Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3). ``` tableau:embedding_site_settings:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` #### Version Version 3.16 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400000	Bad Request	The content of the request body is missing or incomplete, or contains malformed XML.
403	403500	The user does not have permission	Tableau Cloud: Only site administrators can run this method.

#### Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d5-e4f3-a2b1-c0d9-e8f7a6b5c4d/settings/embedding" -X PUT -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @update-sembedding-settings.xml` **Content of update-embedding-settings.xml:** ``` ``` For more information, see [Handling Errors](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). ## Update Site Modifies settings for the specified site, including the content URL, administration mode, user quota, state (active or suspended), storage quota, whether flows are enabled, whether subscriptions are enabled, and whether revisions are enabled. **Note:** You must be signed in to a site to update it. #### URI PUT /api/api-version/sites/site-id #### Parameter Values

api-version	The version of the API to use, such as `3.29`. For more information, see REST API and Resource Versions.
site-id	The ID of the site to update.

#### Request Body **Updating individual settings** ``` ``` **Updating the site logo** To set a new site logo, you pass a multi-part payload to the site. In addition to setting the `X-Tableau-Auth` header to the sign-in token, you must set the `Content-Type` header to `multipart/mixed` and include a boundary string. For example, the header might look like the following example: `Content-Type: multipart/mixed; boundary=az1by2cx34dw` The request body starts with the string you specify as the boundary. This is followed by two headers. You set `Content-Disposition` header to `form-data`, and then a `name` value set to `site_logo` and a `filename` value. You must also include a `Content-Type` header set to `application/octet-stream`. After the headers, you include a blank line then the binary data (not encoded). The binary data is followed by a line that includes the boundary string and the two required termination hyphens (`--`). The following example shows the request body using the boundary string that was specified in the example header earlier. \--az1by2cx34dw Content-Disposition: form-data; name="site\_logo"; filename="new-site-logo.png" Content-Type: application/octet-stream --az1by2cx34dw-- **Restoring the default site logo** To restore the default site logo, you pass a multi-part payload to the site, as you do to set the logo. However, instead of passing binary data for the image, you pass an empty image. And instead of setting the `Content-Type` header in the body to `application/octet-stream`, you set the content type to `text/plain`. The following example shows the request body using the boundary string that was specified in the example header earlier. \--az1by2cx34dw Content-Disposition: form-data; name="site\_logo"; filename="empty.txt" Content-Type: text/plain --az1by2cx34dw-- #### Attribute Values

new-site-name	(Optional) The new name of the site.
new-content-url	(Optional) The new site URL. This value can contain only characters that are valid in a URL. These characters include letters (A-Z, a-z), digits (0-9), hyphens ("-"), and underscores ("_") If you provide invalid characters, those characters are stripped from the URL and the site is created anyway. For example, if you try to set the site URL as `test.site`, it's converted to `testsite` and returned in the response. The response's site URL namespace is the authoritative source of truth for the new site URL.
new-admin-mode	(Optional) Specify ContentAndUsers to allow site administrators to use the server interface and `tabcmd` commands to add and remove users. (Specifying this option doesn't give site administrators permissions to manage users using the REST API.) Specify ContentOnly to prevent site administrators from adding or removing users. (Server administrators can always add or remove users.) Note: You cannot set adminMode to ContentOnly and also set a userQuota value. The default value is ContentAndUsers.
new-state	(Optional) Active to set the site to active mode, or Suspended to suspend the site. Default is Active.
new-storage-quota	(Optional) The new maximum amount of space for the new site, in megabytes. If you set a quota and the site exceeds it, publishers will be prevented from uploading new content until the site is under the limit again.
new-disable-subscriptions	(Optional) true to prevent users from being able to subscribe to workbooks on the specified site. Default is false.
revision-history-enabled	(Optional) true if the site maintains revisions for changes to workbooks and data sources; otherwise, false. The default is false.
revision-limit	(Optional) An integer between 2 and 10000 to indicate a limited number of revisions for content. Setting this value to -1 removes any value that was set previously, and effectively removes any limit to the number of revisions that are maintained.
allow-subscription-attachments-flag	(Optional) If true, and subscription to attachments is enabled on the server, then users can create subscriptions that send an email with images of a workbook or view in a PDF attachment. The default value is true. If subscription to attachments is disabled in the server settings, then making this value true will have no effect. Default is true.
subscribe-others-enabled-flag	(Optional) Specify true to enable and false to disable the ability for view owners to subscribe other users to a view. Default is true.
editing-flows-enabled-flag	(Optional) Specify true to enable and false to disable editing flows for a site. For more information on flows, see Enable and Configure Tableau Prep Conductor. The default is set to true, which means editing flows is enabled by default. For more information, see Implication of disabling Tableau Prep Conductor.
scheduling-flows-enabled-flag	(Optional) Specify true to enable and false to disable scheduling flows for a site. For more information on flows, see Enable and Configure Tableau Prep Conductor. The default is set to true, which means scheduling flows is enabled by default. For more information, see Implication of disabling Tableau Prep Conductor.
flows-enabled-flag	The flowsEnabled attribute is deprecated as of API 3.10.
guest-access-enabled-flag	(Optional) Specify true to enable and false to disable the ability for guests, users without specific site access permission, to access the site. Default is false.
cache-warmup-enabled-flag	This attribute was removed in API 3.19 and later. For current methods to improve Tableau performance see, View Acceleration. (Optional) Set this value to true to enable cache warm up to improve workbook load times. Set the value to false to disable cache warmup. Default is true.
commenting-enabled-flag	(Optional) Specify true to enable and false to disable the ability for user comments on views in the site. Default is true.
extractEncryptionMode	(Optional) Specify enforced, enabled, or disabled. Default is disabled. For more information, see Extract and Encryption Methods.
dataAccelerationMode	(Optional) Specify enable_selective or disabled. The default is enable_selective, which lets you update particular workbooks to turn on data acceleration using the accelerationEnabled attribute. For more information, see Data Acceleration (Retired). Tableau's View Acceleration feature and Data Acceleration-related APIs were retired in Tableau Cloud in June 2026 and in Tableau Server version 2026.2.
requestAccessEnabled	(Optional) Specify true to allow users send access request emails to content or project owners. Specify false if you don't want users to be able to request access. The default is false.
runNowEnabled	(Optional) Specify true to allow users to run flows, extract refreshes, and schedules manually. Specify false if you don't want users to be able to run flows, extract refreshes, and subscriptions manually. The default is true. If this attribute is set to false, the following methods will fail and will return an error message. Run Flow Now Run Flow Task Update Data Source Now Run Extract Refresh Task
Licensing attributes For user-based license types, the maximum number of users is set by the licenses activated on that server. For core-based licensing, there's no limit to the number of users; if you specify a maximum value, only licensed users are counted, and server administrators are excluded. The REST API enables administrators to set licensing limits below the purchased maximum with two types of license-related attributes: - User Quota - The total maximum number of licenses currently configured for a site. - Tiered Capacities - If set, the configured maximum license count for each license type (role). . An on-premises server administrator can both get and set them but if license maximums are set using one attribute kind then the value(s) of the other kind must be null. Setting values for both kinds of attributes will result in an error. For more information, see Licensing Overview.
User quota all-license-limit-total	(Optional) The maximum total number of users with Creator, Explorer, or Viewer licenses currently allowed on a site. On-premises server administrators can set `userQuota` with the following rules: The number can't exceed the number of licenses activated for the site; and if tiered capacity attributes are set, then `userQuota` will equal the sum of the tiered capacity values, and attempting to set `userQuota` will cause an error. An administrator can revert the license limit to number of activated licenses on the site, or shift control of license limits to tiered capacities values, by omitting `userQuota` from a Create Site or Update Site request, or making its value -1.
Tiered capacity attributes creator-license-limit explorer-license-limit viewer-license-limit	(Optional) The maximum number of licenses for users with the Creator, Explorer, or Viewer role, respectively, allowed on a site. On-premises server administrators can set tiered capacity attributes with the following rules: the number can't exceed the number of licenses of a given type that are activated for the site; a value must be supplied for every tiered capacity license type every time any one or more of them is set. A value of -1 removes the administrator-applied limit for a license type, and reverts the limit to the number of activated licenses configured for the role. Setting the value of a tiered capacity to -1 will not automatically increase the limit if more licenses are purchased and activated for the role in the future. To use role-specific license limits, the `userQuota` must be set to null by omitting the attribute from Create Site or Update Site request, or setting its value to -1. Attempting to set values for both tiered capacities and `userQuota` will result in an error.
data-alerts-enabled-flag	(Optional, boolean) If `true`, data alerts are enabled on the site. Default value is `true`.
commenting-mentions-enabled-flag	(Optional, boolean) If `true`, mentions for commenting are enabled. Default value is `true`.
catalog-obfuscation-enabled-flag	(Optional, boolean) If `true`, catalog obfuscation is enabled on the site. Default value is `true`.
flow-auto-save-enabled-flag	(Optional, boolean) If `true`, flow auto save is enabled on the site. Default value is `true`.
run-now-enabled-flag	(Optional, boolean) If `true`, run now for schedules is enabled which allows non-administrators to run schedules manually. Default value is `true`.
metrics-content-type-enabled-flag	(Optional, boolean) If `true`, the metrics content type is enabled on the server. Default value is `false`.
notify-site-admins-on-throttle-flag	(Optional, boolean) If `true`, site admins will be notified if their background jobs are being throttled. Default value is `false`.
authoring-enabled-flag	(Optional, boolean) If `true`, web authoring is enabled. Default value is `false`.
custom-subscription-email-enabled-flag	(Optional, boolean) If `true`, sending custom subscription email is enabled. If set to false after being set true, the current custom subscription email is voided. Default value is `false`.
custom-subscription-email	A valid custom email that will be sent if customSubscriptionEmailEnabled is set to true. Default value is `false`.
custom-subscription-footer-enabled-flag	(Optional, boolean) If `true`, a custom footer will be included on subscription and data alert emails. If set to false after being set true, the current custom subscription footer is voided. Default value is `false`.
custom-subscription-footer	A custom subscription footer that will be added to subscription and data alerts if customSubscriptionFooterEnabled is set to true. Default value is `false`.
ask-data-mode	The mode of the ask data feature on the site. Can be set to one of two values: `DisabledByDefault` - Enables creation of Ask Data lenses for all published data sources. Data sources do not have lenses created automatically. `DisabledAlways` - Disables Ask Data lenses and related content throughout the site. Preserves information about lenses and data source indexes, which are restored if Ask Data is re-enabled. Default value is `DisabledByDefault`. For more information, see Disable or Enable Ask Data for a Site.
named-sharing-enabled-flag	(Optional, boolean) If `true`, named sharing is enabled. Default value is `true`.
cataloging-enabled-flag	(Optional, boolean) If `true`, data catalog is enabled for the site. Default value is `true`.
derived-permissions-enabled-flag	(Optional, boolean) If `true`, derived permissions are enabled for the site. Default value is `false`.
user-visibility-mode	(Optional, string) When the value is `FULL` users can see the user of other site users. If the value is `LIMITED` User information on the site is not visible to other users. Default value is FULL. For more information, see User Visibility.
use-default-time-zone	(Optional, boolean) Set this to `true`, if you want the time-zone attribute use the Server time Zone at run time. This attribute is set to official IANA name. If this is set to `false`, the time-zone value must be specified.
time-zone	(Optional, string) Use this attribute to specify a time zone other than the Server time zone at run time. Only canonical names in the official IANA database are supported. You can find the list of the canonical time zone names on Wikipedia.
autoSuspendRefreshEnabled	(Optional) Tableau can automatically suspend extract refresh tasks for inactive workbooks to save resources. Specify true to enable or false to disable. Default is true.
autoSuspendRefreshInactivityWindow	(Optional) An integer between 7 and 100 to indicate the number of days to wait before automatically suspending extract refresh tasks for inactive workbooks. The default is 30.
explainDataEnabled	(Optional, boolean) Set this attribute to `false` to disable Explain Data capabilities for a site. By default, this attribute is set to `true`. For more information about this site setting, see Disable or Enable Explain Data for a Site in the Tableau Server Help.
dqwSubscriptionsEnabled	(Optional, boolean) Set this attribute to `false` to exclude data quality warnings (DQWs) from subscription emails. By default, this attribute is set to `true`. For more information about this site setting, see Disable or Enable Explain Data for a Site in the Tableau Server Help.
attribute-capture-enabled	(Optional, boolean) Set this attribute to `true` to enable user attribute functions used in embedded content to accept the passing of user attributes from a JSON Web Token (JWT) via Tableau connected apps. The user attributes are passed to Tableau at runtime to control and customize the data that can show for an authorized user. By default, this attribute is set to `false`. For more information, see Tableau Embedding API v3 Help. This attribute is available starting from API version 3.25. Starting in October 2025 (API version 3.27), you can also use this attribute to pass user information about your identity provider to Tableau Cloud. During single sign-on (SSO), user attribute functions in Tableau content can accept attributes from OIDC claims or SAML assertions. For more information, see OIDC or SAML topics in the Tableau Cloud Help.
groupAssertionsEnabled	(Optional) Set to `true` to allow assertions into group membership using session info. Set to `false` if you don't want users to be able to be asserted in to groups. The default is `false`. If this attribute is set to false, it will disable group assertions for the entire site, including the following settings: groupAssertionsSAMLEnabled groupAssertionsOIDCEnabled groupAssertionsConnectedAppsEnabled
groupAssertionsSAMLEnabled	(Optional, boolean) Set to `true` to allow assertions into group membership using SAML session info. Set to `false` if you don't want users to be able to be asserted in to groups. The default is `false`. If this attribute is set to false, it will disable group assertions for SAML sessions.
groupAssertionsOIDCEnabled	(Optional, boolean) Set to `true` to allow assertions into group membership using OIDC session info. Set to `false` if you don't want users to be able to be asserted in to groups. The default is `false`. If this attribute is set to false, it will disable group assertions for OIDC sessions.
groupAssertionsConnectedAppsEnabled	(Optional, boolean) Set to `true` to allow assertions into group membership using Connected App JWT tokens. Set to `false` if you don't want users to be able to be asserted into groups via connected apps. The default is `false`. If this attribute is set to false, it will disable group assertions for JWT connected app connections.
groupSetsEnabled	(Optional, boolean) Set to `true` to allow groups sets. Set to `false` if you don't want group sets support for the site. The default is `false`. If this attribute is set to false, it will disable group sets for the site.
recycleBinEnabled	(Optional, boolean) Set to `true` to enable the Recycle Bin. Set to `false` to disable it. The default is `true`.

Any combination of the attributes inside the element is valid. Only the attributes that are included are updated for the site. If no attributes are present, no update occurs. To update only the logo, include an empty element (``) and the logo in the multipart message. Starting in API version 2.3, you can call Update Site to upload a custom logo image for the site. (For information about custom logos, see [Custom the Name or Logo](https://help.tableau.com/current/server/en-us/help.htm#customize_namelogo.htm) in the Tableau Server Help.) To upload a logo image, you include the image in a multipart message; this is similar to how you publish a workbook or data source. You must include the following headers in the request: - `MIME-Version: 1.0` - `Content-Type: multipart/mixed; boundary=boundary-string` - `X-Tableau-auth: authentication-token` The following example shows the request body for an Update Site request that updates the site with a new logo. For this example, the boundary string has been set in the header to `6691a87289ac461bab2c945741f136e6`. The `` element can be empty if you're calling Update Site only to update the logo image. ``` --6691a87289ac461bab2c945741f136e6 Content-Disposition: name="request_payload" Content-Type: text/xml --6691a87289ac461bab2c945741f136e6 Content-Disposition: name="site_logo"; filename="MySiteLogo.png" Content-Type: application/octet-stream logo stream here --6691a87289ac461bab2c945741f136e6-- ``` To clear a custom logo image and revert to using the default logo for the site, call Update Site with a multipart message, but leave the portion of the request body blank where you would normally include the logo stream. For more information about creating multipart messages, see [Publishing Resources](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_concepts_publish.htm). #### Permissions Tableau Server: This method can only be called by server administrators. #### Required scope for JWT authorization Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17). ``` tableau:sites:update ``` For more information, see [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) (Cloud) and access scopes for connected apps: [Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm), [Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm), or [Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm). #### Response Code 200 #### Response Body ``` ``` Response Body Details: - userQuota, storageQuota, and tiered capacity (tierCreatorCapacity, tierExplorerCapacity, tierViewerCapacity) attributes are only present in the response body if those quotas have been set for the site being queried. #### Version Version 1.0 and later. For more information, see [REST API and Resource Versions](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). #### Errors

HTTP status	`error` Code	Condition	Details
400	400008	Invalid revision history limit	The value for the revision history limit isn't an integer.
400	400000	Bad request	The content of the request body is missing or incomplete, or contains malformed XML.
400	400004	Invalid administrator mode	An administrator mode parameter was provided in the request with an invalid value. The valid values are ContentOnly and ContentAndUsers.
400	400004	Invalid state	A state parameter was provided in the request with an invalid value
404	404000	Site not found	The site ID in the URI doesn't correspond to an existing site.
405	405000	Invalid request method	Request type wasn't PUT.
409	409001	Site name conflict	The new site name in the request already belongs to an existing site.
409	409002	Site URL conflict	The new content URL in the request already belongs to an existing site.
409	409004	User quota and tiered capacity conflict	The request can't set both tiered capacity attributes and userQuota. One or the other must be null.
409	409004	License limit exceeded	The request can't set tiered capacity attributes or userQuota values that are larger than the number of active licenses configured for the site.
409	409004	Administrator mode or user quota conflict	The request can't set adminMode to ContentOnly and also specify a userQuota value.

For more information, see [Handling Errors](https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_concepts_errors.htm). #### Example `curl "http://MY-SERVER/api/3.29/sites/9a8b7c6d5-e4f3-a2b1-c0d9-e8f7a6b5c4d" -X PUT -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @update-site.xml` **Content of update-site.xml:** ``` ``` **Example response:** ``` ```