Docs/API reference
API REFERENCEDomains
Add, list, update and check the domains of your workspace.
GET/domains
POST/domains
GET/domains/{id}
PATCH/domains/{id}
POST/domains/{id}/check
DELETE/domains/{id}
List parameters
The domain object
{
"id": "dom_01J9Z3K8V6Q2M4N7P5R8T0W1XY",
"name": "harborgoods.com",
"display_name": "harborgoods.com",
"label": "Harbor Goods shop",
"status": "expiring",
"registrar": "OVH SAS",
"expires_at": "2026-10-04",
"expiry_source": "whois",
"days_left": 8,
"auto_renew": null,
"checks": { "whois": true, "ssl": true, "dns": true, "email": false },
"ssl": {
"issuer": "Let's Encrypt R11",
"valid_to": "2026-11-02",
"days_left": 37,
"state": "valid",
"auto_renew": "detected"
},
"dns": { "ns": ["dns110.ovh.net", "ns110.ovh.net"], "dmarc": "p=none" },
"tags": ["Client"],
"teams": ["team_01J9Z3M2QK7T4V8W1X5Y9Z3A6B"],
"source": "api",
"added_at": "2026-09-20T08:14:03Z",
"last_checked_at": "2026-09-26T06:00:12Z"
}Add and update parameters
Checks and limits
Was this page helpful?