Update the Entity Store

Base URL: https://{kibana_url}

PUT /api/security/entity_store

Update the Entity Store log extraction configuration. Omitting a field leaves it unchanged. Sending null for a field clears that override and reverts to the default value.

Required authorization

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Header parameters

Request body

Responses

200

Indicates a successful response.

application/json

400

Bad request.

application/json

404

Entity Store not found.

application/json

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

PUT kbn://api/security/entity_store
{
  "logExtraction": {
    "lookbackPeriod": "6h",
    "frequency": "10m",
    "fieldHistoryLength": 15
  }
}

curl Shell

curl -X PUT -H "kbn-xsrf: true" -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"logExtraction":{"lookbackPeriod":"6h","frequency":"10m","fieldHistoryLength":15}}' \
  "${KIBANA_URL}/api/security/entity_store"

Response

A log extraction parameter has an invalid duration format.

{
  "error": "Bad Request",
  "message": "[request body]: logExtraction.frequency: must be a valid duration of at least 30 seconds (e.g. 1m, 30s)",
  "statusCode": 400
}

{
  "error": "Not Found",
  "message": "Entity store is not installed",
  "statusCode": 404
}

Request Console 1 / 2 languages

Send null for any field to clear that override and revert it to the default value.

Console Kibana Dev Tools

PUT kbn:/api/security/entity_store
{
  "logExtraction": {
    "delay": "null",
    "frequency": "null"
  }
}

Generated from the API spec

curl Shell

curl -X PUT -H "kbn-xsrf: true" -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "logExtraction": {
      "delay": "null",
      "frequency": "null"
    }
  }' \
  "${KIBANA_URL}/api/security/entity_store"

Generated from the API spec

Response

The Entity Store configuration was successfully updated.

{
  "ok": true
}

{
  "error": "Bad Request",
  "message": "[request body]: logExtraction.frequency: must be a valid duration of at least 30 seconds (e.g. 1m, 30s)",
  "statusCode": 400
}

{
  "error": "Not Found",
  "message": "Entity store is not installed",
  "statusCode": 404
}

Request Console 1 / 2 languages

Update the log extraction configuration with a new lookback period and frequency.

Console Kibana Dev Tools

PUT kbn:/api/security/entity_store
{
  "logExtraction": {
    "fieldHistoryLength": 15,
    "frequency": "10m",
    "lookbackPeriod": "6h"
  }
}

Generated from the API spec

curl Shell

curl -X PUT -H "kbn-xsrf: true" -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "logExtraction": {
      "fieldHistoryLength": 15,
      "frequency": "10m",
      "lookbackPeriod": "6h"
    }
  }' \
  "${KIBANA_URL}/api/security/entity_store"

Generated from the API spec

Response

The Entity Store configuration was successfully updated.

{
  "ok": true
}

{
  "error": "Bad Request",
  "message": "[request body]: logExtraction.frequency: must be a valid duration of at least 30 seconds (e.g. 1m, 30s)",
  "statusCode": 400
}

{
  "error": "Not Found",
  "message": "Entity store is not installed",
  "statusCode": 404
}

Required authorization

Authentication

Header parameters

Request body { }

Responses

Request body