Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_site.htm below:

Site Methods - Tableau

Creates a site on Tableau Server. To make changes to an existing site, call Update Site. This method isn’t available for Tableau Cloud.

For more information, see Work with Sites(Link opens in a new window) and Add or Edit Sites(Link opens in a new window) 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.

POST /api/api-version/sites

<tsRequest>
  <site
	name="site-name"
	contentUrl="content-url"
	adminMode="admin-mode"
	storageQuota="limit-in-megabytes"
	disableSubscriptions="disable-subscriptions"
    editingFlowsEnabled="editing-flows-enabled-flag"
    schedulingFlowsEnabled="scheduling-flows-enabled-flag"
	allowSubscriptionAttachments="allow-subcription-attachments-flag"
	guestAccessEnabled="guest-access-enabled-flag"
	cacheWarmupEnabled="cache-warmup-enabled-flag [REMOVED IN API 3.19]"
	commentingEnabled="commenting-enabled-flag"
	revisionHistoryEnabled="enable-revision-history-flag"
	revisionLimit="num-revision-limit"
	subscribeOthersEnabled="subscribe-others-enabled-flag"
	extractEncryptionMode="extractEncryptionMode"
	requestAccessEnabled="request-access-enabled-flag"
	runNowEnabled="run-now-enabled-flag"
	userQuota="all-license-limit-total"
	tierCreatorCapacity="creator-license-limit"
	tierExplorerCapacity="explorer-license-limit"
	tierViewerCapacity="viewer-license-limit"
	dataAlertsEnabled="data-alerts-enabled-flag"
	commentingMentionsEnabled="commenting-mentions-enabled-flag"
	catalogObfuscationEnabled="catalog-obfuscation-enabled-flag"
	flowAutoSaveEnabled="flow-auto-save-enabled-flag"
	runNowEnabled="run-now-enabled-flag"
	metricsContentTypeEnabled="metrics-content-type-enabled-flag"
	notifySiteAdminsOnThrottle="notify-site-admins-on-throttle-flag"
	authoringEnabled="authoring-enabled-flag"
	customSubscriptionEmailEnabled="custom-subscription-email-enabled-flag"
	customSubscriptionEmail="custom-subscription-email"
	customSubscriptionFooterEnabled="custom-subscription-footer-enabled-flag"
	customSubscriptionFooter="custom-subscription-footer"
	askDataMode="ask-data-mode"
	namedSharingEnabled="named-sharing-enabled-flag"
	catalogingEnabled="cataloging-enabled-flag"
	derivedPermissionsEnabled="derived-permissions-enabled-flag"
	userVisibilityMode="user-visibility-mode"
	useDefaultTimeZone="default-time-zone-flag"
 	timeZone="time-zone"
	autoSuspendRefreshEnabled="auto-suspend-refresh-enabled-flag"
	autoSuspendRefreshInactivityWindow="auto-suspend-refresh-inactivity-window"
	explainDataEnabled="explainDataEnabled"
	dqwSubscriptionsEnabled="dqw-subscriptions-enabled"
	groupAssertionsEnabled="group-assertions-enabled-flag"
	groupAssertionsSAMLEnabled="group-assertions-saml-enabled-flag"
	groupAssertionsOIDCEnabled="group-assertions-oidc-enabled-flag"
	groupAssertionsConnectedAppsEnabled="group-assertions-connected-apps-enabled-flag"
	groupSetsEnabled="group-sets-enabled-flag" />
</tsRequest>
        

