URI

POST /api/api-version/sites

Request Body

<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"    recycleBinEnabled="recycle-bin-enabled-flag" /></tsRequest>

Attribute Values

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, seeAccess scopes for UATs(Link opens in a new window) (Cloud)and access scopes for connected apps:Cloud(Link opens in a new window),Server-Windows(Link opens in a new window),orServer-Linux(Link opens in a new window).

Response Code

201

Response Body

<tsResponse>  <siteapi-placeholder">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"    recycleBinEnabled="recycle-bin-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.

Response Headers

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

Version

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

Errors

For more information, seeHandling Errors.

Example

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

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

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, seeAccess scopes for UATs(Link opens in a new window) (Cloud)and access scopes for connected apps:Cloud(Link opens in a new window),Server-Windows(Link opens in a new window),orServer-Linux(Link opens in a new window).

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)

<tsResponse>   <jobapi-placeholder">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 theQuery Job(Link opens in a new window) method.

• mode has the value ofAsynchronous.

• type has the value ofSiteDelete.

• progress is set to0 when the asynchronous delete job is created, and then changes to100 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 to1 when the asynchronous delete job is created, and then changes to0 when the job is complete.

Version

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

Errors

For more information, seeHandling Errors.

cURL Request Example

Delete site

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

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

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

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

URI

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

Parameter Values

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, seeAccess scopes for UATs(Link opens in a new window) (Cloud)and access scopes for connected apps:Cloud(Link opens in a new window),Server-Windows(Link opens in a new window),orServer-Linux(Link opens in a new window).

Response Code

200

Response Body

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

Attribute Values

Version

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 ofView 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 willalso not cause any change on the server or return meaningful information about data acceleration of a workbook. We recommend removingany dependencies on data acceleration in your requests to REST API endpoints, as the feature may become unsupported in future releasesresulting in error codes being returned.

For more information, seeREST API and Resource Versions.

Errors

For more information, seeHandling Errors.

Example

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

Example response:

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

URI

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

Path Parameter Values

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, seeAccess scopes for UATs(Link opens in a new window) (Cloud)and access scopes for connected apps:Cloud(Link opens in a new window),Server-Windows(Link opens in a new window),orServer-Linux(Link opens in a new window).

Response Code

200

Permissions

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

Response Body

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

Example Response

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

Example

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

For more information, seeHandling Errors.

URI

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

Parameter Values

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 hasRead 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, seeAccess scopes for UATs(Link opens in a new window) (Cloud)and access scopes for connected apps:Cloud(Link opens in a new window),Server-Windows(Link opens in a new window),orServer-Linux(Link opens in a new window).

Response Code

200

Response Body

<tsResponse ><recents>  <recent><view api-placeholder">view-id"  name="view-name"  contentUrl="view-content-url"  createdAt="created-at-time"  updatedAt="updated-at-time"  viewUrlName="view-url-name"><workbookworkbook-of-view" "/><ownerapi-placeholder">owner-id" /><projectapi-placeholder">project-id" /><tags/></view>  </recent>  <recent>    <workbook  api-placeholder">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" >        <projectapi-placeholder">project-id"/>        <ownerapi-placeholder">ownwer-id"name="project-name" />        <tags/></workbook>  </recent>  <!--  more recently viewed views and workbooks  --></tsResponse>

The value ofview-url-name is the name of the view in its URL.For example, if a view namedView 1 shows the URLhttps://MY_SERVER/#/site/MY_SITE/views/VIEW_1in your browser address bar, then the theview-url-name would beVIEW_1.Modifying thename (display name) of a view will not impact theview-url-name(path element of the view's URL).

Version

Version 3.5 and later. For more information, seeREST API and Resource Versions.

Errors

For more information, seeHandling Errors.

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:

<tsResponse >  <recents>    <recent>      <view       name="MySQL PostgresSQL"    contentUrl="my_site1"    createdAt="2019-01-28T20:33:35Z"    updatedAt="2019-01-28T20:44:05Z"viewUrlName="MySQL_PostgresSQL">  <workbook/>  <owner/>  <project/>  <tags/>      </view>    </recent>    <recent>  <workbook       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 name="project2"/>      <owner name="my_name"/>      <tags/>  </workbook>    </recent>    <!--  more recently viewed views and workbooks  --%gt;  </recent></tsResponse>

