The API

Everything the dashboard does with monitors, incidents, maintenance windows and SLA policies, from a script: one key, one base address, JSON in and out.

Base address

https://api.nuvostatus.com

Every path below is relative to it. Requests and answers are JSON; times are ISO 8601 in UTC; identifiers are UUIDs.

Authentication

A key belongs to one workspace and is made in its settings by an owner or an administrator. Its value is shown once; keep it where your scripts keep secrets. Send it as a bearer token on every request. A key with the read scope sees what a viewer sees; one with the write scope can also create, change, pause and delete monitors and schedule maintenance. Members, keys and the workspace itself are never reachable with a key.

curl "https://api.nuvostatus.com/v1/me" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Errors

An error is an envelope with a stable code, the same codes the dashboard shows. The status says what kind: 400 for a body or a parameter the API does not accept (with details per field), 401 for a missing, unknown, revoked or expired key, 403 for something the key may not do, 404 for a resource that is not in the key’s workspace, 409 for a limit reached, 429 past the limit of requests.

{
  "error": {
    "code": "monitor.not_found"
  }
}

Pagination

A list answers with items and next. Pass next as the cursor of the following request to get the page after it; next is null on the last page. Checks and incidents come newest first; limit says how many at most.

GET https://api.nuvostatus.com/v1/incidents?limit=20
GET https://api.nuvostatus.com/v1/incidents?limit=20&cursor=MjAyNi0xMC0wNlQxOTo0NDo0NS4wMDBa

Backup and restore

A workspace’s whole configuration leaves as one versioned JSON document and comes back the same way, into the same workspace or another. The document carries monitors, groups, maintenance windows, channels and status pages, and no secret: a monitor’s credential, a channel’s destination and a page’s password stay behind, and the import names the entries it left unconfigured. Nothing already there is created twice, and the plan is checked before anything is written. A read key may take the backup; a write key may restore it.

GET https://api.nuvostatus.com/v1/workspace/export
POST https://api.nuvostatus.com/v1/workspace/import

Limits

The limit follows the workspace plan: 60 requests a minute on free, 120 on starter, 600 on pro and 1,200 on business. It is counted in PostgreSQL, per key and per minute, so restarting the API does not reset it. Every answer says where the key stands in the RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset headers; past the limit the answer is 429 request.rate_limited with Retry-After.

Zapier

A workspace can also send its incidents to Zapier: add a Zapier channel with your Catch Hook URL and every enabled channel receives the incident as JSON. The payload, the setup steps and the guarantees every channel shares are in the notification channel documentation at docs/architecture/notifications.md.

Reference

Every operation, with what it takes and what it answers. The same description is published for machines at /docs/api/openapi.json.

The key, its workspace, and the plan

GET /v1/meScope: read

Says which key is calling, what it may do, the workspace it belongs to, the limits that apply to it, what it uses of them, and whether it is within them. A read key may be limited to a set of monitors; `monitorIds` says which, and empty means the whole workspace. Read-only: nothing about billing can be changed through a key.

Answers

  • 200 — The answer.
    { key: { id: string, scope: "read" | "write", monitorIds: string[] }, workspace: { id: string, name: string, defaultLocale: string, role: "owner" | "admin" | "member" | "viewer", createdAt: string, planId: string, escalationAfterSeconds: integer | null }, plan: { planId: "free" | "starter" | "pro" | "business" | "beta" }, limits: { monitors: integer, minIntervalSeconds: integer, members: integer, retentionDays: integer, apiKeys: integer, contacts: integer, maintenanceWindows: integer, regions: integer, statusPages: integer, webhooks: integer, manualChecksPerDay: integer }, usage: { monitors: integer, members: integer, contacts: integer, maintenanceWindows: integer, apiKeys: integer, shortestIntervalSeconds: integer | null }, compliance: { withinLimits: boolean, exceeded: { key: "monitors" | "minIntervalSeconds" | "members" | "retentionDays" | "apiKeys" | "contacts" | "maintenanceWindows" | "regions" | "statusPages" | "webhooks" | "manualChecksPerDay", used: integer, allowed: integer }[], featuresInUse: "monitor.http" | "monitor.tcp" | "monitor.dns" | "monitor.heartbeat" | "monitor.ping" | "monitor.udp" | "monitor.domain" | "ssl" | "api" | "statusPages" | "webhooks"[] } }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/me" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

The account: plan, limits and usage

GET /v1/accountScope: read

The workspace, the plan it is on, its language, and where it stands against the plan’s limits: monitors used and allowed, seats used and allowed, and the shortest interval it may choose. The same figures the dashboard shows, counted by the same queries. The key that asked, with its name and scope, and nothing of another workspace.

Answers

  • 200 — The answer.
    { workspace: { id: string, name: string, slug: string }, plan: string, locale: string, createdAt: string, entitlements: { monitorLimit: integer, monitorsUsed: integer, seatLimit: integer, seatsUsed: integer, minimumIntervalSeconds: integer }, apiKey: { id: string, name: string, scopes: "read" | "write"[] } }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/account" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Read the activity log

GET /v1/audit-logsScope: read

What happened in the workspace, who did it, on what and when, newest first. Only an owner, an administrator or a read key may ask; a write key and a member are refused. The entry never carries the request’s address or a secret, and its metadata holds only what the change recorded on purpose.

Parameters

  • limit — in the query string, optional
  • cursor — in the query string, optional
  • action — in the query string, optional
  • actorId — in the query string, optional
  • targetType — in the query string, optional
  • targetId — in the query string, optional
  • from — in the query string, optional
  • to — in the query string, optional

Answers

  • 200 — The answer.
    { entries: { id: string, actorType: "user" | "api_key" | "system", actorId: string | null, actorName: string | null, action: string, targetType: string | null, targetId: string | null, metadata: {}, createdAt: string }[], nextCursor: string | null }
  • 400 — One of: validation.failed.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, audit.read_forbidden.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/audit-logs" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Export the whole workspace as one document

GET /v1/workspace/exportScope: read

The workspace’s configuration as one versioned JSON file: its name, monitors, groups, maintenance windows, channels and status pages. It carries the shape of every credential and never a value — an HTTP monitor’s headers, password, token and body are the mask, a channel has no destination, a protected page has no password — and each such entry says `secretsOmitted`. Ids are absent by design: an import remaps everything through names, targets and slugs. Send it back to `/v1/workspace/import`, in this workspace or another.

Answers

  • 200 — The answer.
    { formatVersion: 1, exportedAt: string, workspace: { name: string }, monitors: { name: string, type: "http" | "tcp" | "dns" | "heartbeat" | "ping" | "udp" | "domain", config: {}, intervalSeconds: integer, timeoutSeconds: integer, confirmationChecks: integer, confirmationSpanSeconds: integer, importance: "critical" | "standard", certificateAlertDays: integer, slaTargetBp: integer, slaBudgetAlertPercent: integer | null, slowResponseMs: integer | null, runbookUrl?: string | null, responseBaselinePercent?: integer | null, paused: boolean, groupName: string | null, channelNames: string[], secretsOmitted: boolean }[], groups: { name: string }[], maintenance: { name: string, startsAt: string, endsAt: string, recurrence: "none" | "daily" | "weekly" | "monthly", timeZone: string | null, monitorNames: string[], groupNames: string[] }[], channels: { kind: "webhook" | "slack" | "telegram" | "teams" | "discord" | "google_chat" | "mattermost" | "splunk" | "pagerduty" | "pushover" | "pushbullet" | "sms" | "voice" | "zapier", name: string, enabled: boolean, events: "opened" | "resolved" | "escalated"[], severityFloor: "all" | "critical", secretsOmitted: true }[], statusPages: { slug: string, title: string, description: string | null, accentColor: string | null, logoUrl: string | null, locale: "en" | "es" | "de" | "fr" | "pt", subscriberAlertBudget: integer, published: boolean, passwordProtected: boolean, services: … | …[], secretsOmitted: true }[] }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/workspace/export" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Import a workspace document

POST /v1/workspace/importScope: write

Creates what the document carries in this workspace: monitors, groups, maintenance windows, channels and status pages, with every id its own and every reference remapped by name. A channel arrives disabled without its destination; a monitor that needs a credential the file did not carry arrives paused; a page arrives unpublished, and under a fresh slug when its own is taken. Nothing already there — a monitor with the same name and target, a group, channel or page with the same name or slug, a window with the same name and start — is created twice. The plan is checked before anything is written: a document that would exceed it answers `workspace.import_limit_exceeded` and creates nothing. Send an `Idempotency-Key` to make a retry replay this answer.

Parameters

  • Idempotency-Key — in the query string, optional

Request body

{ formatVersion: 1, exportedAt: string, workspace: { name: string }, monitors: { name: string, type: "http" | "tcp" | "dns" | "heartbeat" | "ping" | "udp" | "domain", config: {}, intervalSeconds: integer, timeoutSeconds: integer, confirmationChecks: integer, confirmationSpanSeconds: integer, importance: "critical" | "standard", certificateAlertDays: integer, slaTargetBp: integer, slaBudgetAlertPercent: integer | null, slowResponseMs: integer | null, runbookUrl?: string | null, responseBaselinePercent?: integer | null, paused: boolean, groupName: string | null, channelNames: string[], secretsOmitted: boolean }[], groups: { name: string }[], maintenance: { name: string, startsAt: string, endsAt: string, recurrence: "none" | "daily" | "weekly" | "monthly", timeZone: string | null, monitorNames: string[], groupNames: string[] }[], channels: { kind: "webhook" | "slack" | "telegram" | "teams" | "discord" | "google_chat" | "mattermost" | "splunk" | "pagerduty" | "pushover" | "pushbullet" | "sms" | "voice" | "zapier", name: string, enabled: boolean, events: "opened" | "resolved" | "escalated"[], severityFloor: "all" | "critical", secretsOmitted: true }[], statusPages: { slug: string, title: string, description: string | null, accentColor: string | null, logoUrl: string | null, locale: "en" | "es" | "de" | "fr" | "pt", subscriberAlertBudget: integer, published: boolean, passwordProtected: boolean, services: … | …[], secretsOmitted: true }[] }

Answers

  • 201 — The answer.
    { created: { monitors: integer, groups: integer, maintenance: integer, channels: integer, statusPages: integer }, ids: { monitors: string[], groups: string[], maintenance: string[], channels: string[], statusPages: string[] }, skipped: { kind: "monitor" | "group" | "maintenance" | "channel" | "status_page", name: string, reason: "already_present" | "invalid" | "unknown_reference" }[], unconfigured: { monitors: string[], channels: string[], statusPages: string[] } }
  • 400 — One of: validation.failed, workspace.import_limit_exceeded.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 409 — One of: idempotency.conflict, idempotency.in_progress.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/workspace/import" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"formatVersion":1,"exportedAt":"2026-11-13T10:00:00.000Z","workspace":{"name":"Acme"},"monitors":[{"name":"Shop","type":"tcp","config":{"host":"shop.example.com","port":443},"intervalSeconds":300,"timeoutSeconds":10,"confirmationChecks":3,"confirmationSpanSeconds":60,"importance":"standard","certificateAlertDays":30,"slaTargetBp":9990,"slaBudgetAlertPercent":null,"slowResponseMs":null,"responseBaselinePercent":null,"paused":false,"groupName":"Storefront","channelNames":[],"secretsOmitted":false}],"groups":[{"name":"Storefront"}],"maintenance":[],"channels":[],"statusPages":[]}'

List the members

GET /v1/membersScope: read

The people in the workspace, with the role each holds and since when. Never a session, a credential or a token. A read key sees them as a viewer sees them.

Answers

  • 200 — The answer.
    { items: { id: string, email: string, role: "owner" | "admin" | "member" | "viewer", joinedAt: string }[], next: string | null }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/members" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Invite somebody to the workspace

POST /v1/members/invitationsScope: write

Invites one address with one role. A write key acts as an administrator over people, never as an owner: it may invite members and viewers only. The invitation is sent by email; its token is in the link and never in an answer.

Request body

{ email: string, role: "owner" | "admin" | "member" | "viewer" }

Answers

  • 201 — The answer.
    { invitation: { id: string, email: string, role: "owner" | "admin" | "member" | "viewer", invitedBy: string | null, expiresAt: string, createdAt: string } }
  • 400 — One of: validation.failed.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied, member.role_not_assignable.
  • 409 — One of: member.limit_reached, invitation.already_member, invitation.limit_reached.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/members/invitations" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"person@example.com","role":"member"}'

List the open invitations

GET /v1/members/invitationsScope: write

The invitations that have been sent and not yet accepted, oldest first. Their tokens are not part of any answer.

Answers

  • 200 — The answer.
    { items: { id: string, email: string, role: "owner" | "admin" | "member" | "viewer", invitedBy: string | null, expiresAt: string, createdAt: string }[], next: string | null }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/members/invitations" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Withdraw an invitation

DELETE /v1/members/invitations/{id}Scope: write

Revokes an invitation that has not been accepted; its link stops working.

Parameters

  • id — in the path, required

Answers

  • 204 — Done; no body.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: invitation.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X DELETE "https://api.nuvostatus.com/v1/members/invitations/0199e6a0-0000-7000-8000-000000000001" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Change a member's role

PATCH /v1/members/{id}Scope: write

Gives a member another role. A write key acts as an administrator over people: it may change members and viewers, never an owner or another administrator.

Parameters

  • id — in the path, required

Request body

{ role: "owner" | "admin" | "member" | "viewer" }

Answers

  • 204 — Done; no body.
  • 400 — One of: validation.failed.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied, member.role_not_assignable.
  • 404 — One of: member.not_found.
  • 409 — One of: member.last_owner.
  • 429 — One of: request.rate_limited.

Example

curl -X PATCH "https://api.nuvostatus.com/v1/members/0199e6a0-0000-7000-8000-000000000001" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"role":"member"}'

Remove a member

DELETE /v1/members/{id}Scope: write

Removes a member from the workspace. The last owner stays; an owner or another administrator is out of a write key’s reach.

Parameters

  • id — in the path, required

Answers

  • 204 — Done; no body.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied, member.role_not_assignable.
  • 404 — One of: member.not_found.
  • 409 — One of: member.last_owner.
  • 429 — One of: request.rate_limited.

Example

curl -X DELETE "https://api.nuvostatus.com/v1/members/0199e6a0-0000-7000-8000-000000000001" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

List the monitors

GET /v1/monitorsScope: read

A page of the monitors the key may read, with its state and the limits of the workspace. Search by name or address, keep one group, label or state, order by name, creation or latest median response time, and ask for the next page with `cursor`. A read key limited to some monitors lists exactly those; another monitor of the workspace answers as one that does not exist.

Parameters

  • q — in the query string, optional
  • groupId — in the query string, optional
  • tagId — in the query string, optional
  • status — in the query string, optional
  • sort — in the query string, optional
  • direction — in the query string, optional
  • limit — in the query string, optional
  • cursor — in the query string, optional

