Explore documentation
  1. Welcome to Incidents 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Slack and other integrations ↗
    3. Tag on-call in Slack
    4. Mobile apps ↗
    5. Connecting external calendars
    6. Advanced guide
  4. Incident management
    1. Get started
    2. Post mortems
    3. Metadata & Catalog
    4. Screening alerts
    5. Reporting ↗
  5. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  6. Status pages
    1. Get started
    2. Advanced guide
  7. Incidents API
    1. Getting an API token
    2. Pagination
    3. Monitors
    4. Heartbeats
    5. On-call & incidents
    6. Status pages
      1. Status pages API
      2. Status page groups
      3. Status page sections
      4. Status page resources
      5. Status page subscribers
      6. Status page reports
        1. List status page reports GET
        2. Get status page report GET
        3. Create status page report POST
        4. Update status page report PATCH
        5. Remove status page report DELETE
      7. Status page report updates
    7. Metadata
    8. Integrations
    9. Team members
    10. Organization roles
    11. Usage
    12. Reporting

Create status page report

Returns the newly created status page report.

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

URL parameters

status_page_id
required string

The ID of your status page

Headers

Authorization
required string

Bearer $TOKEN

Content-Type
string

application/json

Body parameters

title
required string

The title of your new status page report.

message
required string

The first status update message for this report.

report_type
string

The type of the report to be created. Expects either manual or maintenance. Default: manual

notify_subscribers
boolean

Whether or not to send a notification e-mail to subscribers of the status page. Default: true. Subscribers are notified at published_at, or right away for a maintenance, and never for a maintenance whose ends_at has already passed.

affected_resources
array of objects

An array of objects, where each object contains status_page_resource_id and status attributes. status_page_resource_id - The ID of the status page resource which you want to affect. status - Has to be maintenance if report_type is set to maintenance. Otherwise has to be one of resolved, degraded or downtime. Required for a manual report.

published_at
string

The time that will show as the time that the first status update was published at (formatted in ISO 8601). Default: current time. A maintenance publishes its first update at starts_at instead.

starts_at
string

The time a maintenance comes into effect, formatted in ISO 8601. Default: current time. A manual report always starts at published_at, the time of its first status update.

ends_at
string

The time when the report ends (formatted in ISO 8601). Only required when report_type is set to maintenance, and can't be before starts_at.

201

Returns a newly created status page report

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",
        "published_at_timezone": "UTC",
        "notify_subscribers": false,
        "status_report_id": 12345,
        "affected_resources": [
          {
            "status_page_resource_id": "12345",
            "status": "downtime"
          }
        ]
      }
    }
  ]
}

Example cURL

Manual status report Maintenance 
curl --request POST \
  --url https://incidents.betterstack.com/api/v2/status-pages/123456/status-reports \
  --header "Authorization: Bearer $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://incidents.betterstack.com/api/v2/status-pages/123456/status-reports \
  --header "Authorization: Bearer $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"}]
}'


Previous article

Get status page report

Next article

Update status page report