Monitoring

Switch on monitoring

Only for a verified, authorised domain, within the organisation's monitored-domain limit. The first scheduled check runs within a few minutes unless a full check finished in the last day.

post/v1/domains/{domainId}/monitoring

Request

  • Base URL: https://api.ironfang.com/security
  • URL: https://api.ironfang.com/security/v1/domains/{domainId}/monitoring
  • Auth: HTTP bearer

Request body

frequency'daily' | 'weekly' required

Response

Monitoring is on.

availableboolean required

Whether monitoring can be switched on or changed now.

consecutive_failuresinteger required
domainstring required
domain_idstring uuid required
frequenciesMonitoringFrequency[] required

The frequencies this organisation may choose.

frequency'daily' | 'weekly'
health'healthy' | 'delayed' | 'attention' | 'paused' | 'off' required

healthy; delayed (a scheduled check is waiting on Ironfang's capacity); attention (recent scheduled checks could not complete); paused; off.

last_completed_atstring date-time nullable
last_scheduled_atstring date-time nullable
last_successful_scan_idstring uuid nullable
next_run_atstring date-time nullable
schedulestring nullable

When checks run, e.g. "Tuesdays around 03:17 UTC".

state'off' | 'pending_first_run' | 'active' | 'paused' | 'paused_verification_lost' | 'paused_authorisation' | 'paused_repeated_failures' | 'paused_by_ironfang' required

off (never switched on, or switched off), pending_first_run, active, paused (by the customer), paused_verification_lost, paused_authorisation, paused_repeated_failures, paused_by_ironfang.

state_reasonstring nullable

Why monitoring is paused, in words the customer can act on.

unavailable_reasonstring nullable

Changes

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