Monitoring

Start or stop watching a destination

Switching on queues an immediate check. Switching off keeps the history, so switching back on does not report a clean record.

put/links/{id}/monitor

Request

  • Base URL: https://fixed.link/api/v1
  • URL: https://fixed.link/api/v1/links/{id}/monitor
  • Auth: HTTP bearer

Path parameters

idstring required

Link ID

Request body

enabledboolean required

Response

The updated monitor

enabledboolean required
state'unknown' | 'up' | 'down' required

"unknown" until the first check completes, which is not the same as healthy.

lastCheckedAtstring date-time nullable required
lastStatusinteger nullable required

Status of the last response. Null when nothing answered at all.

lastReasonstring nullable required
lastLatencyMsinteger nullable required
changedAtstring date-time nullable required

When the state last changed, which is when the current outage started.

uptimePercentnumber required

Over the measured window, which is capped at the monitor’s own age.

measuredMsinteger required

Changes

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