Plan caps for this workspace: plan, period, probe_count, monthly_probe_quota, endpoints_used, max_endpoints, max_regions, min_interval_seconds, sample_retention_days, max_status_pages. Call this before creating anything. Stop when a cap is reached.
Takes no parameters.
Enabled probe regions: id, name, and region.
Takes no parameters.
Checks in this workspace. Use this before create_check so you do not add a second check for a URL that is already watched.
Takes no parameters.
One check, including assertion, DNS, and TCP fields. Secrets such as request headers, request body, and HTTP auth are not returned.
Parametersendpoint_idrequired
Check results. view is status, history, or outages. history uses hours (default 24) and returns status, status_code, latency_ms, dns_ms, connect_ms, location_name, location_region, and observed_at. Sample metadata is omitted.
Parametersviewrequiredhoursendpoint_idrequired
Create a check. kind is http, api, dns, or tcp. Defaults: GET, status 200, 10s timeout, email alerts on, interval_seconds from the plan minimum, and one region. DNS defaults to an A record over UDP. TCP requires port. Pass regions only when you want more than the default, and only within max_regions from usage. Request headers, request body, and HTTP auth stay in the console. To link a status page, pass site_id, site_slug, and component_id together.
Parameterskindrequirednamerequiredporttargetrequiredregionssite_idsite_slugdns_serververify_sslhttp_methodtcp_payloadcomponent_id+16 more
Update a check. Pass only the fields to change. enabled false pauses and true resumes. Linking requires site_id, site_slug, and component_id together, plus optional incident_mode (off, auto, or review: review stores a draft a person approves before it is published), incident_auto_resolve, and display_metrics. Request headers, request body, and HTTP auth stay in the console.
Parametersnameporttargetenabledregionssite_idsite_slugdns_serververify_sslendpoint_idrequiredhttp_methodtcp_payload+17 more
Delete a check. Run only when the user asked to delete this check in this conversation.
Parametersendpoint_idrequired
Queue a probe for one check. Returns job_id. Call get_check_results with view status for the result; it is not included here.
Parametersendpoint_idrequired
Status pages in this workspace: slug, name, visibility, publicUrl, custom domain, and the worst open incident status.
Takes no parameters.
One status page: components with ids, groups, incidents with public ids, Slack connection state, and alert-destination ids. has_password is returned; the password is not.
Parametersslugrequired
Create a public status page. visibility internal requires Pro and a password of at least 8 characters that the user typed; never invent a password or repeat it. custom_domain is a hostname such as status.acme.com and requires Pro. With endpoint_ids, each check becomes a component linked to the page with incidents and latency enabled. Returns slug, publicUrl, component ids, and linked check ids. If a later step fails, the new page is deleted.
Parametersurlnamerequiredslugrequiredpasswordvisibilityendpoint_idscustom_domain
Update a status page. Fields: name, url, visibility, password, custom_domain, show_auto_detected (label incidents a check opened itself as detected automatically). custom_domain null removes it. visibility internal needs a password of at least 8 characters that the user typed. Never invent a password or repeat it.
Parametersurlnameslugrequiredpasswordvisibilitycustom_domainshow_auto_detected
Delete a status page and its components. Run only when the user asked to delete this page in this conversation.
Parametersslugrequired
Check the CNAME and TXT records for a status page custom domain.
Parametersslugrequired
Add a component to an existing status page. Returns its id so update_check can link a check to it.
Parametersurlnamerequiredslugrequired
Rename a component or change its URL.
Parametersurlnameslugrequiredcomponent_idrequired
Delete a component. Run only when the user asked to delete this component in this conversation.
Parametersslugrequiredcomponent_idrequired
Create, update, or delete a component group. action is create, update, or delete. create and update need name. update and delete need group_id. Delete only when the user asked.
Parametersnameslugrequiredactionrequiredgroup_id
Slack connection for a status page. action start returns a URL for the user to open; do not complete OAuth. action disconnect removes the connection. Disconnect only when the user asked. Connection state is on get_status_page.
Parametersslugrequiredactionrequired
Replace the alert destinations attached to a status page with these existing destination ids. Use list_alert_destinations for the ids. An empty list detaches all of them.
Parametersslugrequireddestination_idsrequired
Drafts waiting for review from checks in incident_mode review, pending first. Approving one publishes it as a status incident.
Parametersslugrequired
approve_incident_proposal
Publish a pending review draft as a status incident. This emails subscribers and posts to Slack. Run only when the user asked to publish it in this conversation. Optional title, body, and impact (minor, major, or critical) replace the draft text.
Parametersbodyslugrequiredtitleimpactproposal_idrequired
dismiss_incident_proposal
Dismiss a pending review draft. Nothing is published.
Parametersslugrequiredproposal_idrequired
Open an incident. This emails subscribers and posts to Slack the same way the console does. Run only when the user asked to publish this incident in this conversation. status is investigating, identified, monitoring, or resolved. impact is minor, major, or critical. component_ids are component public ids. opened_at with resolved_at backfills a past incident.
Parametersbodyrequiredslugrequiredtitlerequiredimpactrequiredstatusrequiredopened_atresolved_atcomponent_ids
One incident, including updates newest first.
Parametersslugrequiredpublic_idrequired
Edit an incident. This can email subscribers and post to Slack. Run only when the user asked. With update_id, edit that posted update instead of the incident. Never invent a status the user did not ask for.
Parametersbodyslugrequiredtitleimpactstatuspublic_idrequiredupdate_idupdate_bodycomponent_ids
Post an incident update. This emails subscribers and posts to Slack. Run only when the user asked to publish this update in this conversation. status resolved closes the incident.
Parametersbodyrequiredslugrequiredstatusrequiredpublic_idrequired
Maintenance windows: id, name, starts_at, duration_seconds, timezone, recurrence, weekdays, ends_at, notify_subscribers, and items.
Takes no parameters.
create_maintenance_window
Schedule a maintenance window. duration_seconds is 60 through 7 days. Pass both the check (endpoint_ids) and its public component (status_components) so probes pause and the page shows Under maintenance. notify_subscribers defaults to false. Set it true only when the user asked to email subscribers. This can email subscribers, so run only when the user asked to schedule this window.
Parametersnamerequiredtimezonerequiredweekdaysstarts_atrequiredendpoint_idsduration_secondsrequiredstatus_componentsnotify_subscribers
update_maintenance_window
Update a maintenance window. notify_subscribers defaults to false unless you set it. This can email subscribers. Run only when the user asked to change this window.
Parametersnametimezoneweekdaysstarts_atwindow_idrequiredendpoint_idsduration_secondsstatus_componentsnotify_subscribers
cancel_maintenance_window
Cancel a maintenance window. notify_subscribers defaults to false. This can email subscribers. Run only when the user asked to cancel this window in this conversation.
Parameterswindow_idrequirednotify_subscribers
Existing alert destinations: id, kind, name, and hint. Secrets are not returned. Creating a destination stays in the console.
Takes no parameters.
Send a real test alert to an existing destination. Run only when the user asked to send the test.
Parametersdestination_idrequired