EVevervault
Core
Relays

Retrieve a Custom Domain

Changed on

Retrieves a custom domain for a Relay.

get/relays/{relay_id}/custom-domains/{id}

Request

Path parameters

relay_idstring required

The id of the Relay to which the custom domain belongs.

idstring required

The id of the custom domain to be fetched.

Response

The custom domain has been fetched.

idstring required

The unique identifier for the custom domain.

customDomainstring required

The customer managed domain to which requests to be relayed to your domain should be sent.

relaystring required

The ID of the Relay with which this custom domain is associated.

status'active' | 'inactive' required

The status of the domains DNS verification.

validationRecordstring uuidv4 required

Validation TXT record to be added on the _ev-custom-relay subdomain of your custom domain

createdAtinteger required

The exact time, in epoch milliseconds, when this custom domain was created.

updatedAtinteger required

The exact time, in epoch milliseconds, when this custom domain was last updated.

Example response

{
  "id": "custom_domain_j3od9Bl0WV1n",
  "customDomain": "subdomain.example.com",
  "status": "active",
  "validationRecord": "986f3008-86e7-4caf-bd8b-a5d312844153",
  "relay": "relay_destination_d4ja57js9lnh",
  "createdAt": 1692972623233,
  "updatedAt": 1692972623233
}

Changes

  • 8d0ca833fa04Revision changes
    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status