Skip to main content
POST
/
environments
/
{environmentId}
/
custom
/
hostnames
Create a custom hostname for the environment
curl --request POST \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/custom/hostnames \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "hostname": "auth.dynamic.xyz",
  "usage": "cookies"
}
'
{
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "hostname": "auth.dynamic.xyz",
  "usage": "cookies",
  "status": "active",
  "verificationRecords": [
    {
      "dnsRecordType": "TXT",
      "verificationType": "certificate",
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "errors": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.dynamic.xyz/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
environmentId
string
required

ID of the environment

Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json
​
hostname
string
required
Maximum string length: 255
Pattern: ^(?!-)[A-Za-z0-9-]+([\-\.]{1}[a-z0-9]+)*\.[A-Za-z]{2,15}$
Example:

"auth.dynamic.xyz"

​
usage
enum<string>
required
Available options:
cookies,
globalWallet

Response

Successfully created

​
id
string
required
Required string length: 36
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"95b11417-f18f-457f-8804-68e361f9164f"

​
hostname
string
required
Maximum string length: 255
Pattern: ^(?!-)[A-Za-z0-9-]+([\-\.]{1}[a-z0-9]+)*\.[A-Za-z]{2,15}$
Example:

"auth.dynamic.xyz"

​
usage
enum<string>
required
Available options:
cookies,
globalWallet
​
status
enum<string>
required
Available options:
active,
pending,
error
​
verificationRecords
object[]
required

List of DNS records required to verify ownership of the custom hostname

​
errors
string

Error message describing why hostname verification or activation failed