{ "openapi": "3.1.0", "info": { "title": "WhatPing API", "version": "1.0.0", "description": "Provision monitors and read their state.\n\nWrites are validated by the same code the dashboard uses, so the API accepts exactly what the interface accepts and nothing more." }, "servers": [ { "url": "https://api.whatping.com" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "A workspace API key, `sk_\u2026`. Scoped read or write." } }, "schemas": { "MonitorCreate": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "http", "tcp", "push", "ssl", "domain", "dns", "email-auth", "icmp", "udp", "grpc", "smtp", "imap" ] }, "interval_sec": { "type": "integer" }, "timeout_ms": { "type": "integer" }, "down_threshold": { "type": "integer" }, "repeat_every_min": { "type": "integer" }, "confirm_externally": { "type": "boolean" }, "url": { "type": "string" }, "expected_status": { "type": "integer" }, "accepted_status": { "type": "string" }, "max_redirects": { "type": "integer" }, "expected_keyword": { "type": "string" }, "keyword_inverted": { "type": "boolean" }, "host": { "type": "string" }, "port": { "type": "integer" }, "push_expected_interval_sec": { "type": "integer" }, "push_grace_sec": { "type": "integer" }, "cert_warn_days": { "type": "integer" }, "domain_warn_days": { "type": "integer" }, "dns_record_type": { "type": "string" }, "dns_expected": { "type": "string" }, "packet_count": { "type": "integer" }, "loss_threshold_pct": { "type": "integer" }, "udp_payload": { "type": "string" }, "udp_payload_hex": { "type": "string" }, "udp_expect_hex": { "type": "string" }, "dns_query_name": { "type": "string" }, "grpc_service": { "type": "string" }, "starttls": { "type": "boolean" }, "tls": { "type": "boolean" } }, "required": [ "name", "type" ] }, "MonitorUpdate": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "interval_sec": { "type": "integer" }, "timeout_ms": { "type": "integer" }, "down_threshold": { "type": "integer" }, "repeat_every_min": { "type": "integer" }, "confirm_externally": { "type": "boolean" }, "url": { "type": "string" }, "expected_status": { "type": "integer" }, "accepted_status": { "type": "string" }, "max_redirects": { "type": "integer" }, "expected_keyword": { "type": "string" }, "keyword_inverted": { "type": "boolean" }, "host": { "type": "string" }, "port": { "type": "integer" }, "push_expected_interval_sec": { "type": "integer" }, "push_grace_sec": { "type": "integer" }, "cert_warn_days": { "type": "integer" }, "domain_warn_days": { "type": "integer" }, "dns_record_type": { "type": "string" }, "dns_expected": { "type": "string" }, "packet_count": { "type": "integer" }, "loss_threshold_pct": { "type": "integer" }, "udp_payload": { "type": "string" }, "udp_payload_hex": { "type": "string" }, "udp_expect_hex": { "type": "string" }, "dns_query_name": { "type": "string" }, "grpc_service": { "type": "string" }, "starttls": { "type": "boolean" }, "tls": { "type": "boolean" } } } } }, "security": [ { "bearerAuth": [] } ], "paths": { "/v1/channels": { "get": { "summary": "List alert channels", "description": "Destinations are redacted. The API cannot read back a stored credential.\n\nRequires a `read` key.", "operationId": "get_v1_channels", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Missing, unknown, revoked or expired key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "403": { "description": "The key lacks the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "404": { "description": "Not found, or not in this workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; see `retry-after`", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } } } }, "post": { "summary": "Create an alert channel", "description": "`type` is one of webhook, ntfy, telegram, email, with its own fields (webhook `url`, ntfy `topic_url`, telegram `bot_token`+`chat_id`, email `to`). A webhook URL that resolves to a private address is refused.\n\nRequires a `write` key.", "operationId": "post_v1_channels", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Missing, unknown, revoked or expired key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "403": { "description": "The key lacks the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "404": { "description": "Not found, or not in this workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; see `retry-after`", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } } } } }, "/v1/channels/{id}": { "delete": { "summary": "Delete an alert channel", "description": "Also detaches it from every monitor. A channel in another workspace returns 404.\n\nRequires a `write` key.", "operationId": "delete_v1_channels_id", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Missing, unknown, revoked or expired key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "403": { "description": "The key lacks the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "404": { "description": "Not found, or not in this workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; see `retry-after`", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/incidents": { "get": { "summary": "List incidents", "description": "Filter by `status` (open, resolved) and `monitor_id`.\n\nRequires a `read` key.", "operationId": "get_v1_incidents", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Missing, unknown, revoked or expired key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "403": { "description": "The key lacks the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "404": { "description": "Not found, or not in this workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; see `retry-after`", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } } }, "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ] } }, "/v1/incidents/{id}/ack": { "post": { "summary": "Acknowledge an incident", "description": "Stops reminder notifications without resolving the incident \u2014 it stays open until the monitor recovers.\n\nRequires a `write` key.", "operationId": "post_v1_incidents_id_ack", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Missing, unknown, revoked or expired key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "403": { "description": "The key lacks the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "404": { "description": "Not found, or not in this workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; see `retry-after`", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/me": { "get": { "summary": "Current key", "description": "The key's scope, its workspace, and usage against the monitor limit.\n\nRequires a `read` key.", "operationId": "get_v1_me", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Missing, unknown, revoked or expired key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "403": { "description": "The key lacks the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "404": { "description": "Not found, or not in this workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; see `retry-after`", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } } } } }, "/v1/monitors": { "get": { "summary": "List monitors", "description": "Filter by `type`, `state` or `enabled`. Cursor paginated.\n\nRequires a `read` key.", "operationId": "get_v1_monitors", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Missing, unknown, revoked or expired key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "403": { "description": "The key lacks the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "404": { "description": "Not found, or not in this workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; see `retry-after`", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } } }, "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ] }, "post": { "summary": "Create a monitor", "description": "Validated by the same code the dashboard uses. Send `Idempotency-Key` to make retries safe. A `push` monitor returns `push_token` exactly once.\n\nRequires a `write` key.", "operationId": "post_v1_monitors", "security": [ { "bearerAuth": [] } ], "responses": { "401": { "description": "Missing, unknown, revoked or expired key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "403": { "description": "The key lacks the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "404": { "description": "Not found, or not in this workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; see `retry-after`", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "201": { "description": "Created" }, "409": { "description": "Idempotency-Key reused with a different body", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitorCreate" } } } } } }, "/v1/monitors/{id}": { "delete": { "summary": "Delete a monitor", "description": "Removes its incidents and channel attachments. Check history is purged in the background.\n\nRequires a `write` key.", "operationId": "delete_v1_monitors_id", "security": [ { "bearerAuth": [] } ], "responses": { "401": { "description": "Missing, unknown, revoked or expired key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "403": { "description": "The key lacks the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "404": { "description": "Not found, or not in this workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; see `retry-after`", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "204": { "description": "Deleted" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "Get a monitor", "description": "A monitor in another workspace returns 404, not 403.\n\nRequires a `read` key.", "operationId": "get_v1_monitors_id", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Missing, unknown, revoked or expired key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "403": { "description": "The key lacks the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "404": { "description": "Not found, or not in this workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; see `retry-after`", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "Update a monitor", "description": "Partial. `type` is immutable. The whole target is re-validated, so a partial edit cannot bypass a rule.\n\nRequires a `write` key.", "operationId": "patch_v1_monitors_id", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Missing, unknown, revoked or expired key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "403": { "description": "The key lacks the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "404": { "description": "Not found, or not in this workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; see `retry-after`", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonitorUpdate" } } } } } }, "/v1/monitors/{id}/channels": { "get": { "summary": "List attached channels", "description": "Channel IDs attached to this monitor.\n\nRequires a `read` key.", "operationId": "get_v1_monitors_id_channels", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Missing, unknown, revoked or expired key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "403": { "description": "The key lacks the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "404": { "description": "Not found, or not in this workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; see `retry-after`", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/monitors/{id}/channels/{channelId}": { "delete": { "summary": "Detach a channel", "description": "Idempotent.\n\nRequires a `write` key.", "operationId": "delete_v1_monitors_id_channels_channelId", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Missing, unknown, revoked or expired key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "403": { "description": "The key lacks the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "404": { "description": "Not found, or not in this workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; see `retry-after`", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "Attach a channel", "description": "Idempotent.\n\nRequires a `write` key.", "operationId": "put_v1_monitors_id_channels_channelId", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Missing, unknown, revoked or expired key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "403": { "description": "The key lacks the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "404": { "description": "Not found, or not in this workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; see `retry-after`", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/monitors/{id}/pause": { "post": { "summary": "Pause a monitor", "description": "Clears failure accounting and resolves any open incident, so resuming does not alert from stale counters.\n\nRequires a `write` key.", "operationId": "post_v1_monitors_id_pause", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Missing, unknown, revoked or expired key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "403": { "description": "The key lacks the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "404": { "description": "Not found, or not in this workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; see `retry-after`", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/monitors/{id}/results": { "get": { "summary": "List check results", "description": "Newest first. `since` is epoch milliseconds. Results are retained 7 days.\n\nRequires a `read` key.", "operationId": "get_v1_monitors_id_results", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Missing, unknown, revoked or expired key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "403": { "description": "The key lacks the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "404": { "description": "Not found, or not in this workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; see `retry-after`", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ] } }, "/v1/monitors/{id}/resume": { "post": { "summary": "Resume a monitor", "description": "The monitor returns to `pending` until its next check.\n\nRequires a `write` key.", "operationId": "post_v1_monitors_id_resume", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Missing, unknown, revoked or expired key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "403": { "description": "The key lacks the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "404": { "description": "Not found, or not in this workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; see `retry-after`", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/v1/monitors/{id}/rotate-token": { "post": { "summary": "Rotate a heartbeat token", "description": "Invalidates the previous token immediately. The new one is returned once.\n\nRequires a `write` key.", "operationId": "post_v1_monitors_id_rotate_token", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Missing, unknown, revoked or expired key", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "403": { "description": "The key lacks the required scope", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "404": { "description": "Not found, or not in this workspace", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "422": { "description": "Validation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; see `retry-after`", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "field": { "type": "string" } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } } } }