Documentation

Check an ending

GET/v1/endings/{ending}Links

Whether an ending is free on a domain, the check the dashboard runs as you type. Endings are 3 to 40 letters, digits, dashes or underscores; the answer carries the ending as it would be saved. Advisory only: creating or renaming a link still decides. Braked per account (60 a minute) on top of the key's rate limit.

Parameters

Parameter	Type	Required	Description
`ending`	string, in the path	required
`domain`	string	optional	One of the account's own live domains. Left out: the domain a new link would get (the account's default, else snip.link).
`exclude`	string	optional	A link's id or ending, when checking a rename: its own endings count as free.

Example request

Terminal

curl "https://snip.link/v1/endings/spring-menu" \
  -H "Authorization: Bearer $SNIP_KEY"

Example response

Response

{
  "ending": "spring-menu",
  "available": true,
  "message": "This ending is available."
}

Response fields

Field	Type	Description
`ending`	string
`available`	boolean
`message`	string

Errors

Status	Meaning
400	The body or query is invalid. `details` names each field.
401	The API key is missing, malformed or revoked.
404	No link by that id or ending in this account.
429	Either the key exceeded its requests-per-second limit (honor Retry-After), or a daily or plan quota is used up (`details.reason`).

Back to getting started