Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. Monitoring
    1. Get started with monitoring
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  4. On-call scheduling and alerting
    1. Get started with on-call
    2. Sending alerts to Slack ↗
    3. Connecting external calendars
    4. Advanced on-call setup
  5. Incidents
    1. Working with incidents
    2. Create incidents manually
    3. Post mortems
    4. Incident silencing
    5. Incident metadata
  6. Status pages
    1. Get started with status pages
    2. Working with status pages
  7. Integrations
    1. Integrating with Better Stack
  8. Team and account management
    1. Team management
    2. Account settings
    3. Audit logs
    4. Migrating to pay as you go
  9. API
    1. Get started with API
  10. Monitors API
    1. Monitors
    2. Monitor groups
    3. Heartbeats
    4. Heartbeat groups
  11. On-call & Incidents API
    1. On-call calendar
    2. On-call calendar events
    3. Escalation policies
    4. Escalation policy groups
    5. Severities
    6. Severity groups
    7. Incidents
    8. Comments
  12. Integrations API
    1. New Relic Integrations
    2. Datadog Integrations
    3. AWS CloudWatch Integrations
    4. Azure Integrations
    5. Google Monitoring Integrations
    6. Grafana Integrations
    7. Prometheus Integrations
    8. Email integrations
    9. Incoming webhooks
    10. Slack Integrations
    11. Outgoing Webhook integrations
    12. Splunk On-Call integrations
    13. PagerDuty Integrations
  13. Status pages API
    1. Status pages
    2. Status page sections
    3. Status page resources
    4. Status page reports
      1. List existing reports on a status page GET
      2. Get a single status page report GET
      3. Create a new status page report POST
      4. Update an existing status page report PATCH
      5. Delete an existing status page report DELETE
      6. Status page reports API response params
    5. Status page report updates
  14. Other API
    1. Metadata

Create a new status page report

Returns the newly created status page report.

POST https://uptime.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
string

The title of your new status page report.

message
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 email to subscribers of the status page. Default: false

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.

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

starts_at
string

The time when the report comes into effect (formatted in ISO-8601). Default: current time

ends_at
string

The time when the report ends (formatted in ISO-8601). Only required when report_type is set to maintenance.

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

Example cURL

Example
curl --request POST \
  --url https://uptime.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"}]
}'

Example cURL - Creating maintenance

 
curl --request POST \
  --url https://uptime.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 a single status page report

Next article

Update an existing status page report