Initialize an Entity Engine | Kibana Serverless API

Initialize an Entity Engine Beta

POST /api/entity_store/engines/{entityType}/init

Path parameters

entityType string Required

The entity type of the engine (either 'user' or 'host').

Values are user or host.

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

Body Required

Schema for the engine 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
- 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.

POST /api/entity_store/engines/{entityType}/init

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

Request examples

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

Response examples (200)

{
  "error": {},
  "fieldHistoryLength": 42,
  "filter": "string",
  "indexPattern": "string",
  "status": "installing",
  "type": "user"
}