API endpoints

The Upty API exposes 78 operations under https://upty.io. Authenticated operations accept an API key or a signed-in session unless noted otherwise. Workspace membership operations require a signed-in session. Read-only keys are limited to read operations; a write key does not bypass plan limits, ownership or other operation-specific restrictions.

Public operations do not require an API key; individual endpoints may have additional requirements. For parameters, request bodies, responses and examples, open the operation or browse the full API reference.

Monitors

Endpoint	What it does	Access
`GET /api/regions`	Regions	Read or write key
`GET /api/monitors/groups`	List Groups	Read or write key
`GET /api/monitors`	List Monitors	Read or write key
`POST /api/monitors`	Create Monitor	Write key
`GET /api/monitors/{monitor_id}`	Get Monitor	Read or write key
`PUT /api/monitors/{monitor_id}`	Update Monitor	Write key
`DELETE /api/monitors/{monitor_id}`	Delete Monitor	Write key
`GET /api/monitors/{monitor_id}/stats`	Monitor Stats	Read or write key
`GET /api/monitors/{monitor_id}/details`	Monitor Details	Read or write key
`POST /api/monitors/{monitor_id}/clone`	Clone Monitor	Write key
`POST /api/monitors/import`	Import Monitors	Write key
`PUT /api/monitors/{monitor_id}/paused`	Set Paused	Write key
`POST /api/monitors/{monitor_id}/ack`	Ack	Write key
`DELETE /api/monitors/{monitor_id}/ack`	Unack	Write key
`PUT /api/monitors/{monitor_id}/group`	Move Monitor	Write key
`POST /api/monitors/bulk`	Bulk	Write key
`GET /api/monitors/{monitor_id}/heartbeat`	Heartbeat Info	Read or write key

Maintenance

Endpoint	What it does	Access
`GET /api/maintenance`	List Windows	Read or write key
`POST /api/maintenance`	Create Window	Write key
`PUT /api/maintenance/{window_id}`	Update Window	Write key
`DELETE /api/maintenance/{window_id}`	Delete Window	Write key

Channels

Endpoint	What it does	Access
`GET /api/channels/types`	Types	Read or write key
`GET /api/channels`	List Channels	Read or write key
`POST /api/channels`	Create Channel	Write key
`PATCH /api/channels/{channel_id}`	Patch Channel	Write key
`DELETE /api/channels/{channel_id}`	Delete Channel	Write key
`POST /api/channels/{channel_id}/test`	Test Channel	Write key

Status page

Endpoint	What it does	Access
`GET /api/status-page`	Get Status Page	Read or write key
`PUT /api/status-page`	Put Status Page	Write key
`DELETE /api/status-page`	Delete Status Page	Write key
`POST /api/status-page/regenerate-address`	Regenerate Address	Write key
`POST /api/status-page/password`	Set Page Password	Write key
`DELETE /api/status-page/password`	Remove Page Password	Write key
`GET /api/status-page/announcements`	List Announcements	Read or write key
`POST /api/status-page/announcements`	Create Announcement	Write key
`PATCH /api/status-page/announcements/{ann_id}`	Update Announcement	Write key
`DELETE /api/status-page/announcements/{ann_id}`	Delete Announcement	Write key
`GET /api/status-page/subscribers`	List Subscribers	Read or write key
`DELETE /api/status-page/subscribers/{sub_id}`	Delete Subscriber	Write key
`GET /api/status-page/domain`	Get Domain	Read or write key
`PUT /api/status-page/domain`	Put Domain	Write key
`DELETE /api/status-page/domain`	Delete Domain	Write key
`POST /api/status-page/domain/verify`	Verify Domain	Write key
`GET /api/status-page/incidents`	List Incidents	Read or write key
`POST /api/status-page/incidents`	Create Incident	Write key
`POST /api/status-page/incidents/{inc_id}/updates`	Add Update	Write key
`PATCH /api/status-page/incidents/{inc_id}`	Update Incident	Write key
`DELETE /api/status-page/incidents/{inc_id}`	Delete Incident	Write key

Notifications

Endpoint	What it does	Access
`GET /api/notifications`	Get Notifications	Read or write key

Reports

Endpoint	What it does	Access
`GET /api/reports/weekly`	Weekly Preview	Read or write key
`GET /api/reports/uptime`	Uptime Report	Read or write key
`GET /api/reports/uptime.csv`	Uptime Csv	Read or write key

Account

Endpoint	What it does	Access
`GET /api/me`	Me	Read or write key

Public

Endpoint	What it does	Access
`GET /api/healthz`	Healthz	Public
`GET /api/version`	Version	Public
`POST /api/public/status/{slug}/subscribe`	Subscribe	Public; see details
`GET /api/public/status/subscribe/confirm`	Confirm Subscription	Public; see details
`GET /api/public/status/unsubscribe`	Unsubscribe	Public; see details
`POST /api/public/status/{slug}/unlock`	Unlock	Public; see details
`GET /api/public/status/{slug}`	Public Status	Public; see details

Other

Endpoint	What it does	Access
`GET /api/status-pages`	List Status Pages	Read or write key
`POST /api/status-pages`	Create Status Page	Write key
`GET /api/groups`	List Groups	Read or write key
`POST /api/groups`	Create Group	Write key
`PATCH /api/groups/{group_id}`	Rename Group	Write key
`DELETE /api/groups/{group_id}`	Delete Group	Write key
`HEAD /media/blog/{image_id}.{extension}`	Public Image	Public; see details
`GET /media/blog/{image_id}.{extension}`	Public Image	Public; see details
`GET /api/monitor-templates`	List Templates	Read or write key
`POST /api/monitor-templates`	Create Template	Write key
`GET /api/monitor-templates/{template_id}`	Get Template	Read or write key
`PATCH /api/monitor-templates/{template_id}`	Rename Template	Write key
`DELETE /api/monitor-templates/{template_id}`	Delete Template	Write key
`GET /api/workspace/roles`	Roles	Signed-in session
`GET /api/workspace/members`	Members	Signed-in session
`POST /api/workspace/members`	Add Member	Signed-in session
`PATCH /api/workspace/members/{member_id}`	Change Member	Signed-in session
`DELETE /api/workspace/members/{member_id}`	Remove Member	Signed-in session

MonitorsCopy Anchor Link

MaintenanceCopy Anchor Link

ChannelsCopy Anchor Link

Status pageCopy Anchor Link

NotificationsCopy Anchor Link

ReportsCopy Anchor Link

AccountCopy Anchor Link

PublicCopy Anchor Link

OtherCopy Anchor Link

On this page