---
schema_version: "1"
id: ed350fd3866e19bcdf62cd365601ad85d11af94cffb94b2ab95fb3ec9f2e4f3c
title: Custom Domain Methods
collection: tableau
version: next
locale: en-us
portal_url: https://docs.salesforce.com/tableau/next/en-us/api/rest_api/REST/rest_api_ref_custom_domain.md
canonical_url: https://help.tableau.com/v0.0/api/rest_api/en-us/REST/rest_api_ref_custom_domain.htm
source_site: help.tableau.com
content_type: documentation
content_hash: 40cc0eb579a427777185a132cd60485b6f89f52d878727706eff597071464fc6
description: Custom domains allow your Tableau Cloud site to use a subdomain of your top level domain
---
[Skip to main content](#main-content)

# 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](https://help.tableau.com/current/online/en-us/custom_domain.htm).

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](https://help.tableau.com/current/online/en-us/protected_auth.htm#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](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)

**Permissions:** Only users with administrator permissions can create a custom domain for a site. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)

**License:** No additional license required.

**Access Scope:** \`tableau:custom\_domains:create\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)

POST {server}/api/-/customdomains/settings/site/{site\_luid}

[view details](#)

## 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](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)

**Permissions:** Only users with administrator permissions can view a site's custom domain settings. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)

**License:** No additional license required.

**Access Scope:** \`tableau:custom\_domains:delete\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)

DELETE {server}/api/-/customdomains/settings/site/{site\_luid}

[view details](#)

## 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](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)

**Permissions:** Can be called by any user that is a member of the site associated with the custom domain. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)

**License:** No additional license required.

**Access Scope:** \`tableau:custom\_domains:read\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)

GET {server}/api/-/customdomains/site/{site\_luid}

[view details](#)

## 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](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)

**Permissions:** Only users with administrator permissions can view a site's custom domain settings. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)

**License:** No additional license required.

**Access Scope:** \`tableau:custom\_domains:read\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)

GET {server}/api/-/customdomains/settings/site/{site\_luid}

[view details](#)

## 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](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm) [Version Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm)

**Permissions:** Only users with administrator permissions can update a site's custom domain settings. [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm) [Permissions Overview](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_permissions.htm)

**License:** No additional license required.

**Access Scope:** \`tableau:custom\_domains:update\`. Added in API 3.28. Access Scopes Overview: [Access scopes for UATs](https://help.tableau.com/current/api/cloud-manager/en-us/docs/unified_access_tokens.html#scopes) and [Access scopes for connected apps](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) [Tableau Cloud](https://help.tableau.com/current/online/en-us/connected_apps_scopes.htm) | [Tableau Server-Windows](https://help.tableau.com/current/server/en-us/connected_apps_scopes.htm) | [Tableau Server-Linux](https://help.tableau.com/current/server-linux/en-us/connected_apps_scopes.htm)

PUT {server}/api/-/customdomains/settings/site/{site\_luid}

[view details](#)