Developers

Domains

Notes

Domains control the brand hostname used in preview and landing URLs. The list includes global platform domains and any custom domains on your account (platform domains marked hidden by operators are omitted). Custom domain creation is limited by your plan quota.

List

API endpoint:

GET https://skipdns.link/api/v2/domains

Request example:

curl --location --request GET 'https://skipdns.link/api/v2/domains' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_token}'

Show

API endpoint:

GET https://skipdns.link/api/v2/domains/{id}

Request example:

curl --location --request GET 'https://skipdns.link/api/v2/domains/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_token}'

Store

API endpoint:

POST https://skipdns.link/api/v2/domains

Request example:

curl --location --request POST 'https://skipdns.link/api/v2/domains' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {api_token}' \
--data-raw '{"name":"preview.client.com"}'

Parameters:

Parameter Type Description
name
required string
Custom domain hostname (for example preview.client.com).
index_page
optional string
Optional index page path or URL for the domain root.
not_found_page
optional string
Optional not-found page path or URL for unknown aliases on this domain.

Update

API endpoint:

PUT / PATCH https://skipdns.link/api/v2/domains/{id}

Request example:

curl --location --request PATCH 'https://skipdns.link/api/v2/domains/{id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {api_token}' \
--data-raw '{"index_page":"/welcome"}'

Parameters:

Parameter Type Description
index_page
optional string
Index page path or URL.
not_found_page
optional string
Not-found page path or URL.

Delete

API endpoint:

DELETE https://skipdns.link/api/v2/domains/{id}

Request example:

curl --location --request DELETE 'https://skipdns.link/api/v2/domains/{id}' \
--header 'Authorization: Bearer {api_token}'