Answers

  • 200 — The answer.
    { items: { type: "http", config: { url: …, method: …, followRedirects: …, expectedStatus: …, keyword: …, keywordMustAppear: …, conditions: …, conditionMode: …, headers: …, auth: …, body: … }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: …, missingCapability: … }, lastCheck: { at: …, class: …, error: …, statusCode: …, responseMs: … }, certificate: { notBefore: …, notAfter: …, issuer: …, subject: …, sans: …, seenAt: …, daysLeft: …, state: … }, maintenance: { id: …, name: …, endsAt: … }, incident: { id: …, startedAt: …, confirmedAt: …, recovering: …, flapping: … }, notifications: { alertMembers: …, contactIds: …, quietUntil: …, quietForever: … }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: …[], nextCheckAt: string | null, heartbeat: { lastPingAt: …, dueAt: … }, createdAt: string, updatedAt: string } | { type: "tcp", config: { host: …, port: … }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: …, missingCapability: … }, lastCheck: { at: …, class: …, error: …, statusCode: …, responseMs: … }, certificate: { notBefore: …, notAfter: …, issuer: …, subject: …, sans: …, seenAt: …, daysLeft: …, state: … }, maintenance: { id: …, name: …, endsAt: … }, incident: { id: …, startedAt: …, confirmedAt: …, recovering: …, flapping: … }, notifications: { alertMembers: …, contactIds: …, quietUntil: …, quietForever: … }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: …[], nextCheckAt: string | null, heartbeat: { lastPingAt: …, dueAt: … }, createdAt: string, updatedAt: string } | { type: "dns", config: { name: …, recordType: …, expected: …, resolver: … }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: …, missingCapability: … }, lastCheck: { at: …, class: …, error: …, statusCode: …, responseMs: … }, certificate: { notBefore: …, notAfter: …, issuer: …, subject: …, sans: …, seenAt: …, daysLeft: …, state: … }, maintenance: { id: …, name: …, endsAt: … }, incident: { id: …, startedAt: …, confirmedAt: …, recovering: …, flapping: … }, notifications: { alertMembers: …, contactIds: …, quietUntil: …, quietForever: … }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: …[], nextCheckAt: string | null, heartbeat: { lastPingAt: …, dueAt: … }, createdAt: string, updatedAt: string } | { type: "heartbeat", config: { periodSeconds: …, graceSeconds: … }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: …, missingCapability: … }, lastCheck: { at: …, class: …, error: …, statusCode: …, responseMs: … }, certificate: { notBefore: …, notAfter: …, issuer: …, subject: …, sans: …, seenAt: …, daysLeft: …, state: … }, maintenance: { id: …, name: …, endsAt: … }, incident: { id: …, startedAt: …, confirmedAt: …, recovering: …, flapping: … }, notifications: { alertMembers: …, contactIds: …, quietUntil: …, quietForever: … }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: …[], nextCheckAt: string | null, heartbeat: { lastPingAt: …, dueAt: … }, createdAt: string, updatedAt: string } | { type: "ping", config: { host: … }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: …, missingCapability: … }, lastCheck: { at: …, class: …, error: …, statusCode: …, responseMs: … }, certificate: { notBefore: …, notAfter: …, issuer: …, subject: …, sans: …, seenAt: …, daysLeft: …, state: … }, maintenance: { id: …, name: …, endsAt: … }, incident: { id: …, startedAt: …, confirmedAt: …, recovering: …, flapping: … }, notifications: { alertMembers: …, contactIds: …, quietUntil: …, quietForever: … }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: …[], nextCheckAt: string | null, heartbeat: { lastPingAt: …, dueAt: … }, createdAt: string, updatedAt: string } | { type: "udp", config: { host: …, port: … }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: …, missingCapability: … }, lastCheck: { at: …, class: …, error: …, statusCode: …, responseMs: … }, certificate: { notBefore: …, notAfter: …, issuer: …, subject: …, sans: …, seenAt: …, daysLeft: …, state: … }, maintenance: { id: …, name: …, endsAt: … }, incident: { id: …, startedAt: …, confirmedAt: …, recovering: …, flapping: … }, notifications: { alertMembers: …, contactIds: …, quietUntil: …, quietForever: … }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: …[], nextCheckAt: string | null, heartbeat: { lastPingAt: …, dueAt: … }, createdAt: string, updatedAt: string } | { type: "domain", config: { domain: … }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: …, missingCapability: … }, lastCheck: { at: …, class: …, error: …, statusCode: …, responseMs: … }, certificate: { notBefore: …, notAfter: …, issuer: …, subject: …, sans: …, seenAt: …, daysLeft: …, state: … }, maintenance: { id: …, name: …, endsAt: … }, incident: { id: …, startedAt: …, confirmedAt: …, recovering: …, flapping: … }, notifications: { alertMembers: …, contactIds: …, quietUntil: …, quietForever: … }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: …[], nextCheckAt: string | null, heartbeat: { lastPingAt: …, dueAt: … }, createdAt: string, updatedAt: string }[], next: string | null, total: integer, limits: { maxMonitors: integer, usedMonitors: integer, intervals: 30 | 60 | 120 | 180 | 300 | 600 | 900 | 1800 | 3600[] } }
  • 400 — One of: validation.failed, monitor.invalid_cursor.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/monitors" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Create a monitor

POST /v1/monitorsScope: write

A monitor of one of the kinds. A heartbeat answers with the address its job must call, shown here and never again. Send an `Idempotency-Key` to make a retry replay this answer instead of creating a second monitor.

Parameters

  • Idempotency-Key — in the query string, optional

Request body

{ type: "http", name: string, channelIds?: string[], dependsOn?: string[], intervalSeconds?: 30 | 60 | 120 | 180 | 300 | 600 | 900 | 1800 | 3600, confirmationChecks?: integer, confirmationSpanSeconds?: integer, timeoutSeconds?: integer, importance?: "critical" | "standard", certificateThresholds?: { warningDays: integer, criticalDays: integer }, certificateAlertDays?: integer, slaTargetBp?: integer, slaBudgetAlertPercent?: integer | null, slowResponseMs?: integer | null, baselinePercent?: integer | null, runbookUrl?: string | null, config: { url: string, method?: "GET" | "HEAD" | "POST" | "PUT" | "PATCH" | "DELETE", followRedirects?: boolean, expectedStatus?: string[], keyword?: string | null, keywordMustAppear?: boolean, conditions?: … | … | … | … | … | …[], conditionMode?: "all" | "any", headers?: { name: …, value: … }[], auth?: { type: … } | { type: …, username: …, password: … } | { type: …, token: … } | { type: …, value: … }, body?: { contentType: string, value: string } } } | { type: "tcp", name: string, channelIds?: string[], dependsOn?: string[], intervalSeconds?: 30 | 60 | 120 | 180 | 300 | 600 | 900 | 1800 | 3600, confirmationChecks?: integer, confirmationSpanSeconds?: integer, timeoutSeconds?: integer, importance?: "critical" | "standard", certificateThresholds?: { warningDays: integer, criticalDays: integer }, certificateAlertDays?: integer, slaTargetBp?: integer, slaBudgetAlertPercent?: integer | null, slowResponseMs?: integer | null, baselinePercent?: integer | null, runbookUrl?: string | null, config: { host: string, port: integer } } | { type: "dns", name: string, channelIds?: string[], dependsOn?: string[], intervalSeconds?: 30 | 60 | 120 | 180 | 300 | 600 | 900 | 1800 | 3600, confirmationChecks?: integer, confirmationSpanSeconds?: integer, timeoutSeconds?: integer, importance?: "critical" | "standard", certificateThresholds?: { warningDays: integer, criticalDays: integer }, certificateAlertDays?: integer, slaTargetBp?: integer, slaBudgetAlertPercent?: integer | null, slowResponseMs?: integer | null, baselinePercent?: integer | null, runbookUrl?: string | null, config: { name: string, recordType: "A" | "AAAA" | "CNAME" | "MX" | "TXT" | "NS", expected?: string[], resolver?: "system" | "cloudflare" | "google" | "quad9" | "opendns" } } | { type: "heartbeat", name: string, channelIds?: string[], dependsOn?: string[], importance?: "critical" | "standard", confirmationChecks?: integer, confirmationSpanSeconds?: integer, slowResponseMs?: integer | null, baselinePercent?: integer | null, runbookUrl?: string | null, config: { periodSeconds: 60 | 120 | 300 | 600 | 900 | 1800 | 3600 | 7200 | 21600 | 43200 | 86400 | 604800 | 2592000, graceSeconds: integer } } | { type: "ping", name: string, channelIds?: string[], dependsOn?: string[], intervalSeconds?: 30 | 60 | 120 | 180 | 300 | 600 | 900 | 1800 | 3600, confirmationChecks?: integer, confirmationSpanSeconds?: integer, timeoutSeconds?: integer, importance?: "critical" | "standard", certificateThresholds?: { warningDays: integer, criticalDays: integer }, certificateAlertDays?: integer, slaTargetBp?: integer, slaBudgetAlertPercent?: integer | null, slowResponseMs?: integer | null, baselinePercent?: integer | null, runbookUrl?: string | null, config: { host: string } } | { type: "udp", name: string, channelIds?: string[], dependsOn?: string[], intervalSeconds?: 30 | 60 | 120 | 180 | 300 | 600 | 900 | 1800 | 3600, confirmationChecks?: integer, confirmationSpanSeconds?: integer, timeoutSeconds?: integer, importance?: "critical" | "standard", certificateThresholds?: { warningDays: integer, criticalDays: integer }, certificateAlertDays?: integer, slaTargetBp?: integer, slaBudgetAlertPercent?: integer | null, slowResponseMs?: integer | null, baselinePercent?: integer | null, runbookUrl?: string | null, config: { host: string, port: integer } } | { type: "domain", name: string, channelIds?: string[], dependsOn?: string[], intervalSeconds?: 30 | 60 | 120 | 180 | 300 | 600 | 900 | 1800 | 3600, confirmationChecks?: integer, confirmationSpanSeconds?: integer, timeoutSeconds?: integer, importance?: "critical" | "standard", certificateThresholds?: { warningDays: integer, criticalDays: integer }, certificateAlertDays?: integer, slaTargetBp?: integer, slaBudgetAlertPercent?: integer | null, slowResponseMs?: integer | null, baselinePercent?: integer | null, runbookUrl?: string | null, config: { domain: string } }

Answers

  • 201 — The answer.
    { monitor: { type: "http", config: { url: string, method: "GET" | "HEAD" | "POST" | "PUT" | "PATCH" | "DELETE", followRedirects: boolean, expectedStatus: …[], keyword: string | null, keywordMustAppear: boolean, conditions: …[], conditionMode: "all" | "any", headers: …[], auth: … | … | …, body: { contentType: …, value: … } }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: …[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: …, name: … }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "tcp", config: { host: string, port: integer }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: …[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: …, name: … }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "dns", config: { name: string, recordType: "A" | "AAAA" | "CNAME" | "MX" | "TXT" | "NS", expected: …[], resolver: "system" | "cloudflare" | "google" | "quad9" | "opendns" }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: …[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: …, name: … }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "heartbeat", config: { periodSeconds: 60 | 120 | 300 | 600 | 900 | 1800 | 3600 | 7200 | 21600 | 43200 | 86400 | 604800 | 2592000, graceSeconds: integer }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: …[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: …, name: … }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "ping", config: { host: string }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: …[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: …, name: … }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "udp", config: { host: string, port: integer }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: …[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: …, name: … }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "domain", config: { domain: string }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: …[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: …, name: … }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string }, heartbeatUrl?: string }
  • 400 — One of: validation.failed, monitor.url_not_allowed, monitor.host_not_allowed, monitor.domain_invalid, monitor.keyword_needs_body, monitor.conditions_need_body, monitor.json_condition_needs_body, monitor.interval_not_allowed, monitor.secrets_unavailable.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 409 — One of: monitor.limit_reached, idempotency.conflict, idempotency.in_progress.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/monitors" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"tcp","name":"Database","config":{"host":"db.example.com","port":5432},"intervalSeconds":300}'
{"type":"http","name":"Shop","config":{"url":"https://shop.example.com/health","expectedStatus":["2xx"]},"baselinePercent":60}
{"type":"http","name":"Private API","config":{"url":"https://api.example.com/orders","method":"POST","headers":[{"name":"X-Environment","value":"production"}],"auth":{"type":"bearer","token":"a-token"},"body":{"contentType":"application/json","value":"{\"limit\":1}"},"expectedStatus":["2xx"]}}
{"type":"http","name":"Status page text","config":{"url":"https://shop.example.com/status","conditions":[{"type":"body_contains","text":"All systems operational"},{"type":"body_not_contains","text":"maintenance"}],"conditionMode":"all"}}
{"type":"dns","name":"Mail","config":{"name":"example.com","recordType":"MX","expected":["mail.example.com"],"resolver":"system"}}
{"type":"heartbeat","name":"Nightly backup","config":{"periodSeconds":86400,"graceSeconds":3600}}
{"type":"ping","name":"Office router","config":{"host":"router.example.com"}}
{"type":"udp","name":"Game server","config":{"host":"game.example.com","port":27015}}
{"type":"domain","name":"Company domain","config":{"domain":"example.com"}}

Import monitors from a CSV export

POST /v1/monitors/imports/csvScope: write

A Pingdom, StatusCake or plain CSV export. Every row of the file is answered in order: created, already imported, a duplicate of a row above, over the plan’s cap, or refused with its file row and a code. A refusal never fails the rest, and importing the same file twice creates nothing. Send an `Idempotency-Key` to make a retry replay this answer.

Parameters

  • Idempotency-Key — in the query string, optional

Request body

{ format: "pingdom" | "statuscake" | "generic", csv: string, filename?: string }

Answers

  • 200 — The answer.
    { batch: { id: string, format: "pingdom" | "statuscake" | "generic", filename: string | null, rowsRead: integer, rowsCreated: integer, rowsSkipped: integer, rowsRefused: integer, rowsLimitReached: integer, createdAt: string }, rows: { row: integer, outcome: "created" | "already_imported" | "duplicate_in_file" | "limit_reached" | "refused", name: string, code?: "auth.cannot_revoke_current" | "auth.email_not_verified" | "auth.invalid_code" | "auth.invalid_credentials" | "auth.invalid_token" | "auth.password_too_long" | "auth.password_too_short" | "auth.totp_required" | "auth.two_factor_already_enabled" | "auth.two_factor_not_enabled" | "auth.unauthenticated" | "internal.error" | "invitation.already_member" | "invitation.limit_reached" | "invitation.not_found" | "account.password_incorrect" | "account.sole_owner" | "account.disabled" | "account.email_taken" | "account.email_unchanged" | "admin.not_an_operator" | "admin.permission_denied" | "admin.user_not_found" | "admin.workspace_not_found" | "admin.monitor_not_found" | "admin.incident_not_found" | "admin.plan_unknown" | "admin.plan_below_usage" | "admin.override_invalid" | "admin.subscription_not_found" | "alert_digest.invalid_window" | "alert_grouping.invalid" | "api.bulk_empty" | "audit.read_forbidden" | "billing.provider_unavailable" | "billing.plan_not_sold" | "billing.no_subscription" | "billing.subscription_state" | "billing.subscription_conflict" | "billing.webhook_rejected" | "entitlement.feature_not_included" | "escalation_steps.invalid" | "escalation.rotation_not_found" | "escalation_steps.contact_not_found" | "escalation_steps.channel_not_found" | "member.limit_reached" | "member.last_owner" | "member.not_found" | "member.role_not_assignable" | "monitor.account_limit_reached" | "monitor.confirmation_out_of_range" | "monitor.interval_not_allowed" | "monitor.limit_reached" | "monitor.timeout_not_allowed" | "monitor.update_forbidden" | "import.invalid_export" | "import.row_refused" | "import.secret_unavailable" | "import.source_key_refused" | "import.source_unavailable" | "import.unsupported_type" | "import.missing_target" | "import.invalid_target" | "import.invalid_name" | "import.unsupported_interval" | "import.too_many_rows" | "incident.not_found" | "incident.invalid_cursor" | "incident.impact_invalid" | "incident.assignee_not_member" | "incident.assignment_forbidden" | "incident.already_resolved" | "incident.not_resolved" | "incident.already_open" | "incident.not_manual" | "incident.cause_invalid" | "incident.declaration_forbidden" | "incident.export_too_large" | "action_item.not_found" | "action_item.too_many" | "action_item.incident_open" | "action_item.owner_not_member" | "action_item.due_in_past" | "postmortem.not_found" | "incident_comment.not_author" | "incident_comment.not_found" | "monitor.invalid_cursor" | "monitor.not_found" | "monitor.not_deleted" | "monitor.restore_window_expired" | "monitor.url_not_allowed" | "monitor.channel_not_found" | "monitor.keyword_needs_body" | "monitor.conditions_need_body" | "monitor.json_condition_needs_body" | "monitor.config_invalid" | "monitor.authorization_header_conflict" | "monitor.auth_value_has_scheme" | "monitor.domain_invalid" | "monitor.secrets_unavailable" | "monitor.host_not_allowed" | "monitor.not_a_heartbeat" | "monitor.slow_response_not_supported" | "monitor.baseline_not_supported" | "monitor.pause_until_in_past" | "monitor.pause_until_too_far" | "monitor.dependency_not_found" | "monitor.dependency_self" | "monitor.dependency_limit" | "monitor.dependency_duplicate" | "monitor.dependency_cycle" | "monitor.runbook_url_invalid" | "monitor.paused" | "monitor.check_too_soon" | "monitor.check_budget_spent" | "monitor.check_not_supported" | "monitor.no_capable_probe" | "manual_check.not_found" | "on_call.invalid_participant" | "on_call.invalid_window" | "on_call.invalid_name" | "on_call.name_taken" | "on_call.rotation_not_found" | "on_call.rotation_last" | "rotation.in_use" | "group.not_found" | "group.name_taken" | "group.limit_reached" | "group.order_invalid" | "idempotency.conflict" | "idempotency.in_progress" | "tag.not_found" | "tag.name_taken" | "tag.limit_reached" | "tag.limit_per_monitor" | "sla_policy.not_found" | "sla_policy.name_taken" | "sla_policy.monitor_already_covered" | "sla_report.not_found" | "sla_report.month_not_closed" | "sla_report.too_large" | "api_key.not_found" | "api_key.limit_reached" | "api_key.write_key_not_limited" | "api_key.monitor_not_allowed" | "api_key.not_rotatable" | "api_key.grace_out_of_range" | "contact.not_found" | "contact.already_exists" | "contact.limit_reached" | "contact.availability_invalid" | "contact.unavailable" | "maintenance.not_found" | "maintenance.not_editable" | "maintenance.limit_reached" | "maintenance.monitor_not_found" | "maintenance.group_not_found" | "maintenance.invalid_window" | "maintenance.skip_not_recurring" | "maintenance.skip_not_an_occurrence" | "maintenance.skip_started" | "maintenance.skip_already_skipped" | "maintenance.skip_not_found" | "maintenance_window.group_not_found" | "maintenance_window.limit_exceeded" | "maintenance_window.monitor_not_found" | "maintenance_window.not_active" | "maintenance_window.not_found" | "contact.not_verified" | "contact.unknown_contact" | "contact.verification_invalid" | "channel.not_found" | "channel.name_taken" | "channel.limit_reached" | "channel.config_invalid" | "channel.events_empty" | "channel.secret_unavailable" | "channel.secret_not_rotatable" | "delivery.not_found" | "delivery.not_retryable" | "delivery.paced" | "email.lane_budget_exhausted" | "email.suppression_not_found" | "email.webhook_rejected" | "alert_provider.not_configured" | "permission.denied" | "probe.enrolment_expired" | "probe.enrolment_invalid_key" | "probe.enrolment_invalid_request" | "probe.enrolment_revoked" | "probe.enrolment_unknown" | "probe.enrolment_used" | "request.content_type_not_allowed" | "request.cross_site" | "request.host_not_allowed" | "request.origin_missing" | "request.origin_not_allowed" | "request.rate_limited" | "resource.not_found" | "status_page.limit_reached" | "status_page.monitor_not_found" | "status_page.not_found" | "status_page.password_incorrect" | "status_page.slug_taken" | "status_page.unavailable" | "status_page.service_not_found" | "status_page.services_required" | "status_page.domain_invalid" | "status_page.domain_taken" | "status_page_announcement.invalid_window" | "status_page_announcement.limit_reached" | "status_page_announcement.not_found" | "status_page_subscriber.not_found" | "validation.failed" | "weekly_report.invalid_reader" | "workspace.limit_reached" | "workspace.not_found" | "workspace.nothing_to_change" | "workspace.import_limit_exceeded", monitorId?: string }[] }
  • 400 — One of: validation.failed, import.invalid_export, import.too_many_rows.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 409 — One of: idempotency.conflict, idempotency.in_progress.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/monitors/imports/csv" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"format":"pingdom","filename":"monitors.csv","csv":"Monitor name,Host,Resolution,Type\nShop,https://shop.example.com/,1,http\n"}'