Version: Available in API 3.13 and later.

License: No additional license required.

Permissions: Only the user that owns a Personal Space can get its details.

Access scope:tableau:projects:read

• Scope added in API 3.27 (Tableau Cloud December 2025 / Server 2025.3).
• For more information, seeVersions(Link opens in a new window),Permissions(Link opens in a new window),Access scopes for UATs(Link opens in a new window) (Cloud),and access scopes forCloud(Link opens in a new window),Server-Windows,(Link opens in a new window) orServer-Linux(Link opens in a new window).

URI

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

Parameter Values

Request Body

none

cURL Example

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

Response Code

200

Response Body

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

Errors

For more information, seeHandling Errors.

Version: Available in API 3.24 (Tableau Cloud November 2024) and later. Not available for Tableau Server.Version Overview(Link opens in a new window)

License: No additional license required.

Permissions: Tableau Cloud site admins only.

JWT Access Scope: Not available.

URI

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

URI Parameter Values

Request Body

None

cURL Request Example

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

Response Code

200

Response Body

<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 theidpConfigurationId to specify the authentication method for a user inAdd User to Site andUpdate User methods.

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

Errors

For more information, seeHandling Errors.

URI

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

Parameter Values

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:sites:read

For more information, seeAccess scopes for UATs(Link opens in a new window) (Cloud)and access scopes for connected apps:Cloud(Link opens in a new window),Server-Windows(Link opens in a new window),orServer-Linux(Link opens in a new window).

Response Code

200

Response Body

<tsResponse>  <siteapi-placeholder">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 present in the response body for Tableau Cloud starting from API version 3.19 (March 2023) and Tableau Server starting from API version 3.25 (Tableau Server 2025.1).

Version

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

Errors

For more information, seeHandling Errors.

Example

Command:

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

Example response:

<tsResponse>  <site    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.27/sites/Default?key=name" -X GET \-H "X-Tableau-Auth:ABCD1234abcdABCD|ABCD1234abcdABCDABCD1234abcd-1"

Example response:

<tsResponse>  <site    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>

URI

GET /api/api-version/sites

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

Parameter Values

Request Body

None

Permissions

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

Required scope for JWT authorization

Introduced in Tableau Server 2022.3 (API 3.17).

tableau:sites:read

For more information, seeAccess scopes for UATs(Link opens in a new window) (Cloud)and access scopes for connected apps:Cloud(Link opens in a new window),Server-Windows(Link opens in a new window),orServer-Linux(Link opens in a new window).

Response Code

200

Response Body

<tsResponse>  <pagination pageNumber="pageNumber"pageSize="page-size"totalAvailable="total-available" />  <sites><site      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 ="request-access-enabled-flag"      runNowEnabled="run-now-enabled-flag"      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 siteid,name, andcontent-url attributes.

Version

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

Errors

For more information, seeHandling Errors.

Example

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

Example response:

<tsResponse>  <pagination pageNumber="1"    pageSize="1"    totalAvailable="2"/>  <sites>    <site    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>

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 hasRead permissions for (either explicitly or implicitly).

Access Scope:tableau:content:read

• For more information, seeVersions(Link opens in a new window),Permissions(Link opens in a new window),Access scopes for UATs(Link opens in a new window) (Cloud),and access scopes forCloud(Link opens in a new window),Server-Windows,(Link opens in a new window) orServer-Linux(Link opens in a new window).

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

Note: Thefilter andsort parameters can be combined with each other and with paging parameters andfields parameters using an ampersand (&).

Request Body

None

cURL Request

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

Response Code

200

Response Body

<tsResponse>  <pagination pageNumber="1" pageSize="100" totalAvailable="2" />  <views>    <view name="Economic Indicators"         contentUrl="Finance/sheets/EconomicIndicators">      <workbook />      <owner />    </view>    <view name="Investing in the Dow"          contentUrl="Finance/sheets/InvestingintheDow">      <workbook />      <owner />    </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 hasincludeUsageStatistics=true in the URI.

Errors

For more information, seeHandling Errors.