(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.

(Optional) Specify true to prevent users from being able to subscribe to workbooks on the specified site. The default is false.

(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(Link opens in a new window).

The default is set to true, which means editing flows is enabled by default. For more information, see Implication of disabling Tableau Prep Conductor.

(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(Link opens in a new window).

The default is set to true which means scheduling flows is enabled by default. For more information, see Implication of disabling Tableau Prep Conductor.

The flowsEnabled attribute is deprecated as of API version 3.10.

(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.

(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.

This attribute is removed in API 3.19 and later (Tableau Cloud September 2021). For current methods to improve Tableau performance see, View Acceleration(Link opens in a new window).

(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.

(Optional) Specify true to enable and false to disable the ability for user comments on views in the site. Default is true.

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.

(Optional) Specify true to enable and false to disable the ability for view owners to subscribe other users to a view. Default is true.

(Optional) Specify enforced, enabled, or disabled. Default is disabled. For more information, see Extract and Encryption Methods.

(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(Link opens in a new window)

Update Data Source Now(Link opens in a new window)

Run Extract Refresh Task(Link opens in a new window)

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:

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(Link opens in a new window).

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

commenting-mentions-enabled-flag

catalog-obfuscation-enabled-flag

flow-auto-save-enabled-flag

run-now-enabled-flag

metrics-content-type-enabled-flag

notify-site-admins-on-throttle-flag

authoring-enabled-flag

custom-subscription-email-enabled-flag

custom-subscription-email

custom-subscription-footer-enabled-flag

custom-subscription-footer

ask-data-mode

• 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.

named-sharing-enabled-flag

cataloging-enabled-flag

derived-permissions-enabled-flag

user-visibility-mode

(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(Link opens in a new window).
• For Tableau Server, see Disable or Enable Explain Data for a Site(Link opens in a new window).

(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(Link opens in a new window).
• For Tableau Server, see Disable or Enable Explain Data for a Site(Link opens in a new window).

• groupAssertionsSAMLEnabled
• groupAssertionsOIDCEnabled
• groupAssertionsConnectedAppsEnabled

(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.

This method can only be called by server administrators.

Introduced in Tableau Server 2022.3 (API 3.17).

Authorize use of this method in your connected app by including this scope in its JSON Web Token (JWT). For more information, see Access Scopes for Connected Apps(Link opens in a new window) in the Tableau Server Help.

tableau:sites:create

201

<tsResponse>
  <site id="site-id"
 	name="site-name"
	contentUrl="content-url"
 	adminMode="admin-mode"
	disableSubscriptions="disable-subscriptions-flag"
	state="active-or-suspended"
	revisionHistoryEnabled="history-enabled-flag"
	revisionLimit="max-num-revisions"
	allowSubscriptionAttachments="allow-subcription-attachments-flag"
	subscribeOthersEnabled="enable-subscription-of-others-flag"
	guestAccessEnabled="guest-access-enabled-flag"
	cacheWarmupEnabled="cache-warmup-enabled-flag [REMOVED IN API 3.19]"
	commentingEnabled="commenting-enabled-flag"
    editingFlowsEnabled="editing-flows-enabled-flag"
    schedulingFlowsEnabled="scheduling-flows-enabled-flag"
	extractEncryptionMode="encryption-mode"
	catalogingEnabled="cataloging-enabled-flag"
	derivedPermissionsEnabled="derived-permissions-enabled-flag"
	requestAccessEnabled="request-access-enabled-flag"
	runNowEnabled="run-now-enabled-flag"
	userQuota="all-license-limit-total"
	tierCreatorCapacity="creator-license-limit"
	tierExplorerCapacity="explorer-license-limit"
	tierViewerCapacity="viewer-license-limit"
	askDataMode="ask-data-mode"
	useDefaultTimeZone="default-time-zone-flag"
	timeZone="time-zone"
	autoSuspendRefreshEnabled="auto-suspend-refresh-enabled-flag"
	autoSuspendRefreshInactivityWindow="auto-suspend-refresh-inactivity-window"
	explainDataEnabled="explain-data-enabled"
	dqwSubscriptionsEnabled="dqw-subscriptions-enabled"
	groupAssertionsEnabled="group-assertions-enabled-flag"
	groupAssertionsSAMLEnabled="group-assertions-saml-enabled-flag"
	groupAssertionsOIDCEnabled="group-assertions-oidc-enabled-flag"
	groupAssertionsConnectedAppsEnabled="group-assertions-connected-apps-enabled-flag"
	groupSetsEnabled="group-sets-enabled-flag" />
  </site>
</tsResponse>
        

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.

Location: /api/3.26/sites/new-site-id

Version 1.0 and later. For more information, see REST API and Resource Versions.

Note: An empty string or all whitespace is invalid.

For more information, see Handling Errors.

curl "http://MY-SERVER/api/3.26/sites/" -X POST -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @create-site.xml

Content of create-site.xml:

<tsRequest>
	<site name="Marketing-Site"
		contentUrl="marketingsite"
		adminMode="ContentAndUsers"
		tierCreatorCapacity="2"
		tierExplorerCapacity="1"
		tierViewerCapacity="1"
		useDefaultTimeZone="false"
		timeZone="America/Los_Angeles"/>
</tsRequest>
        

Response body:

<tsResponse>
	<site id="43e01bb6-d7f9-42ef-bc9f-0422c07520e5"
		name="Marketing-Site"
		contentUrl="marketingsite"
		adminMode="ContentAndUsers"
		disableSubscriptions="true"
		state="Active"
		revisionHistoryEnabled="true"
		revisionLimit="25"
		subscribeOthersEnabled="false"
		allowSubscriptionAttachments="true"
		guestAccessEnabled="true"
		cacheWarmupEnabled="true"  [REMOVED IN API 3.19]
		commentingEnabled="true"
        editingFlowsEnabled="false"
        schedulingFlowsEnabled="false"
		extractEncryptionMode="enabled"
		catalogingEnabled="true"
		derivedPermissionsEnabled="false"
		requestAccessEnabled="false"
		runNowEnabled="true"
		userQuota="4"
		tierCreatorCapacity="2"
		tierExplorerCapacity="1"
		tierViewerCapacity="1"
		useDefaultTimeZone="false"
		timeZone="America/Los_Angeles" />
</tsResponse>
        

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 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.

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

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

None

This method can only be called by server administrators.

Delete site

204

Delete site asynchronously (beginning in API 3.18)

201

Delete site

None

Delete site asynchronously (beginning in API 3.18)

<tsResponse>
   <job id="job-id"
     mode="mode"
     type="type"
	 progress="progress"
	 createdAt="createdAt"
	 finishCode="finishCode" />
</tsResponse>

The <job> 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(Link opens in a new window) 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 1.0 and later. For more information, see REST API and Resource Versions.

For more information, see Handling Errors.

Delete site

curl "http://MY-SERVER/api/3.26/sites/9a8b7c6d5-e4f3-a2b1-c0d9-e8f7a6b5c4d" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"

curl "http://MY-SERVER/api/3.26/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.26/sites/async-delete/9a8b7c6d5-e4f3-a2b1-c0d9-e8f7a6b5c4d" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"

curl "http://MY-SERVER/api/3.26/sites/async-delete/marketing-site?key=contentUrl" -X DELETE -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"

curl "http://MY-SERVER/api/3.26/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(Link opens in a new window) method.

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.

Starting in Tableau version 2022.1 (API v3.16), with the introduction of View Acceleration(Link opens in a new window), the data acceleration feature is deprecated. Requests for data acceleration endpoints and attributes will not return an error, but will also not cause any change on the server or return meaningful information about data acceleration of a workbook. We recommend removing any dependencies on data acceleration in your requests to REST API endpoints, as the feature may become unsupported in future releases resulting in error codes being returned.

GET /api/api-version/sites/site-id/dataAccelerationReport

None

This method can only be called by server administrators and site administrators.

200

<tsResponse>
  <dataAccelerationReport>
    <comparisonRecord site="Default" sheetURI="sheetURI" unacceleratedSessionCount="unacceleratedSessionCount" averageUnAcceleratedPLT="averageUnAcceleratedPLT" acceleratedSessionCount="acceleratedSessionCount" averageAcceleratedPLT="averageAcceleratedPLT" />
</tsResponse>
					
        

In Tableau Server 2020.2 (API 3.8) through 2021.4 (API 3.15) data acceleration is supported.

Starting in Tableau version 2022.1 (API v3.16), with the introduction of View Acceleration(Link opens in a new window), the data acceleration feature is deprecated. Requests for data acceleration endpoints and attributes will not return an error, but will also not cause any change on the server or return meaningful information about data acceleration of a workbook. We recommend removing any dependencies on data acceleration in your requests to REST API endpoints, as the feature may become unsupported in future releases resulting in error codes being returned.

For more information, see REST API and Resource Versions.

For more information, see Handling Errors.

curl "http://MY-SERVER/api/3.26/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/dataAccelerationReport" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"

Example response:

<tsResponse version-and-namespace-settings>
  <dataAccelerationReport>
    <comparisonRecord site="Default" sheetURI="Live/Sheet1" unacceleratedSessionCount="0" averageUnAcceleratedPLT="0.0" acceleratedSessionCount="1" averageAcceleratedPLT="0.166" />
  ...
  </dataAccelerationReport>
</tsResponse>
          

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 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(Link opens in a new window)” section in the connected apps topic in the Tableau Cloud Help.

GET /api/api-version/sites/site-id/settings/embedding

None

200

Any Tableau Cloud or Tableau Server user can call this method.

<tsResponse>
  <siteid="view-id"
        <settings unrestrictedEmbeddingname="true-or-false"
  </site>
</tsResponse>
        

<tsResponse>
      <settings unrestrictedEmbedding="false"/>
    </site>
</tsResponse>

curl "http://MY-SERVER/api/3.26/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/settings/embedding" -X GET -H "X-Tableau-Auth:1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d"

API version 3.16 and later.

For more information, see Handling Errors.

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.

GET /api/api-version/sites/site-id/content/recent

None

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).

Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17).

Authorize use of this method in your connected app by including this scope in its JSON Web Token (JWT). For more information, see Access Scopes for Connected Apps(Link opens in a new window) in the Tableau Cloud Help or Access Scopes for Connected Apps(Link opens in a new window) in the Tableau Server Help.

tableau:content:read

200

<tsResponse >
<recents>
  <recent>
	<view
	  id="view-id"
	  name="view-name"
	  contentUrl="view-content-url"
	  createdAt="created-at-time"
	  updatedAt="updated-at-time"
	  viewUrlName="view-url-name">
		<workbook id=""workbook-of-view" "/>
		<owner id="owner-id" />
		<project id="project-id" />
		<tags/>
	</view>
  </recent>
  <recent>
    <workbook
 	  id="workbook-id"
	  name="workbook-name"
	  description="workbook-description"
	  contentUrl="workbook-content-url"
	  webpageUrl="workbook-webpage-url"
	  showTabs="show-tags-flag"
	  size="size-in-mb"
	  createdAt="created-at-time"
	  updatedAt="updated-at-time"
	  encryptExtracts="encrypt-extracts-flag"
	  defaultViewId="default-view-id" >
        <project id="project-id"/>
        <owner id="ownwer-id"
		name="project-name" />
        <tags/>
	</workbook>
  </recent>
  <!--  more recently viewed views and workbooks  -->
</tsResponse>
        

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 3.5 and later. For more information, see REST API and Resource Versions.

For more information, see Handling Errors.

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:

<tsResponse >
  <recents>
    <recent>
      <view
	    id="8a922e79-3041-4916-942e-1a18162ef8a9"
	    name="MySQL PostgresSQL"
	    contentUrl="my_site1"
	    createdAt="2019-01-28T20:33:35Z"
	    updatedAt="2019-01-28T20:44:05Z"
		viewUrlName="MySQL_PostgresSQL">
		  <workbook id="1eb0d238-c9d2-49ec-a0ce-762ddc6f9827"/>
		  <owner id="2dbbee8a-202c-4a74-82d6-8e3544f55ceb"/>
		  <project id="50b87b02-74b6-11e8-a4b0-df15be81c0c4"/>
		  <tags/>
      </view>
    </recent>
    <recent>
	  <workbook
	    id="5589cf2b-8601-43f9-9151-0f6c2db760cc"
	    name="Connections-AmazonAurora (1)"
	    description=""
	    contentUrl="my_site2"
	    webpageUrl="https://my_server/#/workbooks/222"
	    showTabs="false"
	    size="7"
	    createdAt="2019-02-13T20:52:37Z"
	    updatedAt="2019-02-13T20:52:38Z"
	    encryptExtracts="false"
	    defaultViewId="d4bed763-1cb1-4924-b455-6a6c298d860d">
	      <project id="add6c395-11b8-4d57-a66b-733220a33aa0" name="project2"/>
	      <owner id="3f90c20d-069f-46dd-b5a0-6e7092140790" name="my_name"/>
	      <tags/>
	  </workbook>
    </recent>
    <!--  more recently viewed views and workbooks  --%gt;
  </recent>
</tsResponse>
            

Gets the details of the Personal Space for the currently authenticated user.

Personal Space must be enabled for the site in order to be returned by this method. For more information see, Create and Edit Private Content in Personal Space(Link opens in a new window)

GET /api/api-version/sites/site-id/personalSpace

none

curl "http://MY-SERVER/api/3.26/sites/7bfb590b-cfa7-4576-8bea-e9cc035/personalSpace -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"

200

<tsResponse>
  <personalSpace
    luid="b76c9984-c7a8-4ae4-826d-e08372ad7d61",
    ownerLuid="39e76bc4-737f-40c0-bca7-e635fe0e9fd9",
    readOnly="false" />
</tsResponse>

{
  "personalSpace": {
  "luid": "b76c9984-c7a8-4ae4-826d-e08372ad7d61",
  "ownerLuid": "39e76bc4-737f-40c0-bca7-e635fe0e9fd9",
  "readOnly": false
  }
}

readOnly is true only if Personal Space is disabled in site settings or the user's role for the site does not allow writing to a Personal Space.

For more information, see Handling Errors.

List all authentications configurations on the site.

For more information, see Authentication(Link opens in a new window) in the Tableau Cloud Help.

GET /api/api-version/sites/site-luid/site-auth-configurations

None

curl "https://us-west-2a.online.tableau.com/api/3.26/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/site-auth-configurations" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"

200

<tsResponse>
  <siteAuthConfigurations>
    <siteAuthConfiguration>
      authSetting="OIDC"
      enabled="true"
      idpConfigurationId="00000000-0000-0000-0000-000000000000"
      idpConfigurationName="Initial Salesforce"
      knownProviderAlias="Salesforce"
    </siteAuthConfiguration>
    <siteAuthConfiguration>
      authSetting="SAML"
      enabled="true"
      idpConfigurationId="11111111-1111-1111-1111-111111111111"
      idpConfigurationName="Initial SAML"
    </siteAuthConfiguration>
  </siteAuthConfigurations>
</tsResponse>

{
"siteAuthConfigurations": [ 
    {
       "authSetting":"OIDC",
       "enabled":"true", 
       "idPConfigurationId":"00000000-0000-0000-0000-000000000000",
       "idPConfigurationName":"Initial Salesforce",
       "knownProviderAlias":"Salesforce"
    },
    {
       "authSetting":"SAML",
       "enabled":"true", 
       "idPConfigurationId":"11111111-1111-1111-1111-111111111111",
       "idPConfigurationName":"Initial SAML"
    }
  ]
}

Notes:

• Use the idpConfigurationId to specify the authentication method for a user in Add User to Site and Update User methods.

• The knownProviderAlias is returned when the authentication type is either Google or Salesforce.

For more information, see Handling Errors.

Returns information about the specified site, with the option to return information about the storage space and user count for the site.

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.

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.

Note: You can only get site information for the site that you have signed in to.

GET /api/api-version/sites/site-id

GET /api/api-version/sites/site-name?key=name

GET /api/api-version/sites/content-url?key=contentUrl

GET /api/api-version/sites/site-id?includeUsage=include-usage-flag

To set the flag to include usage in the response, append includeUsage=true as a querystring element any valid query site URI.

None

This method can only be called by server administrators and site administrators.

200

<tsResponse>
  <site id="site-id"
	name="site-name"
	contentUrl="content-url"
	adminMode="admin-mode"
	disableSubscriptions="new-disable-subscriptions"
	state="active-or-suspended
	revisionHistoryEnabled="revision-history-enabled-flag"
	revisionLimit="revision-limit"
	subscribeOthersEnabled="subscribe-others-enabled-flag"
	allowSubscriptionAttachments="allow-subcription-attachments-flag"
	userQuota="num-users"
	guestAccessEnabled="guest-access-enabled-flag"
	cacheWarmupEnabled="cache-warmup-enabled-flag [REMOVED IN API 3.19]"
	commentingEnabled="commenting-enabled-flag"
	storageQuota="limit-in-megabytes"
    editingFlowsEnabled="editing-flows-enabled-flag"
    schedulingFlowsEnabled="scheduling-flows-enabled-flag"
	extractEncryptionMode="encryption-mode"
	catalogingEnabled="cataloging-enabled-flag"
	derivedPermissionsEnabled="derived-permissions-enabled-flag"
	requestAccessEnabled="request-access-enabled-flag"
	runNowEnabled="run-now-enabled-flag"
	usage numUsers="number-of-users"
	storage="storage-in-megabytes"
	userQuota="all-license-limit-total"
	tierCreatorCapacity="creator-license-limit"
	tierExplorerCapacity="explorer-license-limit"
	tierViewerCapacity="viewer-license-limit"
	isDataAlertsEnabled="data-alerts-enabled-flag"
    askDataMode="ask-data-mode"
	useDefaultTimeZone="default-time-zone-flag"
	timeZone="time-zone"
    autoSuspendRefreshEnabled="auto-suspend-refresh-enabled-flag"
    autoSuspendRefreshInactivityWindow="auto-suspend-refresh-inactivity-window"
	explainDataEnabled="explain-data-enabled"
	dqwSubscriptionsEnabled="dqw-subscriptions-enabled"
	attributeCaptureEnabled="attribute-capture-enabled"/>
  </site>
</tsResponse>
        

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.
• attributeCaptureEnabled attribute is only present in the response body for Tableau Cloud starting from API version 3.19 (March 2023).

Version 1.0 and later. For more information, see REST API and Resource Versions.

For more information, see Handling Errors.

Command:

curl "http://MY-SERVER/api/3.26/sites/1234abcd-12ab-12ab-12ab-1234abcd1234?includeUsage=true" -X GET \
-H "X-Tableau-Auth:ABCD1234abcdABCD|ABCD1234abcdABCDABCD1234abcd-1"

Example response:

<tsResponse>
  <site id="1234abcd-12ab-12ab-12ab-1234abcd1234"
    	name="new_site_name"
    	contentUrl="new_site_url"
    	adminMode="ContentAndUsers"
    	storageQuota="100"
    	disableSubscriptions="true"
    	state="Active"
    	revisionHistoryEnabled="true"
    	revisionLimit="25"
    	subscribeOthersEnabled="false"
    	allowSubscriptionAttachments="true"
    	guestAccessEnabled="false"
    	cacheWarmupEnabled="true"
    	commentingEnabled="true"
        editingFlowsEnabled="false"
        schedulingFlowsEnabled="false"
	extractEncryptionMode="enabled"
	catalogingEnabled="true"
    	derivedPermissionsEnabled="false"
    	requestAccessEnabled ="false"
    	runNowEnabled="true"
    	usage numUsers="0" storage="0"
	userQuota="4"
	tierCreatorCapacity="2"
	tierExplorerCapacity="1"
	tierViewerCapacity="1"
    	isDataAlertsEnabled="true"
    	askDataMode="DisabledByDefault"
	useDefaultTimeZone="false"
	timeZone="America/Los_Angeles"
	explainDataEnabled="true"
	dqwSubscriptionsEnabled="false"
	attributeCaptureEnabled="false" />
  </site>
</tsResponse>
          

Command:

curl "http://MY-SERVER/api/3.26/sites/Default?key=name" -X GET \
-H "X-Tableau-Auth:ABCD1234abcdABCD|ABCD1234abcdABCDABCD1234abcd-1"

Example response:

<tsResponse>
  <site id="1234abcd-12ab-12ab-12ab-1234abcd1234"
	name="new_site_name"
	contentUrl=""
	adminMode="ContentAndUsers"
	storageQuota="100"
	disableSubscriptions="true"
	state="Active"
	revisionHistoryEnabled="true"
	revisionLimit="25"
	subscribeOthersEnabled="false"
    allowSubscriptionAttachments="true"
	guestAccessEnabled="false"
	cacheWarmupEnabled="true"
	commentingEnabled="true"
    editingFlowsEnabled="false"
    schedulingFlowsEnabled="false"
	extractEncryptionMode="enabled"
	catalogingEnabled="true"
	derivedPermissionsEnabled="false"
	requestAccessEnabled ="false"
 	runNowEnabled="true"/>
	userQuota="4"
	tierCreatorCapacity="2"
	tierExplorerCapacity="1"
	tierViewerCapacity="1"
    askDataMode="DisabledByDefault"
	useDefaultTimeZone="false"
	timeZone="America/Los_Angeles" />
  </site>
</tsResponse>
          

Returns a list of the sites on the server that the caller of this method has access to. This method is not available for Tableau Cloud.

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.

GET /api/api-version/sites

GET /api/api-version/sites?pageSize=page-size&pageNumber=page-number

None

This method can be called by all users. The method only returns the sites that the user has access to.

Introduced in Tableau Server 2022.3 (API 3.17).

Authorize use of this method in your connected app by including this scope in its JSON Web Token (JWT). For more information, see Access Scopes for Connected Apps(Link opens in a new window) in the Tableau Server Help.

tableau:sites:read

200

<tsResponse>
  <pagination pageNumber="pageNumber"
	pageSize="page-size"
	totalAvailable="total-available" />
  <sites>
	<site id="site-id"
	  name="site-name"
	  contentUrl="content-url"
	  adminMode="admin-mode"
	  disableSubscriptions="disable-subscriptions-flag"
	  userQuota="num-users"
	  storageQuota="limit-in-megabytes"
	  state="active-or-suspended"
	  statusReason="reason-for-state"
	  revisionHistoryEnabled="revision-history-flag"
	  revisionLimit="num-revisions"
	  subscribeOthersEnabled="subscribe-others-flag"
      allowSubscriptionAttachments="allow-subcription-attachments-flag"
	  guestAccessEnabled="guest-access-enabled-flag"
	  cacheWarmupEnabled="cache-warmup-enabled-flag [REMOVED IN API 3.19]"
	  commentingEnabled="enable-commenting-flag"
      editingFlowsEnabled="editing-flows-enabled-flag"
      schedulingFlowsEnabled="scheduling-flows-enabled-flag"
	  extractEncryptionMode="extract-encryption-mode"
	  catalogingEnabled="enable-cataloging-flag"
	  derivedPermissionsEnabled="derived-permissions-enabled-flag
	  requestAccessEnabled ="false"
	  runNowEnabled="true"
	  isDataAlertsEnabled="data-alerts-enabled-flag"
	  askDataMode="ask-data-mode"
	useDefaultTimeZone="default-time-zone-flag"
	  timeZone="time-zone"
	  explainDataEnabled="explain-data-enabled"
	  dqwSubscriptionsEnabled="dqw-subscriptions-enabled" />
	<!--   ... additional sites ... -->
  </sites>
</tsResponse>
        

The response for users without administrative permissions contains only the site id, name, and content-url attributes.

Version 1.0 and later. For more information, see REST API and Resource Versions.

For more information, see Handling Errors.

curl "http://MY-SERVER/api/3.26/sites?pageSize=1&pageNumber=1" -X GET -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd"

Example response:

<tsResponse>
  <pagination pageNumber="1"
    pageSize="1"
    totalAvailable="2"/>
  <sites>
    <site id="abcd1234-ab12-ab12-ab12-abcd1234abcd"
    name="Default"
    contentUrl=""
	adminMode="ContentAndUsers"
	disableSubscriptions="true"
	state="Active"
    revisionHistoryEnabled="true"
	revisionLimit="25"
	subscribeOthersEnabled="false"
	allowSubscriptionAttachments="true"
	guestAccessEnabled="true"
	cacheWarmupEnabled="true" [REMOVED IN API 3.19]
	commentingEnabled="true"
    editingFlowsEnabled="false"
    schedulingFlowsEnabled="false"
	extractEncryptionMode="enabled"
	catalogingEnabled="true"
	derivedPermissionsEnabled="false"
	requestAccessEnabled ="false"
    runNowEnabled="true"
	isDataAlertsEnabled="true"
	askDataMode="DisabledByDefault"
	useDefaultTimeZone="false"
	timeZone="America/Los_Angeles"
	explainDataEnabled="true"
	dqwSubscriptionsEnabled="false" />
  </sites>
</tsResponse>
        

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.

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

Note: The filter and sort parameters can be combined with each other and with paging parameters and fields parameters using an ampersand (&).

None

curl "http://MY-SERVER/api/3.26/sites/9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d/views" -X GET -H "X-Tableau-Auth:1a1b1c1d-2e2f-2a2b-3c3d-3e3f4a4b4c4d"

200

<tsResponse>
  <pagination pageNumber="1" pageSize="100" totalAvailable="2" />
  <views>
    <view 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" />
    </view>
    <view 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" />
    </view>
  </views>
</tsResponse>

{
  "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 <usage> element is included in the response only if the method has includeUsageStatistics=true in the URI.

For more information, see Handling Errors.

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(Link opens in a new window) 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(Link opens in a new window) or Tableau Server Help(Link opens in a new window).

PUT /api/api-version/sites/site-id/settings/embedding

<tsRequest>
  <site>
    <settings unrestrictedEmbedding="true/false"
     allowList="domain-list"/>
  </site>
</tsRequest>

Example request:

<tsRequest>
   <site>
     <settings unrestrictedEmbedding="false"
      allowList="mydomain.com"/>
    </site>
</tsRequest>

(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.

(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.

Any Tableau Cloud or Tableau Server user can call this method.

200

<tsResponse>
  <site id="site-id"
	settings unrestrictedEmbedding="true-or-false"
	allowList="domain-allow-list/>
  </site>
</tsResponse>
        

Example response:

<tsResponse>
      <settings unrestrictedEmbedding="false"/>
	allowList="mydomain.com"
    </site>
</tsResponse>

Version 3.16 and later. For more information, see REST API and Resource Versions.

Tableau Cloud: Only site administrators can run this method.

curl "http://MY-SERVER/api/3.26/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:

<tsRequest>
   <site>
     <settings unrestrictedEmbedding="false"
      allowList="mydomain.com"/>
    </site>
</tsRequest>

For more information, see Handling Errors.

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.

This method is not available for Tableau Cloud.

Note: You must be signed in to a site to update it.

PUT /api/api-version/sites/site-id

Updating individual settings

<tsRequest>
  <site name="new-site-name"
	contentUrl="new-content-url"
	adminMode="new-admin-mode"
	storageQuota="limit-in-megabytes"
	disableSubscriptions="new-disable-subscriptions"
	state="new-state"
	revisionHistoryEnabled="revision-history-enabled"
	revisionLimit="revision-limit"
	allowSubscriptionAttachments="allow-subcription-attachments-flag"
	subscribeOthersEnabled="subscribe-others-enabled-flag"
	guestAccessEnabled="guest-access-enabled-flag"
	cacheWarmupEnabled="cache-warmup-enabled-flag [REMOVED IN API 3.19]"
	commentingEnabled="commenting-enabled-flag"
	editingFlowsEnabled="editing-flows-enabled-flag"
	schedulingFlowsEnabled="scheduling-flows-enabled-flag"
	extractEncryptionMode="extractEncryptionMode"
	dataAccelerationMode="dataAccelerationMode"
	requestAccessEnabled="request-access-enabled-flag"
	runNowEnabled="run-now-enabled-flag"
	userQuota="all-license-limit-total"
	tierCreatorCapacity="creator-license-limit"
	tierExplorerCapacity="explorer-license-limit"
	tierViewerCapacity="viewer-license-limit"
	dataAlertsEnabled="data-alerts-enabled-flag"
	commentingMentionsEnabled="commenting-mentions-enabled-flag"
	catalogObfuscationEnabled="catalog-obfuscation-enabled-flag"
	flowAutoSaveEnabled="flow-auto-save-enabled-flag"
	runNowEnabled="run-now-enabled-flag"
	metricsContentTypeEnabled="metrics-content-type-enabled-flag"
	notifySiteAdminsOnThrottle="notify-site-admins-on-throttle-flag"
	authoringEnabled="authoring-enabled-flag"
	customSubscriptionEmailEnabled="custom-subscription-email-enabled-flag"
	customSubscriptionEmail="custom-subscription-email"
	customSubscriptionFooterEnabled="custom-subscription-footer-enabled-flag"
	customSubscriptionFooter="custom-subscription-footer"
	askDataMode="ask-data-mode"
	namedSharingEnabled="named-sharing-enabled-flag"
	catalogingEnabled="cataloging-enabled-flag"
	derivedPermissionsEnabled="derived-permissions-enabled-flag"
	userVisibilityMode="user-visibility-mode"
	useDefaultTimeZone="default-time-zone-flag"
	timeZone="time-zone"
	autoSuspendRefreshEnabled="auto-suspend-refresh-enabled-flag"
	autoSuspendRefreshInactivityWindow="auto-suspend-refresh-inactivity-window"
	explainDataEnabled="explaindataenabled"
	dqwSubscriptionsEnabled="dqwsubscriptionsenabled"
	attributeCaptureEnabled="attribute-capture-enabled"
	groupAssertionsEnabled="group-assertions-enabled-flag"
	groupAssertionsSAMLEnabled="group-assertions-saml-enabled-flag"
	groupAssertionsOIDCEnabled="group-assertions-oidc-enabled-flag"
	groupAssertionsConnectedAppsEnabled="group-assertions-connected-apps-enabled-flag"
	groupSetsEnabled="group-sets-enabled-flag" />
</tsRequest>
          

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  <binary data here> --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--

Note: You cannot set adminMode to ContentOnly and also set a userQuota value. The default value is ContentAndUsers.

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.

(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.

(Optional) Specify true to enable and false to disable the ability for view owners to subscribe other users to a view. Default is true.

(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(Link opens in a new window).

The default is set to true, which means editing flows is enabled by default. For more information, see Implication of disabling Tableau Prep Conductor.

(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(Link opens in a new window).

The default is set to true, which means scheduling flows is enabled by default. For more information, see Implication of disabling Tableau Prep Conductor.

The flowsEnabled attribute is deprecated as of API 3.10.

(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.

This attribute was removed in API 3.19 and later. For current methods to improve Tableau performance see, View Acceleration(Link opens in a new window).

(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.

(Optional) Specify true to enable and false to disable the ability for user comments on views in the site. Default is true.

(Optional) Specify enforced, enabled, or disabled. Default is disabled. For more information, see Extract and Encryption Methods.

(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. (Data acceleration is not available in Tableau Server 2022.1 (API 3.16) and later. See View Acceleration(Link opens in a new window).)

(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(Link opens in a new window)

Update Data Source Now(Link opens in a new window)

Run Extract Refresh Task(Link opens in a new window)

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:

. 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(Link opens in a new window).

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

commenting-mentions-enabled-flag

catalog-obfuscation-enabled-flag

flow-auto-save-enabled-flag

run-now-enabled-flag

metrics-content-type-enabled-flag

notify-site-admins-on-throttle-flag

authoring-enabled-flag

custom-subscription-email-enabled-flag

custom-subscription-email

custom-subscription-footer-enabled-flag

custom-subscription-footer

ask-data-mode

• 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.

named-sharing-enabled-flag

cataloging-enabled-flag

derived-permissions-enabled-flag

user-visibility-mode

(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(Link opens in a new window) in the Tableau Server Help.

(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(Link opens in a new window) in the Tableau Server Help.

(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). 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(Link opens in a new window) Help. This attribute is available starting from API version 3.25.

• groupAssertionsSAMLEnabled
• groupAssertionsOIDCEnabled
• groupAssertionsConnectedAppsEnabled

Any combination of the attributes inside the <site> 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 <site> element (<site />) 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(Link opens in a new window) 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 <site> 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  <tsRequest>   <site site attributes >   </site> </tsRequest> --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.

Tableau Server: This method can only be called by server administrators.

Introduced in Tableau Cloud June 2022 (API 3.16) and Tableau Server 2022.3 (API 3.17).

Authorize use of this method in your connected app by including this scope in its JSON Web Token (JWT). For more information, see Access Scopes for Connected Apps(Link opens in a new window) in the Tableau Cloud Help or Access Scopes for Connected Apps(Link opens in a new window) in the Tableau Server Help.

tableau:sites:update

200

<tsResponse>
  <site id="site-id"
	name="site-name"
	contentUrl="content-url"
	adminMode="admin-mode"
	storageQuota="limit-in-megabytes"
	disableSubscriptions="true-or-false"
	state="active-or-suspended"
	revisionHistoryEnabled="true-or-false"
	revisionLimit="revision-limit"
	allowSubscriptionAttachments="allow-subcription-attachments-flag"
	cacheWarmupEnabled="cache-warmup-enabled-flag [REMOVED IN API 3.19]"
	commentingEnabled="commenting-enabled-flag"
    editingFlowsEnabled="editing-flows-enabled-flag"
    schedulingFlowsEnabled="scheduling-flows-enabled-flag"
	catalogingEnabled="cataloging-enabled-flag"
	derivedPermissionsEnabled="derived-permissions-enabled-flag"
	requestAccessEnabled= "request-access-enabled-flag"
	runNowEnabled="run-now-enabled-flag"
	userQuota="all-license-limit-total"
	tierCreatorCapacity="creator-license-limit"
	tierExplorerCapacity="explorer-license-limit"
	tierViewerCapacity="viewer-license-limit"
	askDataMode="ask-data-mode"
	useDefaultTimeZone="default-time-zone-flag"
	timeZone="time-zone"
	autoSuspendRefreshEnabled="auto-suspend-refresh-enabled-flag"
	autoSuspendRefreshInactivityWindow="auto-suspend-refresh-inactivity-window"
	explainDataEnabled="explain-data-enabled"
	dqwSubscriptionsEnabled="dqw-subscriptions-enabled"
	attributeCaptureEnabled="attribute-capture-enabled"
	groupAssertionsEnabled="group-assertions-enabled-flag"
	groupAssertionsSAMLEnabled="group-assertions-saml-enabled-flag"
	groupAssertionsOIDCEnabled="group-assertions-oidc-enabled-flag"
	groupAssertionsConnectedAppsEnabled="group-assertions-connected-apps-enabled-flag"
	groupSetsEnabled="group-sets-enabled-flag" />
  </site>
</tsResponse>
        

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 1.0 and later. For more information, see REST API and Resource Versions.

For more information, see Handling Errors.

curl "http://MY-SERVER/api/3.26/sites/9a8b7c6d5-e4f3-a2b1-c0d9-e8f7a6b5c4d" -X PUT -H "X-Tableau-Auth:12ab34cd56ef78ab90cd12ef34ab56cd" -d @update-site.xml

Content of update-site.xml:

<tsRequest>
  <site
	adminMode="ContentOnly"
	storageQuota="1000"
	tierCreatorCapacity="2"
	tierExplorerCapacity="1"
	tierViewerCapacity="1"
	useDefaultTimeZone="false"
	timeZone="America/Los_Angeles" />
</tsRequest>
      

Example response:

<tsResponse<
  <site id="9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d"
	name="Default"
	contentUrl="svc_licensingtest"
	adminMode="ContentAndUsers"
	disableSubscriptions="false"
	state="Active"
	revisionHistoryEnabled="true"
	revisionLimit="25"
	subscribeOthersEnabled="true"
	allowSubscriptionAttachments="true"
	guestAccessEnabled="false"
	cacheWarmupEnabled="true" [REMOVED IN API 3.19]
	commentingEnabled="true"
    editingFlowsEnabled="false"
    schedulingFlowsEnabled="false"
	extractEncryptionMode="disabled"
	catalogingEnabled="true"
	derivedPermissionsEnabled="true"
	askDataMode="DisabledByDefault"
	useDefaultTimeZone="false"
	timeZone="America/Los_Angeles"
	explainDataEnabled="true"
	dqwSubscriptionsEnabled="false"
</tsResponse>
      

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4