Import monitors from UptimeRobot with the workspace key

POST /v1/monitors/imports/uptimerobot/apiScope: write

Connects the workspace to UptimeRobot’s v3 API with its own key and creates every monitor the product can carry, each once: authentication exactly as the vendor sends it, the accepted status codes, request headers and body, and the certificate alert days. The key is stored sealed, is never returned, and the API asks the configured vendor host and no other. A monitor the product cannot express is answered with its own reason; importing again creates nothing.

Request body

{ apiKey: string }

Answers

  • 200 — The answer.
    { imported: { monitor: { type: …, config: …, id: …, name: …, target: …, intervalSeconds: …, timeoutSeconds: …, paused: …, pausedUntil: …, status: …, statusSince: …, pendingReason: …, lastCheck: …, certificate: …, maintenance: …, incident: …, notifications: …, groupId: …, groupName: …, groupState: …, tags: …, nextCheckAt: …, heartbeat: …, createdAt: …, updatedAt: … } | { type: …, config: …, id: …, name: …, target: …, intervalSeconds: …, timeoutSeconds: …, paused: …, pausedUntil: …, status: …, statusSince: …, pendingReason: …, lastCheck: …, certificate: …, maintenance: …, incident: …, notifications: …, groupId: …, groupName: …, groupState: …, tags: …, nextCheckAt: …, heartbeat: …, createdAt: …, updatedAt: … } | { type: …, config: …, id: …, name: …, target: …, intervalSeconds: …, timeoutSeconds: …, paused: …, pausedUntil: …, status: …, statusSince: …, pendingReason: …, lastCheck: …, certificate: …, maintenance: …, incident: …, notifications: …, groupId: …, groupName: …, groupState: …, tags: …, nextCheckAt: …, heartbeat: …, createdAt: …, updatedAt: … } | { type: …, config: …, id: …, name: …, target: …, intervalSeconds: …, timeoutSeconds: …, paused: …, pausedUntil: …, status: …, statusSince: …, pendingReason: …, lastCheck: …, certificate: …, maintenance: …, incident: …, notifications: …, groupId: …, groupName: …, groupState: …, tags: …, nextCheckAt: …, heartbeat: …, createdAt: …, updatedAt: … } | { type: …, config: …, id: …, name: …, target: …, intervalSeconds: …, timeoutSeconds: …, paused: …, pausedUntil: …, status: …, statusSince: …, pendingReason: …, lastCheck: …, certificate: …, maintenance: …, incident: …, notifications: …, groupId: …, groupName: …, groupState: …, tags: …, nextCheckAt: …, heartbeat: …, createdAt: …, updatedAt: … } | { type: …, config: …, id: …, name: …, target: …, intervalSeconds: …, timeoutSeconds: …, paused: …, pausedUntil: …, status: …, statusSince: …, pendingReason: …, lastCheck: …, certificate: …, maintenance: …, incident: …, notifications: …, groupId: …, groupName: …, groupState: …, tags: …, nextCheckAt: …, heartbeat: …, createdAt: …, updatedAt: … } | { type: …, config: …, id: …, name: …, target: …, intervalSeconds: …, timeoutSeconds: …, paused: …, pausedUntil: …, status: …, statusSince: …, pendingReason: …, lastCheck: …, certificate: …, maintenance: …, incident: …, notifications: …, groupId: …, groupName: …, groupState: …, tags: …, nextCheckAt: …, heartbeat: …, createdAt: …, updatedAt: … }, heartbeatUrl?: string }[], skipped: { externalId: string, name: string, uptimeRobotType: string, reason: "already_imported" | "duplicate" | "invalid_monitor" | "invalid_target" | "needs_credentials" | "paused" | "unsupported_configuration" | "unsupported_interval" | "unsupported_timeout" | "unsupported_type", authHint?: "literal" }[] }
  • 400 — One of: validation.failed, import.invalid_export, import.source_key_refused, import.source_unavailable, import.secret_unavailable, monitor.secrets_unavailable.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 409 — One of: monitor.limit_reached.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/monitors/imports/uptimerobot/api" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"apiKey":"ur123456-abcdef0123456789abcdef0123456789"}'

The stored UptimeRobot connection

GET /v1/monitors/imports/uptimerobot/apiScope: read

Whether a key is stored for this workspace, when it was last used and what the last import amounted to. The key itself is never part of any answer.

Answers

  • 200 — The answer.
    { source: { provider: "uptimerobot", connected: boolean, createdAt: string | null, lastUsedAt: string | null, lastOutcome: { created: integer, skipped: integer, refused: integer, limitReached: integer } } }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/monitors/imports/uptimerobot/api" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Disconnect the stored UptimeRobot key

DELETE /v1/monitors/imports/uptimerobot/apiScope: write

Deletes the stored key. Monitors already imported are untouched; a later import needs the key again.

Answers

  • 204 — Done; no body.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 429 — One of: request.rate_limited.

Example

curl -X DELETE "https://api.nuvostatus.com/v1/monitors/imports/uptimerobot/api" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Read a monitor

GET /v1/monitors/{id}Scope: read

The monitor with its state, its last check, its open incident and, over HTTPS, its certificate.

Parameters

  • id — in the path, required

