# Uptizm API > Uptizm is an uptime, incident and status-page service. This REST API lets a team API key manage monitors, custom metrics, incidents, status pages, maintenance windows, notification channels, on-call schedules and escalation policies. Base URL `https://api.uptizm.com/v1`; authenticate with `Authorization: Bearer upz_...`. Every endpoint names the ability a key needs (`x-required-ability`). Read the quickstart first: it links the guide that owns each topic. ## Guides - [Uptizm API quickstart](https://uptizm.com/docs/quickstart.md) - [Authentication](https://uptizm.com/docs/authentication.md) - [Create monitors](https://uptizm.com/docs/create-monitors.md) - [Errors](https://uptizm.com/docs/errors.md) - [Rate limits](https://uptizm.com/docs/rate-limits.md) - [Pagination](https://uptizm.com/docs/pagination.md) - [Idempotency](https://uptizm.com/docs/idempotency.md) - [Anonymous workspaces for agents](https://uptizm.com/docs/anonymous-workspaces.md) ## Reference - [API reference](https://uptizm.com/docs/api.md): Every resource and its endpoint count. - [OpenAPI spec](https://uptizm.com/docs/openapi.json): The OpenAPI 3.1 document for every endpoint below. - [Everything in one file](https://uptizm.com/llms-full.txt): The guides and every endpoint page inline. ## Resources - [Keys API](https://uptizm.com/docs/api/keys.md): 2 endpoints. - [Monitors API](https://uptizm.com/docs/api/monitors.md): 19 endpoints. - [Metrics API](https://uptizm.com/docs/api/metrics.md): 10 endpoints. - [Incidents API](https://uptizm.com/docs/api/incidents.md): 16 endpoints. - [Dashboard API](https://uptizm.com/docs/api/dashboard.md): 4 endpoints. - [Status pages API](https://uptizm.com/docs/api/status-pages.md): 16 endpoints. - [Maintenance API](https://uptizm.com/docs/api/maintenance.md): 5 endpoints. - [Channels API](https://uptizm.com/docs/api/channels.md): 6 endpoints. - [On-call API](https://uptizm.com/docs/api/on-call.md): 11 endpoints. - [Escalation API](https://uptizm.com/docs/api/escalation.md): 8 endpoints. - [Team API](https://uptizm.com/docs/api/team.md): 6 endpoints. ## Keys - [POST /claim-code](https://uptizm.com/docs/post-claim-code.md): Get a claim url for an anonymous workspace. Requires `claim:create`. - [GET /me](https://uptizm.com/docs/get-me.md): Describe the calling key. Requires `self`. ## Monitors - [POST /monitors/analyze](https://uptizm.com/docs/post-monitors-analyze.md): Start an AI analysis of a URL. Requires `monitors:write`. - [GET /monitors/analyze/{run}](https://uptizm.com/docs/get-monitors-analyze-run.md): Poll an AI analysis run. Requires `monitors:read`. - [GET /monitors](https://uptizm.com/docs/get-monitors.md): List monitors. Requires `monitors:read`. - [POST /monitors](https://uptizm.com/docs/post-monitors.md): Create a monitor. Requires `monitors:write`. - [GET /monitors/{monitor}](https://uptizm.com/docs/get-monitors-monitor.md): Get a monitor. Requires `monitors:read`. - [PUT /monitors/{monitor}](https://uptizm.com/docs/put-monitors-monitor.md): Update a monitor. Requires `monitors:write`. - [DELETE /monitors/{monitor}](https://uptizm.com/docs/delete-monitors-monitor.md): Delete a monitor. Requires `monitors:write`. - [POST /monitors/{monitor}/pause](https://uptizm.com/docs/post-monitors-monitor-pause.md): Pause a monitor. Requires `monitors:write`. - [POST /monitors/{monitor}/resume](https://uptizm.com/docs/post-monitors-monitor-resume.md): Resume a monitor. Requires `monitors:write`. - [POST /monitors/{monitor}/test](https://uptizm.com/docs/post-monitors-monitor-test.md): Run a check now. Requires `monitors:write`. - [GET /monitors/{monitor}/checks](https://uptizm.com/docs/get-monitors-monitor-checks.md): List a monitor's checks. Requires `monitors:read`. - [GET /monitors/{monitor}/checks/{check}](https://uptizm.com/docs/get-monitors-monitor-checks-check.md): Get one check. Requires `monitors:read`. - [GET /monitors/{monitor}/content](https://uptizm.com/docs/get-monitors-monitor-content.md): List archived content versions. Requires `monitors:read`. - [GET /monitors/{monitor}/content/candidates](https://uptizm.com/docs/get-monitors-monitor-content-candidates.md): List metric candidates. Requires `monitors:read`. - [GET /monitors/{monitor}/content/{contentHash}](https://uptizm.com/docs/get-monitors-monitor-content-contenthash.md): Download an archived version. Requires `monitors:read`. - [GET /monitors/{monitor}/uptime](https://uptizm.com/docs/get-monitors-monitor-uptime.md): Get uptime over a range. Requires `monitors:read`. - [GET /monitors/{monitor}/response-times](https://uptizm.com/docs/get-monitors-monitor-response-times.md): Get response times over a range. Requires `monitors:read`. - [GET /monitors/{monitor}/anomalies](https://uptizm.com/docs/get-monitors-monitor-anomalies.md): List anomalies. Requires `monitors:read`. - [GET /monitors/{monitor}/status-history](https://uptizm.com/docs/get-monitors-monitor-status-history.md): Get the 90-day status history. Requires `monitors:read`. ## Metrics - [GET /monitors/{monitor}/metrics](https://uptizm.com/docs/get-monitors-monitor-metrics.md): List a monitor's metrics. Requires `metrics:read`. - [POST /monitors/{monitor}/metrics](https://uptizm.com/docs/post-monitors-monitor-metrics.md): Create a metric. Requires `metrics:write`. - [POST /monitors/{monitor}/metrics/preview](https://uptizm.com/docs/post-monitors-monitor-metrics-preview.md): Preview a metric rule. Requires `metrics:write`. - [POST /monitors/{monitor}/metrics/discover](https://uptizm.com/docs/post-monitors-monitor-metrics-discover.md): Discover metrics with AI. Requires `metrics:write`. - [PATCH /monitors/{monitor}/metrics/reorder](https://uptizm.com/docs/patch-monitors-monitor-metrics-reorder.md): Reorder metrics. Requires `metrics:write`. - [PUT /monitors/{monitor}/metrics/{metric}](https://uptizm.com/docs/put-monitors-monitor-metrics-metric.md): Update a metric. Requires `metrics:write`. - [DELETE /monitors/{monitor}/metrics/{metric}](https://uptizm.com/docs/delete-monitors-monitor-metrics-metric.md): Delete a metric. Requires `metrics:write`. - [GET /monitors/{monitor}/metrics/series](https://uptizm.com/docs/get-monitors-monitor-metrics-series.md): Get recent samples of every metric. Requires `metrics:read`. - [GET /monitors/{monitor}/metrics/{metric}/series](https://uptizm.com/docs/get-monitors-monitor-metrics-metric-series.md): Get a metric series. Requires `metrics:read`. - [GET /monitors/{monitor}/metrics/{metric}/readings](https://uptizm.com/docs/get-monitors-monitor-metrics-metric-readings.md): List a metric's readings. Requires `metrics:read`. ## Incidents - [GET /incidents](https://uptizm.com/docs/get-incidents.md): List incidents. Requires `incidents:read`. - [POST /incidents](https://uptizm.com/docs/post-incidents.md): Open an incident. Requires `incidents:write`. - [GET /incidents/digest](https://uptizm.com/docs/get-incidents-digest.md): Get the weekly digest. Requires `incidents:read`. - [GET /incidents/{incident}](https://uptizm.com/docs/get-incidents-incident.md): Get an incident. Requires `incidents:read`. - [POST /incidents/{incident}/resolve](https://uptizm.com/docs/post-incidents-incident-resolve.md): Resolve an incident. Requires `incidents:write`. - [POST /incidents/{incident}/acknowledge](https://uptizm.com/docs/post-incidents-incident-acknowledge.md): Acknowledge an incident. Requires `incidents:write`. - [POST /incidents/{incident}/reopen](https://uptizm.com/docs/post-incidents-incident-reopen.md): Reopen an incident. Requires `incidents:write`. - [POST /incidents/{incident}/assign](https://uptizm.com/docs/post-incidents-incident-assign.md): Assign an incident. Requires `incidents:write`. - [POST /incidents/{incident}/postmortem](https://uptizm.com/docs/post-incidents-incident-postmortem.md): Save a postmortem. Requires `incidents:write`. - [POST /incidents/{incident}/updates](https://uptizm.com/docs/post-incidents-incident-updates.md): Post an incident update. Requires `incidents:write`. - [GET /incidents/{incident}/analysis](https://uptizm.com/docs/get-incidents-incident-analysis.md): Get the AI root-cause analysis. Requires `incidents:read`. - [POST /incidents/{incident}/analysis/feedback](https://uptizm.com/docs/post-incidents-incident-analysis-feedback.md): Rate the AI analysis. Requires `incidents:write`. - [POST /incidents/{incident}/draft-update](https://uptizm.com/docs/post-incidents-incident-draft-update.md): Draft a status update with AI. Requires `incidents:write`. - [POST /incidents/{incident}/draft-postmortem](https://uptizm.com/docs/post-incidents-incident-draft-postmortem.md): Draft a postmortem with AI. Requires `incidents:write`. - [POST /ai-suggestions/{suggestion}/accept](https://uptizm.com/docs/post-ai-suggestions-suggestion-accept.md): Accept an AI suggestion. Requires `incidents:write`. - [POST /ai-suggestions/{suggestion}/dismiss](https://uptizm.com/docs/post-ai-suggestions-suggestion-dismiss.md): Dismiss an AI suggestion. Requires `incidents:write`. ## Dashboard - [GET /dashboard/stats](https://uptizm.com/docs/get-dashboard-stats.md): Get team statistics. Requires `stats:read`. - [GET /dashboard/active-incidents](https://uptizm.com/docs/get-dashboard-active-incidents.md): List active incidents. Requires `stats:read`. - [GET /dashboard/monitors-snapshot](https://uptizm.com/docs/get-dashboard-monitors-snapshot.md): List the worst monitors. Requires `stats:read`. - [GET /dashboard/ai-inbox](https://uptizm.com/docs/get-dashboard-ai-inbox.md): List pending AI suggestions. Requires `stats:read`. ## Status pages - [GET /status-pages](https://uptizm.com/docs/get-status-pages.md): List status pages. Requires `status_pages:read`. - [POST /status-pages](https://uptizm.com/docs/post-status-pages.md): Create a status page. Requires `status_pages:write`. - [GET /status-pages/{statusPage}](https://uptizm.com/docs/get-status-pages-statuspage.md): Get a status page. Requires `status_pages:read`. - [PUT /status-pages/{statusPage}](https://uptizm.com/docs/put-status-pages-statuspage.md): Update a status page. Requires `status_pages:write`. - [DELETE /status-pages/{statusPage}](https://uptizm.com/docs/delete-status-pages-statuspage.md): Delete a status page. Requires `status_pages:write`. - [PATCH /status-pages/{statusPage}/monitors/reorder](https://uptizm.com/docs/patch-status-pages-statuspage-monitors-reorder.md): Reorder a page's monitors. Requires `status_pages:write`. - [POST /status-pages/{statusPage}/monitors](https://uptizm.com/docs/post-status-pages-statuspage-monitors.md): Attach a monitor to a page. Requires `status_pages:write`. - [DELETE /status-pages/{statusPage}/monitors/{monitor}](https://uptizm.com/docs/delete-status-pages-statuspage-monitors-monitor.md): Detach a monitor from a page. Requires `status_pages:write`. - [POST /status-pages/{statusPage}/logo](https://uptizm.com/docs/post-status-pages-statuspage-logo.md): Upload a page logo. Requires `status_pages:write`. - [DELETE /status-pages/{statusPage}/logo](https://uptizm.com/docs/delete-status-pages-statuspage-logo.md): Remove the page logo. Requires `status_pages:write`. - [POST /status-pages/{statusPage}/dark-logo](https://uptizm.com/docs/post-status-pages-statuspage-dark-logo.md): Upload a dark-mode logo. Requires `status_pages:write`. - [DELETE /status-pages/{statusPage}/dark-logo](https://uptizm.com/docs/delete-status-pages-statuspage-dark-logo.md): Remove the dark-mode logo. Requires `status_pages:write`. - [POST /status-pages/{statusPage}/preview](https://uptizm.com/docs/post-status-pages-statuspage-preview.md): Re-render the page preview. Requires `status_pages:write`. - [GET /status-pages/{statusPage}/subscribers](https://uptizm.com/docs/get-status-pages-statuspage-subscribers.md): List page subscribers. Requires `status_pages:read`. - [POST /status-pages/{statusPage}/subscribers](https://uptizm.com/docs/post-status-pages-statuspage-subscribers.md): Add a page subscriber. Requires `status_pages:write`. - [DELETE /status-pages/{statusPage}/subscribers/{subscriber}](https://uptizm.com/docs/delete-status-pages-statuspage-subscribers-subscriber.md): Remove a page subscriber. Requires `status_pages:write`. ## Maintenance - [GET /scheduled-maintenances](https://uptizm.com/docs/get-scheduled-maintenances.md): List maintenance windows. Requires `maintenance:read`. - [POST /scheduled-maintenances](https://uptizm.com/docs/post-scheduled-maintenances.md): Plan a maintenance window. Requires `maintenance:write`. - [GET /scheduled-maintenances/{maintenance}](https://uptizm.com/docs/get-scheduled-maintenances-maintenance.md): Get a maintenance window. Requires `maintenance:read`. - [PUT /scheduled-maintenances/{maintenance}](https://uptizm.com/docs/put-scheduled-maintenances-maintenance.md): Update a maintenance window. Requires `maintenance:write`. - [DELETE /scheduled-maintenances/{maintenance}](https://uptizm.com/docs/delete-scheduled-maintenances-maintenance.md): Delete a maintenance window. Requires `maintenance:write`. ## Channels - [GET /notification-channels](https://uptizm.com/docs/get-notification-channels.md): List notification channels. Requires `channels:read`. - [POST /notification-channels](https://uptizm.com/docs/post-notification-channels.md): Create a notification channel. Requires `channels:write`. - [GET /notification-channels/{channel}](https://uptizm.com/docs/get-notification-channels-channel.md): Get a notification channel. Requires `channels:read`. - [PUT /notification-channels/{channel}](https://uptizm.com/docs/put-notification-channels-channel.md): Update a notification channel. Requires `channels:write`. - [DELETE /notification-channels/{channel}](https://uptizm.com/docs/delete-notification-channels-channel.md): Delete a notification channel. Requires `channels:write`. - [POST /notification-channels/{channel}/test](https://uptizm.com/docs/post-notification-channels-channel-test.md): Send a test notification. Requires `channels:write`. ## On-call - [GET /on-call/current](https://uptizm.com/docs/get-on-call-current.md): Get who is on call. Requires `oncall:read`. - [GET /on-call/schedules](https://uptizm.com/docs/get-on-call-schedules.md): List on-call schedules. Requires `oncall:read`. - [POST /on-call/schedules](https://uptizm.com/docs/post-on-call-schedules.md): Create an on-call schedule. Requires `oncall:write`. - [GET /on-call/schedules/{schedule}](https://uptizm.com/docs/get-on-call-schedules-schedule.md): Get an on-call schedule. Requires `oncall:read`. - [PUT /on-call/schedules/{schedule}](https://uptizm.com/docs/put-on-call-schedules-schedule.md): Update an on-call schedule. Requires `oncall:write`. - [DELETE /on-call/schedules/{schedule}](https://uptizm.com/docs/delete-on-call-schedules-schedule.md): Delete an on-call schedule. Requires `oncall:write`. - [POST /on-call/schedules/{schedule}/rotations](https://uptizm.com/docs/post-on-call-schedules-schedule-rotations.md): Add a rotation slot. Requires `oncall:write`. - [PATCH /on-call/schedules/{schedule}/rotations/reorder](https://uptizm.com/docs/patch-on-call-schedules-schedule-rotations-reorder.md): Reorder the rotation. Requires `oncall:write`. - [DELETE /on-call/schedules/{schedule}/rotations/{rotation}](https://uptizm.com/docs/delete-on-call-schedules-schedule-rotations-rotation.md): Remove a rotation slot. Requires `oncall:write`. - [POST /on-call/schedules/{schedule}/overrides](https://uptizm.com/docs/post-on-call-schedules-schedule-overrides.md): Add an override. Requires `oncall:write`. - [DELETE /on-call/schedules/{schedule}/overrides/{override}](https://uptizm.com/docs/delete-on-call-schedules-schedule-overrides-override.md): Remove an override. Requires `oncall:write`. ## Escalation - [GET /escalation-policies](https://uptizm.com/docs/get-escalation-policies.md): List escalation policies. Requires `oncall:read`. - [POST /escalation-policies](https://uptizm.com/docs/post-escalation-policies.md): Create an escalation policy. Requires `oncall:write`. - [GET /escalation-policies/{policy}](https://uptizm.com/docs/get-escalation-policies-policy.md): Get an escalation policy. Requires `oncall:read`. - [PUT /escalation-policies/{policy}](https://uptizm.com/docs/put-escalation-policies-policy.md): Update an escalation policy. Requires `oncall:write`. - [DELETE /escalation-policies/{policy}](https://uptizm.com/docs/delete-escalation-policies-policy.md): Delete an escalation policy. Requires `oncall:write`. - [POST /escalation-policies/{policy}/steps](https://uptizm.com/docs/post-escalation-policies-policy-steps.md): Add an escalation step. Requires `oncall:write`. - [PATCH /escalation-policies/{policy}/steps/reorder](https://uptizm.com/docs/patch-escalation-policies-policy-steps-reorder.md): Reorder escalation steps. Requires `oncall:write`. - [DELETE /escalation-policies/{policy}/steps/{step}](https://uptizm.com/docs/delete-escalation-policies-policy-steps-step.md): Remove an escalation step. Requires `oncall:write`. ## Team - [GET /team/members](https://uptizm.com/docs/get-team-members.md): List team members. Requires `team:read`. - [PUT /team/members/{user}](https://uptizm.com/docs/put-team-members-user.md): Change a member's role. Requires `team:manage`. - [DELETE /team/members/{user}](https://uptizm.com/docs/delete-team-members-user.md): Remove a team member. Requires `team:manage`. - [GET /team/invitations](https://uptizm.com/docs/get-team-invitations.md): List pending invitations. Requires `team:read`. - [POST /team/invitations](https://uptizm.com/docs/post-team-invitations.md): Invite a member. Requires `team:manage`. - [DELETE /team/invitations/{invitation}](https://uptizm.com/docs/delete-team-invitations-invitation.md): Cancel an invitation. Requires `team:manage`.