Reads the alert index name if it exists | Kibana API documentation (v9)

Reads the alert index name if it exists

GET /api/detection_engine/index

Api key auth Basic auth

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- index_mapping_outdated boolean | null Required
- name string Required
401 application/json

Unsuccessful authentication response
Hide response attributes Show response attributes object
- error string Required
- message string Required
- statusCode integer Required
403 application/json

Not enough permissions response
Hide response attributes Show response attributes object
- message string Required
- status_code integer Required
404 application/json

Not found
Hide response attributes Show response attributes object
- message string Required
- status_code integer Required
500 application/json

Internal server error response
Hide response attributes Show response attributes object
- message string Required
- status_code integer Required

GET /api/detection_engine/index

curl \
 --request GET 'http://localhost:5622/api/detection_engine/index' \
 --header "Authorization: $API_KEY"

Response examples (200)

{
  "name": ".alerts-security.alerts-default",
  "index_mapping_outdated": false
}

Response examples (401)

{
  "error": "string",
  "message": "string",
  "statusCode": 42
}

Response examples (403)

{
  "message": "string",
  "status_code": 42
}

Response examples (404)

{
  "message": "string",
  "status_code": 42
}

Response examples (500)

{
  "message": "string",
  "status_code": 42
}