Explore documentation
  1. Welcome to Uptime 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Sending alerts to Slack ↗
    3. Connecting external calendars
    4. Advanced guide
  4. Incidents
    1. Get started
    2. Advanced guide
  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. Uptime API
    1. Getting an API token
    2. Monitors
    3. Heartbeats
    4. On-call & incidents
    5. Status pages
      1. Status pages API
      2. Status page groups
      3. Status page sections
      4. Status page resources
      5. 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
        6. Response attributes
      6. Status page report updates
    6. Metadata
    7. Integrations

Update status page report

Update an existing status page report. Send only the parameters you wish to change (e.g. title)

PATCH https://uptime.betterstack.com/api/v2/status-pages/{status_page_id}/status-reports/{status_report_id}

URL parameters

status_page_id
required string

The ID of your status page

status_report_id
required string

The ID of your status report

Headers

Authorization
required string

Bearer $TOKEN

Content_Type
string

application/json

Body parameters

title
string

The title of your new status page report.

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.

affected_resources
array of objects

An array of objects, where each object contains status_page_resource_id and status attributes, only possible to change if report_type is set to maintenance. status_page_resource_id - The ID of the status page resource which you want to affect. status - Has to be maintenance.

200

Returns the updated status page report

Response body

{
  "data": {
    "id": "12345",
    "type": "status_report",
    "attributes": {
      "title": "Updated 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

Example
curl --request PATCH \
  --url https://uptime.betterstack.com/api/v2/status-pages/123456/status-reports/12345 \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{"title": "Updated status report title"}'

Previous article

Create status page report

Next article

Remove status page report