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.
无需输入参数。
Enabled probe regions: id, name, and region.
无需输入参数。
Checks in this workspace. Use this before create_check so you do not add a second check for a URL that is already watched.
无需输入参数。
One check, including assertion, DNS, and TCP fields. Secrets such as request headers, request body, and HTTP auth are not returned.
输入参数endpoint_id必填
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.
输入参数view必填hoursendpoint_id必填
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.
输入参数kind必填name必填porttarget必填regionssite_idsite_slugdns_serververify_sslhttp_methodtcp_payloadcomponent_id另有 16 个
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.
输入参数nameporttargetenabledregionssite_idsite_slugdns_serververify_sslendpoint_id必填http_methodtcp_payload另有 17 个
Delete a check. Run only when the user asked to delete this check in this conversation.
输入参数endpoint_id必填
Queue a probe for one check from each of its live regions (the same regions a scheduled run uses). Returns job_id and regions. Call get_check_results with view status for the result; it is not included here.
输入参数endpoint_id必填
Status pages in this workspace: slug, name, visibility, publicUrl, custom domain, and the worst open incident status.
无需输入参数。
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.
输入参数slug必填
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.
输入参数urlname必填slug必填passwordvisibilityendpoint_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.
输入参数urlnameslug必填passwordvisibilitycustom_domainshow_auto_detected
Delete a status page and its components. Run only when the user asked to delete this page in this conversation.
输入参数slug必填
Check the CNAME and TXT records for a status page custom domain.
输入参数slug必填
Add a component to an existing status page. Returns its id so update_check can link a check to it.
输入参数urlname必填slug必填
Rename a component or change its URL.
输入参数urlnameslug必填component_id必填
Delete a component. Run only when the user asked to delete this component in this conversation.
输入参数slug必填component_id必填
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.
输入参数nameslug必填action必填group_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.
输入参数slug必填action必填
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.
输入参数slug必填destination_ids必填
Drafts waiting for review from checks in incident_mode review, pending first. Approving one publishes it as a status incident.
输入参数slug必填
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.
输入参数bodyslug必填titleimpactproposal_id必填
dismiss_incident_proposal
Dismiss a pending review draft. Nothing is published.
输入参数slug必填proposal_id必填
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.
输入参数body必填slug必填title必填impact必填status必填opened_atresolved_atcomponent_ids
One incident, including updates newest first.
输入参数slug必填public_id必填
Edit an incident's title or impact. Run only when the user asked. With update_id and update_body, rewrite that posted update's message (no new notification). To change status, post a message, or resolve, use post_incident_update instead.
输入参数bodyslug必填titleimpactstatuspublic_id必填update_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.
输入参数body必填slug必填status必填public_id必填
Maintenance windows: id, name, starts_at, duration_seconds, timezone, recurrence, weekdays, ends_at, notify_subscribers, and items.
无需输入参数。
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.
输入参数name必填timezone必填weekdaysstarts_at必填endpoint_idsduration_seconds必填status_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.
输入参数nametimezoneweekdaysstarts_atwindow_id必填endpoint_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.
输入参数window_id必填notify_subscribers
Existing alert destinations: id, kind, name, and hint. Secrets are not returned. Creating a destination stays in the console.
无需输入参数。
Send a real test alert to an existing destination. Run only when the user asked to send the test.
输入参数destination_id必填