Monitors

Precheck Monitor Target

Probe a target once before creating a monitor to flag if it looks down.

post/v1/monitors/precheck

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

Headers

X-Organization-Idstring uuid nullable

Request body

type'HTTP' | 'PING' | 'SSL' | 'TCP' | 'DNS' required

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

targetstring required
configobject

Response

Successful Response

status'up' | 'down' | 'error' | 'unknown' required

Advisory outcome of a У2 pre-check, returned to the create-monitor form.

UP/DOWN/ERROR map from the worker's CheckResultStatus; UNKNOWN is the fail-open value used whenever the core cannot get a definite reply (no worker in the region, request timeout, malformed reply, or the pre-check kill switch). Only DOWN/ERROR should gate the form with a modal; UP/UNKNOWN proceed to create directly.

regionstring required
response_time_msinteger nullable
status_codeinteger nullable
errorstring nullable
failure_kind'TIMEOUT' | 'DNS_FAILURE' | 'CONNECTION_REFUSED' | 'TLS_INVALID' | 'HTTP_4XX' | 'HTTP_5XX' | 'HTTP_UNEXPECTED_STATUS' | 'KEYWORD_MISSING' | 'TOO_MANY_REDIRECTS' | 'TARGET_BLOCKED' | 'PORT_STATE_MISMATCH' | 'INVALID_TARGET' | 'UNKNOWN'

Structured classification of why a probe reported a non-UP result.

Set by the worker on DOWN/ERROR outcomes so the core can store a typed incident cause (icons, grouping, filtering) while CheckResult.error / the incident's cause_detail carry the raw human-readable reason. Absent on UP results.

Changes

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