Get the custom hostnames for this environemnt

GET /environments/{environmentId}/custom/hostnames

Try it

Get the custom hostnames for this environemnt

cURL

curl --request GET \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/custom/hostnames \
  --header 'Authorization: Bearer <token>'

200

{
  "customHostnames": [
    {
      "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>"
    }
  ]
}

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

Example:

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

Response

200

application/json

List of custom hostnames for this environment

customHostnames · object[] · required

Show child attributes

customHostnames. id · string · required

Required string length: 36

Example:

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

customHostnames. hostname · string · required

Maximum string length: 255

Example:

"auth.dynamic.xyz"

customHostnames. usage · enum<string> · required

Available options: cookies, globalWallet

customHostnames. status · enum<string> · required

Available options: active, pending, error

customHostnames. verificationRecords · object[] · required

Show child attributes

customHostnames.verificationRecords. dnsRecordType · enum<string> · required

Available options: TXT, CNAME

customHostnames.verificationRecords. verificationType · enum<string> · required

Available options: certificate, ownership, alias

customHostnames.verificationRecords. name · string · required

customHostnames.verificationRecords. value · string · required

customHostnames. errors · string