sorryapp_list_pages
List status pages
List the status pages the API token's user can access: id, name, state (operational/degraded/...), timezone, locale, support contacts, notification channels. The id is the page_id every other tool takes. Sorry: GET /v1/pages.
Takes no parameters.
sorryapp_get_page
Get status page
Get one status page, optionally with related resources embedded (brand, components, custom_domain, notices, notices.updates, theme). Sorry: GET /v1/pages/{page_id}?include=...
Parametersincludepage_idrequired
sorryapp_list_components
List components
List a status page's components (the parts of your service shown on the page): id, name, description, state (operational/degraded/partially-degraded), position, parent_id. Sorry: GET /v1/pages/{page_id}/components.
Parameterspage_idrequired
sorryapp_get_component
Get component
Get one component of a status page. Sorry: GET /v1/pages/{page_id}/components/{component_id}.
Parameterspage_idrequiredcomponent_idrequired
sorryapp_list_notices
List notices
List a status page's notices (incidents = type unplanned, maintenance = type planned): id, type, state, timeline_state, subject, synopsis, began/ended times, public link. Optional filters and embedded updates/components. Sorry: GET /v1/pages/{page_id}/notices.
Parameterspagetypestateincludepage_idrequiredcreated_aftersubject_contains
sorryapp_get_notice
Get notice
Get one notice (incident or maintenance) with its state, times and public link. Sorry: GET /v1/pages/{page_id}/notices/{notice_id}.
Parametersincludepage_idrequirednotice_idrequired
sorryapp_list_notice_updates
List notice updates
List the updates (timeline comments) of one notice: id, content, should_publish, public link, times. Sorry: GET /v1/pages/{page_id}/notices/{notice_id}/updates.
Parameterspage_idrequirednotice_idrequired
sorryapp_get_notice_update
Get notice update
Get one update of a notice. Sorry: GET /v1/pages/{page_id}/notices/{notice_id}/updates/{update_id}.
Parameterspage_idrequirednotice_idrequiredupdate_idrequired
sorryapp_list_notice_templates
List notice templates
List the page's notice templates (reusable subject + opening comment for new incidents or maintenance): id, name, subject, initial_comment, optional component_id. Returns the vendor-default template page; paging controls are withheld pending a verified request contract. Sorry: GET /v1/pages/{page_id}/notice_templates.
Parameterspage_idrequiredname_containscomponent_name_contains
sorryapp_list_update_templates
List update templates
List the page's update templates (reusable text for one notice update): id, name, content, optional component_id. Returns the vendor-default template page; paging controls are withheld pending a verified request contract. Sorry: GET /v1/pages/{page_id}/update_templates.
Parameterspage_idrequiredname_containscomponent_name_contains
sorryapp_list_subscribers
List subscribers
List a status page's subscribers (people and channels notified of notices): id, email, phone number, name, company, tags, created time. Webhook URLs of Slack/Teams subscribers are redacted. Contains personal data. Sorry: GET /v1/pages/{page_id}/subscribers.
Parameterspageincludepage_idrequiredper_pagecomponent_id
sorryapp_get_subscriber
Get subscriber
Get one subscriber of a status page (personal data; webhook URLs redacted). Sorry: GET /v1/pages/{page_id}/subscribers/{subscriber_id}.
Parameterspage_idrequiredsubscriber_idrequired
sorryapp_list_timezones
List timezones
List the timezone names Sorry accepts for a status page (name and GMT offset label). Sorry: GET /v1/timezones.
Takes no parameters.
sorryapp_create_component
Create component
WRITE: add a component to a status page. It appears on the PUBLIC status page immediately, as operational. Sorry: POST /v1/pages/{page_id}/components.
Parametersnamerequiredconfirmrequiredpage_idrequireddescription
sorryapp_update_component
Update component
WRITE: rename a component or change its description on the PUBLIC status page (overwrites the previous value). It cannot change the component's state: state follows open notices (use the notice tools). Sorry: PATCH /v1/pages/{page_id}/components/{component_id}.
Parametersnameconfirmrequiredpage_idrequireddescriptioncomponent_idrequired
sorryapp_create_incident
Create incident notice
WRITE: open an incident (an unplanned notice) on the status page. These changes are PUBLIC on the status page, including publish=false. publish=true additionally requests delivery to subscribers and integrations (email, SMS, Slack, Teams, X); vendor SMS/notification charges may apply. Confirm the content and audience first. It marks the listed components degraded on the PUBLIC page. Starts in the investigating state. Sorry: POST /v1/pages/{page_id}/notices with type=unplanned.
Parametersconfirmrequiredpage_idrequiredpublishsubjectrequiredcomponent_idsinitial_comment
sorryapp_create_maintenance
Create maintenance notice
WRITE: schedule maintenance (a planned notice) on the status page. These changes are PUBLIC on the status page, including publish=false. publish=true additionally requests delivery to subscribers and integrations (email, SMS, Slack, Teams, X); vendor SMS/notification charges may apply. Confirm the content and audience first. Sorry: POST /v1/pages/{page_id}/notices with type=planned.
Parametersconfirmrequiredpage_idrequiredpublishsubjectrequiredcomponent_idsbegins_at_datebegins_at_timeinitial_commentduration_in_minutesshould_automate_schedule
sorryapp_update_notice
Update notice
WRITE: change a notice: its subject, state (for example resolved), affected components, schedule, and/or add a comment (an update) to its timeline. These changes are PUBLIC on the status page, including publish=false. publish=true additionally requests delivery to subscribers and integrations (email, SMS, Slack, Teams, X); vendor SMS/notification charges may apply. Confirm the content and audience first. Fields you pass overwrite the previous values. Sorry: PATCH /v1/pages/{page_id}/notices/{notice_id}.
Parametersstateconfirmrequiredpage_idrequiredpublishsubjectnotice_idrequiredcomponent_idsbegins_at_datebegins_at_timeadditional_commentduration_in_minutes
sorryapp_create_notice_update
Add notice update
WRITE: add one update (a comment) to a notice's timeline. It is PUBLIC on the status page, and Sorry's docs say a new update is also published to the page's configured integrations (email, SMS, Slack, Teams, X). The docs list no switch to suppress that on this endpoint, so confirm_publish=true is required; this endpoint has no exposed suppression switch. Sorry: POST /v1/pages/{page_id}/notices/{notice_id}/updates.
Parameterscontentrequiredpage_idrequirednotice_idrequiredconfirm_publishrequired
sorryapp_edit_notice_update
Edit notice update
WRITE: rewrite the text of an existing notice update on the PUBLIC status page (overwrites the previous text; the old text is not kept). Sorry: PATCH /v1/pages/{page_id}/notices/{notice_id}/updates/{update_id}.
Parametersconfirmrequiredcontentrequiredpage_idrequirednotice_idrequiredupdate_idrequired
sorryapp_create_subscriber
Add one subscriber
WRITE: add ONE subscriber (an email address and/or a phone number) to a status page. From then on that person is emailed/texted about notices published on the page, and Sorry may send them a confirmation. Add only people who asked to be notified. No bulk import. Sorry: POST /v1/pages/{page_id}/subscribers.
Parametersemailconfirmrequiredpage_idrequiredphone_numbercomponent_ids