Endpoints - Validate Custom Domain

Service:: CDN

API Version:: 2025-04-15

Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/profiles/{profileName}/endpoints/{endpointName}/validateCustomDomain?api-version=2025-04-15

URI Parameters

Name	In	Required	Type	Description
endpointName	path	True	string	Name of the endpoint under the profile which is unique globally.
profileName	path	True	string	Name of the CDN profile which is unique within the resource group.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
hostName	True	string	The host name of the custom domain. Must be a domain name.

Responses

Name	Type	Description
200 OK	ValidateCustomDomainOutput	OK. The request has succeeded.
Other Status Codes	ErrorResponse	CDN error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Endpoints_ValidateCustomDomain

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/RG/providers/Microsoft.Cdn/profiles/profile1/endpoints/endpoint1/validateCustomDomain?api-version=2025-04-15

{
  "hostName": "www.someDomain.com"
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Cdn.Models;
using Azure.ResourceManager.Cdn;

// Generated from example definition: specification/cdn/resource-manager/Microsoft.Cdn/stable/2025-04-15/examples/Endpoints_ValidateCustomDomain.json
// this example is just showing the usage of "CdnEndpoints_ValidateCustomDomain" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this CdnEndpointResource created on azure
// for more information of creating CdnEndpointResource, please refer to the document of CdnEndpointResource
string subscriptionId = "subid";
string resourceGroupName = "RG";
string profileName = "profile1";
string endpointName = "endpoint1";
ResourceIdentifier cdnEndpointResourceId = CdnEndpointResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, profileName, endpointName);
CdnEndpointResource cdnEndpoint = client.GetCdnEndpointResource(cdnEndpointResourceId);

// invoke the operation
ValidateCustomDomainContent content = new ValidateCustomDomainContent("www.someDomain.com");
ValidateCustomDomainResult result = await cdnEndpoint.ValidateCustomDomainAsync(content);

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "customDomainValidated": true,
  "message": null,
  "reason": null
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ValidateCustomDomainInput	Input of the custom domain to be validated for DNS mapping.
ValidateCustomDomainOutput	Output of custom domain validation.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ValidateCustomDomainInput

Object

Input of the custom domain to be validated for DNS mapping.

Name	Type	Description
hostName	string	The host name of the custom domain. Must be a domain name.

ValidateCustomDomainOutput

Object

Output of custom domain validation.

Name	Type	Description
customDomainValidated	boolean	Indicates whether the custom domain is valid or not.
message	string	Error message describing why the custom domain is not valid.
reason	string	The reason why the custom domain is not valid.

Share via

Endpoints - Validate Custom Domain

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Endpoints_ValidateCustomDomain

Sample request

Sample response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ValidateCustomDomainInput

ValidateCustomDomainOutput