get_check | Get one check definition (same fields as list_checks, secrets removed). Required: id (check UUID, see list_checks or list_check_statuses). Optional: includeDependencies (boolean), applyGroupSettings (boolean: return the check with its group settings applied). |
get_check_group | Get one check group (same fields as list_check_groups, secrets removed). Required: id (integer group ID, see list_check_groups). |
get_check_session | Get a check session started by trigger_check_session: status (STARTED, PROGRESS, PASSED, FAILED, DEGRADED, TIMED_OUT, CANCELLED…), run locations, elapsed time and one summary per result (hasFailures, hasErrors, isDegraded, responseTime). |
get_check_status | Get the current status of one check (hasFailures, hasErrors, isDegraded, longest/shortest run, last run location). |
get_maintenance_window | Get one maintenance window by its ID (integer, see list_maintenance_windows). |
get_report | Aggregated statistics per check (successRatio, avg, p95, p99 response times) over a window. Optional: quickRange (last24Hrs default, last7Days, last30Days, thisWeek, thisMonth, lastWeek, lastMonth) or from / to (UNIX timestamps in seconds, as strings, override quickRange), filterByTags (array of tag strings), deactivated (boolean: true = only deactivated checks, false = only active ones), granularity (day, week, month: one aggregate per bucket), timezone (IANA name, e.g. “Europe/Paris”, used with granularity). |
get_status_page | Get one status page by its UUID (see list_status_pages). |
list_alert_channels | List alert channels: id, type (EMAIL, SLACK, SLACK_APP, WEBHOOK, SMS, PAGERDUTY, OPSGENIE, CALL), subscriptions (checkId / groupId, activated), sendRecovery, sendFailure, sendDegraded, sslExpiry, autoSubscribe. The channel config (URLs, keys, addresses) is removed. Optional: limit (1–100, default 10), page (from 1). |
list_check_alerts | List the alerts sent for the account within a 6-hour window (default: the last 6 hours): check name, checkId, alertType, runLocation, error, statusCode. Optional: from / to (UNIX timestamps in seconds, as strings, at most 6 hours apart), limit (1–100, default 10), page (from 1). |
list_check_alerts_for_check | List the alerts sent for one check within a 6-hour window (default: the last 6 hours). Optional: from / to (UNIX timestamps in seconds, as strings, at most 6 hours apart), limit (1–100, default 10), page (from 1). |
list_check_groups | List check groups: id (integer), name, activated, muted, tags, locations, concurrency, runtimeId, apiCheckDefaults (url, assertions — no headers, query parameters nor basic auth), environment variable keys (values removed), alertChannelSubscriptions. Optional: limit (1–100, default 10), page (from 1), tag (array of tag strings, any match), name (array of exact group names). |
list_check_results | List the latest raw results of one check (kept 30 days): id, runLocation, hasFailures, hasErrors, isDegraded, responseTime, startedAt, stoppedAt, attempts, resultType, errorGroupIds. Request/response payloads are never returned. Optional filters: limit (1–100, default 10), location (e.g. “eu-west-1”), checkType, hasFailures (boolean), resultType (“FINAL” default, “ATTEMPT” or “ALL”), from / to (UNIX timestamps in seconds, numbers), nextId (cursor returned by the previous page). Rate limit: 60 requests per minute. |
list_check_statuses | List the current status of every check in the account (name, checkId, hasFailures, hasErrors, isDegraded, last run location, SSL days remaining). Use it to find check UUIDs. |
list_checks | List check definitions: id, name, checkType, activated, muted, frequency, locations, tags, groupId, request (method, url, bodyType, assertions — no headers, query parameters, body nor basic auth), script, alertChannelSubscriptions, environment variable keys (values removed), heartbeat period (ping token removed). Optional: limit (1–100, default 10), page (from 1), search (name, partial match), checkType (API, BROWSER, HEARTBEAT, MULTI_STEP, TCP, PLAYWRIGHT, URL, DNS, SSL, ICMP, TRACEROUTE, GRPC, AGENTIC), status (passing, failing, degraded), tag (array of tag strings, any match), apiCheckUrlFilterPattern (string contained in an API check URL), applyGroupSettings (boolean). |
list_dashboards | List dashboards: dashboardId, header, customUrl, customDomain, tags, isPrivate, refreshRate, paginate and display settings. Private dashboard keys are removed. Optional: limit (1–100, default 10), page (from 1). |
list_locations | List the public data-center locations checks can run from (region code, e.g. “eu-west-1”, and name). |
list_maintenance_windows | List maintenance windows (name, tags, startsAt, endsAt, repeat rule, timezone, whether checks are paused or alerts silenced). Optional: limit (1–100, default 10), page (from 1). |
list_status_pages | List the status pages of the account (name, url, custom domain, private or public). Optional: limit (1–100, default 20), nextId (cursor returned by the previous page). |