Answers

  • 200 — The answer.
    { type: "http", config: { url: string, method: "GET" | "HEAD" | "POST" | "PUT" | "PATCH" | "DELETE", followRedirects: boolean, expectedStatus: string[], keyword: string | null, keywordMustAppear: boolean, conditions: … | … | … | … | … | …[], conditionMode: "all" | "any", headers: { name: …, value: … }[], auth: { type: … } | { type: …, username: …, password: … } | { type: …, token: … }, body: { contentType: string, value: string } }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "tcp", config: { host: string, port: integer }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "dns", config: { name: string, recordType: "A" | "AAAA" | "CNAME" | "MX" | "TXT" | "NS", expected: string[], resolver: "system" | "cloudflare" | "google" | "quad9" | "opendns" }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "heartbeat", config: { periodSeconds: 60 | 120 | 300 | 600 | 900 | 1800 | 3600 | 7200 | 21600 | 43200 | 86400 | 604800 | 2592000, graceSeconds: integer }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "ping", config: { host: string }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "udp", config: { host: string, port: integer }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "domain", config: { domain: string }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 404 — One of: monitor.not_found.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/monitors/0199e6a0-0000-7000-8000-000000000001" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Change a monitor

PATCH /v1/monitors/{id}Scope: write

Only what is sent changes. `config` takes the fields of the monitor's own kind. Changing what is checked starts its history of state over.

Parameters

  • id — in the path, required

Request body

{ name?: string, channelIds?: string[], dependsOn?: string[], importance?: "critical" | "standard", config?: {}, intervalSeconds?: 30 | 60 | 120 | 180 | 300 | 600 | 900 | 1800 | 3600, confirmationChecks?: integer, confirmationSpanSeconds?: integer, timeoutSeconds?: integer, paused?: boolean, pausedUntil?: string | null, groupId?: string | null, tagIds?: string[], certificateAlertDays?: integer, slaTargetBp?: integer, slaBudgetAlertPercent?: integer | null, slowResponseMs?: integer | null, baselinePercent?: integer | null, runbookUrl?: string | null }

Answers

  • 200 — The answer.
    { type: "http", config: { url: string, method: "GET" | "HEAD" | "POST" | "PUT" | "PATCH" | "DELETE", followRedirects: boolean, expectedStatus: string[], keyword: string | null, keywordMustAppear: boolean, conditions: … | … | … | … | … | …[], conditionMode: "all" | "any", headers: { name: …, value: … }[], auth: { type: … } | { type: …, username: …, password: … } | { type: …, token: … }, body: { contentType: string, value: string } }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "tcp", config: { host: string, port: integer }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "dns", config: { name: string, recordType: "A" | "AAAA" | "CNAME" | "MX" | "TXT" | "NS", expected: string[], resolver: "system" | "cloudflare" | "google" | "quad9" | "opendns" }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "heartbeat", config: { periodSeconds: 60 | 120 | 300 | 600 | 900 | 1800 | 3600 | 7200 | 21600 | 43200 | 86400 | 604800 | 2592000, graceSeconds: integer }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "ping", config: { host: string }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "udp", config: { host: string, port: integer }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "domain", config: { domain: string }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string }
  • 400 — One of: validation.failed, monitor.config_invalid, monitor.url_not_allowed, monitor.host_not_allowed, monitor.domain_invalid, monitor.json_condition_needs_body, monitor.interval_not_allowed, monitor.secrets_unavailable.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: monitor.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X PATCH "https://api.nuvostatus.com/v1/monitors/0199e6a0-0000-7000-8000-000000000001" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Primary database","config":{"port":5433}}'

Pause a monitor

POST /v1/monitors/{id}/pauseScope: write

Stops its checks; an open incident is closed as paused, told to nobody. Pausing a paused monitor changes nothing.

Parameters

  • id — in the path, required

Answers

  • 200 — The answer.
    { type: "http", config: { url: string, method: "GET" | "HEAD" | "POST" | "PUT" | "PATCH" | "DELETE", followRedirects: boolean, expectedStatus: string[], keyword: string | null, keywordMustAppear: boolean, conditions: … | … | … | … | … | …[], conditionMode: "all" | "any", headers: { name: …, value: … }[], auth: { type: … } | { type: …, username: …, password: … } | { type: …, token: … }, body: { contentType: string, value: string } }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "tcp", config: { host: string, port: integer }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "dns", config: { name: string, recordType: "A" | "AAAA" | "CNAME" | "MX" | "TXT" | "NS", expected: string[], resolver: "system" | "cloudflare" | "google" | "quad9" | "opendns" }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "heartbeat", config: { periodSeconds: 60 | 120 | 300 | 600 | 900 | 1800 | 3600 | 7200 | 21600 | 43200 | 86400 | 604800 | 2592000, graceSeconds: integer }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "ping", config: { host: string }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "udp", config: { host: string, port: integer }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "domain", config: { domain: string }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: monitor.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/monitors/0199e6a0-0000-7000-8000-000000000001/pause" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Resume a monitor

POST /v1/monitors/{id}/resumeScope: write

Checks start again at once, with nothing assumed of what was found before the pause.

Parameters

  • id — in the path, required

Answers

  • 200 — The answer.
    { type: "http", config: { url: string, method: "GET" | "HEAD" | "POST" | "PUT" | "PATCH" | "DELETE", followRedirects: boolean, expectedStatus: string[], keyword: string | null, keywordMustAppear: boolean, conditions: … | … | … | … | … | …[], conditionMode: "all" | "any", headers: { name: …, value: … }[], auth: { type: … } | { type: …, username: …, password: … } | { type: …, token: … }, body: { contentType: string, value: string } }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "tcp", config: { host: string, port: integer }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "dns", config: { name: string, recordType: "A" | "AAAA" | "CNAME" | "MX" | "TXT" | "NS", expected: string[], resolver: "system" | "cloudflare" | "google" | "quad9" | "opendns" }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "heartbeat", config: { periodSeconds: 60 | 120 | 300 | 600 | 900 | 1800 | 3600 | 7200 | 21600 | 43200 | 86400 | 604800 | 2592000, graceSeconds: integer }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "ping", config: { host: string }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "udp", config: { host: string, port: integer }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "domain", config: { domain: string }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: monitor.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/monitors/0199e6a0-0000-7000-8000-000000000001/resume" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Delete a monitor

DELETE /v1/monitors/{id}Scope: write

The monitor is gone from every answer, and can be brought back with `/restore` for thirty days. After that the worker removes it and its data for good.

Parameters

  • id — in the path, required

Answers

  • 204 — Done; no body.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: monitor.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X DELETE "https://api.nuvostatus.com/v1/monitors/0199e6a0-0000-7000-8000-000000000001" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Restore a deleted monitor

POST /v1/monitors/{id}/restoreScope: write

Brings a monitor back from the trash, exactly as it was, within thirty days of its deletion and only if the plan has room. A paused monitor comes back paused; any other is due at once. An older one, or one that was never deleted, is refused.

Parameters

  • id — in the path, required

Answers

  • 200 — The answer.
    { type: "http", config: { url: string, method: "GET" | "HEAD" | "POST" | "PUT" | "PATCH" | "DELETE", followRedirects: boolean, expectedStatus: string[], keyword: string | null, keywordMustAppear: boolean, conditions: … | … | … | … | … | …[], conditionMode: "all" | "any", headers: { name: …, value: … }[], auth: { type: … } | { type: …, username: …, password: … } | { type: …, token: … }, body: { contentType: string, value: string } }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "tcp", config: { host: string, port: integer }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "dns", config: { name: string, recordType: "A" | "AAAA" | "CNAME" | "MX" | "TXT" | "NS", expected: string[], resolver: "system" | "cloudflare" | "google" | "quad9" | "opendns" }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "heartbeat", config: { periodSeconds: 60 | 120 | 300 | 600 | 900 | 1800 | 3600 | 7200 | 21600 | 43200 | 86400 | 604800 | 2592000, graceSeconds: integer }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "ping", config: { host: string }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "udp", config: { host: string, port: integer }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "domain", config: { domain: string }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: string[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: string, name: string }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string }
  • 400 — One of: monitor.not_deleted, monitor.restore_window_expired.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: monitor.not_found.
  • 409 — One of: monitor.limit_reached.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/monitors/0199e6a0-0000-7000-8000-000000000001/restore" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Pause, resume or delete many monitors

POST /v1/monitors/bulkScope: write

The same three actions as one monitor at a time, for up to 100 ids. Each id is answered on its own, in the order given and once: one the workspace cannot see comes back ok false with `monitor.not_found`, and the rest still apply. A key that may only read is refused.

Request body

{ action: "pause" | "resume" | "delete", monitorIds: string[] }

Answers

  • 200 — The answer.
    { results: { id: string, ok: boolean, code?: "auth.cannot_revoke_current" | "auth.email_not_verified" | "auth.invalid_code" | "auth.invalid_credentials" | "auth.invalid_token" | "auth.password_too_long" | "auth.password_too_short" | "auth.totp_required" | "auth.two_factor_already_enabled" | "auth.two_factor_not_enabled" | "auth.unauthenticated" | "internal.error" | "invitation.already_member" | "invitation.limit_reached" | "invitation.not_found" | "account.password_incorrect" | "account.sole_owner" | "account.disabled" | "account.email_taken" | "account.email_unchanged" | "admin.not_an_operator" | "admin.permission_denied" | "admin.user_not_found" | "admin.workspace_not_found" | "admin.monitor_not_found" | "admin.incident_not_found" | "admin.plan_unknown" | "admin.plan_below_usage" | "admin.override_invalid" | "admin.subscription_not_found" | "alert_digest.invalid_window" | "alert_grouping.invalid" | "api.bulk_empty" | "audit.read_forbidden" | "billing.provider_unavailable" | "billing.plan_not_sold" | "billing.no_subscription" | "billing.subscription_state" | "billing.subscription_conflict" | "billing.webhook_rejected" | "entitlement.feature_not_included" | "escalation_steps.invalid" | "escalation.rotation_not_found" | "escalation_steps.contact_not_found" | "escalation_steps.channel_not_found" | "member.limit_reached" | "member.last_owner" | "member.not_found" | "member.role_not_assignable" | "monitor.account_limit_reached" | "monitor.confirmation_out_of_range" | "monitor.interval_not_allowed" | "monitor.limit_reached" | "monitor.timeout_not_allowed" | "monitor.update_forbidden" | "import.invalid_export" | "import.row_refused" | "import.secret_unavailable" | "import.source_key_refused" | "import.source_unavailable" | "import.unsupported_type" | "import.missing_target" | "import.invalid_target" | "import.invalid_name" | "import.unsupported_interval" | "import.too_many_rows" | "incident.not_found" | "incident.invalid_cursor" | "incident.impact_invalid" | "incident.assignee_not_member" | "incident.assignment_forbidden" | "incident.already_resolved" | "incident.not_resolved" | "incident.already_open" | "incident.not_manual" | "incident.cause_invalid" | "incident.declaration_forbidden" | "incident.export_too_large" | "action_item.not_found" | "action_item.too_many" | "action_item.incident_open" | "action_item.owner_not_member" | "action_item.due_in_past" | "postmortem.not_found" | "incident_comment.not_author" | "incident_comment.not_found" | "monitor.invalid_cursor" | "monitor.not_found" | "monitor.not_deleted" | "monitor.restore_window_expired" | "monitor.url_not_allowed" | "monitor.channel_not_found" | "monitor.keyword_needs_body" | "monitor.conditions_need_body" | "monitor.json_condition_needs_body" | "monitor.config_invalid" | "monitor.authorization_header_conflict" | "monitor.auth_value_has_scheme" | "monitor.domain_invalid" | "monitor.secrets_unavailable" | "monitor.host_not_allowed" | "monitor.not_a_heartbeat" | "monitor.slow_response_not_supported" | "monitor.baseline_not_supported" | "monitor.pause_until_in_past" | "monitor.pause_until_too_far" | "monitor.dependency_not_found" | "monitor.dependency_self" | "monitor.dependency_limit" | "monitor.dependency_duplicate" | "monitor.dependency_cycle" | "monitor.runbook_url_invalid" | "monitor.paused" | "monitor.check_too_soon" | "monitor.check_budget_spent" | "monitor.check_not_supported" | "monitor.no_capable_probe" | "manual_check.not_found" | "on_call.invalid_participant" | "on_call.invalid_window" | "on_call.invalid_name" | "on_call.name_taken" | "on_call.rotation_not_found" | "on_call.rotation_last" | "rotation.in_use" | "group.not_found" | "group.name_taken" | "group.limit_reached" | "group.order_invalid" | "idempotency.conflict" | "idempotency.in_progress" | "tag.not_found" | "tag.name_taken" | "tag.limit_reached" | "tag.limit_per_monitor" | "sla_policy.not_found" | "sla_policy.name_taken" | "sla_policy.monitor_already_covered" | "sla_report.not_found" | "sla_report.month_not_closed" | "sla_report.too_large" | "api_key.not_found" | "api_key.limit_reached" | "api_key.write_key_not_limited" | "api_key.monitor_not_allowed" | "api_key.not_rotatable" | "api_key.grace_out_of_range" | "contact.not_found" | "contact.already_exists" | "contact.limit_reached" | "contact.availability_invalid" | "contact.unavailable" | "maintenance.not_found" | "maintenance.not_editable" | "maintenance.limit_reached" | "maintenance.monitor_not_found" | "maintenance.group_not_found" | "maintenance.invalid_window" | "maintenance.skip_not_recurring" | "maintenance.skip_not_an_occurrence" | "maintenance.skip_started" | "maintenance.skip_already_skipped" | "maintenance.skip_not_found" | "maintenance_window.group_not_found" | "maintenance_window.limit_exceeded" | "maintenance_window.monitor_not_found" | "maintenance_window.not_active" | "maintenance_window.not_found" | "contact.not_verified" | "contact.unknown_contact" | "contact.verification_invalid" | "channel.not_found" | "channel.name_taken" | "channel.limit_reached" | "channel.config_invalid" | "channel.events_empty" | "channel.secret_unavailable" | "channel.secret_not_rotatable" | "delivery.not_found" | "delivery.not_retryable" | "delivery.paced" | "email.lane_budget_exhausted" | "email.suppression_not_found" | "email.webhook_rejected" | "alert_provider.not_configured" | "permission.denied" | "probe.enrolment_expired" | "probe.enrolment_invalid_key" | "probe.enrolment_invalid_request" | "probe.enrolment_revoked" | "probe.enrolment_unknown" | "probe.enrolment_used" | "request.content_type_not_allowed" | "request.cross_site" | "request.host_not_allowed" | "request.origin_missing" | "request.origin_not_allowed" | "request.rate_limited" | "resource.not_found" | "status_page.limit_reached" | "status_page.monitor_not_found" | "status_page.not_found" | "status_page.password_incorrect" | "status_page.slug_taken" | "status_page.unavailable" | "status_page.service_not_found" | "status_page.services_required" | "status_page.domain_invalid" | "status_page.domain_taken" | "status_page_announcement.invalid_window" | "status_page_announcement.limit_reached" | "status_page_announcement.not_found" | "status_page_subscriber.not_found" | "validation.failed" | "weekly_report.invalid_reader" | "workspace.limit_reached" | "workspace.not_found" | "workspace.nothing_to_change" | "workspace.import_limit_exceeded" }[] }
  • 400 — One of: validation.failed.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/monitors/bulk" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"action":"pause","monitorIds":["0199a1c0-0000-7000-8000-000000000201","0199a1c0-0000-7000-8000-000000000202"]}'

Change one setting on many monitors

PATCH /v1/monitors/bulkScope: write

The same edit as one monitor at a time, for up to 100 ids: the interval, the timeout, the group or the tags, and at least one of them. Each id is answered on its own, in the order given and once, and the answer is 200 even when some were refused: an id the workspace cannot see, an interval its plan does not allow, a group or tag it does not have, or a kind with no interval or timeout of its own is that monitor’s outcome with its code, and the rest still apply. The role is decided once for the whole request; a key that may only read is refused with `monitor.update_forbidden`.

Request body

{ monitorIds: string[], changes: { intervalSeconds?: 30 | 60 | 120 | 180 | 300 | 600 | 900 | 1800 | 3600, timeoutSeconds?: integer, groupId?: string | null, tagIds?: string[] } }

Answers

  • 200 — The answer.
    { outcomes: { id: string, ok: boolean, monitor?: { id: string, name: string, changedFields: …[] }, code?: "auth.cannot_revoke_current" | "auth.email_not_verified" | "auth.invalid_code" | "auth.invalid_credentials" | "auth.invalid_token" | "auth.password_too_long" | "auth.password_too_short" | "auth.totp_required" | "auth.two_factor_already_enabled" | "auth.two_factor_not_enabled" | "auth.unauthenticated" | "internal.error" | "invitation.already_member" | "invitation.limit_reached" | "invitation.not_found" | "account.password_incorrect" | "account.sole_owner" | "account.disabled" | "account.email_taken" | "account.email_unchanged" | "admin.not_an_operator" | "admin.permission_denied" | "admin.user_not_found" | "admin.workspace_not_found" | "admin.monitor_not_found" | "admin.incident_not_found" | "admin.plan_unknown" | "admin.plan_below_usage" | "admin.override_invalid" | "admin.subscription_not_found" | "alert_digest.invalid_window" | "alert_grouping.invalid" | "api.bulk_empty" | "audit.read_forbidden" | "billing.provider_unavailable" | "billing.plan_not_sold" | "billing.no_subscription" | "billing.subscription_state" | "billing.subscription_conflict" | "billing.webhook_rejected" | "entitlement.feature_not_included" | "escalation_steps.invalid" | "escalation.rotation_not_found" | "escalation_steps.contact_not_found" | "escalation_steps.channel_not_found" | "member.limit_reached" | "member.last_owner" | "member.not_found" | "member.role_not_assignable" | "monitor.account_limit_reached" | "monitor.confirmation_out_of_range" | "monitor.interval_not_allowed" | "monitor.limit_reached" | "monitor.timeout_not_allowed" | "monitor.update_forbidden" | "import.invalid_export" | "import.row_refused" | "import.secret_unavailable" | "import.source_key_refused" | "import.source_unavailable" | "import.unsupported_type" | "import.missing_target" | "import.invalid_target" | "import.invalid_name" | "import.unsupported_interval" | "import.too_many_rows" | "incident.not_found" | "incident.invalid_cursor" | "incident.impact_invalid" | "incident.assignee_not_member" | "incident.assignment_forbidden" | "incident.already_resolved" | "incident.not_resolved" | "incident.already_open" | "incident.not_manual" | "incident.cause_invalid" | "incident.declaration_forbidden" | "incident.export_too_large" | "action_item.not_found" | "action_item.too_many" | "action_item.incident_open" | "action_item.owner_not_member" | "action_item.due_in_past" | "postmortem.not_found" | "incident_comment.not_author" | "incident_comment.not_found" | "monitor.invalid_cursor" | "monitor.not_found" | "monitor.not_deleted" | "monitor.restore_window_expired" | "monitor.url_not_allowed" | "monitor.channel_not_found" | "monitor.keyword_needs_body" | "monitor.conditions_need_body" | "monitor.json_condition_needs_body" | "monitor.config_invalid" | "monitor.authorization_header_conflict" | "monitor.auth_value_has_scheme" | "monitor.domain_invalid" | "monitor.secrets_unavailable" | "monitor.host_not_allowed" | "monitor.not_a_heartbeat" | "monitor.slow_response_not_supported" | "monitor.baseline_not_supported" | "monitor.pause_until_in_past" | "monitor.pause_until_too_far" | "monitor.dependency_not_found" | "monitor.dependency_self" | "monitor.dependency_limit" | "monitor.dependency_duplicate" | "monitor.dependency_cycle" | "monitor.runbook_url_invalid" | "monitor.paused" | "monitor.check_too_soon" | "monitor.check_budget_spent" | "monitor.check_not_supported" | "monitor.no_capable_probe" | "manual_check.not_found" | "on_call.invalid_participant" | "on_call.invalid_window" | "on_call.invalid_name" | "on_call.name_taken" | "on_call.rotation_not_found" | "on_call.rotation_last" | "rotation.in_use" | "group.not_found" | "group.name_taken" | "group.limit_reached" | "group.order_invalid" | "idempotency.conflict" | "idempotency.in_progress" | "tag.not_found" | "tag.name_taken" | "tag.limit_reached" | "tag.limit_per_monitor" | "sla_policy.not_found" | "sla_policy.name_taken" | "sla_policy.monitor_already_covered" | "sla_report.not_found" | "sla_report.month_not_closed" | "sla_report.too_large" | "api_key.not_found" | "api_key.limit_reached" | "api_key.write_key_not_limited" | "api_key.monitor_not_allowed" | "api_key.not_rotatable" | "api_key.grace_out_of_range" | "contact.not_found" | "contact.already_exists" | "contact.limit_reached" | "contact.availability_invalid" | "contact.unavailable" | "maintenance.not_found" | "maintenance.not_editable" | "maintenance.limit_reached" | "maintenance.monitor_not_found" | "maintenance.group_not_found" | "maintenance.invalid_window" | "maintenance.skip_not_recurring" | "maintenance.skip_not_an_occurrence" | "maintenance.skip_started" | "maintenance.skip_already_skipped" | "maintenance.skip_not_found" | "maintenance_window.group_not_found" | "maintenance_window.limit_exceeded" | "maintenance_window.monitor_not_found" | "maintenance_window.not_active" | "maintenance_window.not_found" | "contact.not_verified" | "contact.unknown_contact" | "contact.verification_invalid" | "channel.not_found" | "channel.name_taken" | "channel.limit_reached" | "channel.config_invalid" | "channel.events_empty" | "channel.secret_unavailable" | "channel.secret_not_rotatable" | "delivery.not_found" | "delivery.not_retryable" | "delivery.paced" | "email.lane_budget_exhausted" | "email.suppression_not_found" | "email.webhook_rejected" | "alert_provider.not_configured" | "permission.denied" | "probe.enrolment_expired" | "probe.enrolment_invalid_key" | "probe.enrolment_invalid_request" | "probe.enrolment_revoked" | "probe.enrolment_unknown" | "probe.enrolment_used" | "request.content_type_not_allowed" | "request.cross_site" | "request.host_not_allowed" | "request.origin_missing" | "request.origin_not_allowed" | "request.rate_limited" | "resource.not_found" | "status_page.limit_reached" | "status_page.monitor_not_found" | "status_page.not_found" | "status_page.password_incorrect" | "status_page.slug_taken" | "status_page.unavailable" | "status_page.service_not_found" | "status_page.services_required" | "status_page.domain_invalid" | "status_page.domain_taken" | "status_page_announcement.invalid_window" | "status_page_announcement.limit_reached" | "status_page_announcement.not_found" | "status_page_subscriber.not_found" | "validation.failed" | "weekly_report.invalid_reader" | "workspace.limit_reached" | "workspace.not_found" | "workspace.nothing_to_change" | "workspace.import_limit_exceeded" }[] }
  • 400 — One of: monitor.update_forbidden, validation.failed.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 429 — One of: request.rate_limited.

Example

curl -X PATCH "https://api.nuvostatus.com/v1/monitors/bulk" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"monitorIds":["0199a1c0-0000-7000-8000-000000000201","0199a1c0-0000-7000-8000-000000000202"],"changes":{"intervalSeconds":300,"timeoutSeconds":10}}'

The recent checks of a monitor

GET /v1/monitors/{id}/checksScope: read

Newest first, within the thirty days kept. Each check says what it found and how long each step took.

Parameters

  • id — in the path, required
  • limit — in the query string, optional. How many at most; the default is 50 for checks, 20 for incidents.
  • cursor — in the query string, optional. The `next` of the previous page.

Answers

  • 200 — The answer.
    { items: { scheduledAt: string, finishedAt: string, class: "ok" | "fail" | "skipped" | "probe_suspect", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null, timings: { dnsMs: integer | null, connectMs: integer | null, tlsMs: integer | null, ttfbMs: integer | null }, resolvedIp: string | null, redirects: integer, attempts: integer, ping: { sent: integer, received: integer } }[], next: string | null }
  • 400 — One of: validation.failed.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 404 — One of: monitor.not_found.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/monitors/0199e6a0-0000-7000-8000-000000000001/checks" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Uptime and response time

GET /v1/monitors/{id}/summaryScope: read

Over the last day, week and month, and hour by hour over the last day. Uptime counts only the time something of ours observed the target.

Parameters

  • id — in the path, required

Answers

  • 200 — The answer.
    { windows: { 24h: { coveredSeconds: number, downSeconds: number, uptime: number | null, incidents: integer, mtbfSeconds: number | null, timeWithoutIncidentSeconds: number, checks: integer, responseMs: { median: number, p95: number, p99: number }, phases: { dns: { median: …, p95: … }, connect: { median: …, p95: … }, ttfb: { median: …, p95: … } } }, 7d: { coveredSeconds: number, downSeconds: number, uptime: number | null, incidents: integer, mtbfSeconds: number | null, timeWithoutIncidentSeconds: number, checks: integer, responseMs: { median: number, p95: number, p99: number }, phases: { dns: { median: …, p95: … }, connect: { median: …, p95: … }, ttfb: { median: …, p95: … } } }, 30d: { coveredSeconds: number, downSeconds: number, uptime: number | null, incidents: integer, mtbfSeconds: number | null, timeWithoutIncidentSeconds: number, checks: integer, responseMs: { median: number, p95: number, p99: number }, phases: { dns: { median: …, p95: … }, connect: { median: …, p95: … }, ttfb: { median: …, p95: … } } } }, hours: { from: string, coveredSeconds: number, downSeconds: number }[], regions: { region: string, state: "up" | "down" | "unknown", lastCheckedAt: string | null, ageSeconds: integer | null }[], regionPerformance: { region: string, checks: integer, medianMs: integer | null, lastCheckedAt: string | null }[] }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 404 — One of: monitor.not_found.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/monitors/0199e6a0-0000-7000-8000-000000000001/summary" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Regenerate a heartbeat's address

POST /v1/monitors/{id}/heartbeatScope: write

A new token; the old address answers nothing from now on. The new address is in this answer and nowhere else.

Parameters

  • id — in the path, required

Answers

  • 200 — The answer.
    { monitor: { type: "http", config: { url: string, method: "GET" | "HEAD" | "POST" | "PUT" | "PATCH" | "DELETE", followRedirects: boolean, expectedStatus: …[], keyword: string | null, keywordMustAppear: boolean, conditions: …[], conditionMode: "all" | "any", headers: …[], auth: … | … | …, body: { contentType: …, value: … } }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: …[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: …, name: … }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "tcp", config: { host: string, port: integer }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: …[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: …, name: … }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "dns", config: { name: string, recordType: "A" | "AAAA" | "CNAME" | "MX" | "TXT" | "NS", expected: …[], resolver: "system" | "cloudflare" | "google" | "quad9" | "opendns" }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: …[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: …, name: … }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "heartbeat", config: { periodSeconds: 60 | 120 | 300 | 600 | 900 | 1800 | 3600 | 7200 | 21600 | 43200 | 86400 | 604800 | 2592000, graceSeconds: integer }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: …[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: …, name: … }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "ping", config: { host: string }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: …[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: …, name: … }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "udp", config: { host: string, port: integer }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: …[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: …, name: … }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string } | { type: "domain", config: { domain: string }, id: string, name: string, target: string, intervalSeconds: integer, timeoutSeconds: integer, paused: boolean, pausedUntil: string | null, status: "pending" | "passing" | "failing" | "down" | "paused" | "unknown", statusSince: string | null, pendingReason: { code: "no_probe_capability", missingCapability: "http" | "tcp" | "dns" | "http_secrets" | "icmp" | "udp" | "domain" | "ipv6" }, lastCheck: { at: string, class: "ok" | "fail", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null }, certificate: { notBefore: string, notAfter: string, issuer: string, subject: string, sans: integer, seenAt: string, daysLeft: integer, state: "ok" | "attention" | "critical" | "expired" | "invalid" }, maintenance: { id: string, name: string, endsAt: string }, incident: { id: string, startedAt: string, confirmedAt: string, recovering: boolean, flapping: boolean }, notifications: { alertMembers: boolean, contactIds: …[], quietUntil: string | null, quietForever: boolean }, groupId: string | null, groupName: string | null, groupState: "operational" | "degraded" | "down" | "maintenance" | "unknown", tags: { id: …, name: … }[], nextCheckAt: string | null, heartbeat: { lastPingAt: string | null, dueAt: string | null }, createdAt: string, updatedAt: string }, heartbeatUrl?: string }
  • 400 — One of: monitor.not_a_heartbeat.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: monitor.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/monitors/0199e6a0-0000-7000-8000-000000000001/heartbeat" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

List the monitor groups

GET /v1/monitor-groupsScope: read

The groups of the workspace, by name. A monitor without one is ungrouped.

Answers

  • 200 — The answer.
    { groups: { id: string, name: string, state: "operational" | "degraded" | "down" | "maintenance" | "unknown", createdAt: string, updatedAt: string }[] }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/monitor-groups" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Create a monitor group

POST /v1/monitor-groupsScope: write

A folder for monitors; a name unique in the workspace, compared without case.

Parameters

  • Idempotency-Key — in the query string, optional

Request body

{ name: string }

Answers

  • 201 — The answer.
    { group: { id: string, name: string, state: "operational" | "degraded" | "down" | "maintenance" | "unknown", createdAt: string, updatedAt: string } }
  • 400 — One of: validation.failed, group.name_taken, group.limit_reached.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 409 — One of: idempotency.conflict, idempotency.in_progress.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/monitor-groups" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Clients"}'

Rename a monitor group

PATCH /v1/monitor-groups/{id}Scope: write

Changes the group’s name, not its monitors.

Parameters

  • id — in the path, required

Request body

{ name: string }

Answers

  • 200 — The answer.
    { group: { id: string, name: string, state: "operational" | "degraded" | "down" | "maintenance" | "unknown", createdAt: string, updatedAt: string } }
  • 400 — One of: validation.failed, group.not_found, group.name_taken.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 429 — One of: request.rate_limited.

Example

curl -X PATCH "https://api.nuvostatus.com/v1/monitor-groups/0199e6a0-0000-7000-8000-000000000001" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Customers"}'

Delete a monitor group

DELETE /v1/monitor-groups/{id}Scope: write

The monitors in it become ungrouped; none is deleted or paused.

Parameters

  • id — in the path, required

Answers

  • 204 — Done; no body.
  • 400 — One of: group.not_found.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 429 — One of: request.rate_limited.

Example

curl -X DELETE "https://api.nuvostatus.com/v1/monitor-groups/0199e6a0-0000-7000-8000-000000000001" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

List the SLA policies

GET /v1/sla-policiesScope: read

The workspace’s named availability promises, each with its target, window, members and the verdict measured over its window.

Answers

  • 200 — The answer.
    { policies: { id: string, name: string, targetBp: integer, windowDays: 7 | 30 | 90, monitors: { id: …, name: … }[], status: { targetBp: integer, targetUptime: number, windowSeconds: integer, coveredSeconds: integer, downSeconds: integer, allowedDownSeconds: integer, remainingDownSeconds: integer, uptime: number | null, met: boolean | null, members: …[], observations: integer }, createdAt: string, updatedAt: string }[] }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/sla-policies" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Create an SLA policy

POST /v1/sla-policiesScope: write

A name unique in the workspace, a target in basis points and a window of 7, 30 or 90 days. It covers no monitor until monitors are added.

Parameters

  • Idempotency-Key — in the query string, optional

Request body

{ name: string, targetBp: integer, windowDays: 7 | 30 | 90 }

Answers

  • 201 — The answer.
    { policy: { id: string, name: string, targetBp: integer, windowDays: 7 | 30 | 90, monitors: { id: string, name: string }[], status: { targetBp: integer, targetUptime: number, windowSeconds: integer, coveredSeconds: integer, downSeconds: integer, allowedDownSeconds: integer, remainingDownSeconds: integer, uptime: number | null, met: boolean | null, members: { monitorId: …, coveredSeconds: …, downSeconds: …, met: … }[], observations: integer }, createdAt: string, updatedAt: string } }
  • 400 — One of: validation.failed, sla_policy.name_taken.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 409 — One of: idempotency.conflict, idempotency.in_progress.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/sla-policies" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Payments","targetBp":9990,"windowDays":90}'

Read an SLA policy

GET /v1/sla-policies/{id}Scope: read

Its name, target, window, members and the verdict measured over the window. A policy of another workspace is answered as absent.

Parameters

  • id — in the path, required

Answers

  • 200 — The answer.
    { policy: { id: string, name: string, targetBp: integer, windowDays: 7 | 30 | 90, monitors: { id: string, name: string }[], status: { targetBp: integer, targetUptime: number, windowSeconds: integer, coveredSeconds: integer, downSeconds: integer, allowedDownSeconds: integer, remainingDownSeconds: integer, uptime: number | null, met: boolean | null, members: { monitorId: …, coveredSeconds: …, downSeconds: …, met: … }[], observations: integer }, createdAt: string, updatedAt: string } }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 404 — One of: monitor.not_found.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/sla-policies/0199e6a0-0000-7000-8000-000000000001" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Edit an SLA policy

PATCH /v1/sla-policies/{id}Scope: write

Changes its name, target or window; absent fields keep what is stored.

Parameters

  • id — in the path, required

Request body

{ name?: string, targetBp?: integer, windowDays?: 7 | 30 | 90 }

Answers

  • 200 — The answer.
    { policy: { id: string, name: string, targetBp: integer, windowDays: 7 | 30 | 90, monitors: { id: string, name: string }[], status: { targetBp: integer, targetUptime: number, windowSeconds: integer, coveredSeconds: integer, downSeconds: integer, allowedDownSeconds: integer, remainingDownSeconds: integer, uptime: number | null, met: boolean | null, members: { monitorId: …, coveredSeconds: …, downSeconds: …, met: … }[], observations: integer }, createdAt: string, updatedAt: string } }
  • 400 — One of: validation.failed, sla_policy.name_taken.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: monitor.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X PATCH "https://api.nuvostatus.com/v1/sla-policies/0199e6a0-0000-7000-8000-000000000001" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"targetBp":9995}'

Delete an SLA policy

DELETE /v1/sla-policies/{id}Scope: write

Its memberships go with it, and every monitor it covered answers its own target again.

Parameters

  • id — in the path, required

Answers

  • 204 — Done; no body.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: monitor.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X DELETE "https://api.nuvostatus.com/v1/sla-policies/0199e6a0-0000-7000-8000-000000000001" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Add monitors to an SLA policy

POST /v1/sla-policies/{id}/monitorsScope: write

Explicit monitor ids, or a group or tag shortcut resolved at the moment of the write. A monitor already covered by another policy is refused.

Parameters

  • id — in the path, required
  • Idempotency-Key — in the query string, optional

Request body

{ monitorIds?: string[], groupId?: string, tag?: string }

Answers

  • 201 — The answer.
    { policy: { id: string, name: string, targetBp: integer, windowDays: 7 | 30 | 90, monitors: { id: string, name: string }[], status: { targetBp: integer, targetUptime: number, windowSeconds: integer, coveredSeconds: integer, downSeconds: integer, allowedDownSeconds: integer, remainingDownSeconds: integer, uptime: number | null, met: boolean | null, members: { monitorId: …, coveredSeconds: …, downSeconds: …, met: … }[], observations: integer }, createdAt: string, updatedAt: string } }
  • 400 — One of: validation.failed, sla_policy.monitor_already_covered, group.not_found, tag.not_found.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: monitor.not_found.
  • 409 — One of: idempotency.conflict, idempotency.in_progress.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/sla-policies/0199e6a0-0000-7000-8000-000000000001/monitors" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"monitorIds":["0199a1c0-0000-7000-8000-000000000201"]}'

Remove monitors from an SLA policy

DELETE /v1/sla-policies/{id}/monitorsScope: write

The monitors keep their own target; the policy’s verdict is measured again.

Parameters

  • id — in the path, required

Request body

{ monitorIds: string[] }

Answers

  • 200 — The answer.
    { policy: { id: string, name: string, targetBp: integer, windowDays: 7 | 30 | 90, monitors: { id: string, name: string }[], status: { targetBp: integer, targetUptime: number, windowSeconds: integer, coveredSeconds: integer, downSeconds: integer, allowedDownSeconds: integer, remainingDownSeconds: integer, uptime: number | null, met: boolean | null, members: { monitorId: …, coveredSeconds: …, downSeconds: …, met: … }[], observations: integer }, createdAt: string, updatedAt: string } }
  • 400 — One of: validation.failed.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: monitor.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X DELETE "https://api.nuvostatus.com/v1/sla-policies/0199e6a0-0000-7000-8000-000000000001/monitors" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"monitorIds":["0199a1c0-0000-7000-8000-000000000201"]}'

List the tags

GET /v1/tagsScope: read

The workspace’s labels, by name.

Answers

  • 200 — The answer.
    { tags: { id: string, name: string, createdAt: string, updatedAt: string }[] }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/tags" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Create a tag

POST /v1/tagsScope: write

A label in the workspace’s own namespace; its name is unique without case.

Request body

{ name: string }

Answers

  • 201 — The answer.
    { tag: { id: string, name: string, createdAt: string, updatedAt: string } }
  • 400 — One of: validation.failed, tag.name_taken, tag.limit_reached.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/tags" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"production"}'

Rename a tag

PATCH /v1/tags/{id}Scope: write

Changes the word; every monitor carrying it keeps it.

Parameters

  • id — in the path, required

Request body

{ name: string }

Answers

  • 200 — The answer.
    { tag: { id: string, name: string, createdAt: string, updatedAt: string } }
  • 400 — One of: validation.failed, tag.not_found, tag.name_taken.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 429 — One of: request.rate_limited.

Example

curl -X PATCH "https://api.nuvostatus.com/v1/tags/0199e6a0-0000-7000-8000-000000000001" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"critical"}'

Delete a tag

DELETE /v1/tags/{id}Scope: write

Detaches it from every monitor; no monitor is changed otherwise.

Parameters

  • id — in the path, required

Answers

  • 204 — Done; no body.
  • 400 — One of: tag.not_found.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 429 — One of: request.rate_limited.

Example

curl -X DELETE "https://api.nuvostatus.com/v1/tags/0199e6a0-0000-7000-8000-000000000001" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

List the alert contacts

GET /v1/alert-contactsScope: read

The addresses the workspace tells about incidents, and the most it may hold. An address receives nothing until its link is followed.

Answers

  • 200 — The answer.
    { items: { id: string, email: string, name: string | null, isDefault: boolean, verified: boolean, verificationSentAt: string | null, createdAt: string }[], next: string | null, max: integer }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/alert-contacts" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Add an alert contact

POST /v1/alert-contactsScope: write

A new address, unverified: a link is emailed, and only once it is followed is the address told anything. A retry with the same `Idempotency-Key` replays the answer and sends no second link.

Parameters

  • Idempotency-Key — in the query string, optional

Request body

{ email: string, name?: string, isDefault?: boolean, availability?: { days: integer[], from: string | null, to: string | null, timezone: string } }

Answers

  • 201 — The answer.
    { contact: { id: string, email: string, name: string | null, isDefault: boolean, verified: boolean, verificationSentAt: string | null, createdAt: string } }
  • 400 — One of: validation.failed.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 409 — One of: contact.already_exists, contact.limit_reached, idempotency.conflict, idempotency.in_progress.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/alert-contacts" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"oncall@example.com","name":"On call","isDefault":true}'

Read an alert contact

GET /v1/alert-contacts/{id}Scope: read

One address and whether it has been verified.

Parameters

  • id — in the path, required

Answers

  • 200 — The answer.
    { id: string, email: string, name: string | null, isDefault: boolean, verified: boolean, verificationSentAt: string | null, createdAt: string }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 404 — One of: contact.not_found.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/alert-contacts/0199e6a0-0000-7000-8000-000000000001" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Change an alert contact

PATCH /v1/alert-contacts/{id}Scope: write

Its name, or whether it is told for the monitors that choose none of their own.

Parameters

  • id — in the path, required

Request body

{ name?: string | null, isDefault?: boolean, availability?: { days: integer[], from: string | null, to: string | null, timezone: string } }

Answers

  • 200 — The answer.
    { contact: { id: string, email: string, name: string | null, isDefault: boolean, verified: boolean, verificationSentAt: string | null, createdAt: string } }
  • 400 — One of: validation.failed.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: contact.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X PATCH "https://api.nuvostatus.com/v1/alert-contacts/0199e6a0-0000-7000-8000-000000000001" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Primary on call"}'

Remove an alert contact

DELETE /v1/alert-contacts/{id}Scope: write

The monitors that chose it stop naming it; one left without any falls back to the defaults.

Parameters

  • id — in the path, required

Answers

  • 204 — Done; no body.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: contact.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X DELETE "https://api.nuvostatus.com/v1/alert-contacts/0199e6a0-0000-7000-8000-000000000001" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Send the verification link again

POST /v1/alert-contacts/{id}/resendScope: write

A new token and a new message; the previous link stops working.

Parameters

  • id — in the path, required

Answers

  • 202 — The answer.
    { accepted: boolean }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: contact.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/alert-contacts/0199e6a0-0000-7000-8000-000000000001/resend" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Send a test message

POST /v1/alert-contacts/{id}/testScope: write

A test through the alert lane, only to an address whose link has been followed.

Parameters

  • id — in the path, required

Answers

  • 202 — The answer.
    { accepted: boolean }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: contact.not_found.
  • 409 — One of: contact.not_verified.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/alert-contacts/0199e6a0-0000-7000-8000-000000000001/test" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

The weekly report’s readers

GET /v1/report-settingsScope: read

Whether the workspace receives its weekly report and who it reaches: the owners and administrators by default, the members and verified contacts the workspace named instead, or nobody when it is off. A read key may see it.

Answers

  • 200 — The answer.
    { weeklyReport: { enabled: boolean, memberIds: string[], contactIds: string[], updatedAt: string | null }, readers: { kind: "member" | "contact", id: string, email: string, name: string }[] }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/report-settings" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Choose the weekly report’s readers

PUT /v1/report-settingsScope: write

Replaces the whole choice: the switch and the two lists. An id that is not a member or a verified contact of this workspace is refused with `weekly_report.invalid_reader`. Only an owner or an administrator may change it, so a key’s write scope is refused.

Request body

{ enabled: boolean, memberIds: string[], contactIds: string[] }

Answers

  • 200 — The answer.
    { weeklyReport: { enabled: boolean, memberIds: string[], contactIds: string[], updatedAt: string | null }, readers: { kind: "member" | "contact", id: string, email: string, name: string }[] }
  • 400 — One of: validation.failed, weekly_report.invalid_reader.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 429 — One of: request.rate_limited.

Example

curl -X PUT "https://api.nuvostatus.com/v1/report-settings" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"memberIds":["0199a1c0-0000-7000-8000-000000000001"],"contactIds":["0199a1c0-0000-7000-8000-000000000301"]}'

List the status pages

GET /v1/status-pagesScope: read

The pages of the workspace, with their services and whether each is published. A key reads them; publishing one is an owner or an administrator in the dashboard.

Answers

  • 200 — The answer.
    { items: { id: string, slug: string, title: string, description: string | null, accentColor: string | null, logoUrl: string | null, subscriberAlertBudget: integer, hasPassword: boolean, published: boolean, publishedAt: string | null, customDomain: { domain: string | null, txtName: string | null, txtValue: string | null, state: "none" | "pending" | "verified" | "lapsed", lastCheckedAt: string | null, lastCheckOutcome: "verified" | "missing" | "mismatch" | "unavailable", lapsedAt: string | null }, services: … | …[], createdAt: string, updatedAt: string }[], next: string | null }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/status-pages" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Read a status page

GET /v1/status-pages/{id}Scope: read

One page with its services, its address and whether it is published.

Parameters

  • id — in the path, required

Answers

  • 200 — The answer.
    { id: string, slug: string, title: string, description: string | null, accentColor: string | null, logoUrl: string | null, subscriberAlertBudget: integer, hasPassword: boolean, published: boolean, publishedAt: string | null, customDomain: { domain: string | null, txtName: string | null, txtValue: string | null, state: "none" | "pending" | "verified" | "lapsed", lastCheckedAt: string | null, lastCheckOutcome: "verified" | "missing" | "mismatch" | "unavailable", lapsedAt: string | null }, services: { kind: "monitor", monitorId: string, name: string, displayName: string | null, position: integer } | { kind: "group", groupId: string, name: string, monitorIds: …[], position: integer }[], createdAt: string, updatedAt: string }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 404 — One of: status_page.not_found.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/status-pages/0199e6a0-0000-7000-8000-000000000001" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

List the notices of a status page

GET /v1/status-pages/{id}/announcementsScope: read

The dated notices of the page, newest first, ended ones included. A visitor reads only the ones under way or still to come; the workspace manages the whole list.

Parameters

  • id — in the path, required

Answers

  • 200 — The answer.
    { items: { id: string, title: string | null, body: string, startsAt: string, endsAt: string | null, createdAt: string, updatedAt: string }[], next: string | null }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 404 — One of: status_page.not_found.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/status-pages/0199e6a0-0000-7000-8000-000000000001/announcements" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Publish a notice

POST /v1/status-pages/{id}/announcementsScope: write

A notice is public copy with a window. A page holds at most twenty notices under way or still to come; an ended one stops counting. A write key publishes one as a member does.

Parameters

  • id — in the path, required

Request body

{ title?: string | null, body: string, startsAt: string, endsAt?: string | null }

Answers

  • 201 — The answer.
    { announcement: { id: string, title: string | null, body: string, startsAt: string, endsAt: string | null, createdAt: string, updatedAt: string } }
  • 400 — One of: status_page_announcement.invalid_window, status_page_announcement.limit_reached.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: status_page.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/status-pages/0199e6a0-0000-7000-8000-000000000001/announcements" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Database migration","body":"We are migrating the database tonight. Expect a short pause.","startsAt":"2026-11-12T22:00:00Z","endsAt":"2026-11-13T00:00:00Z"}'

Change a notice

PATCH /v1/status-pages/{id}/announcements/{announcementId}Scope: write

A partial change, judged against the stored notice: moving only the end is as able to invert the window as sending both.

Parameters

  • id — in the path, required
  • announcementId — in the path, required

Request body

{ title?: string | null, body?: string, startsAt?: string, endsAt?: string | null }

Answers

  • 200 — The answer.
    { announcement: { id: string, title: string | null, body: string, startsAt: string, endsAt: string | null, createdAt: string, updatedAt: string } }
  • 400 — One of: status_page_announcement.not_found, status_page_announcement.invalid_window, status_page_announcement.limit_reached.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: status_page.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X PATCH "https://api.nuvostatus.com/v1/status-pages/0199e6a0-0000-7000-8000-000000000001/announcements/{announcementId}" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"endsAt":"2026-11-13T01:00:00Z"}'

Remove a notice

DELETE /v1/status-pages/{id}/announcements/{announcementId}Scope: write

The words leave the page at once; an ended notice could simply be left to expire.

Parameters

  • id — in the path, required
  • announcementId — in the path, required

Answers

  • 204 — Done; no body.
  • 400 — One of: status_page_announcement.not_found.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: status_page.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X DELETE "https://api.nuvostatus.com/v1/status-pages/0199e6a0-0000-7000-8000-000000000001/announcements/{announcementId}" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Report a state for one published service

POST /v1/status-pages/{id}/services/{monitorId}/stateScope: write

Tell the page what one of its services is doing when the cause is outside our checks — a payment provider, a CDN, a mail relay — with a note and a deadline. The page shows that state and its note until the deadline, then the monitors speak again by themselves; an expired state changes nothing a visitor reads, even before it is cleared. History, availability and the SLA keep what the monitors measured. The service is addressed by the monitor the page publishes as its own service; a monitor that is not one answers `status_page.service_not_found`. A write key reports one as a member does, and the change is audited.

Parameters

  • id — in the path, required
  • monitorId — in the path, required

Request body

{ state: "degraded" | "outage" | "operational", note?: string | null, minutes: integer }

Answers

  • 200 — The answer.
    { manualState: { monitorId: string, state: "degraded" | "outage" | "operational", note: string | null, expiresAt: string, createdAt: string } }
  • 400 — One of: status_page.service_not_found, validation.failed.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: status_page.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/status-pages/0199e6a0-0000-7000-8000-000000000001/services/{monitorId}/state" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"state":"degraded","note":"Our payment provider is slow; card payments may fail.","minutes":90}'

Return a published service to its monitors

DELETE /v1/status-pages/{id}/services/{monitorId}/stateScope: write

Clears a reported state before its deadline, so the page shows the checks again at once. Clearing a state nobody reported changes nothing and is no error. A write key clears one as a member does, and the change is audited.

Parameters

  • id — in the path, required
  • monitorId — in the path, required

Answers

  • 204 — Done; no body.
  • 400 — One of: status_page.service_not_found.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: status_page.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X DELETE "https://api.nuvostatus.com/v1/status-pages/0199e6a0-0000-7000-8000-000000000001/services/{monitorId}/state" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

List the subscribers of a status page

GET /v1/status-pages/{id}/subscribersScope: read

The addresses subscribed to the page, newest first, and when each was confirmed, with the services each one follows (empty for the whole page, NV-101.1). An address is shown to the page’s own workspace only; the answer never carries a token, its hash or a way to stop. A read key reads the list.

Parameters

  • id — in the path, required
  • limit — in the query string, optional. How many at most; the default is 50 for checks, 20 for incidents.
  • cursor — in the query string, optional. The `next` of the previous page.
  • serviceIds — in the query string, optional. A comma-separated list of the page’s service identifiers: only the addresses that follow one of them. An address that follows the whole page counts as following every one.

Answers

  • 200 — The answer.
    { items: { id: string, email: string, locale: string, confirmedAt: string | null, createdAt: string, serviceIds: string[], services: string[] }[], next: string | null }
  • 400 — One of: validation.failed.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 404 — One of: status_page.not_found.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/status-pages/0199e6a0-0000-7000-8000-000000000001/subscribers" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Remove a subscriber

DELETE /v1/status-pages/{id}/subscribers/{subscriberId}Scope: write

The address stops receiving this page’s alerts at once, and may subscribe again later, starting unconfirmed. The row and its send state are removed. A write key removes one.

Parameters

  • id — in the path, required
  • subscriberId — in the path, required

Answers

  • 204 — Done; no body.
  • 400 — One of: status_page_subscriber.not_found.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: status_page.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X DELETE "https://api.nuvostatus.com/v1/status-pages/0199e6a0-0000-7000-8000-000000000001/subscribers/{subscriberId}" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

List the incidents

GET /v1/incidentsScope: read

Newest first, open ones included. `assignedTo` narrows it to `me` (the caller's user; an API key has none), to `unassigned`, or to one member id.

Parameters

  • limit — in the query string, optional. How many at most; the default is 50 for checks, 20 for incidents.
  • cursor — in the query string, optional. The `next` of the previous page.

Answers

  • 200 — The answer.
    { items: { id: string, monitorId: string, monitorName: string, startedAt: string, confirmedAt: string, resolvedAt: string | null, resolution: "recovered" | "paused" | "superseded" | "deleted" | "manual", origin: "engine" | "manual", cause: string, statusCode: integer | null, checksFailed: integer, lastCheckAt: string, flapping: boolean, maintenance: boolean, regions: string[], acknowledgedAt: string | null, acknowledgedBy: { id: string, name: string }, impact: "minor" | "major" | "critical", assignee: { id: string, name: string }, assignedAt: string | null, declaredBy: { id: string, name: string }, declaredAt: string | null }[], next: string | null }
  • 400 — One of: validation.failed.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/incidents" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Declare an incident by hand

POST /v1/incidentsScope: write

The team already knows the monitor is down: a dependency told them before a check failed, or a hand-made change caused an outage no check can see. The incident is confirmed at its start, carries no failed check, and is shown, told, escalated and counted exactly as one the result pipeline confirmed. The monitor must belong to the workspace and must have no open incident of either origin. A viewer and a read key are refused.

Request body

{ cause: string, severity?: "critical" | "standard", startedAt?: string, monitorId: string }

Answers

  • 201 — The answer.
    { incident: { id: string, monitorId: string, monitorName: string, startedAt: string, confirmedAt: string, resolvedAt: string | null, resolution: "recovered" | "paused" | "superseded" | "deleted" | "manual", origin: "engine" | "manual", cause: string, statusCode: integer | null, checksFailed: integer, lastCheckAt: string, flapping: boolean, maintenance: boolean, regions: string[], acknowledgedAt: string | null, acknowledgedBy: { id: string, name: string }, impact: "minor" | "major" | "critical", assignee: { id: string, name: string }, assignedAt: string | null, declaredBy: { id: string, name: string }, declaredAt: string | null } }
  • 400 — One of: validation.failed, workspace.not_found, incident.already_open, incident.cause_invalid, incident.declaration_forbidden.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/incidents" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"monitorId":"0199a1c0-0000-7000-8000-000000000001","cause":"The payment provider is returning 503 for every charge.","severity":"critical"}'

Read an incident

GET /v1/incidents/{id}Scope: read

The incident, whether and by whom it was acknowledged, the events of its timeline (who was told, and when), the checks made during it and the comments people wrote on it.

Parameters

  • id — in the path, required

Answers

  • 200 — The answer.
    { incident: { id: string, monitorId: string, monitorName: string, startedAt: string, confirmedAt: string, resolvedAt: string | null, resolution: "recovered" | "paused" | "superseded" | "deleted" | "manual", origin: "engine" | "manual", cause: string, statusCode: integer | null, checksFailed: integer, lastCheckAt: string, flapping: boolean, maintenance: boolean, regions: string[], acknowledgedAt: string | null, acknowledgedBy: { id: string, name: string }, impact: "minor" | "major" | "critical", assignee: { id: string, name: string }, assignedAt: string | null, declaredBy: { id: string, name: string }, declaredAt: string | null }, impactOverride: "minor" | "major" | "critical", derivedImpact: "minor" | "major" | "critical", events: { id: string, incidentId: string | null, type: "suspected" | "cleared" | "inconclusive" | "confirmed" | "recovering" | "relapsed" | "resolved" | "paused" | "superseded" | "deleted" | "escalated", at: string, checkScheduledAt: string | null, error: string | null, statusCode: integer | null, notify: "down" | "recovered", notifiedAt: string | null, notifyOutcome: "sent" | "quiet" | "withheld" | "nobody" | "maintenance" | "grouped" | "contact.unavailable", notifyCount: integer | null }[], checks: { scheduledAt: string, finishedAt: string, class: "ok" | "fail" | "skipped" | "probe_suspect", error: "dns_not_found" | "dns_failure" | "dns_timeout" | "connection_refused" | "connection_timeout" | "connection_reset" | "network_unreachable" | "tls_certificate_expired" | "tls_certificate_invalid" | "tls_hostname_mismatch" | "tls_handshake_failed" | "timeout" | "unexpected_status" | "too_many_redirects" | "invalid_redirect" | "destination_not_allowed" | "response_headers_too_large" | "protocol_error" | "keyword_not_found" | "keyword_found" | "json_invalid" | "json_path_missing" | "json_value_mismatch" | "json_too_large" | "header_missing" | "header_mismatch" | "final_url_mismatch" | "dns_no_records" | "dns_unexpected_answer" | "heartbeat_missed" | "no_reply" | "domain_expiring" | "domain_expired" | "lease_expired" | "rate_limited" | "expired" | "probe_overloaded" | "secret_unavailable" | "icmp_unavailable" | "domain_expiry_unknown" | "probe_no_ipv6" | "own_destination" | "self_check_failed", statusCode: integer | null, responseMs: integer | null, timings: { dnsMs: integer | null, connectMs: integer | null, tlsMs: integer | null, ttfbMs: integer | null }, resolvedIp: string | null, redirects: integer, attempts: integer, ping: { sent: integer, received: integer } }[], comments: { id: string, incidentId: string, author: { id: string, name: string }, body: string, visibility: "internal" | "public", createdAt: string }[], postmortem: { incidentId: string, rootCause: string, publicSummary: string, publishedAt: string | null, createdAt: string, updatedAt: string } }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 404 — One of: incident.not_found.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/incidents/0199e6a0-0000-7000-8000-000000000001" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Read the derived timeline of an incident

GET /v1/incidents/{id}/timelineScope: read

The incident told in order, derived from rows that already exist: the first failing check, its confirmation, the alert handed to the notifier, each escalation step with its targets, the acknowledgement and its author, the comments, the public updates and the recovery, each with the seconds since the previous event. It adds no table and copies no event.

Parameters

  • id — in the path, required

Answers

  • 200 — The answer.
    { events: { kind: "detected" | "declared" | "confirmed" | "notified" | "escalation" | "acknowledged" | "comment" | "public_update" | "resolved", at: string, elapsedSeconds: integer, actor: { id: string, name: string }, body: string | null, notification: { said: "down" | "recovered", outcome: "sent" | "quiet" | "withheld" | "nobody" | "maintenance" | "grouped" | "contact.unavailable", count: integer | null }, escalation: { position: integer, targets: …[], outcome: "sent" | "quiet" | "withheld" | "nobody" | "maintenance" | "grouped" | "contact.unavailable" } }[] }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 404 — One of: incident.not_found.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/incidents/0199e6a0-0000-7000-8000-000000000001/timeline" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Read the delivery log of an incident

GET /v1/incidents/{id}/deliveriesScope: read

Every attempt to tell a channel about the incident, newest first: the channel, its status, the attempts, the moment and, for a failure, our classification of the cause. It carries no destination and no payload.

Parameters

  • id — in the path, required

Answers

  • 200 — The answer.
    { items: { id: string, channel: { id: string, name: string, kind: "webhook" | "slack" | "telegram" | "teams" | "discord" | "google_chat" | "mattermost" | "splunk" | "pagerduty" | "pushover" | "pushbullet" | "sms" | "voice" | "zapier" }, incidentEventId: string | null, status: "pending" | "delivered" | "failed", attempts: integer, lastAttemptAt: string | null, deliveredAt: string | null, errorCode: string | null, createdAt: string }[], next: string | null }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 404 — One of: incident.not_found.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/incidents/0199e6a0-0000-7000-8000-000000000001/deliveries" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Retry a failed delivery

POST /v1/deliveries/{id}/retryScope: write

Queues a failed alert again, unchanged, for the worker to send. A delivery that already succeeded is refused with `delivery.not_retryable` rather than sent twice.

Parameters

  • id — in the path, required

Answers

  • 204 — Done; no body.
  • 400 — One of: delivery.not_found, delivery.not_retryable.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/deliveries/0199e6a0-0000-7000-8000-000000000001/retry" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Acknowledge an incident

POST /v1/incidents/{id}/acknowledgeScope: write

Marks it seen. The first acknowledgement stands; a key acknowledges without a person to name.

Parameters

  • id — in the path, required

Answers

  • 200 — The answer.
    { incident: { id: string, monitorId: string, monitorName: string, startedAt: string, confirmedAt: string, resolvedAt: string | null, resolution: "recovered" | "paused" | "superseded" | "deleted" | "manual", origin: "engine" | "manual", cause: string, statusCode: integer | null, checksFailed: integer, lastCheckAt: string, flapping: boolean, maintenance: boolean, regions: string[], acknowledgedAt: string | null, acknowledgedBy: { id: string, name: string }, impact: "minor" | "major" | "critical", assignee: { id: string, name: string }, assignedAt: string | null, declaredBy: { id: string, name: string }, declaredAt: string | null } }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: incident.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/incidents/0199e6a0-0000-7000-8000-000000000001/acknowledge" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Resolve a declared incident by hand

POST /v1/incidents/{id}/resolveScope: write

Closes the incident a person declared, with an optional note kept in its timeline beside the person who wrote it. The incident ends with `resolution: "manual"` and any pending escalation is withdrawn. An incident the result pipeline opened cannot be closed this way: the checks own it.

Parameters

  • id — in the path, required

Request body

{ note?: string }

Answers

  • 200 — The answer.
    { incident: { id: string, monitorId: string, monitorName: string, startedAt: string, confirmedAt: string, resolvedAt: string | null, resolution: "recovered" | "paused" | "superseded" | "deleted" | "manual", origin: "engine" | "manual", cause: string, statusCode: integer | null, checksFailed: integer, lastCheckAt: string, flapping: boolean, maintenance: boolean, regions: string[], acknowledgedAt: string | null, acknowledgedBy: { id: string, name: string }, impact: "minor" | "major" | "critical", assignee: { id: string, name: string }, assignedAt: string | null, declaredBy: { id: string, name: string }, declaredAt: string | null } }
  • 400 — One of: validation.failed, incident.not_manual, incident.already_resolved, incident.declaration_forbidden.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: incident.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/incidents/0199e6a0-0000-7000-8000-000000000001/resolve" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"note":"The provider is back and charges are going through."}'

Publish an update about an incident

POST /v1/incidents/{id}/updatesScope: write

Visitors of the workspace’s status page read it in the incident’s timeline. The update carries its words and its moment; it never names the author.

Parameters

  • id — in the path, required

Request body

{ body: string }

Answers

  • 201 — The answer.
    { update: { id: string, incidentId: string, author: { id: string, name: string }, body: string, visibility: "public", createdAt: string } }
  • 400 — One of: validation.failed.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: incident.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/incidents/0199e6a0-0000-7000-8000-000000000001/updates" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"body":"The database is back and the shop is serving requests again."}'

Set or clear an incident's impact

PATCH /v1/incidents/{id}/impactScope: write

How bad the incident is, chosen on purpose: `minor`, `major` or `critical`, or null to let the rule decide again. The incident answers the level a reader sees and the override that stands. The act is audited with what a reader saw before and after.

Parameters

  • id — in the path, required

Request body

{ impact: "minor" | "major" | "critical" }

Answers

  • 200 — The answer.
    { incident: { id: string, monitorId: string, monitorName: string, startedAt: string, confirmedAt: string, resolvedAt: string | null, resolution: "recovered" | "paused" | "superseded" | "deleted" | "manual", origin: "engine" | "manual", cause: string, statusCode: integer | null, checksFailed: integer, lastCheckAt: string, flapping: boolean, maintenance: boolean, regions: string[], acknowledgedAt: string | null, acknowledgedBy: { id: string, name: string }, impact: "minor" | "major" | "critical", assignee: { id: string, name: string }, assignedAt: string | null, declaredBy: { id: string, name: string }, declaredAt: string | null }, impactOverride: "minor" | "major" | "critical" }
  • 400 — One of: validation.failed, incident.impact_invalid.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: incident.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X PATCH "https://api.nuvostatus.com/v1/incidents/0199e6a0-0000-7000-8000-000000000001/impact" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"impact":"critical"}'

