Documentation

Get an own domain

GET/v1/domains/{domain}Domains

One domain by id or hostname. A pending domain is checked again on read, so polling this route shows it turn active.

Parameters

Parameter	Type	Required	Description
`domain`	string, in the path	required	The domain's id or its hostname.

Example request

curl -s "https://snip.link/v1/domains/go.example.com" \
  -H "Authorization: Bearer $SNIP_KEY"

Example response

{
  "domain": {
    "id": "dom_3c1f0a9e2b7d4c55",
    "hostname": "go.example.com",
    "status": "active",
    "detail": null,
    "cname_target": "customers.snip.link",
    "root_url": "https://example.com",
    "links": 42,
    "created_at": "2026-10-20T12:00:00.000Z"
  }
}

Response fields

Field	Type	Description
`domain`	Domain
`domain.id`	string	Stable id. Every domain route accepts it, or the hostname.
`domain.hostname`	string	The domain links live on, without a scheme.
`domain.status`	pending \| active \| failed	`pending` until the CNAME points at us and the certificate is issued, `active` once links on it answer, `failed` when verification gave up.
`domain.detail`	string, null	What a pending domain is waiting for, or why it failed. Null once active.
`domain.cname_target`	string	The DNS record to add at your DNS provider: a CNAME from the hostname to this target (customers.snip.link).
`domain.root_url`	string, null	Where the bare domain (https://go.example.com/) sends visitors. Null answers 404.
`domain.links`	integer	Links on this domain.
`domain.created_at`	string

Errors

Status	Meaning
401	The API key is missing, malformed or revoked.
404	No domain by that id or hostname 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 the guide