Server definition
- Hash
- sha256:6b9c35d8344d0bf01f147cba7c44a9c9c515741ff4d0c16fc8f3ab1f48827f2b
- What it is
- What a remote MCP server returned when asked what it offers: 59 tools
The blob, as servednamed by its sha256
{
"instructions": "UpHeron monitors websites, APIs, certificates, DNS and mail servers from several locations.\n- Reading (list_monitors, get_monitor, get_uptime_history, list_incidents, get_incident, check_website) is free.\n- During an outage, post_incident_update tells the visitors of the status pages that show the monitor (and their email subscribers) what is going on; comment_on_incident records notes for the team. For a problem the checks cannot see, open_incident opens one by hand and resolve_incident closes it.\n- Before create_monitor, call get_account: a workspace has as many monitors as its plan's slots. Premium monitors (micro_transaction, transaction, extended_transaction, repository) have slots of their own, on Pro and Business only. With every slot in use, the user upgrades at https://upheron.com/pricing.\n- Pass idempotency_key to create_monitor so a retry never creates a second monitor.\n- To bring monitors over from UptimeRobot, Better Stack, Uptime Kuma or a CSV file, call preview_monitor_import, show the user what would be created and skipped, then import_monitors with the ones they choose.\n- WebSocket and gRPC checks (websocket, grpc) come with Pro and Business; get_account says so in service_checks. On a smaller plan a monitor's plan_hold says what the plan paused: the monitor itself (paused), or its faster interval_seconds and extra locations; a bigger plan restores them.\n- A monitor down for weeks has long_outage: stops_at (its checks stop then if it is still down; the workspace's contacts were emailed) or stopped_at (UpHeron paused it after 30 days down). Resuming it counts again from then. Nobody opening the workspace in the dashboard after the warning gets it deleted instead.\n- To watch a code repository for vulnerable dependencies, create_monitor with kind \"repository\" and the GitHub or GitLab URL; a private repository needs check_options.token and the Pro plan.\n- On every plan, http and api monitors can alert on vulnerabilities in the website's software (vulnerability_alerts), checked daily and within 15 minutes of a new advisory on every plan; the website is scanned for its software weekly on Free and daily on Pro and Business. On Pro and Business, if you know or can read what the server runs, send it with import_software, or link the website's GitHub or GitLab repository with repository_url (and repository_token if private) for its exact dependency versions; read the findings with get_vulnerabilities.\n- Poll a monitor no faster than its interval_seconds. Docs: https://upheron.com/docs (also as Markdown at https://upheron.com/llms-full.txt).",
"tools": [
{
"description": "Makes the page as it is now the new baseline of a monitor with content_watch, after get_website_changes shows a change you or the site's owner made on purpose. Later looks compare with it. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Monitor ID from list_monitors.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "accept_page_change",
"outputSchema": null
},
{
"description": "Marks an open incident as being handled: its repeat alerts and escalation stop. Everyone alerted still hears when it recovers. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Incident ID from list_incidents.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "acknowledge_incident",
"outputSchema": null
},
{
"description": "Adds an email address, chat channel, paging service, Jira project, webhook or phone number to alert on outages and recoveries. Email contacts must open a confirmation link before they receive alerts. A phone number texts or calls through the user's own account with a provider, on every plan, which bills them: twilio (Account SID, Auth Token) and plivo (Auth ID, Auth Token) text or call, vonage (API key and secret) and telnyx (API key) text. The user gives you the credentials and the sender, one of the account's numbers or for texts a sender ID of up to 11 letters and digits (not in the US or Canada). It needs no code: check it with test_notification_contact. sms and voice, through UpHeron's own Twilio account, are no longer added.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"destination": {
"description": "Email address; webhook URL (slack, discord, teams, google_chat, mattermost, rocketchat, ntfy, webhook, zapier: its Catch Hook URL); Telegram chat ID; PagerDuty or ilert integration key, Pushover user key or Opsgenie API key; Splunk On-Call REST endpoint URL; Jira site URL (https://your-team.atlassian.net); or for twilio, vonage, plivo and telnyx the phone number to alert, with its country code (+359…).",
"type": "string"
},
"error_types": {
"description": "Alert about the outages of these kinds of errors only, and their recoveries; null or left out for every kind. timeout, connection (refused, reset, unreachable, no reply), dns, tls (handshake and certificate verification), http_5xx, http_4xx, http_status (other unexpected statuses), content (missing text, a failed JSON assertion, a wrong reply), slow (latency threshold, performance score), heartbeat (missed or failed runs), expiry (certificate and domain monitors) and other. Expiry reminders, vulnerability and port alerts are not filtered.",
"items": {
"enum": [
"timeout",
"connection",
"dns",
"tls",
"http_5xx",
"http_4xx",
"http_status",
"content",
"slow",
"heartbeat",
"expiry",
"other"
],
"type": "string"
},
"type": [
"array",
"null"
]
},
"kind": {
"description": "Every plan alerts by email and through your own account with a texting provider, which bills you: `twilio` and `plivo` text or call, `vonage` and `telnyx` text (no code to confirm, send a test instead); the other kinds need a paid plan (pay-as-you-go workspaces: email, webhook, twilio, vonage, plivo and telnyx). `sms` and `voice`, texts and calls through UpHeron's own Twilio account, are no longer added (422 `phone_kind_retired`); contacts added before keep working and confirm with a code (`/alert-channels/{id}/confirm`). Push notifications to a device are added in the dashboard.",
"enum": [
"email",
"slack",
"discord",
"teams",
"google_chat",
"mattermost",
"rocketchat",
"telegram",
"pagerduty",
"opsgenie",
"splunk_oncall",
"ilert",
"pushover",
"ntfy",
"jira",
"webhook",
"zapier",
"twilio",
"vonage",
"plivo",
"telnyx"
],
"type": "string"
},
"name": {
"description": "Your name for the contact, such as \"Ops email\".",
"maxLength": 100,
"type": "string"
},
"options": {
"additionalProperties": {
"type": "string"
},
"description": "opsgenie: `region` (us or eu, default us). splunk_oncall: `routing_key`. jira: `email` (the account the API token belongs to), `project` (key, such as OPS), `issue_type` (default Task) and `resolve_status` (optional: the status a resolved incident's issue moves to, such as Done). twilio: `account_sid` (AC…), `from_number` and `mode` (sms or call, default sms). vonage: `api_key` and `from_number`. plivo: `auth_id` (MA… or SA…), `from_number` and `mode`. telnyx: `from_number` and `messaging_profile_id` (needed for a sender ID; without `from_number` the profile's numbers send). `from_number` is one of the account's numbers with its country code, or for texts a sender ID of up to 11 letters, digits and spaces with at least one letter (not accepted in the US and Canada), or for twilio a Messaging Service SID (MG…).",
"type": "object"
},
"token": {
"description": "Telegram bot token, Pushover application token, ntfy access token (optional), Jira API token, Twilio or Plivo Auth Token, Vonage API secret, Telnyx API key, or a webhook's signing secret (optional: `whsec_` and 24 to 64 bytes in Base64; one is made when it is left out). Stored encrypted and never returned, except a webhook's signing secret as `signing_secret` in the response that made it.",
"type": "string"
}
},
"required": [
"name",
"kind",
"destination"
],
"type": "object"
},
"name": "add_notification_contact",
"outputSchema": null
},
{
"description": "Business plans: puts a contact on call in a schedule from starts_at to ends_at (up to 90 days), instead of the rotation. Overrides may not overlap. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"alert_channel_id": {
"description": "The notification contact on call instead of the rotation.",
"format": "uuid",
"type": "string"
},
"ends_at": {
"description": "In the future, after starts_at and at most 90 days later. Overrides of a schedule may not overlap.",
"format": "date-time",
"type": "string"
},
"schedule_id": {
"description": "Schedule ID from list_on_call_schedules.",
"format": "uuid",
"type": "string"
},
"starts_at": {
"description": "When the override begins, as an ISO 8601 time.",
"format": "date-time",
"type": "string"
}
},
"required": [
"schedule_id",
"alert_channel_id",
"starts_at",
"ends_at"
],
"type": "object"
},
"name": "add_on_call_override",
"outputSchema": null
},
{
"description": "Adds one piece of software the website runs, by name (Debian, nginx, WordPress, Next.js…), package (npm:lodash, composer:vendor/package, pypi:django, wp-plugin:slug) or NVD product (cpe:vendor:product), with its version if known. Replaces a detected or imported entry for the same product. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Monitor ID from list_monitors.",
"format": "uuid",
"type": "string"
},
"name": {
"description": "Product name or package, such as \"Debian\" or \"npm:lodash\".",
"type": "string"
},
"version": {
"description": "Installed version, such as 12 or 4.17.21. Leave out when unknown.",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"name": "add_software",
"outputSchema": null
},
{
"description": "Skips (skipped: true), moves (starts_at and ends_at) or changes the message of one occurrence of a repeating maintenance window, leaving the others as they are; restore: true undoes it. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"ends_at": {
"description": "Its new end, after starts_at.",
"format": "date-time",
"type": "string"
},
"message": {
"description": "What visitors are told about this occurrence instead of the series' message.",
"maxLength": 2000,
"type": [
"string",
"null"
]
},
"occurrence_at": {
"description": "The occurrence's start as the series gives it: occurrence_at from next_occurrences or occurrence_changes.",
"format": "date-time",
"type": "string"
},
"restore": {
"description": "true undoes every change to this occurrence.",
"type": "boolean"
},
"skipped": {
"description": "true skips this occurrence: no maintenance then, and its status pages' subscribers hear it is cancelled if they were told about it.",
"type": "boolean"
},
"starts_at": {
"description": "Moves this occurrence: its new start, with ends_at.",
"format": "date-time",
"type": "string"
},
"window_id": {
"description": "Maintenance window ID from list_maintenance_windows.",
"format": "uuid",
"type": "string"
}
},
"required": [
"window_id",
"occurrence_at"
],
"type": "object"
},
"name": "change_maintenance_occurrence",
"outputSchema": null
},
{
"description": "Checks whether a public website responds right now, from the monitoring service, without an account. Returns status, HTTP code and timings. Free; limited to a few checks a minute.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"url": {
"description": "A public website, such as example.com or https://example.com/path.",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"name": "check_website",
"outputSchema": null
},
{
"description": "Adds a comment to the incident's timeline, seen only by the workspace (Pro plans). Use it to record what you found or did. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"incident_id": {
"description": "Incident ID from list_incidents.",
"format": "uuid",
"type": "string"
},
"message": {
"description": "The comment's text.",
"maxLength": 2000,
"type": "string"
}
},
"required": [
"incident_id",
"message"
],
"type": "object"
},
"name": "comment_on_incident",
"outputSchema": null
},
{
"description": "Confirms an sms or voice contact, added before they were retired, with the 6-digit code it was texted or told in a call. The code works for 24 hours and 5 tries. Ask the phone's owner for it; never guess.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"code": {
"description": "The 6-digit code the phone received.",
"pattern": "^[0-9]{6}$",
"type": "string"
},
"id": {
"description": "Contact ID from add_notification_contact or list_notification_contacts.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"code"
],
"type": "object"
},
"name": "confirm_notification_contact",
"outputSchema": null
},
{
"description": "Business plans: ordered steps, each alerting contacts and whoever is on call in schedules, then waiting for an acknowledgement before the next. Monitors use it with update_monitor's escalation_policy_id. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The policy's name.",
"maxLength": 80,
"type": "string"
},
"repeat_count": {
"default": 0,
"description": "Times the whole policy runs again when nobody acknowledges.",
"maximum": 9,
"minimum": 0,
"type": "integer"
},
"steps": {
"description": "In order; sending steps replaces them all. Each names contacts, schedules or both.",
"items": {
"properties": {
"alert_channel_ids": {
"description": "Notification contacts it alerts.",
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 50,
"type": "array"
},
"schedule_ids": {
"description": "On-call schedules whose on-call contact it alerts.",
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 20,
"type": "array"
},
"wait_minutes": {
"default": 10,
"description": "Minutes to wait for an acknowledgement before the next step.",
"maximum": 1440,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
}
},
"required": [
"name",
"steps"
],
"type": "object"
},
"name": "create_escalation_policy",
"outputSchema": null
},
{
"description": "Schedules maintenance for one monitor or all: no incidents or alerts while it lasts (suppress_alerts), and with announce the status pages that show it list it and tell their subscribers. With recurrence it repeats daily, weekly on chosen days or monthly, in the workspace's time zone (get_account), starting with starts_at to ends_at. Every plan. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"announce": {
"default": false,
"description": "Show the window on the status pages that show its monitor (every page of the workspace without a monitor), and tell their subscribers, one occurrence at a time.",
"type": "boolean"
},
"ends_at": {
"description": "When it ends, after starts_at.",
"format": "date-time",
"type": "string"
},
"message": {
"description": "What visitors are told about the maintenance.",
"maxLength": 2000,
"type": [
"string",
"null"
]
},
"monitor_id": {
"description": "The monitor under maintenance; leave out or null for every monitor.",
"format": "uuid",
"type": [
"string",
"null"
]
},
"name": {
"description": "What the maintenance is, such as Database upgrade.",
"maxLength": 120,
"type": "string"
},
"recurrence": {
"description": "How the window repeats; `null` or left out for a single window. starts_at and ends_at are then the first occurrence, and every other one starts at the same time of day in time_zone, daylight saving time or not, and lasts as long.",
"properties": {
"count": {
"description": "How many occurrences there are, skipped ones included. Not with until.",
"maximum": 1000,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"frequency": {
"description": "Repeat every interval days, months or weeks.",
"enum": [
"daily",
"monthly",
"weekly"
],
"type": "string"
},
"interval": {
"default": 1,
"description": "Every how many days, weeks or months.",
"maximum": 99,
"minimum": 1,
"type": "integer"
},
"month_day": {
"description": "Monthly: the day of the month; a shorter month takes its last day. By default the first occurrence's day.",
"maximum": 31,
"minimum": 1,
"type": "integer"
},
"time_zone": {
"description": "The IANA time zone the times of day follow. By default the workspace's (GET /account).",
"type": "string"
},
"until": {
"description": "The last day, YYYY-MM-DD in time_zone, an occurrence may start on. Not with count.",
"format": "date",
"type": [
"string",
"null"
]
},
"week": {
"description": "Monthly on a weekday instead of a day: the first to fourth, or -1 for the last, of weekday in each month.",
"enum": [
-1,
1,
2,
3,
4
],
"type": "integer"
},
"weekday": {
"description": "With week: the day of the week, 1 (Monday) to 7 (Sunday).",
"maximum": 7,
"minimum": 1,
"type": "integer"
},
"weekdays": {
"description": "Weekly: the days, 1 (Monday) to 7 (Sunday). By default the first occurrence's day.",
"items": {
"maximum": 7,
"minimum": 1,
"type": "integer"
},
"type": "array"
}
},
"required": [
"frequency"
],
"type": [
"object",
"null"
]
},
"starts_at": {
"description": "When it starts, ISO 8601; the first occurrence of a repeating window.",
"format": "date-time",
"type": "string"
},
"suppress_alerts": {
"default": true,
"description": "false keeps the window on record without holding alerts back.",
"type": "boolean"
}
},
"required": [
"name",
"starts_at",
"ends_at"
],
"type": "object"
},
"name": "create_maintenance_window",
"outputSchema": null
},
{
"description": "Creates a monitor in a free slot of the workspace's plan. Premium monitors (multi-step transactions and code repositories) have slots of their own, on Pro and Business only. When every slot is in use the call fails with monitor_limit_reached: the user can upgrade at https://upheron.com/pricing or delete a monitor. Needs a write token.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"alert_channel_ids": {
"description": "Notification contacts to alert. Defaults to all of the workspace's contacts.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"alert_delay_minutes": {
"default": 0,
"description": "Pro and Business plans: minutes the first outage alert waits after the incident opens (on top of `failure_threshold`). Nobody is alerted about, or hears the recovery of, an outage that ends sooner.",
"maximum": 1440,
"minimum": 0,
"type": "integer"
},
"charts": {
"default": "both",
"description": "Charts on public status pages: uptime bars (the last 90 days, or the whole history), the last 24 hours of response time, or both.",
"enum": [
"both",
"uptime",
"response"
],
"type": "string"
},
"check_options": {
"description": "Kind-specific options, such as `json_path`/`expected_value` for `api`, `steps` for transactions, `warn_days` for ssl. Ports go in `url` as host:port. See /docs/api#check-options.",
"type": "object"
},
"confirmation_threshold": {
"default": 1,
"description": "Locations that must fail a check at the same time for it to count as failed. 1, the default, is any location; with 2 of 3 locations, one failing location alone is no outage and alerts nobody. More than the monitor's locations counts as all of them.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"content_threshold": {
"default": 25,
"description": "With `content_watch`: the share of the page's text, in percent, that must change to alert. Smaller changes become the new baseline.",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"content_watch": {
"default": false,
"description": "Business plans, `http` and `api` monitors: look at the page hourly, keeping only a fingerprint of its text, title and external scripts, and alert when the text changes by `content_threshold` percent or more, the title changes, a script from a new host appears or defacement phrases show up. Accept a change with POST /monitors/{id}/changes/accept.",
"type": "boolean"
},
"dns_address_changes": {
"default": "network",
"description": "What A and AAAA answers alert on: `network` when they move to another network (autonomous system), so CDNs rotating addresses do not alert; `address` on any address change, for a site on fixed addresses; `none` never.",
"enum": [
"address",
"network",
"none"
],
"type": "string"
},
"dns_watch": {
"default": true,
"description": "Every plan, `http` and `api` monitors: look up the host's A, AAAA and CNAME records and its zone's NS, MX, SPF and DMARC hourly, and alert when one changes, with the old and new values.",
"type": "boolean"
},
"escalation_policy_id": {
"description": "Business plans: alert this escalation policy (GET /escalation-policies) about outages instead of `alert_channel_ids`, which still receive expiry and vulnerability alerts. `null` alerts the contacts.",
"format": "uuid",
"type": [
"string",
"null"
]
},
"expected_status_max": {
"default": 399,
"description": "The highest HTTP status that counts as up; at least `expected_status_min`.",
"type": "integer"
},
"expected_status_min": {
"default": 200,
"description": "The lowest HTTP status that counts as up.",
"type": "integer"
},
"expiry_alerts": {
"default": true,
"description": "`http` and `api` monitors: check the domain registration and (for HTTPS) the TLS certificate daily. Domain alerts come 30, 14, 7, 3 and 1 days before expiry; certificate alerts only once automatic renewal should have happened (a sixth of the certificate's lifetime, at most 14 days). Uses no extra monitor.",
"type": "boolean"
},
"failure_threshold": {
"default": 1,
"description": "Failed checks in a row before an incident opens. The default alerts on the first failed check.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"header_watch": {
"default": true,
"description": "Every plan, `http` and `api` monitors: grade the page's security headers, cookie flags and HTTPS redirect with each website scan (weekly on Free, daily on paid plans), and alert when one that was there is gone or weaker. See /docs/website-changes.",
"type": "boolean"
},
"heartbeat_grace_seconds": {
"description": "For heartbeat and webhook monitors.",
"type": "integer"
},
"idempotency_key": {
"description": "Any unique string. Repeating a call with the same key within 24 hours returns the first monitor instead of creating another. Use one per intended monitor.",
"maxLength": 255,
"type": "string"
},
"interval_seconds": {
"default": 300,
"description": "Seconds between checks, no faster than the plan allows (300 on Free, 10 on Pro).",
"maximum": 86400,
"minimum": 10,
"type": "integer"
},
"ip_version": {
"default": "auto",
"description": "Network and website checks: `auto` connects over IPv4, or IPv6 when the host has no IPv4 address; `ipv4` and `ipv6` use only that. `ipv6` needs locations with IPv6 (`ipv6` in GET /locations). An IP address as the host sets it.",
"enum": [
"auto",
"ipv4",
"ipv6"
],
"type": "string"
},
"keyword": {
"description": "Text the response body must contain.",
"maxLength": 2000,
"type": "string"
},
"kind": {
"default": "http",
"description": "What to check. `heartbeat` and `webhook` wait for your calls instead of probing. `repository` reads a GitHub or GitLab repository's dependency manifests daily and alerts on vulnerabilities in them, on every plan; put the repository URL in `url` (optionally …/tree/branch/folder) and, for a private repository (Pro plan), an access token in `check_options.token`. `websocket` (a ws:// or wss:// URL) and `grpc` (host[:port]) are created on Pro and Business (Free answers `422` with `plan_required`).",
"enum": [
"http",
"api",
"ssl",
"domain",
"dns",
"blacklist",
"email_auth",
"malware",
"tcp",
"ssh",
"smtp",
"imap",
"pop",
"ftps",
"ping",
"ntp",
"udp",
"minecraft",
"steam",
"websocket",
"grpc",
"transaction",
"micro_transaction",
"extended_transaction",
"group",
"cloud_status",
"page_speed",
"webhook",
"heartbeat",
"repository"
],
"type": "string"
},
"locations": {
"description": "Location codes from GET /locations. Defaults to the first location.",
"items": {
"type": "string"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"lookalike_alerts": {
"default": false,
"description": "Pro and Business, `http` and `api` monitors: look up a few hundred typo and homoglyph spellings of the registered domain daily, and alert when one starts resolving or gains MX records.",
"type": "boolean"
},
"method": {
"default": "GET",
"description": "The HTTP method of the check's request.",
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"type": "string"
},
"name": {
"description": "Shown in alerts and on status pages.",
"maxLength": 160,
"type": "string"
},
"port_scan": {
"default": false,
"description": "Business plans, network and website checks: scan the common TCP ports of the host's verified addresses weekly (POST /monitors/{id}/ports/verify), and alert when a port opens. See /docs/port-scans.",
"type": "boolean"
},
"recovery_threshold": {
"default": 2,
"description": "Successful checks in a row before the incident resolves.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"repeat_alert_minutes": {
"description": "Pro and Business plans: repeat the outage alert to the monitor's contacts this often until someone acknowledges the incident or it recovers, at most 48 times. `null` sends it once.",
"maximum": 1440,
"minimum": 5,
"type": [
"integer",
"null"
]
},
"repository_token": {
"description": "Access token for a private `repository_url`: on GitHub a fine-grained token with read-only Contents, on GitLab `read_api`. Stored encrypted and never returned (`repository_token_set` tells whether one is saved). Leave it out to keep it; `null` removes it.",
"maxLength": 500,
"type": [
"string",
"null"
],
"writeOnly": true
},
"repository_url": {
"description": "Pro and Business, `http` and `api` monitors with vulnerability alerts: the website's GitHub or GitLab repository (optionally …/tree/branch/folder), whose lockfiles and manifests are read hourly for exact versions. A failed read opens no incident. `null` unlinks it and removes what it listed.",
"type": [
"string",
"null"
]
},
"request_body": {
"description": "The body sent with the check's request, such as JSON for a POST.",
"maxLength": 65536,
"type": "string"
},
"request_headers": {
"additionalProperties": {
"type": "string"
},
"description": "Sent with the check; stored encrypted and never returned.",
"type": "object"
},
"slo_target": {
"description": "Every plan: an availability objective in percent, such as 99.9, over slo_window_days; null for none. Downtime is the time in incidents, less maintenance. The monitor's contacts are alerted when its error budget burns fast, is 50%, 75% and 90% used, and when it runs out. See /docs/reports#error-budgets.",
"exclusiveMaximum": 100,
"minimum": 50,
"type": [
"number",
"null"
]
},
"slo_window_days": {
"default": 30,
"description": "The rolling window of the availability objective, in days.",
"enum": [
7,
30,
90
],
"type": "integer"
},
"status_page": {
"default": true,
"description": "Creating only: give the monitor its own published status page while the plan allows more pages. Send `false` when you manage status pages yourself.",
"type": "boolean",
"writeOnly": true
},
"subdomain_alerts": {
"default": false,
"description": "Pro and Business, `http` and `api` monitors: list the domain's subdomains from certificate transparency logs (through crt.sh, which can be days or weeks behind), resolve each daily, and alert on a new one and on a CNAME to a service that reports no site there (a subdomain takeover risk).",
"type": "boolean"
},
"tab_id": {
"description": "The monitor tab (GET /monitor-tabs) the monitor is sorted into in the dashboard; `null` takes it out of its tab.",
"format": "uuid",
"type": [
"string",
"null"
]
},
"timeout_ms": {
"default": 10000,
"description": "Milliseconds a check waits for the reply before it counts as failed.",
"maximum": 60000,
"minimum": 500,
"type": "integer"
},
"url": {
"description": "URL, or host[:port] for network checks.",
"type": "string"
},
"vulnerability_alerts": {
"default": false,
"description": "Every plan, `http` and `api` monitors: scan the website for the software it runs (weekly on Free, daily on paid plans) and alert on newly published vulnerabilities in it, checked daily and within 15 minutes of a new advisory (OSV.dev with the GitHub Advisory Database, NVD, new CVE records, WPVulnerability and WordPress core advisories for WordPress, CISA KEV, endoflife.date).",
"type": "boolean"
},
"vulnerability_severity": {
"default": "high",
"description": "The lowest severity that alerts. Actively exploited vulnerabilities and releases reaching end of support always alert.",
"enum": [
"low",
"medium",
"high",
"critical"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"name": "create_monitor",
"outputSchema": null
},
{
"description": "Business plans: a rotation through notification contacts (list_notification_contacts), handing off daily or weekly at a time in a time zone. The first member is on call from now. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"handoff_day": {
"default": 1,
"description": "Weekly handoffs: the weekday, 1 for Monday.",
"maximum": 7,
"minimum": 1,
"type": "integer"
},
"handoff_time": {
"default": "09:00",
"description": "HH:MM on the schedule's own clock.",
"examples": [
"09:00"
],
"type": "string"
},
"member_ids": {
"description": "Notification contacts (GET /alert-channels) in rotation order. Changing them, the rotation, the handoff or the time zone starts the rotation over with the first member.",
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 50,
"type": "array"
},
"name": {
"description": "The schedule's name.",
"maxLength": 80,
"type": "string"
},
"rotation": {
"default": "weekly",
"description": "How often on call passes to the next member.",
"enum": [
"daily",
"weekly"
],
"type": "string"
},
"time_zone": {
"default": "Etc/UTC",
"description": "An IANA time zone.",
"examples": [
"Europe/Berlin"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"name": "create_on_call_schedule",
"outputSchema": null
},
{
"description": "Deletes a policy; its monitors go back to alerting their own contacts. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"policy_id": {
"description": "Policy ID from list_escalation_policies.",
"format": "uuid",
"type": "string"
}
},
"required": [
"policy_id"
],
"type": "object"
},
"name": "delete_escalation_policy",
"outputSchema": null
},
{
"description": "Deletes a maintenance window, every occurrence of a repeating one included. Subscribers told about an occurrence that has not started hear it is cancelled. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"window_id": {
"description": "Maintenance window ID from list_maintenance_windows.",
"format": "uuid",
"type": "string"
}
},
"required": [
"window_id"
],
"type": "object"
},
"name": "delete_maintenance_window",
"outputSchema": null
},
{
"description": "Deletes a monitor and its history. Frees its plan slot.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Monitor ID from list_monitors.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "delete_monitor",
"outputSchema": null
},
{
"description": "Deletes a schedule no escalation policy uses. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"schedule_id": {
"description": "Schedule ID from list_on_call_schedules.",
"format": "uuid",
"type": "string"
}
},
"required": [
"schedule_id"
],
"type": "object"
},
"name": "delete_on_call_schedule",
"outputSchema": null
},
{
"description": "Plan and its monitor slots (standard in plan_monitors, premium in premium_monitors with their kinds), and the workspace's time zone (workspace.time_zone), which report days follow. Call this first to know whether the plan has room for another monitor.",
"inputSchema": {
"additionalProperties": false,
"properties": {},
"required": [],
"type": "object"
},
"name": "get_account",
"outputSchema": null
},
{
"description": "Who changed what in the workspace, newest first: people, API tokens and agents, with the changed fields and IP (Business plan). Filter by resource_type (monitor, alert_channel, status_page, member, api_token…), action (monitor.updated, or a prefix like monitor.), from and to (YYYY-MM-DD); pass next as before for older entries. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"action": {
"description": "Only this action, such as monitor.updated, or every action with a prefix, such as monitor.",
"type": "string"
},
"before": {
"description": "The next value of the previous page, for older entries.",
"type": "string"
},
"from": {
"description": "First day, YYYY-MM-DD.",
"format": "date",
"type": "string"
},
"limit": {
"description": "Entries per page.",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"resource_type": {
"description": "Only entries about this kind of thing, such as monitor, alert_channel, status_page, member or api_token.",
"type": "string"
},
"to": {
"description": "Last day, YYYY-MM-DD.",
"format": "date",
"type": "string"
}
},
"required": [],
"type": "object"
},
"name": "get_audit_log",
"outputSchema": null
},
{
"description": "For an http or api monitor on Pro and Business plans: the website's registered domain, its subdomains from certificate transparency logs (crt.sh, which can be days or weeks behind) with where each points and any CNAME to a service that reports no site there (subdomain_alerts), and the registered typo and look-alike spellings of the domain with their addresses, mail servers and registration dates (lookalike_alerts). Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Monitor ID from list_monitors.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "get_domain_watch",
"outputSchema": null
},
{
"description": "Every monitor with an availability objective (slo_target over slo_window_days, set with update_monitor): its availability over the rolling window, the error budget in seconds, how much is used and left, the last hour's burn rate and whether it burns fast, least budget left first. Every plan. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {},
"required": [],
"type": "object"
},
"name": "get_error_budgets",
"outputSchema": null
},
{
"description": "One incident with its timeline (detected, acknowledged, comments, status page updates, recovered), root cause and post-mortem, and the status pages its updates go to with their subscriber counts. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"incident_id": {
"description": "Incident ID from list_incidents.",
"format": "uuid",
"type": "string"
}
},
"required": [
"incident_id"
],
"type": "object"
},
"name": "get_incident",
"outputSchema": null
},
{
"description": "One monitor with uptime for 24 hours, 7 days and 30 days, its last 90 days, incident totals, its latest results with errors, recent incidents, and route traces from failing locations (Pro and Business: each hop's loss, round trips and jitter over every round). Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Monitor ID from list_monitors.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "get_monitor",
"outputSchema": null
},
{
"description": "A monitor's most recent check results, newest first. Older results may be merged: repeats checks with the same outcome up to last_checked_at. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Monitor ID from list_monitors.",
"format": "uuid",
"type": "string"
},
"limit": {
"default": 50,
"description": "How many results to return.",
"maximum": 500,
"minimum": 1,
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "get_monitor_results",
"outputSchema": null
},
{
"description": "For a monitor with port_scan on (Business plans): which of its host's addresses are verified and how to verify the rest (a file each address serves, or reverse DNS under the host with a TXT record), the ports the last weekly scan found open, flagged where the service usually should not be public, and the recent scans. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Monitor ID from list_monitors.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "get_ports",
"outputSchema": null
},
{
"description": "Business plans: availability against an SLA target for a range of days in the workspace's time zone (time_zone in get_account; by default this month), with the downtime budget used and left, incidents, MTTR, MTBF and the longest outage, per monitor (lowest availability first) and overall. The dashboard and the API also give it as a PDF. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"from": {
"description": "First day, YYYY-MM-DD, in the workspace's time zone.",
"format": "date",
"type": "string"
},
"monitor_ids": {
"description": "Only these monitors; by default all.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"target": {
"default": 99.9,
"description": "SLA target in percent.",
"exclusiveMaximum": 100,
"minimum": 1,
"type": "number"
},
"to": {
"description": "Last day, YYYY-MM-DD.",
"format": "date",
"type": "string"
}
},
"required": [],
"type": "object"
},
"name": "get_sla_report",
"outputSchema": null
},
{
"description": "A monitor's daily uptime, kept for as long as it exists: checks, successful, failed and average response time per UTC day, oldest first. By default from the first check to today. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"from": {
"description": "First UTC day, YYYY-MM-DD.",
"format": "date",
"type": "string"
},
"id": {
"description": "Monitor ID from list_monitors.",
"format": "uuid",
"type": "string"
},
"to": {
"description": "Last UTC day, YYYY-MM-DD.",
"format": "date",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "get_uptime_history",
"outputSchema": null
},
{
"description": "For an http or api monitor with vulnerability_alerts on: the vulnerabilities and unsupported releases found in the website's software, actively exploited and most severe first, with the version that fixes each, and the software they were matched on (found by scanning the website, imported, or added). Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Monitor ID from list_monitors.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "get_vulnerabilities",
"outputSchema": null
},
{
"description": "For a website or API monitor: its security headers grade with what each missing or weak header does and how to fix it, its DNS records (A, AAAA, CNAME, NS, MX, SPF, DMARC) and the networks its addresses belong to, its page fingerprint (Business: title, external script hosts, and the latest change waiting to be accepted) and the recent header and DNS changes. Settings are header_watch, dns_watch, dns_address_changes, content_watch and content_threshold on update_monitor. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Monitor ID from list_monitors.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "get_website_changes",
"outputSchema": null
},
{
"description": "Creates the monitors the user chose from preview_monitor_import (send their `monitor` objects). Each takes a plan slot like create_monitor; ones already monitored are skipped. Imported heartbeats get new URLs, returned once as heartbeat_url: tell the user to point their scheduled jobs at them. Needs a write token. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"monitors": {
"description": "The `monitor` objects of the preview's items to create, unchanged or edited (name, interval_seconds, status). Each takes a plan slot as a single new monitor would; one already monitored is skipped.",
"items": {
"additionalProperties": true,
"type": "object"
},
"maxItems": 1000,
"minItems": 1,
"type": "array"
},
"source": {
"description": "The preview's source, recorded in the audit log.",
"enum": [
"better_stack",
"csv",
"uptime_kuma",
"uptimerobot"
],
"type": "string"
}
},
"required": [
"monitors"
],
"type": "object"
},
"name": "import_monitors",
"outputSchema": null
},
{
"description": "Tells the monitor what software the website and its server run, so their vulnerabilities are checked. Send a file's contents (package.json, package-lock.json, yarn.lock, pnpm-lock.yaml, bun.lock, mix.lock, composer.json/.lock, requirements.txt, Pipfile.lock, poetry.lock, Gemfile.lock, go.mod, Cargo.lock, pom.xml, .csproj, Dockerfile, docker-compose.yml, .nvmrc, .bun-version, .tool-versions, mise.toml, railpack.json) or a plain list with one item per line as \"name version\", for example \"Debian 12\", \"nginx 1.24.0\", \"PHP 8.2.12\", \"wp-plugin:woocommerce 9.3.3\", \"npm:lodash 4.17.21\". If you can run commands on the server, `cat /etc/os-release`, `nginx -v`, `php -v` and the like give exact versions. Importing the same filename again replaces what it added. Lines that name nothing known are returned as unrecognized. Format and supported files: https://upheron.com/docs/software. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"content": {
"description": "The file's text, or the list.",
"maxLength": 5000000,
"type": "string"
},
"filename": {
"description": "The file's name, such as package-lock.json or Dockerfile; tells the format. Leave out for a plain list.",
"type": "string"
},
"id": {
"description": "Monitor ID from list_monitors.",
"format": "uuid",
"type": "string"
},
"name": {
"description": "A label such as frontend/package.json, to keep two files with the same name apart. Importing under the same label again replaces it. Defaults to the filename.",
"type": "string"
}
},
"required": [
"id",
"content"
],
"type": "object"
},
"name": "import_software",
"outputSchema": null
},
{
"description": "Business plans: escalation policies, whose id a monitor's escalation_policy_id takes, and their steps. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {},
"required": [],
"type": "object"
},
"name": "list_escalation_policies",
"outputSchema": null
},
{
"description": "Outages, newest first, with their status (open, acknowledged, resolved). Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {},
"required": [],
"type": "object"
},
"name": "list_incidents",
"outputSchema": null
},
{
"description": "Location codes you can pass in a monitor's `locations`.",
"inputSchema": {
"additionalProperties": false,
"properties": {},
"required": [],
"type": "object"
},
"name": "list_locations",
"outputSchema": null
},
{
"description": "Maintenance windows, latest first: times when failures open no incidents and send no alerts, for one monitor or all. A repeating window has its recurrence in words (repeats), its next occurrences and the ones skipped or moved. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {},
"required": [],
"type": "object"
},
"name": "list_maintenance_windows",
"outputSchema": null
},
{
"description": "Every monitor with its current status (pending, up, down, degraded), and interval. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {},
"required": [],
"type": "object"
},
"name": "list_monitors",
"outputSchema": null
},
{
"description": "Contacts that receive alerts, whether each is confirmed, and for phone contacts their latest text or call and whether it was delivered.",
"inputSchema": {
"additionalProperties": false,
"properties": {},
"required": [],
"type": "object"
},
"name": "list_notification_contacts",
"outputSchema": null
},
{
"description": "Business plans: on-call schedules with who is on call now, until when, and who is next. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {},
"required": [],
"type": "object"
},
"name": "list_on_call_schedules",
"outputSchema": null
},
{
"description": "The workspace's status pages: their address (/status/{slug}), the monitors they show with the names visitors see, and their named groups of monitors in order. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {},
"required": [],
"type": "object"
},
"name": "list_status_pages",
"outputSchema": null
},
{
"description": "Records that the software behind a finding from get_vulnerabilities was upgraded: to `version`, or by default to the first version that fixes it (the finding's fix_version). The monitor is checked again; findings that no longer apply disappear, and one that still applies stays, marked with the version. Only records the version; it does not change the server. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"finding_id": {
"description": "The finding's id from get_vulnerabilities.",
"format": "uuid",
"type": "string"
},
"id": {
"description": "Monitor ID from list_monitors.",
"format": "uuid",
"type": "string"
},
"version": {
"description": "The version installed. Leave out for the first version that fixes it.",
"type": "string"
}
},
"required": [
"id",
"finding_id"
],
"type": "object"
},
"name": "mark_vulnerability_fixed",
"outputSchema": null
},
{
"description": "Opens an incident for what the checks cannot see: a slow service, a problem a customer reported. With a message it publishes the first update on the status pages that show its monitors (and emails their subscribers on Pro plans); alert pages the monitors' contacts once. It stays open until resolve_incident and never counts as downtime. Every plan, at most 20 open. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"alert": {
"description": "Alert the monitors' contacts once, and again when it is resolved. Ask the user first.",
"type": "boolean"
},
"message": {
"description": "Optional first update for the visitors of the status pages that show the monitors.",
"maxLength": 2000,
"type": "string"
},
"monitor_ids": {
"description": "The monitors it affects (GET /monitors): its updates show on the published status pages that show any of them. None or up to 50.",
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 50,
"type": "array"
},
"severity": {
"default": "critical",
"description": "How serious the problem is.",
"enum": [
"warning",
"critical"
],
"type": "string"
},
"state": {
"description": "The first update's state, investigating by default.",
"enum": [
"investigating",
"identified",
"monitoring"
],
"type": "string"
},
"title": {
"description": "What the dashboard, alerts and status pages call it.",
"maxLength": 120,
"type": "string"
}
},
"required": [
"title"
],
"type": "object"
},
"name": "open_incident",
"outputSchema": null
},
{
"description": "Stops checking a monitor. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Monitor ID from list_monitors.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "pause_monitor",
"outputSchema": null
},
{
"description": "Publishes an update on every published status page that shows the incident's monitor and in their RSS and Atom feeds, and on Pro plans emails those pages' subscribers. States: investigating, identified, monitoring, resolved. Write for the page's visitors. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"incident_id": {
"description": "Incident ID from list_incidents.",
"format": "uuid",
"type": "string"
},
"message": {
"description": "The update's text, as the pages' visitors read it.",
"maxLength": 2000,
"type": "string"
},
"state": {
"description": "Where the work on the incident stands; the pages show it with the update.",
"enum": [
"investigating",
"identified",
"monitoring",
"resolved"
],
"type": "string"
},
"title": {
"description": "Optional title on the pages, such as \"Slow checkout\".",
"maxLength": 120,
"type": "string"
}
},
"required": [
"incident_id",
"state",
"message"
],
"type": "object"
},
"name": "post_incident_update",
"outputSchema": null
},
{
"description": "Reads the monitors of another service: UptimeRobot (a read-only API key, or its bulk upload CSV), Better Stack (a team-based API token), Uptime Kuma (its JSON backup) or a CSV file in UpHeron's format (https://upheron.com/docs/import). Creates nothing: says which would be created and which skipped and why (no UpHeron check for it, already monitored, beyond the plan's monitors, needs Pro), with the UpHeron monitor each maps to. Show the user the list before import_monitors. The key is used once and never stored. Needs a write token. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"api_key": {
"description": "For uptimerobot, a read-only API key (UptimeRobot: Integrations → API); for better_stack, a team-based API token (Better Stack: API tokens → Team-based tokens). Used once to list the monitors, never stored or logged.",
"maxLength": 500,
"type": "string"
},
"file": {
"description": "The export file's text: a CSV for csv and uptimerobot, the backup JSON for uptime_kuma. At most 5 MB and 1,000 monitors.",
"maxLength": 5000000,
"type": "string"
},
"source": {
"description": "Where the monitors come from: better_stack (API token), csv (UpHeron's CSV format or UptimeRobot's bulk upload template), uptime_kuma (the JSON backup of Uptime Kuma 1.x) or uptimerobot (read-only API key, or its bulk upload CSV).",
"enum": [
"better_stack",
"csv",
"uptime_kuma",
"uptimerobot"
],
"type": "string"
}
},
"required": [
"source"
],
"type": "object"
},
"name": "preview_monitor_import",
"outputSchema": null
},
{
"description": "Removes an override from a schedule (its id is in the schedule's overrides). Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"override_id": {
"description": "The override's id, from the schedule's overrides in list_on_call_schedules.",
"format": "uuid",
"type": "string"
},
"schedule_id": {
"description": "Schedule ID from list_on_call_schedules.",
"format": "uuid",
"type": "string"
}
},
"required": [
"schedule_id",
"override_id"
],
"type": "object"
},
"name": "remove_on_call_override",
"outputSchema": null
},
{
"description": "Removes an entry from get_vulnerabilities' software list. Software the scan found is ignored instead, so the next scan does not add it back. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Monitor ID from list_monitors.",
"format": "uuid",
"type": "string"
},
"software_id": {
"description": "The entry's id from get_vulnerabilities.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id",
"software_id"
],
"type": "object"
},
"name": "remove_software",
"outputSchema": null
},
{
"description": "Resolves an incident opened with open_incident; the contacts it alerted hear so. A message is published as the last update on its status pages. Incidents opened by checks resolve with their checks. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"incident_id": {
"description": "Incident ID from list_incidents.",
"format": "uuid",
"type": "string"
},
"message": {
"description": "Optional last update for the status pages that show the incident.",
"maxLength": 2000,
"type": "string"
}
},
"required": [
"incident_id"
],
"type": "object"
},
"name": "resolve_incident",
"outputSchema": null
},
{
"description": "Starts checking a paused monitor again. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Monitor ID from list_monitors.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "resume_monitor",
"outputSchema": null
},
{
"description": "Scans the verified host's common TCP ports now instead of waiting for the weekly scan, at most once an hour. Takes a minute or two; then read get_ports. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Monitor ID from list_monitors.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "scan_ports",
"outputSchema": null
},
{
"description": "Scans the monitor's website for the software it runs and checks it against the vulnerability sources now, instead of waiting for the next scan. Takes up to a minute; then read get_vulnerabilities. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Monitor ID from list_monitors.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "scan_website_software",
"outputSchema": null
},
{
"description": "Sends a contact a test alert, at most 5 a minute for a workspace. For a phone contact it is a real text or call through the user's account, which counts toward its 6 texts or 3 calls an hour; an error says in words what the provider refused (credentials, a trial account's unverified number, the sender).",
"inputSchema": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Contact ID from add_notification_contact or list_notification_contacts.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "test_notification_contact",
"outputSchema": null
},
{
"description": "Business plans. Fields left out keep their value; steps replaces them all. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"name": {
"description": "The policy's name.",
"maxLength": 80,
"type": "string"
},
"policy_id": {
"description": "Policy ID from list_escalation_policies.",
"format": "uuid",
"type": "string"
},
"repeat_count": {
"default": 0,
"description": "Times the whole policy runs again when nobody acknowledges.",
"maximum": 9,
"minimum": 0,
"type": "integer"
},
"steps": {
"description": "In order; sending steps replaces them all. Each names contacts, schedules or both.",
"items": {
"properties": {
"alert_channel_ids": {
"description": "Notification contacts it alerts.",
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 50,
"type": "array"
},
"schedule_ids": {
"description": "On-call schedules whose on-call contact it alerts.",
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 20,
"type": "array"
},
"wait_minutes": {
"default": 10,
"description": "Minutes to wait for an acknowledgement before the next step.",
"maximum": 1440,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
}
},
"required": [
"policy_id"
],
"type": "object"
},
"name": "update_escalation_policy",
"outputSchema": null
},
{
"description": "Changes the title status pages show (public_title) or the root cause (Pro plans) of any incident, and the title, severity and monitors of one opened by hand. Fields left out keep their value. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"incident_id": {
"description": "Incident ID from list_incidents.",
"format": "uuid",
"type": "string"
},
"monitor_ids": {
"description": "The monitors it affects (GET /monitors): its updates show on the published status pages that show any of them. None or up to 50.",
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 50,
"type": "array"
},
"public_title": {
"description": "The title status pages show instead of the incident's own; null goes back to its own.",
"maxLength": 120,
"type": [
"string",
"null"
]
},
"root_cause": {
"description": "What caused the incident (Pro plans); null clears it.",
"maxLength": 5000,
"type": [
"string",
"null"
]
},
"severity": {
"default": "critical",
"description": "How serious the problem is.",
"enum": [
"warning",
"critical"
],
"type": "string"
},
"title": {
"description": "What the dashboard, alerts and status pages call it.",
"maxLength": 120,
"type": "string"
}
},
"required": [
"incident_id"
],
"type": "object"
},
"name": "update_incident",
"outputSchema": null
},
{
"description": "Changes a maintenance window or every occurrence of a repeating one. Fields left out keep their value; recurrence null makes it a single window. Changing the times or recurrence undoes skipped and moved occurrences. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"announce": {
"default": false,
"description": "Show the window on the status pages that show its monitor (every page of the workspace without a monitor), and tell their subscribers, one occurrence at a time.",
"type": "boolean"
},
"ends_at": {
"description": "When it ends, after starts_at.",
"format": "date-time",
"type": "string"
},
"message": {
"description": "What visitors are told about the maintenance.",
"maxLength": 2000,
"type": [
"string",
"null"
]
},
"monitor_id": {
"description": "The monitor under maintenance; leave out or null for every monitor.",
"format": "uuid",
"type": [
"string",
"null"
]
},
"name": {
"description": "What the maintenance is, such as Database upgrade.",
"maxLength": 120,
"type": "string"
},
"recurrence": {
"description": "How the window repeats; `null` or left out for a single window. starts_at and ends_at are then the first occurrence, and every other one starts at the same time of day in time_zone, daylight saving time or not, and lasts as long.",
"properties": {
"count": {
"description": "How many occurrences there are, skipped ones included. Not with until.",
"maximum": 1000,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"frequency": {
"description": "Repeat every interval days, months or weeks.",
"enum": [
"daily",
"monthly",
"weekly"
],
"type": "string"
},
"interval": {
"default": 1,
"description": "Every how many days, weeks or months.",
"maximum": 99,
"minimum": 1,
"type": "integer"
},
"month_day": {
"description": "Monthly: the day of the month; a shorter month takes its last day. By default the first occurrence's day.",
"maximum": 31,
"minimum": 1,
"type": "integer"
},
"time_zone": {
"description": "The IANA time zone the times of day follow. By default the workspace's (GET /account).",
"type": "string"
},
"until": {
"description": "The last day, YYYY-MM-DD in time_zone, an occurrence may start on. Not with count.",
"format": "date",
"type": [
"string",
"null"
]
},
"week": {
"description": "Monthly on a weekday instead of a day: the first to fourth, or -1 for the last, of weekday in each month.",
"enum": [
-1,
1,
2,
3,
4
],
"type": "integer"
},
"weekday": {
"description": "With week: the day of the week, 1 (Monday) to 7 (Sunday).",
"maximum": 7,
"minimum": 1,
"type": "integer"
},
"weekdays": {
"description": "Weekly: the days, 1 (Monday) to 7 (Sunday). By default the first occurrence's day.",
"items": {
"maximum": 7,
"minimum": 1,
"type": "integer"
},
"type": "array"
}
},
"required": [
"frequency"
],
"type": [
"object",
"null"
]
},
"starts_at": {
"description": "When it starts, ISO 8601; the first occurrence of a repeating window.",
"format": "date-time",
"type": "string"
},
"suppress_alerts": {
"default": true,
"description": "false keeps the window on record without holding alerts back.",
"type": "boolean"
},
"window_id": {
"description": "Maintenance window ID from list_maintenance_windows.",
"format": "uuid",
"type": "string"
}
},
"required": [
"window_id"
],
"type": "object"
},
"name": "update_maintenance_window",
"outputSchema": null
},
{
"description": "Changes a monitor's settings, within the plan's interval and location limits. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"alert_channel_ids": {
"description": "Notification contacts to alert. Defaults to all of the workspace's contacts.",
"items": {
"format": "uuid",
"type": "string"
},
"type": "array"
},
"alert_delay_minutes": {
"default": 0,
"description": "Pro and Business plans: minutes the first outage alert waits after the incident opens (on top of `failure_threshold`). Nobody is alerted about, or hears the recovery of, an outage that ends sooner.",
"maximum": 1440,
"minimum": 0,
"type": "integer"
},
"charts": {
"default": "both",
"description": "Charts on public status pages: uptime bars (the last 90 days, or the whole history), the last 24 hours of response time, or both.",
"enum": [
"both",
"uptime",
"response"
],
"type": "string"
},
"check_options": {
"description": "Kind-specific options, such as `json_path`/`expected_value` for `api`, `steps` for transactions, `warn_days` for ssl. Ports go in `url` as host:port. See /docs/api#check-options.",
"type": "object"
},
"confirmation_threshold": {
"default": 1,
"description": "Locations that must fail a check at the same time for it to count as failed. 1, the default, is any location; with 2 of 3 locations, one failing location alone is no outage and alerts nobody. More than the monitor's locations counts as all of them.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"content_threshold": {
"default": 25,
"description": "With `content_watch`: the share of the page's text, in percent, that must change to alert. Smaller changes become the new baseline.",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"content_watch": {
"default": false,
"description": "Business plans, `http` and `api` monitors: look at the page hourly, keeping only a fingerprint of its text, title and external scripts, and alert when the text changes by `content_threshold` percent or more, the title changes, a script from a new host appears or defacement phrases show up. Accept a change with POST /monitors/{id}/changes/accept.",
"type": "boolean"
},
"dns_address_changes": {
"default": "network",
"description": "What A and AAAA answers alert on: `network` when they move to another network (autonomous system), so CDNs rotating addresses do not alert; `address` on any address change, for a site on fixed addresses; `none` never.",
"enum": [
"address",
"network",
"none"
],
"type": "string"
},
"dns_watch": {
"default": true,
"description": "Every plan, `http` and `api` monitors: look up the host's A, AAAA and CNAME records and its zone's NS, MX, SPF and DMARC hourly, and alert when one changes, with the old and new values.",
"type": "boolean"
},
"escalation_policy_id": {
"description": "Business plans: alert this escalation policy (GET /escalation-policies) about outages instead of `alert_channel_ids`, which still receive expiry and vulnerability alerts. `null` alerts the contacts.",
"format": "uuid",
"type": [
"string",
"null"
]
},
"expected_status_max": {
"default": 399,
"description": "The highest HTTP status that counts as up; at least `expected_status_min`.",
"type": "integer"
},
"expected_status_min": {
"default": 200,
"description": "The lowest HTTP status that counts as up.",
"type": "integer"
},
"expiry_alerts": {
"default": true,
"description": "`http` and `api` monitors: check the domain registration and (for HTTPS) the TLS certificate daily. Domain alerts come 30, 14, 7, 3 and 1 days before expiry; certificate alerts only once automatic renewal should have happened (a sixth of the certificate's lifetime, at most 14 days). Uses no extra monitor.",
"type": "boolean"
},
"failure_threshold": {
"default": 1,
"description": "Failed checks in a row before an incident opens. The default alerts on the first failed check.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"header_watch": {
"default": true,
"description": "Every plan, `http` and `api` monitors: grade the page's security headers, cookie flags and HTTPS redirect with each website scan (weekly on Free, daily on paid plans), and alert when one that was there is gone or weaker. See /docs/website-changes.",
"type": "boolean"
},
"heartbeat_grace_seconds": {
"description": "For heartbeat and webhook monitors.",
"type": "integer"
},
"id": {
"description": "Monitor ID from list_monitors.",
"format": "uuid",
"type": "string"
},
"interval_seconds": {
"default": 300,
"description": "Seconds between checks, no faster than the plan allows (300 on Free, 10 on Pro).",
"maximum": 86400,
"minimum": 10,
"type": "integer"
},
"ip_version": {
"default": "auto",
"description": "Network and website checks: `auto` connects over IPv4, or IPv6 when the host has no IPv4 address; `ipv4` and `ipv6` use only that. `ipv6` needs locations with IPv6 (`ipv6` in GET /locations). An IP address as the host sets it.",
"enum": [
"auto",
"ipv4",
"ipv6"
],
"type": "string"
},
"keyword": {
"description": "Text the response body must contain.",
"maxLength": 2000,
"type": "string"
},
"kind": {
"default": "http",
"description": "What to check. `heartbeat` and `webhook` wait for your calls instead of probing. `repository` reads a GitHub or GitLab repository's dependency manifests daily and alerts on vulnerabilities in them, on every plan; put the repository URL in `url` (optionally …/tree/branch/folder) and, for a private repository (Pro plan), an access token in `check_options.token`. `websocket` (a ws:// or wss:// URL) and `grpc` (host[:port]) are created on Pro and Business (Free answers `422` with `plan_required`).",
"enum": [
"http",
"api",
"ssl",
"domain",
"dns",
"blacklist",
"email_auth",
"malware",
"tcp",
"ssh",
"smtp",
"imap",
"pop",
"ftps",
"ping",
"ntp",
"udp",
"minecraft",
"steam",
"websocket",
"grpc",
"transaction",
"micro_transaction",
"extended_transaction",
"group",
"cloud_status",
"page_speed",
"webhook",
"heartbeat",
"repository"
],
"type": "string"
},
"locations": {
"description": "Location codes from GET /locations. Defaults to the first location.",
"items": {
"type": "string"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"lookalike_alerts": {
"default": false,
"description": "Pro and Business, `http` and `api` monitors: look up a few hundred typo and homoglyph spellings of the registered domain daily, and alert when one starts resolving or gains MX records.",
"type": "boolean"
},
"method": {
"default": "GET",
"description": "The HTTP method of the check's request.",
"enum": [
"GET",
"HEAD",
"POST",
"PUT",
"PATCH",
"DELETE"
],
"type": "string"
},
"name": {
"description": "Shown in alerts and on status pages.",
"maxLength": 160,
"type": "string"
},
"port_scan": {
"default": false,
"description": "Business plans, network and website checks: scan the common TCP ports of the host's verified addresses weekly (POST /monitors/{id}/ports/verify), and alert when a port opens. See /docs/port-scans.",
"type": "boolean"
},
"recovery_threshold": {
"default": 2,
"description": "Successful checks in a row before the incident resolves.",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"repeat_alert_minutes": {
"description": "Pro and Business plans: repeat the outage alert to the monitor's contacts this often until someone acknowledges the incident or it recovers, at most 48 times. `null` sends it once.",
"maximum": 1440,
"minimum": 5,
"type": [
"integer",
"null"
]
},
"repository_token": {
"description": "Access token for a private `repository_url`: on GitHub a fine-grained token with read-only Contents, on GitLab `read_api`. Stored encrypted and never returned (`repository_token_set` tells whether one is saved). Leave it out to keep it; `null` removes it.",
"maxLength": 500,
"type": [
"string",
"null"
],
"writeOnly": true
},
"repository_url": {
"description": "Pro and Business, `http` and `api` monitors with vulnerability alerts: the website's GitHub or GitLab repository (optionally …/tree/branch/folder), whose lockfiles and manifests are read hourly for exact versions. A failed read opens no incident. `null` unlinks it and removes what it listed.",
"type": [
"string",
"null"
]
},
"request_body": {
"description": "The body sent with the check's request, such as JSON for a POST.",
"maxLength": 65536,
"type": "string"
},
"request_headers": {
"additionalProperties": {
"type": "string"
},
"description": "Sent with the check; stored encrypted and never returned.",
"type": "object"
},
"slo_target": {
"description": "Every plan: an availability objective in percent, such as 99.9, over slo_window_days; null for none. Downtime is the time in incidents, less maintenance. The monitor's contacts are alerted when its error budget burns fast, is 50%, 75% and 90% used, and when it runs out. See /docs/reports#error-budgets.",
"exclusiveMaximum": 100,
"minimum": 50,
"type": [
"number",
"null"
]
},
"slo_window_days": {
"default": 30,
"description": "The rolling window of the availability objective, in days.",
"enum": [
7,
30,
90
],
"type": "integer"
},
"status_page": {
"default": true,
"description": "Creating only: give the monitor its own published status page while the plan allows more pages. Send `false` when you manage status pages yourself.",
"type": "boolean",
"writeOnly": true
},
"subdomain_alerts": {
"default": false,
"description": "Pro and Business, `http` and `api` monitors: list the domain's subdomains from certificate transparency logs (through crt.sh, which can be days or weeks behind), resolve each daily, and alert on a new one and on a CNAME to a service that reports no site there (a subdomain takeover risk).",
"type": "boolean"
},
"tab_id": {
"description": "The monitor tab (GET /monitor-tabs) the monitor is sorted into in the dashboard; `null` takes it out of its tab.",
"format": "uuid",
"type": [
"string",
"null"
]
},
"timeout_ms": {
"default": 10000,
"description": "Milliseconds a check waits for the reply before it counts as failed.",
"maximum": 60000,
"minimum": 500,
"type": "integer"
},
"url": {
"description": "URL, or host[:port] for network checks.",
"type": "string"
},
"vulnerability_alerts": {
"default": false,
"description": "Every plan, `http` and `api` monitors: scan the website for the software it runs (weekly on Free, daily on paid plans) and alert on newly published vulnerabilities in it, checked daily and within 15 minutes of a new advisory (OSV.dev with the GitHub Advisory Database, NVD, new CVE records, WPVulnerability and WordPress core advisories for WordPress, CISA KEV, endoflife.date).",
"type": "boolean"
},
"vulnerability_severity": {
"default": "high",
"description": "The lowest severity that alerts. Actively exploited vulnerabilities and releases reaching end of support always alert.",
"enum": [
"low",
"medium",
"high",
"critical"
],
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "update_monitor",
"outputSchema": null
},
{
"description": "Business plans. Fields left out keep their value; changing the members, rotation, handoff or time zone starts the rotation over. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"handoff_day": {
"default": 1,
"description": "Weekly handoffs: the weekday, 1 for Monday.",
"maximum": 7,
"minimum": 1,
"type": "integer"
},
"handoff_time": {
"default": "09:00",
"description": "HH:MM on the schedule's own clock.",
"examples": [
"09:00"
],
"type": "string"
},
"member_ids": {
"description": "Notification contacts (GET /alert-channels) in rotation order. Changing them, the rotation, the handoff or the time zone starts the rotation over with the first member.",
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 50,
"type": "array"
},
"name": {
"description": "The schedule's name.",
"maxLength": 80,
"type": "string"
},
"rotation": {
"default": "weekly",
"description": "How often on call passes to the next member.",
"enum": [
"daily",
"weekly"
],
"type": "string"
},
"schedule_id": {
"description": "Schedule ID from list_on_call_schedules.",
"format": "uuid",
"type": "string"
},
"time_zone": {
"default": "Etc/UTC",
"description": "An IANA time zone.",
"examples": [
"Europe/Berlin"
],
"type": "string"
}
},
"required": [
"schedule_id"
],
"type": "object"
},
"name": "update_on_call_schedule",
"outputSchema": null
},
{
"description": "Replaces the monitors a status page shows, in order, each optionally in a named group (\"API\", \"EU region\"); a group sits where its first monitor is and shows their worst state. Every plan. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"components": {
"description": "The monitors the page shows, in order, each once. Leave out to change only the groups' settings.",
"items": {
"properties": {
"display_name": {
"description": "The name visitors see; the monitor's own name by default.",
"maxLength": 160,
"type": "string"
},
"group": {
"description": "The name of the group it is shown in, or null for none. Monitors with the same name form a group.",
"maxLength": 80,
"type": [
"string",
"null"
]
},
"monitor_id": {
"description": "Monitor ID from list_monitors.",
"format": "uuid",
"type": "string"
}
},
"required": [
"monitor_id"
],
"type": "object"
},
"type": "array"
},
"groups": {
"description": "Groups' settings by name: collapsed, and id (from list_status_pages) to rename a group and keep its badges working.",
"items": {
"properties": {
"collapsed": {
"description": "Folded on the page while everything in it is operational (true by default); visitors open and fold it either way.",
"type": "boolean"
},
"id": {
"description": "The group's ID, to rename it.",
"format": "uuid",
"type": "string"
},
"name": {
"description": "The group's name.",
"maxLength": 80,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"status_page_id": {
"description": "Status page ID from list_status_pages.",
"format": "uuid",
"type": "string"
}
},
"required": [
"status_page_id"
],
"type": "object"
},
"name": "update_status_page_components",
"outputSchema": null
},
{
"description": "Looks for the proof of each of the host's addresses from get_ports: the file served at the address, or its reverse DNS (PTR) under the host resolving back to it with the TXT record in place. The TXT record alone proves no address. The proof must stay in place, since every scan checks it again; only covered addresses are scanned. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Monitor ID from list_monitors.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "verify_host",
"outputSchema": null
},
{
"description": "Writes a resolved incident's post-mortem: summary, impact, root cause and follow-ups (one per line), on Pro plans. It stays in the workspace until published: true shows it under the incident on the status pages that show it and in their feeds; false takes it off. Publish only when the user asks. Free.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"follow_ups": {
"description": "What will be done so it does not happen again, one per line.",
"maxLength": 5000,
"type": "string"
},
"impact": {
"description": "Who and what was affected, and for how long.",
"maxLength": 5000,
"type": "string"
},
"incident_id": {
"description": "Incident ID from list_incidents.",
"format": "uuid",
"type": "string"
},
"published": {
"description": "true shows the post-mortem on the status pages that show the incident; false takes it off. Leave out to keep it as it is.",
"type": "boolean"
},
"root_cause": {
"description": "What caused the incident.",
"maxLength": 5000,
"type": "string"
},
"summary": {
"description": "What happened, in a few sentences.",
"maxLength": 5000,
"type": "string"
}
},
"required": [
"incident_id"
],
"type": "object"
},
"name": "write_postmortem",
"outputSchema": null
}
]
}Verify it yourself
curl -s https://api.teppi.xyz/v1/evidence/sha256:6b9c35d8344d0bf01f147cba7c44a9c9c515741ff4d0c16fc8f3ab1f48827f2b | sha256sum