API endpoints

Every endpoint of the UptimeTea REST API, with headers, response bodies and examples in six languages. New here? Start with the introduction: base URL, authentication and errors.

Authentication

• POST Login /auth/login
• GET Get Profile /auth/profile
• POST Register /auth/register
• GET Check token /auth/login
• GET Logout /auth/logout
• POST Request password reset /auth/password/remind
• POST Reset password /auth/password/change
• POST Confirm email /auth/confirm
• POST Resend confirmation email /auth/confirm/resend

Account

• GET Get account /user
• PATCH Update account /user
• DELETE Delete account /user
• GET Confirm email change /confirm-email-change/:token
• PATCH Change password /password
• GET Get alert preferences /notification_preference
• PATCH Update alert preferences /notification_preference
• GET Export your data /export
• GET List MCP tokens /tokens/mcp
• POST Create MCP token /tokens/mcp
• DELETE Revoke MCP token /tokens/mcp/:id

Dashboard

• GET Get dashboard stats /dashboard/stats

Watchers

• GET List watchers /watchers
• GET Get watcher /watchers/:id
• POST Create watcher /watchers
• PATCH Update watcher /watchers/:id
• DELETE Delete watcher /watchers/:id
• POST Protect a whole site /watchers/bundle

Incidents

• GET List incidents /incidents
• GET Get incident /incidents/:id
• PATCH Update incident status /incidents/:id
• POST Create incident /incidents
• DELETE Delete incident /incidents/:id

Incident Comments

• GET List incident comments /incidents/:incident_id/comments
• POST Create incident comment /incidents/:incident_id/comments
• DELETE Delete incident comment /incidents/:incident_id/comments/:id

Postmortems

• GET Get postmortem /incidents/:incident_id/postmortem
• PATCH Update postmortem /incidents/:incident_id/postmortem
• POST Create action item /incidents/:incident_id/postmortem/action_items
• PATCH Update action item /incidents/:incident_id/postmortem/action_items/:id
• DELETE Delete action item /incidents/:incident_id/postmortem/action_items/:id

Maintenance Windows

• GET List maintenance windows /maintenance_windows
• POST Create maintenance window /maintenance_windows
• DELETE Delete maintenance window /maintenance_windows/:id
• GET Get maintenance window /maintenance_windows/:id
• PATCH Update maintenance window /maintenance_windows/:id

Status Pages

• GET List status pages /status_pages
• POST Create status page /status_pages
• GET Get status page /status_pages/:id
• PATCH Update status page /status_pages/:id
• DELETE Delete status page /status_pages/:id

Notifications

• GET List notifications /notifications
• GET Get notification /notifications/:id
• POST Create notification /notifications
• PATCH Mark notification as read /notifications/:id
• DELETE Delete notification /notifications/:id

Webhooks

• GET List webhooks /webhooks
• GET Get webhook /webhooks/:id
• POST Create webhook /webhooks
• PATCH Update webhook /webhooks/:id
• DELETE Delete webhook /webhooks/:id
• GET List webhook deliveries /webhooks/:id/deliveries
• POST Send test event /webhooks/:id/test

On-call Schedules

• GET List on-call schedules /on_call_schedules
• GET Get on-call schedule /on_call_schedules/:id
• POST Create on-call schedule /on_call_schedules
• PATCH Update on-call schedule /on_call_schedules/:id
• DELETE Delete on-call schedule /on_call_schedules/:id
• GET Get who is on call /on_call_schedules/:id/current
• POST Add participant /on_call_schedules/:on_call_schedule_id/participants
• PATCH Move participant /on_call_schedules/:on_call_schedule_id/participants/:id
• DELETE Remove participant /on_call_schedules/:on_call_schedule_id/participants/:id

Escalation Policies

• GET List escalation policies /escalation_policies
• GET Get escalation policy /escalation_policies/:id
• POST Create escalation policy /escalation_policies
• PATCH Update escalation policy /escalation_policies/:id
• DELETE Delete escalation policy /escalation_policies/:id
• POST Add escalation level /escalation_policies/:escalation_policy_id/rules
• PATCH Update escalation level /escalation_policies/:escalation_policy_id/rules/:id
• DELETE Remove escalation level /escalation_policies/:escalation_policy_id/rules/:id

Team

• GET Get team /team
• PATCH Rename team /team
• GET List members /team/members
• GET List removed members /team/members/archived
• PATCH Change member role /team/members/:id
• DELETE Remove member /team/members/:id
• GET List invitations /team/invitations
• POST Invite member /team/invitations
• DELETE Revoke invitation /team/invitations/:id
• DELETE Leave team /team/membership
• GET Get invitation /team/invitations/:token
• POST Accept invitation /team/invitations/:token/accept

Billing

• GET Get billing /billing
• POST Start checkout /billing/checkout
• POST Cancel subscription /billing/cancel

Public Endpoints

• GET Get public status page /status/:slug
• POST Report cron/heartbeat status /callbacks/:callback_token
• GET Get status page by domain /status
• GET Get status widget /status/:slug/widget
• GET Resolve custom domain /domain-resolver
• GET Database health /health/db
• GET Checker health /health/sidekiq
• GET API version /version