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
  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
  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. Escalation policies
    3. Incidents
  12. Integrations API
    1. Email integrations
    2. Incoming webhooks
  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 (with an associated status update) 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

Update an existing 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 $TEAM_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.

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",
        "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 $TEAM_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{"title": "Updated status report title"}'

Previous article

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

Next article

Delete an existing status page report