Update the API key of the Entity Store tasks

Base URL: https://{kibana_url}

POST /api/security/entity_store/update_api_key
POST /s/{space_id}/api/security/entity_store/update_api_key

Auth

Replace the API key of every Entity Store background task with one owned by the user making this request, for example after the user who installed the Entity Store is removed. The tasks keep their schedules and state, and no entity data is changed. The user needs the same privileges as the install endpoint. Tasks that could not be updated are listed in failed; call the endpoint again to retry them.

Required privileges

Privileges securitySolution

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.

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

Type: object

Response

200

Indicates that the request was processed. Check ok and failed to see whether every task was updated.

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Re-grant the API key of every Entity Store task as the user making the request.

Console Kibana Dev Tools

POST kbn://api/security/entity_store/update_api_key
{}

curl Shell

curl -X POST -H "kbn-xsrf: true" -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "${KIBANA_URL}/api/security/entity_store/update_api_key"

Response

Call the endpoint again to retry the tasks listed in failed.

{
  "failed": [
    {
      "id": "entity_store:v2:status_report_task:default",
      "message": "Version conflict",
      "statusCode": 409
    }
  ],
  "ok": false,
  "updated": [
    "entity_store:v2:history_snapshot_task:default"
  ]
}