Add a custom domain

POSThttps://api.norreach.app/v1/sites/{id}/domains

Adds your own domain (e.g. go.example.com) to a site. The answer lists the DNS records to set at your domain's provider; then call verify.

pages:domainsRole must allow: pages.domainsOperation id: add_site_domain

POST/sites/{id}/domains

curl -X POST "https://api.norreach.app/v1/sites/{id}/domains" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "hostname": "go.acme.example"
}'

Add a custom domain

{
  "object": "list",
  "data": [],
  "has_more": false,
  "next_cursor": null
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope pages:domains. API keys and scopes

Path parameters

idstring (uuid)pathrequired

An id (UUID).

Headers

Idempotency-Keystringheader

Any unique string (≤ 255). The same key with the same request returns the first answer for 24 hours.

Body

application/json

hostnamestringrequired

Response

201application/json— Add a custom domain

object"list"required

dataobject[]required

Show child attributes

data[].idstring (uuid)required

An id (UUID).

data[].object"domain"required

data[].hostnamestringrequired

data[].statusstringrequired

Where setting it up has got to (e.g. pending, active, misconfigured).

data[].is_primarybooleanrequired

data[].redirect_tostring | nullrequired

data[].recordsanyrequired

The DNS records to set at your domain's provider.

data[].last_errorstring | nullrequired

data[].last_checked_atstring | nullrequired

has_morebooleanrequired

next_cursornullrequired

Errors

Errors are application/problem+json with a stable code.

Status	Code	Meaning
400	`bad_request`	The request couldn't be read.
400	`unknown_field`	The request has a field this operation doesn't know.
401	`unauthorized`	A valid API key is required.
403	`insufficient_scope`	This API key doesn't have the scope this operation needs.
403	`feature_not_enabled`	The API isn't switched on for this workspace.
403	`role_forbidden`	The key's creator's role can't do this.
404	`not_found`	That doesn't exist.
409	`idempotency_in_progress`	A request with this Idempotency-Key is still running.
413	`too_large`	The request body is too large.
422	`validation_failed`	The request has invalid fields.
422	`idempotency_mismatch`	This Idempotency-Key was used with a different request.
429	`rate_limited`	Too many requests. Slow down and try again.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

POST/sites/{id}/domains

curl -X POST "https://api.norreach.app/v1/sites/{id}/domains" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "hostname": "go.acme.example"
}'

Add a custom domain

{
  "object": "list",
  "data": [],
  "has_more": false,
  "next_cursor": null
}