GEgetorchestra
Incidents

List incidents

Changed on

List incidents for the workspace the credential resolves to, most severe first, with merged children nested under their parent.

Filters apply to top-level incidents only - a child is always returned alongside its parent, so a filtered list still shows the full incident rather than part of one. Use name to filter incidents by a case-insensitive substring match on the incident name. Use sort_column and sort_direction to sort top-level incidents by a single column instead; merged children keep the default order.

get/incidents

Request

  • Base URL
    https://app.getorchestra.io/api/engine/public
  • URL
    https://app.getorchestra.io/api/engine/public/incidents
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getorchestra.io/oauth/authorize
      Token URL: https://app.getorchestra.io/oauth/token scopes: orchestra:read

Query parameters

page_sizeinteger

Number of items per page. Defaults to 10; maximum 100.

pageinteger

Page number. Must be greater than or equal to 1.

statusstring

Filter by status. Comma-separated values are supported.

severitystring

Filter by severity. Comma-separated values are supported.

include_archivedboolean

Include archived incidents. Defaults to false.

namestring nullable

Filter by a case-insensitive substring match on the incident name.

created_beforestring date-time nullable

Only incidents created before this time, as an ISO 8601 timestamp with a timezone.

sort_column'severity' | 'name' | 'created_at' | 'updated_at' nullable

Column used to sort incidents. Defaults to open, most severe first.

sort_direction'asc' | 'desc'

Sort direction. Ignored unless sort_column is set.

Headers

X-Orchestra-Account-Idstring uuid4 nullable

Act on this account rather than the one the credential resolves to. Omit it to use the credential's own account. An API key is issued to a single account, so it may only name that account; an OAuth token may name any account its grant covers.

Response

Successful Response

pageinteger required
pageSizeinteger required
totalinteger required

Changes