---
title: "PATCH /api/v1/statuspages/{statuspage_id}/incidents/{pk}/"
method: PATCH
path: "/api/v1/statuspages/{statuspage_id}/incidents/{pk}/"
tags: ["statuspages"]
---

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

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

## Request

- Base URL: `https://uptime.com` (the document declares no server; this is the origin it was published from)
- URL: `https://uptime.com/api/v1/statuspages/{statuspage_id}/incidents/{pk}/`
- 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)

Partially update a single status page incident or maintenance window

## Path parameters

- `statuspage_id` string, required
- `pk` string, required

## Request body

- Incident
  - `pk` integer
  - `name` string, required: The name of incident, eg. a problem or resolution
  - `description` string
  - `starts_at` string, date-time, required: When this incident occurred in GMT
  - `ends_at` string, date-time, nullable
  - `duration` string
  - `include_in_global_metrics` boolean
  - `incident_type_display` string
  - `updates` object[], required
    - `id` integer
    - `created_at` string, date-time
    - `updated_at` string, date-time, required
    - `description` string
    - `incident_state` 'investigating' | 'identified' | 'monitoring' | 'resolved' | 'notification' | 'maintenance', required
    - `incident_state_display` string
    - `notify_subscribers` boolean: Send notifications to subscribers of this Status Page
    - `resolve_components` boolean: Resolve all affected components to 'Operational'. Requires 'ends_at' to be set on the parent Incident.
    - `resolve_incident` boolean: Resolve the parent Incident.
  - `affected_components` object[], nullable
    - `id` integer
    - `status` 'major-outage' | 'partial-outage' | 'degraded-performance' | 'under-maintenance', required
    - `name` string
    - `description` string
    - `component` object, required
      - `id` integer, required
      - `name` string
  - `created_at` string
  - `incident_state` string
  - `incident_type` 'INCIDENT' | 'SCHEDULED_MAINTENANCE', required
  - `url` string
  - `update_component_status` boolean
  - `notify_subscribers` boolean: Send notifications to subscribers of this Status Page
  - `send_maintenance_start_notification` boolean
  - `resolve_components` boolean: Resolve all affected components to 'Operational'. Requires 'ends_at' to be set.

## Response `200`

- Incident
  - `pk` integer
  - `name` string, required: The name of incident, eg. a problem or resolution
  - `description` string
  - `starts_at` string, date-time, required: When this incident occurred in GMT
  - `ends_at` string, date-time, nullable
  - `duration` string
  - `include_in_global_metrics` boolean
  - `incident_type_display` string
  - `updates` object[], required
    - `id` integer
    - `created_at` string, date-time
    - `updated_at` string, date-time, required
    - `description` string
    - `incident_state` 'investigating' | 'identified' | 'monitoring' | 'resolved' | 'notification' | 'maintenance', required
    - `incident_state_display` string
    - `notify_subscribers` boolean: Send notifications to subscribers of this Status Page
    - `resolve_components` boolean: Resolve all affected components to 'Operational'. Requires 'ends_at' to be set on the parent Incident.
    - `resolve_incident` boolean: Resolve the parent Incident.
  - `affected_components` object[], nullable
    - `id` integer
    - `status` 'major-outage' | 'partial-outage' | 'degraded-performance' | 'under-maintenance', required
    - `name` string
    - `description` string
    - `component` object, required
      - `id` integer, required
      - `name` string
  - `created_at` string
  - `incident_state` string
  - `incident_type` 'INCIDENT' | 'SCHEDULED_MAINTENANCE', required
  - `url` string
  - `update_component_status` boolean
  - `notify_subscribers` boolean: Send notifications to subscribers of this Status Page
  - `send_maintenance_start_notification` boolean
  - `resolve_components` boolean: Resolve all affected components to 'Operational'. Requires 'ends_at' to be set.

---

[API](https://skmtc.dev/uptime/apis/uptime-com-openapi-schema.md) - [All operations](https://skmtc.dev/uptime/apis/uptime-com-openapi-schema/llms.txt) - [OpenAPI document](https://skmtc.dev/uptime/apis/uptime-com-openapi-schema/revisions/e1e4a57a60d8?raw)