Raw schema
{
"type": "object",
"properties": {
"url": {
"description": "The URL to monitor, e.g. https://example.com, tcp://host:port, icmp://host. Omit for pulse checks.",
"type": "string"
},
"type": {
"description": "Check type; inferred from the URL by default โ mainly useful for 'pulse'.",
"type": "string",
"enum": [
"https",
"http",
"icmp",
"pulse",
"tcp",
"tcps"
]
},
"period": {
"description": "Interval in seconds. Regular checks: 15, 30, 60, 120, 300, 600, 1800 or 3600 (default 60). Pulse checks: anywhere from 15 s to 1 month.",
"type": "integer",
"minimum": 15,
"maximum": 2678400
},
"apdex_t": {
"description": "APDEX threshold in seconds: 0.125, 0.25, 0.5, 1.0, 2.0, 4.0 or 8.0 (default 0.5).",
"type": "number"
},
"enabled": {
"description": "Whether the check runs. false pauses it (reversible).",
"type": "boolean"
},
"published": {
"description": "Whether the check's public status page is visible (default false).",
"type": "boolean"
},
"alias": {
"description": "Human-readable name for the check.",
"type": "string"
},
"string_match": {
"description": "Text that must appear in the response. For TCP/TCPS checks, '<closed>' inverts the check (alert if the port is open).",
"type": "string"
},
"mute_until": {
"description": "Mute notifications until a time (ISO8601, e.g. 2026-10-01T08:00:00Z), or 'recovery', or 'forever'.",
"type": "string"
},
"http_verb": {
"description": "HTTP verb for the request (default GET/HEAD).",
"type": "string",
"enum": [
"GET/HEAD",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS"
]
},
"http_body": {
"description": "HTTP body sent with the request.",
"type": "string"
},
"disabled_locations": {
"description": "Monitoring locations to disable: lan, mia, tor, rbx, fra, cap, hel, sin, tok, syd.",
"type": "array",
"items": {
"type": "string",
"enum": [
"lan",
"mia",
"tor",
"rbx",
"fra",
"cap",
"hel",
"sin",
"tok",
"syd"
]
}
},
"recipients": {
"description": "Alert recipient ids to select, e.g. ['email:12345', 'sms:67890'] (from updown_list_recipients).",
"type": "array",
"items": {
"type": "string"
}
},
"custom_headers": {
"description": "HTTP headers updown sends with each request, e.g. { \"X-Api-Key\": \"...\" }.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}