Skip to main content
List incidents with filters
curl --request POST \
  --url https://api.coralogix.com/mgmt/openapi/5/incidents/incidents/v1 \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter": {
    "applicationName": [
      "<string>"
    ],
    "assignee": [
      "<string>"
    ],
    "contextualLabels": {},
    "displayLabels": {},
    "endTime": "2023-11-07T05:31:56Z",
    "isMuted": true,
    "metaLabels": [
      {
        "key": "key",
        "value": "value"
      }
    ],
    "metaLabelsOp": "FILTER_OPERATOR_OR_OR_UNSPECIFIED",
    "searchQuery": {
      "contextualLabel": "<string>",
      "query": "error"
    },
    "severity": [
      "INCIDENT_SEVERITY_UNSPECIFIED"
    ],
    "startTime": "2023-11-07T05:31:56Z",
    "state": [
      "INCIDENT_STATE_UNSPECIFIED"
    ],
    "status": [
      "INCIDENT_STATUS_UNSPECIFIED"
    ],
    "subsystemName": [
      "<string>"
    ]
  },
  "orderBys": [
    {
      "direction": "ORDER_BY_DIRECTION_UNSPECIFIED",
      "incidentField": "INCIDENTS_FIELDS_UNSPECIFIED"
    }
  ]
}
'
{
  "incidents": [
    {
      "assignments": [
        {
          "assignedBy": {
            "userId": "user_id"
          },
          "assignedTo": {
            "userId": "user_id"
          }
        }
      ],
      "contextualLabels": {},
      "createdAt": "2024-01-01T00:00:00.000Z",
      "displayLabels": {},
      "duration": "<string>",
      "events": [
        {
          "administrativeEvent": {
            "userId": "<string>"
          },
          "id": "incident_event_id",
          "incidentEventType": "INCIDENT_EVENT_TYPE_UNSPECIFIED",
          "originatorType": "ORIGINATOR_TYPE_UNSPECIFIED",
          "unassign": {}
        }
      ],
      "id": "incident_id",
      "lastStateUpdateKey": "last_state_update_key",
      "lastStateUpdateTime": "2024-01-01T00:00:00.000Z",
      "severity": "INCIDENT_SEVERITY_UNSPECIFIED",
      "state": "INCIDENT_STATE_UNSPECIFIED",
      "status": "INCIDENT_STATUS_UNSPECIFIED",
      "closedAt": "2024-01-01T00:00:00.000Z",
      "description": "incident_description",
      "isMuted": false,
      "metaLabels": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "name": "incident_name"
    }
  ],
  "pagination": {
    "totalSize": 100,
    "nextPageToken": "next_page_token"
  }
}

Authorizations

Authorization
string
header
required

API key authentication

Body

application/json

Request to list incidents with filtering, pagination and ordering options

filter
Incident query filter · object

Filter configuration for incidents

orderBys
Incident order by · object[]
pagination
Pagination request · object

Pagination parameters for list requests

Response

Response containing a list of incidents and pagination information

incidents
Incident · object[]
required
pagination
Pagination response · object
required

Pagination information for list responses