Developers

Spaces

Notes

A space is an optional label for your links (similar to Gmail labels) and a place to store default routing: IP address and HTTP/HTTPS ports. If you manage previews on two or more servers, create one space per server (or environment) with the correct defaults.

When you create or update a link via the API, set space_id to attach it to a space. If the link leaves ip_address or port fields empty, routing follows the space defaults. You can still override IP or ports on individual links when needed.

Updating a space’s ip_address, http_port, or https_port applies to every link in that space that relies on those defaults—useful when a server moves or you standardize ports across many previews.

List

API endpoint:

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

Request example:

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

Show

API endpoint:

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

Request example:

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

Store

API endpoint:

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

Request example:

curl --location --request POST 'https://skipdns.link/api/v2/spaces' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {api_token}' \
--data-raw '{"name":"Production server","ip_address":"203.0.113.10"}'

Parameters:

Parameter Type Description
name
required string
Space name.
ip_address
optional string
Default IP for links in this space.
http_port
optional integer
Default HTTP port.
https_port
optional integer
Default HTTPS port.
color
optional integer
UI color index (1–6): gray, primary, cyan, green, amber, red. Defaults to 1.

Update

API endpoint:

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

Request example:

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

Parameters:

Parameter Type Description
name
optional string
Space name.
ip_address
optional string
Default IP for links in this space.
http_port
optional integer
Default HTTP port.
https_port
optional integer
Default HTTPS port.
color
optional integer
UI color index (1–6): gray, primary, cyan, green, amber, red. Defaults to 1.

Delete

API endpoint:

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

Request example:

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