Create a new status page report (with an associated status update)

Returns the newly created status page report.

POST https://betteruptime.com/api/v2/status-pages/{status_page_id}/status-reports

URL parameters

status_page_id
required string

Headers

Authorization
required string
Content_Type
string

Body parameters

title
string
message
string
report_type
string
affected_resources
array of objects
published_at
string
starts_at
string
ends_at
string
201

Response body

{
  "data": {
    "id": "12345",
    "type": "status_report",
    "attributes": {
      "title": "Status report title",
      "report_type": "manual",
      "starts_at": "2021-12-17T11:00:00.000Z",
      "ends_at": null,
      "status_page_id": 123456,
      "affected_resources": [
        {
          "status_page_resource_id": "12345",
          "status": "downtime"
        }
      ],
      "aggregate_state": "downtime"
    },
    "relationships": {
      "status_updates": {
        "data": [
          {
            "id": "12345",
            "type": "status_update"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "12345",
      "type": "status_update",
      "attributes": {
        "message": "Status update message",
        "published_at": "2021-12-17T11:00:00.000Z",
        "status_report_id": 12345,
        "affected_resources": [
          {
            "status_page_resource_id": "12345",
            "status": "downtime"
          }
        ]
      }
    }
  ]
}

Example cURL

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"}]
}'
Copied!

Example cURL - 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": "Maintenance title",
    "message": "Maintenance message",
    "report_type": "maintenance",
    "affected_resources": [{"status_page_resource_id": "12345", "status": "maintenance"}]
}'
Copied!