Monitor

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

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.

get/connections/{id}/monitor

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/connections/{id}/monitor
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring required

Response

The monitoring state

connection_idstring required
domainstring required
watchedboolean required
activeboolean required
everystring required

How often the domain is checked (hour).

last_checked_atstring date-time nullable required
next_check_atstring date-time
result'ok' | 'drift' | 'inconclusive' | 'unconfirmed' | 'not_checked' | 'not_watched' required

The last check. drift is only reported after a second, independent look at the zone's own nameservers confirmed it; inconclusive means the lookup did not answer and the previous finding stands; unconfirmed means the first lookup saw a change the zone's own nameservers could not be asked to confirm (see reason): earlier drift stands and nothing is restored.

reason'ns_lookup_failed' | 'timeout' | 'all_servers_refused' | 'no_server_answered' | 'delegated' | 'unsupported_type'

Set when result is unconfirmed, why the nameservers could not confirm.

unconfirmed_checksinteger

Set when result is unconfirmed, how many checks in a row. At 3 the workspace gets one inbox entry.

drift_sincestring date-time
checkedinteger required

Records compared in the last check.

errorstring
attention'action_required' | 'fix_failed' | 'drift'

Set while drift needs the tenant (action_required, fix_failed) or is being repaired (drift).

Changes

No recorded changes to this operation across all 1 revision of this API.