Upcheck REST API reference

Every endpoint of the Upcheck REST API: websites, monitors, check history, alert rules, integrations and team, with request and response schemas.

Requests go to https://api.upcheck.so with an organization API key as a bearer token. The guide covers authentication, conventions and errors, and the MCP server exposes the same operations to AI assistants.

Domains

Monitored websites and their check history.

• GET /v1/domains List websites
• POST /v1/domains Add a website
• POST /v1/domains/refresh Refresh every website
• GET /v1/domains/{id} Get a website
• PATCH /v1/domains/{id} Update a website
• DELETE /v1/domains/{id} Remove a website
• POST /v1/domains/{id}/refresh Refresh a website
• GET /v1/domains/{id}/monitors List a website's monitors
• PUT /v1/domains/{id}/keyword Set the keyword check
• DELETE /v1/domains/{id}/keyword Remove the keyword check
• PUT /v1/domains/{id}/content Set the content check
• DELETE /v1/domains/{id}/content Remove the content check
• PUT /v1/domains/{id}/http Set the uptime check's HTTP options
• DELETE /v1/domains/{id}/http Reset the uptime check's HTTP options
• PUT /v1/domains/{id}/port Set the port check
• DELETE /v1/domains/{id}/port Remove the port check
• GET /v1/domains/{id}/history List a website's check history

Alert rules

What to alert on, how often, and where.

• GET /v1/alert-rules List alert rules
• POST /v1/alert-rules Create an alert rule
• GET /v1/alert-rules/{id} Get an alert rule
• PATCH /v1/alert-rules/{id} Update an alert rule
• DELETE /v1/alert-rules/{id} Delete an alert rule

Alert events

Alerts that were delivered.

• GET /v1/alert-events List delivered alerts

Email lists

Named sets of recipients for the email channel.

• GET /v1/email-lists List email lists
• POST /v1/email-lists Create an email list
• GET /v1/email-lists/{id} Get an email list
• PATCH /v1/email-lists/{id} Update an email list
• DELETE /v1/email-lists/{id} Delete an email list

Integrations

Slack, Discord, Teams and webhook destinations.

• GET /v1/integrations List integrations
• POST /v1/integrations Create an integration
• GET /v1/integrations/{id} Get an integration
• PATCH /v1/integrations/{id} Update an integration
• DELETE /v1/integrations/{id} Delete an integration
• POST /v1/integrations/{id}/test Send a test alert

Team

Members and invitations.

• GET /v1/team/members List members and invitations
• POST /v1/team/invitations Invite a member
• PATCH /v1/team/members/{id} Change a member's role
• DELETE /v1/team/members/{id} Remove a member or withdraw an invitation

Organization

The workspace the key belongs to.

• GET /v1/organization Get the organization
• PATCH /v1/organization Rename the organization

Account

Stats, activity, billing and the key itself.

• GET /v1/me Identify the key
• GET /v1/stats Get dashboard stats
• GET /v1/activity List recent activity
• GET /v1/billing Get the billing summary