Put a member in charge of an incident, or leave it to nobody

PATCH /v1/incidents/{id}/assignmentScope: write

One member of the workspace owns an incident. Null leaves it to nobody. An owner or an administrator may; a member, a viewer and an API key are refused. A resolved incident may still be assigned.

Parameters

  • id — in the path, required

Request body

{ assigneeUserId: string | null }

Answers

  • 200 — The answer.
    { incident: { id: string, monitorId: string, monitorName: string, startedAt: string, confirmedAt: string, resolvedAt: string | null, resolution: "recovered" | "paused" | "superseded" | "deleted" | "manual", origin: "engine" | "manual", cause: string, statusCode: integer | null, checksFailed: integer, lastCheckAt: string, flapping: boolean, maintenance: boolean, regions: string[], acknowledgedAt: string | null, acknowledgedBy: { id: string, name: string }, impact: "minor" | "major" | "critical", assignee: { id: string, name: string }, assignedAt: string | null, declaredBy: { id: string, name: string }, declaredAt: string | null } }
  • 400 — One of: validation.failed, incident.assignee_not_member, incident.assignment_forbidden.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: incident.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X PATCH "https://api.nuvostatus.com/v1/incidents/0199e6a0-0000-7000-8000-000000000001/assignment" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"assigneeUserId":"0199a1c0-0000-7000-8000-000000000001"}'

Read the postmortem of an incident

GET /v1/incidents/{id}/postmortemScope: read

Why it happened and what was done, kept inside the workspace. `publishedAt` says whether visitors of the workspace’s status page read its public summary; null means a draft. The answer is null until a member drafts one.

Parameters

  • id — in the path, required

Answers

  • 200 — The answer.
    { postmortem: { incidentId: string, rootCause: string, publicSummary: string, publishedAt: string | null, createdAt: string, updatedAt: string } }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: incident.not_found.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/incidents/0199e6a0-0000-7000-8000-000000000001/postmortem" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Draft or correct the postmortem of an incident

PUT /v1/incidents/{id}/postmortemScope: write

Takes the root cause the team keeps and the summary a visitor may read. The incident must be resolved (`incident.not_resolved`); a draft stays inside the workspace. Correcting a published one changes what visitors read at once.

Parameters

  • id — in the path, required

Request body

{ rootCause: string, publicSummary: string }

Answers

  • 200 — The answer.
    { postmortem: { incidentId: string, rootCause: string, publicSummary: string, publishedAt: string | null, createdAt: string, updatedAt: string } }
  • 400 — One of: validation.failed, incident.not_resolved.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: incident.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X PUT "https://api.nuvostatus.com/v1/incidents/0199e6a0-0000-7000-8000-000000000001/postmortem" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rootCause":"A connection pool limit set below the traffic the shop received exhausted every connection.","publicSummary":"The shop was unreachable for eleven minutes because its database connections ran out. We raised the limit and added an alert on pool saturation."}'

Publish the postmortem

POST /v1/incidents/{id}/postmortem/publishScope: write

Shows its public summary under the incident on the status pages that carry it, in the page’s language. The first publication’s moment stands; the root cause is never shown.

Parameters

  • id — in the path, required

Answers

  • 200 — The answer.
    { postmortem: { incidentId: string, rootCause: string, publicSummary: string, publishedAt: string | null, createdAt: string, updatedAt: string } }
  • 400 — One of: incident.not_resolved, postmortem.not_found.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: incident.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/incidents/0199e6a0-0000-7000-8000-000000000001/postmortem/publish" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Unpublish the postmortem

POST /v1/incidents/{id}/postmortem/unpublishScope: write

Removes its summary from every public page again without deleting a word: it becomes a draft that only the workspace reads.

Parameters

  • id — in the path, required

Answers

  • 200 — The answer.
    { postmortem: { incidentId: string, rootCause: string, publicSummary: string, publishedAt: string | null, createdAt: string, updatedAt: string } }
  • 400 — One of: incident.not_resolved, postmortem.not_found.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: incident.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/incidents/0199e6a0-0000-7000-8000-000000000001/postmortem/unpublish" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

List the action items of a postmortem

GET /v1/incidents/{id}/action-itemsScope: read

The work a resolved incident’s postmortem demands: each fix with its owner, its plain calendar due date, its state of open, done or dropped, and whether it is overdue. A viewer and a read key may ask; the list is scoped to the key’s workspace.

Parameters

  • id — in the path, required

Answers

  • 200 — The answer.
    { items: { id: string, incidentId: string, title: string, detail: string | null, owner: { id: string, name: string }, dueOn: string | null, state: "open" | "done" | "dropped", completedAt: string | null, completedBy: { id: string, name: string }, createdAt: string, overdue: boolean }[], next: string | null }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: incident.not_found.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/incidents/0199e6a0-0000-7000-8000-000000000001/action-items" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Add an action item to a postmortem

POST /v1/incidents/{id}/action-itemsScope: write

Adds one fix with an optional detail, one owner who must be a member and a due date that cannot be in the past. The incident must be resolved and have a postmortem; at most fifty items exist per incident (`action_item.too_many`). The act is audited by the item’s id, never its title.

Parameters

  • id — in the path, required

Request body

{ title: string, detail?: string | null, ownerUserId?: string | null, dueOn?: string | null }

Answers

  • 201 — The answer.
    { item: { id: string, incidentId: string, title: string, detail: string | null, owner: { id: string, name: string }, dueOn: string | null, state: "open" | "done" | "dropped", completedAt: string | null, completedBy: { id: string, name: string }, createdAt: string, overdue: boolean } }
  • 400 — One of: validation.failed, postmortem.not_found, action_item.incident_open, action_item.too_many, action_item.owner_not_member, action_item.due_in_past.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: incident.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/incidents/0199e6a0-0000-7000-8000-000000000001/action-items" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"Raise the connection pool limit","detail":"From 20 to 80 connections, then alert at 70 percent.","ownerUserId":"0199a1c0-0000-7000-8000-000000000001","dueOn":"2026-11-20"}'

Change an action item

PATCH /v1/action-items/{id}Scope: write

Changes its words, its owner, its due date or its state. Only open→done, open→dropped and done→open are legal; a completion names the person and the moment, and a reopen clears both. A due date may be recorded in the past here. The act is audited by the item’s id, never its title.

Parameters

  • id — in the path, required

Request body

{ title?: string, detail?: string | null, ownerUserId?: string | null, dueOn?: string | null, state?: "open" | "done" | "dropped" }

Answers

  • 200 — The answer.
    { item: { id: string, incidentId: string, title: string, detail: string | null, owner: { id: string, name: string }, dueOn: string | null, state: "open" | "done" | "dropped", completedAt: string | null, completedBy: { id: string, name: string }, createdAt: string, overdue: boolean } }
  • 400 — One of: validation.failed, action_item.not_found, action_item.owner_not_member.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 429 — One of: request.rate_limited.

Example

curl -X PATCH "https://api.nuvostatus.com/v1/action-items/0199e6a0-0000-7000-8000-000000000001" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"state":"done"}'

List the workspace’s action items

GET /v1/action-itemsScope: read

Everything the workspace’s postmortems demanded, across incidents, earliest due date first and undated ones last. Narrows by one state, one owner (`me`, `unassigned` or a member’s id) and `overdue=true`, which keeps only open work. A key has no person behind `me`.

Parameters

  • state — in the query string, optional
  • owner — in the query string, optional
  • overdue — in the query string, optional
  • limit — in the query string, optional

Answers

  • 200 — The answer.
    { items: { id: string, incidentId: string, title: string, detail: string | null, owner: { id: string, name: string }, dueOn: string | null, state: "open" | "done" | "dropped", completedAt: string | null, completedBy: { id: string, name: string }, createdAt: string, overdue: boolean }[], next: string | null }
  • 400 — One of: validation.failed.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/action-items" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

List the maintenance windows

GET /v1/maintenance-windowsScope: read

The ones under way or to come, soonest first, then the last ten that are over.

Answers

  • 200 — The answer.
    { items: { id: string, name: string, startsAt: string, endsAt: string, recurrence: "none" | "daily" | "weekly" | "monthly", timeZone: string | null, monitorIds: string[], createdBy: string | null, createdAt: string, state: "scheduled" | "active" | "past" }[], next: string | null }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/maintenance-windows" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Read a maintenance window

GET /v1/maintenance-windows/{id}Scope: read

One window, whether it is scheduled, under way or over.

Parameters

  • id — in the path, required

Answers

  • 200 — The answer.
    { id: string, name: string, startsAt: string, endsAt: string, recurrence: "none" | "daily" | "weekly" | "monthly", timeZone: string | null, monitorIds: string[], createdBy: string | null, createdAt: string, state: "scheduled" | "active" | "past" }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 404 — One of: maintenance.not_found.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/maintenance-windows/0199e6a0-0000-7000-8000-000000000001" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Schedule a maintenance window

POST /v1/maintenance-windowsScope: write

Checks go on under a window; an incident that opens is recorded without an email, and the window's time counts for nothing in uptime. A retry with the same `Idempotency-Key` replays the first answer.

Parameters

  • Idempotency-Key — in the query string, optional

Request body

{ name: string, startsAt: string, endsAt: string, monitorIds: string[], groupIds?: string[], recurrence?: "none" | "daily" | "weekly" | "monthly", timeZone?: string | null }

Answers

  • 201 — The answer.
    { id: string, name: string, startsAt: string, endsAt: string, recurrence: "none" | "daily" | "weekly" | "monthly", timeZone: string | null, monitorIds: string[], createdBy: string | null, createdAt: string, state: "scheduled" | "active" | "past" }
  • 400 — One of: validation.failed.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: maintenance.monitor_not_found.
  • 409 — One of: maintenance.limit_reached, idempotency.conflict, idempotency.in_progress.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/maintenance-windows" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Database upgrade","startsAt":"2026-10-12T22:00:00Z","endsAt":"2026-10-13T00:00:00Z","monitorIds":["0199e6a0-0000-7000-8000-000000000001"]}'

Schedule several maintenance windows at once

POST /v1/maintenance-windows/bulkScope: write

Up to fifty windows in one request. Each is scheduled in its own transaction and answered with its own result: an invalid window, a monitor or group of another workspace, or a plan limit reached fails that item only, and the others are created. An omitted monitor or group list means every monitor.

Request body

{ windows: any[] }

