CRcronitor
telemetry

Send a telemetry event

Records a job or heartbeat event. Every request returns 200, even with an invalid key: authentication happens after ingestion. https://cronitor.io/docs/telemetry-api

get/p/{apiKey}/{monitorKey}

Request

  • Base URL
    https://cronitor.link
  • Auth
    none required

Path parameters

apiKeystring required

An API key with the monitor:telemetry scope. Telemetry keys are not secret.

monitorKeystring required

The monitor key. An unknown key creates a monitor.

Query parameters

state'run' | 'complete' | 'fail' | 'tick' | 'ok'

Omit to record a tick. ok resets the monitor to passing.

messagestring
seriesstring

Matches a run event with its complete or fail event.

metricstring[]

A metric in name:value form. Repeat for multiple metrics.

[
  "count:100"
]
envstring
hoststring
status_codeinteger

The exit code returned by the job.

Response

Event accepted.

Changes

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