Monitors

Create Monitor

Create a new monitor for the active organization.

Plan limits apply to the monitor count, the minimum interval, monitors checked more often than every 60 seconds and the number of regions; GET /v1/plans/usage shows them and what is left. Send is_active: false to create it paused — no check runs until you resume it.

post/v1/monitors

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
  • Auth: API key in header Authorization

Headers

X-Organization-Idstring uuid nullable

Request body

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
confirmation_thresholdinteger nullable
notification_cooldown_secondsinteger nullable
channel_idsstring[] nullable
tagsstring[]
is_activeboolean

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.