Answers

  • 200 — The answer.
    { results: { index: integer, id?: string, code?: "auth.cannot_revoke_current" | "auth.email_not_verified" | "auth.invalid_code" | "auth.invalid_credentials" | "auth.invalid_token" | "auth.password_too_long" | "auth.password_too_short" | "auth.totp_required" | "auth.two_factor_already_enabled" | "auth.two_factor_not_enabled" | "auth.unauthenticated" | "internal.error" | "invitation.already_member" | "invitation.limit_reached" | "invitation.not_found" | "account.password_incorrect" | "account.sole_owner" | "account.disabled" | "account.email_taken" | "account.email_unchanged" | "admin.not_an_operator" | "admin.permission_denied" | "admin.user_not_found" | "admin.workspace_not_found" | "admin.monitor_not_found" | "admin.incident_not_found" | "admin.plan_unknown" | "admin.plan_below_usage" | "admin.override_invalid" | "admin.subscription_not_found" | "alert_digest.invalid_window" | "alert_grouping.invalid" | "api.bulk_empty" | "audit.read_forbidden" | "billing.provider_unavailable" | "billing.plan_not_sold" | "billing.no_subscription" | "billing.subscription_state" | "billing.subscription_conflict" | "billing.webhook_rejected" | "entitlement.feature_not_included" | "escalation_steps.invalid" | "escalation.rotation_not_found" | "escalation_steps.contact_not_found" | "escalation_steps.channel_not_found" | "member.limit_reached" | "member.last_owner" | "member.not_found" | "member.role_not_assignable" | "monitor.account_limit_reached" | "monitor.confirmation_out_of_range" | "monitor.interval_not_allowed" | "monitor.limit_reached" | "monitor.timeout_not_allowed" | "monitor.update_forbidden" | "import.invalid_export" | "import.row_refused" | "import.secret_unavailable" | "import.source_key_refused" | "import.source_unavailable" | "import.unsupported_type" | "import.missing_target" | "import.invalid_target" | "import.invalid_name" | "import.unsupported_interval" | "import.too_many_rows" | "incident.not_found" | "incident.invalid_cursor" | "incident.impact_invalid" | "incident.assignee_not_member" | "incident.assignment_forbidden" | "incident.already_resolved" | "incident.not_resolved" | "incident.already_open" | "incident.not_manual" | "incident.cause_invalid" | "incident.declaration_forbidden" | "incident.export_too_large" | "action_item.not_found" | "action_item.too_many" | "action_item.incident_open" | "action_item.owner_not_member" | "action_item.due_in_past" | "postmortem.not_found" | "incident_comment.not_author" | "incident_comment.not_found" | "monitor.invalid_cursor" | "monitor.not_found" | "monitor.not_deleted" | "monitor.restore_window_expired" | "monitor.url_not_allowed" | "monitor.channel_not_found" | "monitor.keyword_needs_body" | "monitor.conditions_need_body" | "monitor.json_condition_needs_body" | "monitor.config_invalid" | "monitor.authorization_header_conflict" | "monitor.auth_value_has_scheme" | "monitor.domain_invalid" | "monitor.secrets_unavailable" | "monitor.host_not_allowed" | "monitor.not_a_heartbeat" | "monitor.slow_response_not_supported" | "monitor.baseline_not_supported" | "monitor.pause_until_in_past" | "monitor.pause_until_too_far" | "monitor.dependency_not_found" | "monitor.dependency_self" | "monitor.dependency_limit" | "monitor.dependency_duplicate" | "monitor.dependency_cycle" | "monitor.runbook_url_invalid" | "monitor.paused" | "monitor.check_too_soon" | "monitor.check_budget_spent" | "monitor.check_not_supported" | "monitor.no_capable_probe" | "manual_check.not_found" | "on_call.invalid_participant" | "on_call.invalid_window" | "on_call.invalid_name" | "on_call.name_taken" | "on_call.rotation_not_found" | "on_call.rotation_last" | "rotation.in_use" | "group.not_found" | "group.name_taken" | "group.limit_reached" | "group.order_invalid" | "idempotency.conflict" | "idempotency.in_progress" | "tag.not_found" | "tag.name_taken" | "tag.limit_reached" | "tag.limit_per_monitor" | "sla_policy.not_found" | "sla_policy.name_taken" | "sla_policy.monitor_already_covered" | "sla_report.not_found" | "sla_report.month_not_closed" | "sla_report.too_large" | "api_key.not_found" | "api_key.limit_reached" | "api_key.write_key_not_limited" | "api_key.monitor_not_allowed" | "api_key.not_rotatable" | "api_key.grace_out_of_range" | "contact.not_found" | "contact.already_exists" | "contact.limit_reached" | "contact.availability_invalid" | "contact.unavailable" | "maintenance.not_found" | "maintenance.not_editable" | "maintenance.limit_reached" | "maintenance.monitor_not_found" | "maintenance.group_not_found" | "maintenance.invalid_window" | "maintenance.skip_not_recurring" | "maintenance.skip_not_an_occurrence" | "maintenance.skip_started" | "maintenance.skip_already_skipped" | "maintenance.skip_not_found" | "maintenance_window.group_not_found" | "maintenance_window.limit_exceeded" | "maintenance_window.monitor_not_found" | "maintenance_window.not_active" | "maintenance_window.not_found" | "contact.not_verified" | "contact.unknown_contact" | "contact.verification_invalid" | "channel.not_found" | "channel.name_taken" | "channel.limit_reached" | "channel.config_invalid" | "channel.events_empty" | "channel.secret_unavailable" | "channel.secret_not_rotatable" | "delivery.not_found" | "delivery.not_retryable" | "delivery.paced" | "email.lane_budget_exhausted" | "email.suppression_not_found" | "email.webhook_rejected" | "alert_provider.not_configured" | "permission.denied" | "probe.enrolment_expired" | "probe.enrolment_invalid_key" | "probe.enrolment_invalid_request" | "probe.enrolment_revoked" | "probe.enrolment_unknown" | "probe.enrolment_used" | "request.content_type_not_allowed" | "request.cross_site" | "request.host_not_allowed" | "request.origin_missing" | "request.origin_not_allowed" | "request.rate_limited" | "resource.not_found" | "status_page.limit_reached" | "status_page.monitor_not_found" | "status_page.not_found" | "status_page.password_incorrect" | "status_page.slug_taken" | "status_page.unavailable" | "status_page.service_not_found" | "status_page.services_required" | "status_page.domain_invalid" | "status_page.domain_taken" | "status_page_announcement.invalid_window" | "status_page_announcement.limit_reached" | "status_page_announcement.not_found" | "status_page_subscriber.not_found" | "validation.failed" | "weekly_report.invalid_reader" | "workspace.limit_reached" | "workspace.not_found" | "workspace.nothing_to_change" | "workspace.import_limit_exceeded" }[] }
  • 400 — One of: validation.failed, api.bulk_empty, maintenance.invalid_window.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: maintenance_window.monitor_not_found, maintenance_window.group_not_found.
  • 409 — One of: maintenance_window.limit_exceeded.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/maintenance-windows/bulk" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"windows":[{"name":"Database upgrade","startsAt":"2026-10-12T22:00:00Z","endsAt":"2026-10-13T00:00:00Z","monitorIds":["0199e6a0-0000-7000-8000-000000000001"]},{"name":"Certificate rotation","startsAt":"2026-10-14T22:00:00Z","endsAt":"2026-10-15T00:00:00Z"}]}'

End several maintenance windows now

POST /v1/maintenance-windows/bulk/endScope: write

Up to a hundred windows. Only a window under way ends; one that has not begun, or is already over, answers `maintenance_window.not_active` in its own result. A window of another workspace is as absent as one that never existed, and no id of another workspace is returned.

Request body

{ ids: string[] }

Answers

  • 200 — The answer.
    { results: { id: string, code?: "auth.cannot_revoke_current" | "auth.email_not_verified" | "auth.invalid_code" | "auth.invalid_credentials" | "auth.invalid_token" | "auth.password_too_long" | "auth.password_too_short" | "auth.totp_required" | "auth.two_factor_already_enabled" | "auth.two_factor_not_enabled" | "auth.unauthenticated" | "internal.error" | "invitation.already_member" | "invitation.limit_reached" | "invitation.not_found" | "account.password_incorrect" | "account.sole_owner" | "account.disabled" | "account.email_taken" | "account.email_unchanged" | "admin.not_an_operator" | "admin.permission_denied" | "admin.user_not_found" | "admin.workspace_not_found" | "admin.monitor_not_found" | "admin.incident_not_found" | "admin.plan_unknown" | "admin.plan_below_usage" | "admin.override_invalid" | "admin.subscription_not_found" | "alert_digest.invalid_window" | "alert_grouping.invalid" | "api.bulk_empty" | "audit.read_forbidden" | "billing.provider_unavailable" | "billing.plan_not_sold" | "billing.no_subscription" | "billing.subscription_state" | "billing.subscription_conflict" | "billing.webhook_rejected" | "entitlement.feature_not_included" | "escalation_steps.invalid" | "escalation.rotation_not_found" | "escalation_steps.contact_not_found" | "escalation_steps.channel_not_found" | "member.limit_reached" | "member.last_owner" | "member.not_found" | "member.role_not_assignable" | "monitor.account_limit_reached" | "monitor.confirmation_out_of_range" | "monitor.interval_not_allowed" | "monitor.limit_reached" | "monitor.timeout_not_allowed" | "monitor.update_forbidden" | "import.invalid_export" | "import.row_refused" | "import.secret_unavailable" | "import.source_key_refused" | "import.source_unavailable" | "import.unsupported_type" | "import.missing_target" | "import.invalid_target" | "import.invalid_name" | "import.unsupported_interval" | "import.too_many_rows" | "incident.not_found" | "incident.invalid_cursor" | "incident.impact_invalid" | "incident.assignee_not_member" | "incident.assignment_forbidden" | "incident.already_resolved" | "incident.not_resolved" | "incident.already_open" | "incident.not_manual" | "incident.cause_invalid" | "incident.declaration_forbidden" | "incident.export_too_large" | "action_item.not_found" | "action_item.too_many" | "action_item.incident_open" | "action_item.owner_not_member" | "action_item.due_in_past" | "postmortem.not_found" | "incident_comment.not_author" | "incident_comment.not_found" | "monitor.invalid_cursor" | "monitor.not_found" | "monitor.not_deleted" | "monitor.restore_window_expired" | "monitor.url_not_allowed" | "monitor.channel_not_found" | "monitor.keyword_needs_body" | "monitor.conditions_need_body" | "monitor.json_condition_needs_body" | "monitor.config_invalid" | "monitor.authorization_header_conflict" | "monitor.auth_value_has_scheme" | "monitor.domain_invalid" | "monitor.secrets_unavailable" | "monitor.host_not_allowed" | "monitor.not_a_heartbeat" | "monitor.slow_response_not_supported" | "monitor.baseline_not_supported" | "monitor.pause_until_in_past" | "monitor.pause_until_too_far" | "monitor.dependency_not_found" | "monitor.dependency_self" | "monitor.dependency_limit" | "monitor.dependency_duplicate" | "monitor.dependency_cycle" | "monitor.runbook_url_invalid" | "monitor.paused" | "monitor.check_too_soon" | "monitor.check_budget_spent" | "monitor.check_not_supported" | "monitor.no_capable_probe" | "manual_check.not_found" | "on_call.invalid_participant" | "on_call.invalid_window" | "on_call.invalid_name" | "on_call.name_taken" | "on_call.rotation_not_found" | "on_call.rotation_last" | "rotation.in_use" | "group.not_found" | "group.name_taken" | "group.limit_reached" | "group.order_invalid" | "idempotency.conflict" | "idempotency.in_progress" | "tag.not_found" | "tag.name_taken" | "tag.limit_reached" | "tag.limit_per_monitor" | "sla_policy.not_found" | "sla_policy.name_taken" | "sla_policy.monitor_already_covered" | "sla_report.not_found" | "sla_report.month_not_closed" | "sla_report.too_large" | "api_key.not_found" | "api_key.limit_reached" | "api_key.write_key_not_limited" | "api_key.monitor_not_allowed" | "api_key.not_rotatable" | "api_key.grace_out_of_range" | "contact.not_found" | "contact.already_exists" | "contact.limit_reached" | "contact.availability_invalid" | "contact.unavailable" | "maintenance.not_found" | "maintenance.not_editable" | "maintenance.limit_reached" | "maintenance.monitor_not_found" | "maintenance.group_not_found" | "maintenance.invalid_window" | "maintenance.skip_not_recurring" | "maintenance.skip_not_an_occurrence" | "maintenance.skip_started" | "maintenance.skip_already_skipped" | "maintenance.skip_not_found" | "maintenance_window.group_not_found" | "maintenance_window.limit_exceeded" | "maintenance_window.monitor_not_found" | "maintenance_window.not_active" | "maintenance_window.not_found" | "contact.not_verified" | "contact.unknown_contact" | "contact.verification_invalid" | "channel.not_found" | "channel.name_taken" | "channel.limit_reached" | "channel.config_invalid" | "channel.events_empty" | "channel.secret_unavailable" | "channel.secret_not_rotatable" | "delivery.not_found" | "delivery.not_retryable" | "delivery.paced" | "email.lane_budget_exhausted" | "email.suppression_not_found" | "email.webhook_rejected" | "alert_provider.not_configured" | "permission.denied" | "probe.enrolment_expired" | "probe.enrolment_invalid_key" | "probe.enrolment_invalid_request" | "probe.enrolment_revoked" | "probe.enrolment_unknown" | "probe.enrolment_used" | "request.content_type_not_allowed" | "request.cross_site" | "request.host_not_allowed" | "request.origin_missing" | "request.origin_not_allowed" | "request.rate_limited" | "resource.not_found" | "status_page.limit_reached" | "status_page.monitor_not_found" | "status_page.not_found" | "status_page.password_incorrect" | "status_page.slug_taken" | "status_page.unavailable" | "status_page.service_not_found" | "status_page.services_required" | "status_page.domain_invalid" | "status_page.domain_taken" | "status_page_announcement.invalid_window" | "status_page_announcement.limit_reached" | "status_page_announcement.not_found" | "status_page_subscriber.not_found" | "validation.failed" | "weekly_report.invalid_reader" | "workspace.limit_reached" | "workspace.not_found" | "workspace.nothing_to_change" | "workspace.import_limit_exceeded" }[] }
  • 400 — One of: validation.failed, api.bulk_empty.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: maintenance_window.not_found.
  • 409 — One of: maintenance_window.not_active.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/maintenance-windows/bulk/end" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["0199e6a0-0000-7000-8000-000000000001","0199e6a0-0000-7000-8000-000000000002"]}'

Change a scheduled maintenance window

PATCH /v1/maintenance-windows/{id}Scope: write

Its name, its span or the monitors it covers, before it begins. Once under way a window can only end.

Parameters

  • id — in the path, required

Request body

{ name?: string, startsAt?: string, endsAt?: string, recurrence?: "none" | "daily" | "weekly" | "monthly", timeZone?: string | null, monitorIds?: string[], groupIds?: string[] }

Answers

  • 200 — The answer.
    { id: string, name: string, startsAt: string, endsAt: string, recurrence: "none" | "daily" | "weekly" | "monthly", timeZone: string | null, monitorIds: string[], createdBy: string | null, createdAt: string, state: "scheduled" | "active" | "past" }
  • 400 — One of: validation.failed.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: maintenance.not_found, maintenance.monitor_not_found.
  • 409 — One of: maintenance.not_editable.
  • 429 — One of: request.rate_limited.

Example

curl -X PATCH "https://api.nuvostatus.com/v1/maintenance-windows/0199e6a0-0000-7000-8000-000000000001" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Database upgrade, moved","startsAt":"2026-10-13T22:00:00Z","endsAt":"2026-10-14T00:00:00Z","monitorIds":null}'

End a maintenance window now

POST /v1/maintenance-windows/{id}/endScope: write

A window under way ends at this moment; one that has not begun is removed.

Parameters

  • id — in the path, required

Answers

  • 204 — Done; no body.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: maintenance.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/maintenance-windows/0199e6a0-0000-7000-8000-000000000001/end" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

List the next occurrences of a maintenance series

GET /v1/maintenance-windows/{id}/occurrencesScope: read

The occurrences that intersect the next thirty days, soonest first, each with its state. A skipped occurrence is `skipped`, never `upcoming` or `active`; every other occurrence keeps the state its own times give it.

Parameters

  • id — in the path, required
  • days — in the query string, optional

Answers

  • 200 — The answer.
    { occurrences: { startsAt: string, endsAt: string, state: "upcoming" | "active" | "past" | "skipped", skipId: string | null }[] }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed.
  • 404 — One of: maintenance.not_found.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/maintenance-windows/0199e6a0-0000-7000-8000-000000000001/occurrences" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Skip one occurrence of a maintenance series

POST /v1/maintenance-windows/{id}/skipsScope: write

The occurrence never opens: no incident is recorded as maintenance under it, nobody is told, the public calendar does not list it, and a failure during it is an ordinary incident. The series and its past are untouched. A window that does not recur and an instant that is not one of its occurrences answer `maintenance.skip_not_recurring` and `maintenance.skip_not_an_occurrence`; one already skipped answers `maintenance.skip_already_skipped`.

Parameters

  • id — in the path, required

Request body

{ startsAt: string }

Answers

  • 201 — The answer.
    { skip: { id: string, maintenanceId: string, occurrenceStart: string, createdBy: string | null, createdAt: string } }
  • 400 — One of: validation.failed, maintenance.skip_not_recurring, maintenance.skip_not_an_occurrence, maintenance.skip_started, maintenance.skip_already_skipped.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: maintenance.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X POST "https://api.nuvostatus.com/v1/maintenance-windows/0199e6a0-0000-7000-8000-000000000001/skips" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY" \
  -H "Content-Type: application/json" \
  -d '{"startsAt":"2026-10-19T22:00:00Z"}'

Remove a skip before the occurrence starts

DELETE /v1/maintenance-windows/{id}/skips/{skipId}Scope: write

The occurrence is scheduled again exactly as the series says. A skip that is gone answers `maintenance.skip_not_found`; one whose occurrence has already started answers `maintenance.skip_started`.

Parameters

  • id — in the path, required
  • skipId — in the path, required

Answers

  • 204 — Done; no body.
  • 400 — One of: maintenance.skip_not_found, maintenance.skip_started.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: maintenance.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X DELETE "https://api.nuvostatus.com/v1/maintenance-windows/0199e6a0-0000-7000-8000-000000000001/skips/{skipId}" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Delete a maintenance window

DELETE /v1/maintenance-windows/{id}Scope: write

A window under way ends now; one that has not begun is removed.

Parameters

  • id — in the path, required

Answers

  • 204 — Done; no body.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: maintenance.not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X DELETE "https://api.nuvostatus.com/v1/maintenance-windows/0199e6a0-0000-7000-8000-000000000001" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

List the silenced email addresses

GET /v1/email/suppressionsScope: write

The addresses of this workspace that a hard bounce or a complaint silenced, newest first, and the provider event that last silenced each. No message, body or secret is part of an answer. Only someone who administers the workspace may ask: a write key acts as an administrator, a read key as a viewer, which is refused.

Answers

  • 200 — The answer.
    { items: { address: string, reason: "hard_bounce" | "complaint", createdAt: string, lastEvent: { providerEventId: string, kind: "hard_bounce" | "complaint", receivedAt: string } }[], next: null }
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 429 — One of: request.rate_limited.

Example

curl "https://api.nuvostatus.com/v1/email/suppressions" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"

Let a silenced address receive email again

DELETE /v1/email/suppressions/{address}Scope: write

Clears the suppression of one address, so a fixed mailbox receives alerts and reports again. An address that is not suppressed answers `email.suppression_not_found`. Each clear is recorded in the activity log. Only someone who administers the workspace may clear one.

Parameters

  • address — in the path, required

Answers

  • 204 — Done; no body.
  • 400 — One of: validation.failed.
  • 401 — One of: auth.unauthenticated.
  • 403 — One of: request.host_not_allowed, permission.denied.
  • 404 — One of: email.suppression_not_found.
  • 429 — One of: request.rate_limited.

Example

curl -X DELETE "https://api.nuvostatus.com/v1/email/suppressions/{address}" \
  -H "Authorization: Bearer $NUVOSTATUS_KEY"