Skip to main content
PATCH
Patch incident (title, severity, affected services, visibility, customer targeting)

Authorizations

Authorization
string
header
required

An organization API key (obs_pub_…) sent as Authorization: Bearer <key>. Each key carries scopes; an endpoint lists the scope it needs. read:change_events is reserved: keys can carry it, but no endpoint needs it yet.

Scopes

write:incidents

Path Parameters

id
string<uuid>
required

Incident id.

Body

application/json
title
string
severity
enum<string>
Available options:
minor,
major,
critical
affected_services
string<uuid>[]
visible_to_customer_ids
string<uuid>[]
customer_targeting
object

Affected customers. mode none = public subscribers only; selected = the listed customers; all = every customer. Each customers entry is a customer id (uuid) or the customer's external_id, resolved within your organization; unknown values are rejected with 422 unknown_customers. customers is required (non-empty) for selected and not allowed otherwise. On a customer-scoped update (visible_to_customer_ids set) the targeting must be selected with exactly the visible customers.

postmortem_url
string<uri> | null

Response

ok

id
string<uuid>
required
title
string
required
type
enum<string>
required
Available options:
Incident,
Maintenance
created_at
string<date-time>
required
severity
enum<string> | null
Available options:
minor,
major,
critical,
maintenance,
null
state
enum<string>
Available options:
draft,
published,
resolved,
scheduled,
in_progress,
completed,
canceled
published_at
string<date-time> | null
resolved_at
string<date-time> | null
scheduled_start_at
string<date-time> | null
scheduled_end_at
string<date-time> | null
actual_start_at
string<date-time> | null
actual_end_at
string<date-time> | null
canceled_at
string<date-time> | null
postmortem_url
string<uri> | null
affected_services
object[]
visible_to_customer_ids
string<uuid>[]
customer_targeting
object

Which customers the update affects: mode (none, selected or all), customers (empty unless mode is selected), and whether their linked subscribers are emailed.

messages
object[]

The timeline, oldest first (by date, then id).