Create a check
updown_create_checkAdd a new monitoring check. The type (http, https, tcp, tcps, icmp) is inferred from the URL scheme; pass type 'pulse' (and no URL) for a cron/heartbeat check. Each check consumes updown credits while enabled. Requires the read/write API key. updown: POST /api/checks.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | The URL to monitor, e.g. https://example.com, tcp://host:port, icmp://host. Omit for pulse checks. | |
| type | No | Check type; inferred from the URL by default — mainly useful for 'pulse'. | |
| alias | No | Human-readable name for the check. | |
| period | No | 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. | |
| apdex_t | No | APDEX threshold in seconds: 0.125, 0.25, 0.5, 1.0, 2.0, 4.0 or 8.0 (default 0.5). | |
| enabled | No | Whether the check runs. false pauses it (reversible). | |
| http_body | No | HTTP body sent with the request. | |
| http_verb | No | HTTP verb for the request (default GET/HEAD). | |
| published | No | Whether the check's public status page is visible (default false). | |
| mute_until | No | Mute notifications until a time (ISO8601, e.g. 2026-10-01T08:00:00Z), or 'recovery', or 'forever'. | |
| recipients | No | Alert recipient ids to select, e.g. ['email:12345', 'sms:67890'] (from updown_list_recipients). | |
| string_match | No | Text that must appear in the response. For TCP/TCPS checks, '<closed>' inverts the check (alert if the port is open). | |
| custom_headers | No | HTTP headers updown sends with each request, e.g. { "X-Api-Key": "..." }. | |
| disabled_locations | No | Monitoring locations to disable: lan, mia, tor, rbx, fra, cap, hel, sin, tok, syd. |