CustomDomain™ docs
API referenceMonitor

What the drift monitor last found for the domain, and what was done

GET
/connections/{id}/monitor

Every live domain is checked against its records once an hour. This returns the last check (when, the result, the drifted records with expected and observed values), what was done about drift (put back automatically with the continuous access CustomDomain™ holds, or left for the tenant because the record was changed rather than removed, because there is no continuous access, or because automatic repair is not switched on), whether repairs are automatic for this domain and why, the records it is held to, and the drift history. An end user's widget token (scope connect) reads this only when it is bound to the domain and minted with the connection's own end_user_ref; use an API key otherwise.

Automatic repair runs only where the deployment switched it on (MONITOR_AUTO_REPAIR; repair.paused is true otherwise). It puts back only the record sets that disappeared, from the records CustomDomain™ wrote (a kept Domain Connect authorization re-applies its template, the only write it allows), and only for drift that began after a clean check. A record missing since monitoring started is left for the tenant. Repairs are paced and capped per hourly pass and per provider account, and after 3 repairs of a domain within 24 hours the monitor stops and reports fix_failed.

Authorization

AuthorizationBearer <token>

Short-lived widget JWT minted server-side via POST /v1/tokens. Scoped to one application (and optionally one domain).

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/connections/string/monitor"
{  "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"    }  ]}
{  "code": "string",  "title": "string",  "details": "string"}
{  "code": "string",  "title": "string",  "details": "string"}
{  "code": "string",  "title": "string",  "details": "string"}