You are viewing v4 of the Coralogix API. v5 is the current version. Go to the v5 reference

List incidents with filters

POSThttps://api.coralogix.com/mgmt/openapi/4/incidents/incidents/v1

Lists all available incidents based on specified filters and order. The list is ordered in an unspecified direction and sorted by creation time.

Requires the following permissions:

• incidents:read

Authorizations

Authorizationstringheaderrequired

API key authentication

The value is a Coralogix API key. Create a personal or team API key and assign its permissions.

Request

Body

application/json

Request to list incidents with filtering, pagination and ordering options

filter# object
Filter configuration for incidents
orderBys#object[]oneOf

• Option 1
• Option 2

orderBys.direction#v1.OrderByDirectionrequired

Possible values: [ORDER_BY_DIRECTION_UNSPECIFIED, ORDER_BY_DIRECTION_ASC, ORDER_BY_DIRECTION_DESC]

orderBys.incidentField#IncidentFields

Possible values: [INCIDENTS_FIELDS_UNSPECIFIED, INCIDENTS_FIELDS_ID, INCIDENTS_FIELDS_SEVERITY, INCIDENTS_FIELDS_NAME, INCIDENTS_FIELDS_CREATED_TIME, INCIDENTS_FIELDS_CLOSED_TIME, INCIDENTS_FIELDS_STATE, INCIDENTS_FIELDS_STATUS, INCIDENTS_FIELDS_LAST_STATE_UPDATE_TIME, INCIDENTS_FIELDS_APPLICATION_NAME, INCIDENTS_FIELDS_SUBSYSTEM_NAME, INCIDENTS_FIELDS_DURATION]

pagination# object
Pagination parameters for list requests

Response

200400401500application/json

Response containing a list of incidents and pagination information

incidents# object[]required
pagination# objectrequired
Pagination information for list responses