API resources & workflows

Groups

Use /groups to list and create groups, and the group ID routes to rename or remove one. A monitor’s group is updated through /monitors/{monitor_id}/group. Group limits and ownership still apply.

Notification channels

Use GET /channels/types to discover channel types and GET /channels to list configured destinations. Creating or testing a channel can send information to an external service; validate its configuration before automating these actions. Secret destination values may be masked in responses.

Maintenance windows

The /maintenance collection lists and creates windows. A one-time window includes a title, start, end and affected monitor IDs. Recurring windows use recurrence and duration fields. Send explicit timezone-aware timestamps and check the schema for validation constraints.

{
  "title": "Planned deployment",
  "starts_at": "2030-01-15T02:00:00Z",
  "ends_at": "2030-01-15T02:30:00Z",
  "monitor_ids": [
    "MONITOR_UUID"
  ]
}

This is an illustrative payload with a placeholder UUID and date. Replace both, and check the allowed scheduling range, before making a request.

Status pages and incidents

/status-pages lists or creates pages. Selected-page operations use /status-page and can require operation-specific page context. Incident and announcement operations publish customer-visible information: inspect the target page before creating, updating or deleting content.

Public status, subscription, confirmation and unlock endpoints have their own behavior. They are not general management routes. Use the documented operation rather than assuming that every public route needs a workspace API key.

Reports

The API exposes uptime reports and a CSV variant. Read the query parameters in the endpoint reference and respect the documented response content type. A CSV download should be saved or parsed as CSV instead of being passed to a JSON parser.

Access boundaries

Billing, sign-in, administrator operations and key creation are deliberately excluded from the public contract. An endpoint appearing in the reference does not waive its session, ownership, permission or plan checks. Refer to the operation reference for request and response shapes.