Incidents

List incident rules

List all incident rules.

get/api/v2/incidents/config/rules

Request

Query parameters

filter[task_id]string
Example:notify-incident-handles-job

Filter rules by task ID.

filter[trigger]string
Example:incident_created_trigger

Filter rules by trigger.

incidentTypeUUIDstring uuid
Example:00000000-0000-0000-0000-000000000000

Filter rules by incident type UUID.

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "condition": {
          "normalized_query": "severity:SEV-1",
          "raw_query": "severity:SEV-1"
        },
        "condition_table_type": 1,
        "conditions": [
          {
            "field": "severity",
            "values": [
              "SEV-1",
              "SEV-2"
            ]
          }
        ],
        "created": "2024-01-01T00:00:00.000Z",
        "created_by_uuid": "00000000-0000-0000-0000-000000000001",
        "enabled": true,
        "execution_type": 1,
        "modified": "2024-01-01T00:00:00.000Z",
        "modified_by_uuid": "00000000-0000-0000-0000-000000000001",
        "org_id": 123456,
        "task_id": "notify-incident-handles-job",
        "task_payload": "{}",
        "trigger": "incident_created_trigger"
      },
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "incidents_rules"
    }
  ]
}

Changes

Changes to this operation have not been checked yet.