Skip to main content
PUT
Update
🔑 Requires the incident_lifecycles.update scope.

Authorizations

Authorization
string
header
required

API key from your incident.io dashboard (Settings → API keys)

Path Parameters

id
string
required

Unique ID of this incident status

Example:

"01FCNDV6P870EA6S7TK1DSYD5H"

Body

application/json
description
string
required

Rich text description of the incident status

Example:

"Impact has been **fully mitigated**, and we're ready to learn from this incident."

name
string
required

Unique name of this status

Example:

"Closed"

rank
integer<int64>

Where this status sits within its category, lowest rank first. No two statuses in the same category can share a rank, but ranks needn't run consecutively — leaving gaps (10, 20, 30) means you can later insert a status between two others without renumbering them. Omit it to leave this status where it is.

Example:

4

Response

OK response.

incident_status
object
required