Find and/or aggregate detection alerts

Base URL: https://{kibana_url}

POST /api/detection_engine/signals/search
POST /s/{space_id}/api/detection_engine/signals/search

Auth

Find and/or aggregate detection alerts that match the given query.

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.

Request body

Search and/or aggregation query

_source union boolean | string | string[]
aggs object
fields string[]
query object
runtime_mappings object
size integer · min: 0
sort union oneOf: One of: (string | object)[] or string | object
track_total_hits boolean

Responses

Successful response

application/json

Response Type: object

Invalid input data response

application/json

One of:

error string required
message string required
statusCode integer required

Unsuccessful authentication response

application/json

error string required
message string required
statusCode integer required

Internal server error response

application/json

message string required
status_code integer required

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/detection_engine/signals/search
{
  "aggs": {
    "alertsByGrouping": {
      "terms": {
        "field": "host.name",
        "size": 10
      }
    },
    "missingFields": {
      "missing": {
        "field": "host.name"
      }
    }
  },
  "query": {
    "bool": {
      "filter": [
        {
          "bool": {
            "filter": [
              {
                "match_phrase": {
                  "kibana.alert.workflow_status": "open"
                }
              }
            ],
            "must": [],
            "must_not": [
              {
                "exists": {
                  "field": "kibana.alert.building_block_type"
                }
              }
            ],
            "should": []
          }
        },
        {
          "range": {
            "@timestamp": {
              "gte": "2025-01-17T08:00:00.000Z",
              "lte": "2025-01-18T07:59:59.999Z"
            }
          }
        }
      ]
    }
  },
  "runtime_mappings": {},
  "size": 0
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/detection_engine/signals/search" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "aggs": {
      "alertsByGrouping": {
        "terms": {
          "field": "host.name",
          "size": 10
        }
      },
      "missingFields": {
        "missing": {
          "field": "host.name"
        }
      }
    },
    "query": {
      "bool": {
        "filter": [
          {
            "bool": {
              "filter": [
                {
                  "match_phrase": {
                    "kibana.alert.workflow_status": "open"
                  }
                }
              ],
              "must": [],
              "must_not": [
                {
                  "exists": {
                    "field": "kibana.alert.building_block_type"
                  }
                }
              ],
              "should": []
            }
          },
          {
            "range": {
              "@timestamp": {
                "gte": "2025-01-17T08:00:00.000Z",
                "lte": "2025-01-18T07:59:59.999Z"
              }
            }
          }
        ]
      }
    },
    "runtime_mappings": {},
    "size": 0
  }'

Generated from the API spec

Response

{
  "_shards": {
    "failed": 0,
    "skipped": 0,
    "successful": 1,
    "total": 1
  },
  "aggregations": {
    "alertsByGrouping": {
      "buckets": [
        {
          "doc_count": 5,
          "key": "Host-f43kkddfyc"
        }
      ],
      "doc_count_error_upper_bound": 0,
      "sum_other_doc_count": 0
    },
    "missingFields": {
      "doc_count": 0
    }
  },
  "hits": {
    "hits": [],
    "max_score": "null",
    "total": {
      "relation": "eq",
      "value": 5
    }
  },
  "timed_out": false,
  "took": 0
}

{
  "error": "Bad Request",
  "message": "Failed to parse search request: unknown query clause in bool filter",
  "statusCode": 400
}

{
  "error": "Unauthorized",
  "message": "[security_exception\n\tRoot causes:\n\t\tsecurity_exception: unable to authenticate user [elastic] for REST request [/_security/_authenticate]]: unable to authenticate user [elastic] for REST request [/_security/_authenticate]",
  "statusCode": 401
}

{
  "message": "Internal Server Error",
  "status_code": 500
}

Path parameters

Request body { }

Responses

Request body