# Initialize an Entity Engine

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

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

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

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

Initialize a single entity engine for the specified entity type.


## Servers
- https://<KIBANA_URL>: https://<KIBANA_URL> ()


## Authentication methods
- Api key auth


## Parameters

### Path parameters
- **entityType** (string)
  The entity type of the engine.


### Body: application/json (object)
Schema for the engine initialization
- **delay** (string)
  The delay before the transform will run.
- **docsPerSecond** (integer)
  The number of documents per second to process.
- **enrichPolicyExecutionInterval** (string)
  Interval in which enrich policy runs. For example, `"1h"` means the rule runs every hour. Must be less than or equal to half the duration of the lookback period,
- **fieldHistoryLength** (integer)
  The number of historical values to keep for each field.
- **filter** (string)

- **frequency** (string)
  The frequency at which the transform will run.
- **indexPattern** (string)
  An additional Elasticsearch index pattern to include as a source for entity data. Merged with the default data view indices when the engine runs.
- **lookbackPeriod** (string)
  The amount of time the transform looks back to calculate the aggregations.
- **maxPageSearchSize** (integer)
  The initial page size to use for the composite aggregation of each checkpoint.
- **timeout** (string)
  The timeout for initializing the aggregating transform.
- **timestampField** (string)
  The field to use as the timestamp for the entity type.


## Responses
### 200
Successful response

#### Body: application/json (object)
- **delay** (string)
  The delay before the transform processes new data, allowing late-arriving documents to be included.
- **docsPerSecond** (integer)
  Throttle value for the number of documents processed per second. Use -1 for no throttle.
- **error** (object)
  Present when the engine status is `error`. Describes the failure.
- **fieldHistoryLength** (integer)
  The number of historical values retained per field.
- **filter** (string)
  An optional Kibana Query Language (KQL) filter applied to source documents before aggregation.
- **frequency** (string)
  How often the transform runs.
- **indexPattern** (string)
  An additional Elasticsearch index pattern to include as a source for entity data. Merged with the default data view indices when the engine runs.
- **lookbackPeriod** (string)
  How far back the transform looks when calculating aggregations.
- **status** (string)
  The current operational status of an entity engine.
- **timeout** (string)
  The timeout for initializing the aggregating transform.
- **timestampField** (string)
  The field used as the timestamp for source documents.
- **type** (string)
  The type of entity.

### 400
Invalid request


[Powered by Bump.sh](https://bump.sh)