CRcronitor
monitors

Create or update monitors

Upserts monitors by key. Send an array of monitors, or {"monitors": [...]} to receive the same shape back. A YAML body (Content-Type: application/yaml) imports a YAML configuration.

put/api/monitors

Request

  • Base URL
    https://cronitor.io
  • Auth
    HTTP basic

Headers

Cronitor-Version'2025-11-28' | '2020-10-01'

API version. These schemas describe 2025-11-28. Requests without the header get 2020-10-01. https://cronitor.io/docs/api#versioning

Request body

assertionsstring[] nullable

Assertions such as "response.code = 200" or "metric.queue_depth < 100".

failure_toleranceinteger nullable

Failures tolerated before an alert. Default 0.

grace_secondsinteger nullable

Seconds to wait after a missed or late event before alerting.

consecutive_alert_thresholdinteger
groupstring nullable

Group key.

keystring nullable

Unique monitor key. Required when creating a monitor.

metadatastring nullable
namestring
notestring nullable
pausedboolean
platformstring nullable
schedulesstring[] nullable

Cron expressions, intervals such as "every 5 minutes", or RRULEs.

schedule_toleranceinteger nullable

Missed runs tolerated before an alert. Default 0.

tagsstring[] nullable
timezonestring nullable

IANA timezone. Defaults to the account timezone.

type'job' | 'heartbeat' | 'check' | 'site'
environmentsstring[]
statuspagesstring[]

Status page keys.

sitestring nullable

RUM site key.

defaultNamestring
defaultNotestring
tolerated_failuresinteger

Use failure_tolerance.

Response

attributesobject nullable required

Values derived from the monitor configuration.

assertionsstring[] nullable

Assertions such as "response.code = 200" or "metric.queue_depth < 100".

createdstring date-time required
disabledboolean required
failure_toleranceinteger nullable

Failures tolerated before an alert. Default 0.

grace_secondsinteger nullable

Seconds to wait after a missed or late event before alerting.

consecutive_alert_thresholdinteger
groupstring nullable

Group key.

initializedboolean nullable required

Whether the monitor has received telemetry.

keystring nullable

Unique monitor key. Required when creating a monitor.

latest_eventsobject nullable required

Latest event of each kind, keyed by event name. Present with withEvents=true.

latest_invocationsobject[] nullable required

Present with withInvocations=true.

metric_namesstring[] nullable required
metadatastring nullable
namestring
next_expected_atnumber nullable required

Unix timestamp of the next scheduled run. Null when the monitor has no schedule. May include fractional seconds.

notestring nullable
passingboolean nullable required

Present when the request has withStatus=true (the default).

pausedboolean
platformstring nullable
runningboolean nullable required

Present when the request has withStatus=true (the default).

schedulesstring[] nullable

Cron expressions, intervals such as "every 5 minutes", or RRULEs.

schedule_toleranceinteger nullable

Missed runs tolerated before an alert. Default 0.

tagsstring[] nullable
timezonestring nullable

IANA timezone. Defaults to the account timezone.

type'job' | 'heartbeat' | 'check' | 'site'
environmentsstring[]
statuspagesstring[]

Status page keys.

sitestring nullable

RUM site key.

Changes

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