Status Pages

From here you're able to create, update and delete Status Pages from your account. This is also the place to control basic settings like timezone, support links and language.

Endpoint

https://api.sorryapp.com/v1/pages/:page_id

Objects

These are the attributes which represent the object, most of which can be posted too and received in response to the available methods.

Properties

Name
id
Description
The unique identifier for the page.
Name
name
Description
The name used within the UI to distinguish your page.
Name
timezone
Description
The timezone used to display datetimes on the status page.
Name
support_email
Description
The email address your audience should use.
Name
support_telephone
Description
The telephone number your audience should use to contact you.
Name
support_url
Description
The URL of the helpdesk your audience should use.
Name
visible_to_search
Description
Boolean, used to control robots.txt and meta robots tag.
Name
meta_title
Description
Optional meta title used for search engines.
Name
meta_description
Description
Optional meta description used for search engines.
Name
google_analytics_id
Description
Your Google UA identity, used for adding tracking code to your page.
Name
locale
Description
Two-Letter ISO 639-1 locale for the page. i.e. 'en', 'fr'
Name
created_at
Description
The date/time the record was created.
Name
updated_at
Description
The date/time the record was last updated.
Name
include
Description
brand, components, custom_domain, notices, subscribers, theme

GET/v1/pages

List pages

This endpoint displays a list of all status pages within the account.

Request

GET

/v1/pages

curl -X GET https://api.sorryapp.com/v1/pages \
-H "Authorization: Bearer {token}"

Response

{
"response": [
    {
        "id": "12ab34cd",
        "state": "operational",
        "name": "Acme",
        "timezone": "UTC",
        "support_email": "help@acme.com",
        "support_telephone": null,
        "support_url": "https://help.acme.com,
        "visible_to_search": true,
        "locale": "en",
        ...
    }
],
"count": 1
}

POST/v1/pages

Create a page

This endpoint allows you to create a new status page.

Required attributes

Name
name
Type
string
Description
The name of the status page

Request

POST

/v1/pages

curl -X POST https://api.sorryapp.com/v1/pages \
  -d name="Acme" \
  -H "Authorization: Bearer {token}"

Response

{
"response": {
    "id": "12ab34cd",
    "state": "operational",
    "name": "Acme",
    "timezone": "UTC",
    "support_email": null,
    "support_telephone": null,
    "support_url": null,
    "visible_to_search": false,
    "meta_title": null,
    "meta_description": null,
    "google_analytics_id": null,
    "timeline_threshold": 604800,
    "timeline_threshold_in_days": 7,
    "timeline_sort_order": "asc",
    "locale": "en",
    "created_at": "2025-01-21T13:37:16.926Z",
    "updated_at": "2025-01-21T13:37:17.058Z",
    "endpoint": "12ab34cd.sorryapp.com",
    "send_notifications_by_email": true,
    "send_notifications_by_sms": false,
    "send_notifications_by_slack": true,
    "send_notifications_by_microsoft_teams": true,
    "send_notifications_by_twitter": false
  }
}

GET/v1/pages/:page_id

Retrieve a page

This endpoint retrieves a single page using the id of the page, which can be found either in the GET pages method or via the management UI.

Request

GET

/v1/pages/:page_id

curl -X GET https://api.sorryapp.com/v1/pages/12ab34cd \
-H "Authorization: Bearer {token}"

Response

{
"response": {
    "id": "12ab34cd",
    "state": "operational",
    "name": "Acme",
    "timezone": "UTC",
    "support_email": null,
    "support_telephone": null,
    "support_url": null,
    "visible_to_search": false,
    "meta_title": null,
    "meta_description": null,
    "google_analytics_id": null,
    "timeline_threshold": 604800,
    "timeline_threshold_in_days": 7,
    "timeline_sort_order": "asc",
    "locale": "en",
    "created_at": "2025-01-21T13:37:16.926Z",
    "updated_at": "2025-01-21T13:37:17.058Z",
    "endpoint": "12ab34cd.sorryapp.com",
    "send_notifications_by_email": true,
    "send_notifications_by_sms": false,
    "send_notifications_by_slack": true,
    "send_notifications_by_microsoft_teams": true,
    "send_notifications_by_twitter": false
}
}

PATCH/v1/pages/:page_id

Update a page

This endpoint allows you to update the status page, such as name, timezone, support email etc.

Request

PATCH

/v1/pages/12ab34cd

curl -X PATCH https://api.sorryapp.com/v1/pages/12ab34cd \
-d support_email="support@acme.com" \
-H "Authorization: Bearer {token}"

Response

{
"response": {
    "id": "12ab34cd",
    "state": "operational",
    "name": "Acme",
    "timezone": "UTC",
    "support_email": "support@acme.com",
    ...
}
}

DELETE/v1/pages/:page_id

Delete a page

This endpoint allows you to delete the status page, including all notices, components and subscribers.

Request

DELETE

/v1/pages/12ab34cd

curl -X DELETE https://api.sorryapp.com/v1/pages/12ab34cd \
-H "Authorization: Bearer {token}"