Create a custom hostname for the environment

Creates a new custom hostname for the specified environment.

POST /environments/{environmentId}/custom/hostnames

Create a custom hostname for the environment

cURL

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"
}
'

201

{
  "id": "95b11417-f18f-457f-8804-68e361f9164f",
  "hostname": "auth.dynamic.xyz",
  "verificationRecords": [
    {
      "name": "<string>",
      "value": "<string>"
    }
  ],
  "errors": "<string>"
}

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

201

application/json

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

Show child attributes

errors · string

Error message describing why hostname verification or activation failed