Links

Notes
Expert level
The API key should be sent as a Bearer token in the Authorization header of the request. Get your API key.
List

API endpoint:

GET
https://www.skipdns.link/api/v1/links

Request example:

curl --location --request GET 'https://www.skipdns.link/api/v1/links' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Parameter
Type
Description
search
optional string
The search query.
by
optional string
Search by. Possible values are: url for Live URL, alias for Alias, ip_address for IP address (exact match). Defaults to: url.
status
optional integer
Filter by status. Possible values are: 0 for All, 1 for Active, 2 for Expired, 3 for Disabled. Defaults to: 0.
space
optional integer
Filter by space ID.
domain
optional integer
Filter by domain ID.
sort
optional string
Sort. Possible values are: desc for Descending, asc for Ascending. Defaults to: desc.
per_page
optional int
Results per page. Possible values are: 10 to 100. Defaults to: 10.
Show

API endpoint:

GET
https://www.skipdns.link/api/v1/links/{id-or-alias}

Request example:

curl --location --request GET 'https://www.skipdns.link/api/v1/links/{id-or-alias}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
Store

API endpoint:

POST
https://www.skipdns.link/api/v1/links

Request example:

curl --location --request POST 'https://www.skipdns.link/api/v1/links' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parameter
Type
Description
url
required string
The live URL to create a temp link for.
ip_address
optional string
The IP address where the link should load from.
http_port
optional integer
The port number for HTTP requests.
https_port
optional integer
The port number for HTTPS requests.
domain
optional integer
The domain ID the link to be saved under.
alias
optional string
The link alias.
password
optional string
The link password.
space
optional integer
The space ID the link to be saved under.
disabled
optional integer
Whether the link is disabled or not. Possible values are: 0 for Active, 1 for Disabled. Defaults to: 0.
expiration_date
optional string
The link expiration date in YYYY-MM-DD format.
expiration_time
optional string
The link expiration time in HH:MM format.
Update

API endpoint:

PUT PATCH
https://www.skipdns.link/api/v1/links/{id}

Request example:

curl --location --request PUT 'https://www.skipdns.link/api/v1/links/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'
Parameter
Type
Description
url
optional string
The new live URL to update the link to.
ip_address
optional string
The IP address where the link should load from.
http_port
optional integer
The port number for HTTP requests.
https_port
optional integer
The port number for HTTPS requests.
alias
optional string
The link alias.
password
optional string
The link password.
space
optional integer
The space ID the link to be saved under.
disabled
optional integer
Whether the link is disabled or not. Possible values are: 0 for Active, 1 for Disabled.
expiration_date
optional string
The link expiration date in YYYY-MM-DD format.
expiration_time
optional string
The link expiration time in HH:MM format.
Delete

API endpoint:

DELETE
https://www.skipdns.link/links/{id}/destroy

Request example:

curl --location --request DELETE 'https://www.skipdns.link/links/{id}/destroy' \
--header 'Authorization: Bearer {api_key}'