Links

Status Page Reports API

Manage your status page reports and scheduled maintenances using a simple HTTP API.
Do you need help with the integration?
Let us know at [email protected]

Obtaining an API token

get
https://betteruptime.com
/api/v2/status-pages/:status_page_id/status-reports
Listing existing reports on a status page
Example cURL
curl --request GET \
--url https://betteruptime.com/api/v2/status-pages/123456/status-reports \
--header 'Authorization: Bearer YOUR_API_TOKEN'
get
https://betteruptime.com
/api/v2/status-pages/:status_page_id/status-reports/:status_report_id
Getting a single status page report
Example cURL
curl --request GET \
--url https://betteruptime.com/api/v2/status-pages/123456/status-reports/12345 \
--header 'Authorization: Bearer YOUR_API_TOKEN'
post
https://betteruptime.com
/api/v2/status-pages/:status_page_id/status-reports
Creating a new status page report (with an associated status update)
Example cURL
Example: creating maintenance
curl --request POST \
--url https://betteruptime.com/api/v2/status-pages/123456/status-reports \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"title": "Status report title",
"message": "Status update message",
"report_type": "manual",
"affected_resources": [{"status_page_resource_id": "12345", "status": "downtime"}]
}'
curl --request POST \
--url https://betteruptime.com/api/v2/status-pages/123456/status-reports \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"title": "Maintenance title",
"message": "Maintenance message",
"report_type": "maintenance",
"affected_resources": [{"status_page_resource_id": "12345", "status": "maintenance"}]
}'
patch
https://betteruptime.com
/api/v2/status-pages/:status_page_id/status-reports/status_report_id
Updating an existing status page report
Example cURL
curl --request PATCH \
--url https://betteruptime.com/api/v2/status-pages/123456/status-reports/12345 \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{"title": "Updated status report title"}'
delete
https://betteruptime.com
/api/v2/status-pages/:status_page_id/status-reports/status_report_id
Deleting an existing status page report
Example cURL
curl --request DELETE \
--url https://betteruptime.com/api/v2/status-pages/123456/status-reports/12345 \
--header 'Authorization: Bearer YOUR_API_TOKEN'