Source
API documentation — updown.io
Checked for updown.io on 1 Nov 2026
- Page
- https://updown.io/api
- Checked
- 1 Nov 2026, 10:42 UTC
- How we may use it
- Public page, crawling permitted
Technical details
- type
- page
- http status
- 200
- content hash
- sha256:2a869001aceb91bfccffdd11675c4242e00f4deba29979615f2d206c6d5e32c1
- permission
- robots_ok
- screenshot
- Screenshot on file (internal exhibit, not published)
Cited by
Facts read from this source
-
Rest API Report an error
“The REST API ⇣ allows you to fetch your metrics and automate your checks administration. It's a simple HTTPS API returning JSON.”
-
API endpoints Report an error
“GET /api/checks ⇣ – List all your checks.”
-
Webhooks Report an error
“The Push API (webhooks) ⇣ allows you to receive updates in real time when your checks goes up or down.”
-
Webhook events Report an error
“check.down ⇣ – When a check goes down (after confirmation)”
-
Dns API Report an error
“We maintain some DNS records allowing you to easily automate some tasks like whitelisting our IPs in your firewall (supported by PFSense for example).”
-
API auth Report an error
“All API calls require authentication with an API key which can be passed either as a URL query parameter ?api-key= or as an HTTP header X-API-KEY:”
-
Readonly API key Report an error
“We also offer read-only API key so you can build public integrations (like a truly custom status page or TV dashboard) directly in javascript without giving away your read/write access.”
-
Readonly get only Report an error
“This API key will only work with GET endpoints (green).”
-
Gzip Report an error
“All API calls supports gzip compression and we recommend enabling it to increase response speed and save bandwidth.”
-
Check types Report an error
“The type of check to create (https, http, icmp, pulse, tcp or tcps).”
-
Check intervals Report an error
“Interval in seconds (15, 30, 60, 120, 300, 600, 1800 or 3600 for regular checks). Between 15 sec and 1 month for pulse checks”
-
Monitoring locations Report an error
“Can be any of these: ["lan", "mia", "tor", "rbx", "fra", "cap", "hel", "sin", "tok", "syd"].”
-
String match Report an error
“Search for this string in the page.”
-
Custom headers Report an error
“The HTTP headers you want in updown requests.”
-
Http verb options Report an error
“The HTTP verb used to perform the request ('GET/HEAD', 'POST', 'PUT', 'PATCH', 'DELETE' or 'OPTIONS')”
-
Apdex thresholds Report an error
“APDEX threshold in seconds (0.125, 0.25, 0.5, 1.0, 2.0, 4.0 or 8.0)”
-
Recipient types API Report an error
“Type of recipient ('email', 'sms', 'webhook', 'slack_compatible' or 'msteams' only). The other integrations (slack, telegram, zapier, statuspage, etc.) require the web UI to setup.”
-
Recipient channels Report an error
“The "id" attribute is the one you need to select recipients in the checks API.”
-
Status page visibility Report an error
“Page visibility, can be either 'public', 'protected' or 'private'”
-
Status page access key Report an error
“Access key for protected pages, defaults to a 30-bytes random string if unset”
-
Metrics time range default Report an error
“Start time, default to 1 month ago”
-
Webhook retry Report an error
“Any other response will be considered an error and the webhook request will be retried up to 25 times across several days.”
-
Webhook removal Report an error
“After 1000 failed deliveries, the webhook endpoint will be automatically removed from your account.”
-
Downtimes paging Report an error
“The page to fetch (100 per page)”
-
Client libraries Report an error
“Ruby: askehansen/updown-ruby (also offers a CLI)”
-
Nodes API Report an error
“GET /api/nodes ⇣ – List all updown.io servers (monitoring & webhooks)”
-
Ip format Report an error
“Response format, supports either json or txt.”
-
Time formats Report an error
“ISO8601, ex: 2011-10-05T22:26:12-04:00 RFC2822, ex: Wed, 05 Oct 2011 22:26:12 -0400”
-
Performance drop alert Report an error
“When the Apdex drops more than 30% below the lowest of the last 5 hours.”
-
Ssl expiration alert Report an error
“When your SSL certificate approaches expiration date (1, 7, 14, and 30 days before for 1y certs)”
-
Domain expiration alert Report an error
“When your domain name approaches expiration date (14, 7, and 1 days before, if enabled) ← NEW”
-
Company origin Report an error
“Made with in Paris, France since 2012”
1 fact read from this page is not shown because it could not be confirmed on the page as captured.
Scores citing this record
- The Agency Developer Checks, locations & failure confirmation
- The Agency Developer Alerting, escalation & on-call
- The Agency Developer Status pages & incident communication
- The Agency Developer API, monitoring as code & team administration
- The Customer Support Lead Checks, locations & failure confirmation
- The Customer Support Lead Status pages & incident communication
- The Customer Support Lead API, monitoring as code & team administration
- The Customer Support Lead Uptime reports, data & the vendor's own reliability
- The E-Commerce Operations Manager Checks, locations & failure confirmation
- The E-Commerce Operations Manager Alerting, escalation & on-call
- The E-Commerce Operations Manager Status pages & incident communication
- The E-Commerce Operations Manager API, monitoring as code & team administration
- The SaaS Platform Engineer Checks, locations & failure confirmation
- The SaaS Platform Engineer Status pages & incident communication
- The SaaS Platform Engineer API, monitoring as code & team administration
- The SaaS Platform Engineer Uptime reports, data & the vendor's own reliability
- The Information Security Officer Checks, locations & failure confirmation
- The Information Security Officer Status pages & incident communication
- The Information Security Officer API, monitoring as code & team administration
- The Skeptic Checks, locations & failure confirmation
- The Skeptic Alerting, escalation & on-call
- The Skeptic Status pages & incident communication
- The Skeptic API, monitoring as code & team administration