---
title: "Install the Entity Store"
method: POST
path: "/api/security/entity_store/install"
tags: ["Security entity store"]
---

# Install the Entity Store

`POST /api/security/entity_store/install`

**Spaces method and path for this operation:**

<div><span class="operation-verb post">post</span>&nbsp;<span class="operation-path">/s/{space_id}/api/security/entity_store/install</span></div>

Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.

Install the Entity Store and create engines for the specified entity types. A single `logExtraction` configuration is shared across all entity types. Supply it once at install to customize settings; omit it (or send an empty object) to use defaults on first install or preserve the existing configuration on re-install. To change settings after install, use the update endpoint.<br/><br/>[Required authorization] Route required privileges: securitySolution.

## Headers

- `kbn-xsrf` string, required

## Request body

- object
  - `entityTypes` string[]
  - `historySnapshot` object
    - `frequency` string
  - `logExtraction` object
    - `additionalIndexPatterns` string[]
    - `delay` string
    - `docsLimit` integer
    - `excludedIndexPatterns` string[]
    - `fieldHistoryLength` integer
    - `frequency` string
    - `lookbackPeriod` string
    - `maxLogsPerPage` integer
    - `maxLogsPerWindow` integer
    - `maxLogsPerWindowCapBehavior` 'defer' | 'drop'
    - `maxTimeWindowSize` string

## Response `200`

Indicates all requested entity types are already installed.

## Other responses

- `201` — Indicates the Entity Store was successfully installed.
- `403` — Insufficient privileges.

---

[API](https://skmtc.net/elastic/apis/kibana-apis.md) · [All operations](https://skmtc.net/elastic/apis/kibana-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elastic/kibana-apis/versions/531c9e2a7d23/schema)