Custom Domain Methods
Custom domains allow your Tableau Cloud site to use a subdomain of your top level domain. For example, if you control example.com, you can use the subdomain analytics.example.com for your Tableau Cloud site. By using your domain, you maintain brand identity because the user won't see Tableau URLs in the address bar of their browser. Furthermore, because it's your domain, security constraints around third-party cookies don't apply. For information on custom domains, see Use a Custom Domain with Tableau Cloud.
The custom domain REST API methods allow you to create, update, delete, or get information on custom domains using the REST API.
Note: If you use custom OAuth authentication for any connectors, you must configure a new OAuth client to use the custom domain with those connectors. The new client should use the custom domain as the Redirect URL. For more information on setting up custom OAuth, see Configure Custom OAuth.
Create custom domain settings
Starts the process of custom domain setup for a Tableau site.
Version: Available in API 3.26 (Tableau Cloud June 2025) and later. Not available for Tableau Server. Versioning Overview Version Overview
Permissions: Only users with administrator permissions can create a custom domain for a site. Permissions Overview Permissions Overview
License: No additional license required.
Access Scope: Not available.
Access Scopes Overview: Cloud Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
POST {server}/api/-/customdomains/settings/site/{site_luid}
Delete custom domain settings
Deletes the custom domain setup for a Tableau site.
Version: Available in API 3.26 (Tableau Cloud June 2025) and later. Not available for Tableau Server. Versioning Overview Version Overview
Permissions: Only users with administrator permissions can view a site's custom domain settings. Permissions Overview Permissions Overview
License: No additional license required.
Access Scope: Not available.
Access Scopes Overview: Cloud Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
DELETE {server}/api/-/customdomains/settings/site/{site_luid}
Get Custom Domain Name
Gets the custom domain for a Tableau site, if one is provisioned. For more information about how, see
Version: Available in API 3.26 (Tableau Cloud June 2025) and later. Not available for Tableau Server. Versioning Overview Version Overview
Permissions: Can be called by any user that is a member of the site associated with the custom domain. Permissions Overview Permissions Overview
License: No additional license required.
Access Scope: Not available.
Access Scopes Overview: Cloud Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
GET {server}/api/-/customdomains/site/{site_luid}
Get custom domain settings
Gets the custom domain settings for a Tableau site.
Version: Available in API 3.26 (Tableau Cloud June 2025) and later. Not available for Tableau Server. Versioning Overview Version Overview
Permissions: Only users with administrator permissions can view a site's custom domain settings. Permissions Overview Permissions Overview
License: No additional license required.
Access Scope: Not available.
Access Scopes Overview: Cloud Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
GET {server}/api/-/customdomains/settings/site/{site_luid}
Update custom domain settings
Updates the custom domain setup for a Tableau site.
Version: Available in API 3.26 (Tableau Cloud June 2025) and later. Not available for Tableau Server. Versioning Overview Version Overview
Permissions: Only users with administrator permissions can update a site's custom domain settings. Permissions Overview Permissions Overview
License: No additional license required.
Access Scope: Not available.
Access Scopes Overview: Cloud Tableau Cloud | Tableau Server-Windows | Tableau Server-Linux
PUT {server}/api/-/customdomains/settings/site/{site_luid}