Initialize the Entity Store | Kibana Serverless API

Initialize the Entity Store Beta

POST /api/entity_store/enable

application/json; Elastic-Api-Version=2023-10-31

Body Required

Schema for the entity store initialization

fieldHistoryLength integer

The number of historical values to keep for each field.

Default value is 10.
filter string
indexPattern string

Responses

200 application/json; Elastic-Api-Version=2023-10-31

Successful response
Hide response attributes Show response attributes object
- engines array[object]
  
  Hide engines attributes Show engines attributes object
  
  error object
  
  Additional properties are allowed.
  
  fieldHistoryLength integer Required
  
  filter string
  
  indexPattern string Required
  
  status string Required
  
  Values are installing, started, stopped, updating, or error.
  
  type string Required
  
  Values are user or host.
- succeeded boolean

POST /api/entity_store/enable

curl \
 -X POST https://localhost:5601/api/entity_store/enable \
 -H "Content-Type: application/json; Elastic-Api-Version=2023-10-31"

Request examples

{
  "fieldHistoryLength": 10,
  "filter": "string",
  "indexPattern": "string"
}

Response examples (200)

{
  "engines": [
    {
      "error": {},
      "fieldHistoryLength": 42,
      "filter": "string",
      "indexPattern": "string",
      "status": "installing",
      "type": "user"
    }
  ],
  "succeeded": true
}