CustomDomain™ docs
API referenceMonitor

Every domain of the workspace with its last drift check

GET
/monitor/domains

The monitoring state of the domains in the API key's workspace (or one application with app_id), the ones needing attention first, a page at a time, with counts over every domain. Pass the previous page's next_cursor as cursor for the next page; there is no next_cursor on the last one. The per domain detail (watched records, repair route, history) is on GET /connections/{id}/monitor.

AuthorizationBearer <token>

Long-lived tenant API key, cd_live_… (production) or cd_test_… (staging, development), stored hashed. Keys created before the switch to cd_ start with sk_live_… / sk_test_… and are still accepted. Scoped to the owning application's tenant.

In: header

Query Parameters

app_id?string
limit?integer

Domains per page; a larger value is read as 1000.

Range1 <= value <= 1000
Default200
cursor?string

The previous page's next_cursor.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/monitor/domains"
{  "every": "string",  "auto_repair": true,  "next_cursor": "string",  "summary": {    "domains": 0,    "watched": 0,    "ok": 0,    "drift": 0,    "needs_action": 0,    "inconclusive": 0,    "not_checked": 0  },  "domains": [    {      "connection_id": "string",      "domain": "string",      "watched": true,      "active": true,      "every": "string",      "last_checked_at": "2019-08-24T14:15:22Z",      "next_check_at": "2019-08-24T14:15:22Z",      "result": "ok",      "drift_since": "2019-08-24T14:15:22Z",      "drift": [        {          "subdomain": "string",          "type": "string",          "verdict": "record_missing",          "expected": [            "string"          ],          "observed": [            "string"          ]        }      ],      "checked": 0,      "error": "string",      "action": {        "kind": "auto_fixed",        "at": "2019-08-24T14:15:22Z",        "description": "string"      },      "attention": "action_required",      "repair": {        "automatic": true,        "paused": true,        "via": "managed_dns",        "detail": "string"      },      "alerts": {        "webhooks": true,        "email": true      },      "watching": [        {          "name": "string",          "type": "string",          "value": "string"        }      ],      "history": [        {          "id": "string",          "application_id": "string",          "connection_id": "string",          "domain": "string",          "kind": "string",          "detail": {},          "created_at": "2019-08-24T14:15:22Z"        }      ],      "application_id": "string",      "status": "string"    }  ]}
{  "code": "string",  "title": "string",  "details": "string"}
{  "code": "string",  "title": "string",  "details": "string"}