Monitors

Get Monitor

Return a single monitor by id.

get/v1/monitors/{monitor_id}

Request

  • Base URL: https://api.fettle.sh (the document declares no server; this is the origin it was published from)
  • URL: https://api.fettle.sh/v1/monitors/{monitor_id}
  • Auth: API key in header Authorization

Path parameters

monitor_idstring uuid required

Headers

X-Organization-Idstring uuid nullable

Response

Successful Response

idstring uuid required
user_idstring uuid required
namestring required
type'HTTP' | 'PING' | 'SSL' | 'TCP' | 'DNS' required

Type of probe a worker must run for a :class:CheckJob.

targetstring required
interval_secondsinteger required
timeout_secondsinteger required
regionsstring[] required
configobject required
status'PENDING' | 'UP' | 'DEGRADED' | 'DOWN' | 'PAUSED' required

Aggregated state of a monitor as derived by the results state machine.

last_checked_atstring date-time nullable required
next_run_atstring date-time nullable required
confirmation_thresholdinteger required
notification_cooldown_secondsinteger required
ssl_expires_atstring date-time nullable required
is_activeboolean required
badge_enabledboolean
tagsstring[]
created_atstring date-time required
updated_atstring date-time required
channel_idsstring[]

Changes

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