Endpoint & Available Methods

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

The Page Object

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

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

List Page

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

Example Request

curl -X GET https://api.sorryapp.com/v1/pages \
  -H "Authorization: Bearer 0526ff9fdbb3ca728daa3d17781eac1a15a1c3f0917abc53394d17ecdc8a8751"

Example Response

{"response":[{"id":"xxxxxx","name":"My Example Status Page","timezone":"UTC","support_email":"support@example.com","support_telephone":"08000 100 200","support_url":"http://example.com/support","visible_to_search":true,"meta_title":"Our status page","meta_description":"Where we keep you up to date with what's going on.","google_analytics_id":"UA-12456","created_at":"2016-02-09 14:39:21 +0000","updated_at":"2016-02-09 14:39:21 +0000"}],"count":1}

Create Page

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

Example Request

curl -X POST https://api.sorryapp.com/v1/pages \
  -d name="My Example Status Page" \
  -H "Authorization: Bearer 0526ff9fdbb3ca728daa3d17781eac1a15a1c3f0917abc53394d17ecdc8a8751"

Example Response

{"response":{"id":"xxxxxx","name":"My Example Status Page","timezone":"UTC","support_email":"support@example.com","support_telephone":"08000 100 200","support_url":"http://example.com/support","visible_to_search":true,"meta_title":"Our status page","meta_description":"Where we keep you up to date with what's going on.","google_analytics_id":"UA-12456","created_at":"2016-02-09 14:39:21 +0000","updated_at":"2016-02-09 14:39:21 +0000"}}

Retrieve Page

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

Example Request

curl -X GET https://api.sorryapp.com/v1/pages/:page_id \
  -H "Authorization: Bearer 0526ff9fdbb3ca728daa3d17781eac1a15a1c3f0917abc53394d17ecdc8a8751"

Example Response

{"response":{"id":"xxxxxx","name":"My Example Status Page","timezone":"UTC","support_email":"support@example.com","support_telephone":"08000 100 200","support_url":"http://example.com/support","visible_to_search":true,"meta_title":"Our status page","meta_description":"Where we keep you up to date with what's going on.","google_analytics_id":"UA-12456","created_at":"2016-02-09 14:39:21 +0000","updated_at":"2016-02-09 14:39:21 +0000"}}

Update Page

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

Example Request

curl -X PATCH https://api.sorryapp.com/v1/pages/:page_id \
  -d name="My Example Status Page" \
  -H "Authorization: Bearer 0526ff9fdbb3ca728daa3d17781eac1a15a1c3f0917abc53394d17ecdc8a8751"

Example Response

{"response":{"id":"xxxxxx","name":"My Example Status Page","timezone":"UTC","support_email":"support@example.com","support_telephone":"08000 100 200","support_url":"http://example.com/support","visible_to_search":true,"meta_title":"Our status page","meta_description":"Where we keep you up to date with what's going on.","google_analytics_id":"UA-12456","created_at":"2016-02-09 14:39:21 +0000","updated_at":"2016-02-09 14:39:21 +0000"}}

Delete Page

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

Example Request

curl -X DELETE https://api.sorryapp.com/v1/pages/:page_id \
  -H "Authorization: Bearer 0526ff9fdbb3ca728daa3d17781eac1a15a1c3f0917abc53394d17ecdc8a8751"