UPuptime
statuspages

GET /api/v1/statuspages/{statuspage_id}/incidents/{pk}/

Changed on

Get a single status page incident or maintenance window

Request

Path parameters

statuspage_idstring required
pkstring required

Response

pkinteger
namestring required

The name of incident, eg. a problem or resolution

descriptionstring
starts_atstring date-time required

When this incident occurred in GMT

ends_atstring date-time nullable
durationstring
include_in_global_metricsboolean
incident_type_displaystring
created_atstring
incident_statestring
incident_type'INCIDENT' | 'SCHEDULED_MAINTENANCE' required
urlstring
update_component_statusboolean
notify_subscribersboolean

Send notifications to subscribers of this Status Page

send_maintenance_start_notificationboolean
resolve_componentsboolean

Resolve all affected components to 'Operational'. Requires 'ends_at' to be set.

Changes

  • e1e4a57a60d8Revision changes
    • breaking

      the response's property format changed from date-time to no format for status

    • info

      added the optional property to the response with the status

    • info

      the response optional property // became read-only for the status

    • info

      the response optional property // became read-only for the status

    • info

      added the optional write-only property notify_subscribers to the response with the status

    • info

      added the optional write-only property resolve_components to the response with the status

    • info

      added the optional write-only property updates/items/notify_subscribers to the response with the status

    • info

      added the optional write-only property updates/items/resolve_components to the response with the status

    • info

      added the optional write-only property updates/items/resolve_incident to the response with the status

    • info

      the response property became required for the status

    • info

      the response property // became required for the status