Create Domain
POST {{apiPath}}/environments/{{envID}}/customDomains
The POST /environments/{{envID}}/customDomains
operation adds a new resource entity to the specified environment resource.
Note: An environment can have only one configured custom domain. The custom domain name must also be unique across all PingOne environments, and geographies.
Prerequisites
- See Custom Domains for important overview information.
For property descriptions, see Custom domains data model.
Property | Type | Required? |
---|---|---|
domainName | String | Required |
Request Body
{"domainName"=>"custom-domain.example.com"}
RESPONSES
status: Created
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/customDomains/93838ab0-0238-40fa-ae4e-6b890882d323"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"}},"id":"93838ab0-0238-40fa-ae4e-6b890882d323","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"domainName":"custom-domain.example.com","status":"VERIFICATION_REQUIRED","canonicalName":"5849925b-5d87-42d4-88fb-12a24bb3a7d6.edge1.pingone.com"}