Sign In

Incidents API

Create, update, and resolve incidents programmatically.

Permissions required: incidents.read, incidents.create, incidents.update, or incidents.delete

The Incident Object

Attributes:

Attribute Type Description
id string Unique identifier with inc_ prefix
object string Always "incident"
title string Incident title
description string Detailed description
status string Status: investigating, identified, monitoring, resolved
severity string Severity: critical, major, minor, maintenance
created integer Unix timestamp of creation
updated integer Unix timestamp of last update
resolved_at integer Unix timestamp of resolution (null if open)
metadata object Custom key-value pairs

List Incidents

Returns a list of incidents.

GET /incidents

Permission: incidents.read

Query Parameters:

Parameter Type Description
limit integer Number of objects (1-100, default 10)
starting_after string Cursor for pagination
ending_before string Cursor for reverse pagination
status string Filter by status
severity string Filter by severity
resolved boolean Filter by resolution status
sort string Sort field (prefix with - for descending)

Request:

Response:

Create Incident

Creates a new incident.

POST /incidents

Permission: incidents.create

Body Parameters:

Parameter Required Type Description
title Yes string Incident title
description No string Detailed description
severity No string Severity level (default: major)
status No string Initial status (default: investigating)
metadata No object Custom key-value pairs

Request:

Response (201 Created):

Get Incident

Retrieves an incident by ID.

GET /incidents/:id

Permission: incidents.read

Request:

Response:

Update Incident

Updates an incident. Only include fields you want to change.

PATCH /incidents/:id

Permission: incidents.update

Body Parameters:

Parameter Type Description
title string Incident title
description string Detailed description
status string Status update
severity string Severity level
metadata object Custom key-value pairs (merged)

Request:

Response:

Resolve Incident

Resolves an open incident.

POST /incidents/:id/resolve

Permission: incidents.update

Body Parameters:

Parameter Required Type Description
resolution_message No string Resolution summary

Request:

Response:

Delete Incident

Permanently deletes an incident.

DELETE /incidents/:id

Permission: incidents.delete

Request:

Response: 204 No Content