DomainManager
API

Domains API

List, add, remove and re-verify domains, and manage their services.

All endpoints are under /api/v1 and return JSON.

Method Path Scope
GET /domains domains:read
GET /domains/{id} domains:read
POST /domains domains:write
DELETE /domains/{id} domains:write
POST /domains/{id}/reverify domains:write
POST /domains/{id}/attach domains:write
POST /domains/{id}/detach domains:write
GET /domains/{id}/records dns:read
POST, PUT, DELETE /domains/{id}/records[/{record}] dns:write

To add a domain, send name, and optionally mode (ns or lite), group_id and service_ids:

curl -X POST https://your-domainmanager/api/v1/domains \
  -H "Authorization: Bearer <token>" -H "Accept: application/json" \
  -d name=example.com -d mode=ns

Adding a domain held by another account returns 409; start a claim from the app. An invalid name, or a domain already in your team, returns 422 with the reason.

Still stuck? Talk to us.