statuspages

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

Partially update a single status page incident or maintenance window

Request

Base URL
https://uptime.com (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/uptime/apis/uptime-com-openapi-schema/docs/api/v1/statuspages/:statuspage_id/incidents/:pk/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

statuspage_idstring required

pkstring required

Request body

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.

Response