---
type: api
title: Get the status of the Entity Store
description: **Spaces method and path for this operation:**
url: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/v8/operation/operation-getentitystorestatus
resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/v8/operation/operation-getentitystorestatus
products:
  - Kibana
---

# Get the status of the Entity Store

- Server: `https://{kibana_url}`

## Paths

- `GET` `/api/entity_store/status`
- `GET` `/s/{space_id}/api/entity_store/status`

- [Api key auth](/elastic/docs-builder/docs/4371/api/doc/kibana/v8/authentication#apikeyauth)
- [Basic auth](/elastic/docs-builder/docs/4371/api/doc/kibana/v8/authentication#basicauth)

## Description

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

Get the overall Entity Store status and per-engine statuses, optionally including component-level health details.

## Query String Parameters

- `include_components` (boolean)
  If true, returns a detailed status of each engine including all its components.

## Response

Successful response

`application/json`

- `engines` ([] object)
  Per-engine status information.
  - `delay` (string · pattern: [smdh]$ · default: 1m)
    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.
    - `action` (enum)
      The lifecycle action that caused the error.
      Values: `init`
    - `message` (string)
      A human-readable error message.
  - `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 · pattern: [smdh]$ · default: 1m)
    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 · pattern: [smdh]$ · default: 24h)
    How far back the transform looks when calculating aggregations.
  - `status` (enum)
    The current operational status of an entity engine.
    Values: `installing`, `started`, `stopped`, `updating`, `error`
  - `timeout` (string · pattern: [smdh]$ · default: 180s)
    The timeout for initializing the aggregating transform.
  - `timestampField` (string)
    The field used as the timestamp for source documents.
  - `type` (enum)
    The type of entity.
    Values: `user`, `host`, `service`
  - `components` ([] object)
    Detailed component-level status. Only included when include_components is true.
    - `errors` ([] object)
      Errors reported by this component, if any.
      - `message` (string)
        Detailed error message.
      - `title` (string)
        Short error title.
    - `health` (enum)
      The health status of the component.
      Values: `green`, `yellow`, `red`, `unavailable`, `unknown`
    - `id` (string)
      Unique identifier for the component.
    - `installed` (boolean)
      Whether the component is currently installed.
    - `resource` (enum)
      The type of Elasticsearch or Kibana resource backing an engine component.
      Values: `entity_engine`, `entity_definition`, `index`, `component_template`, `index_template`, `ingest_pipeline`, `enrich_policy`, `task`, `transform`
- `status` (enum)
  The overall operational status of the Entity Store.
  Values: `not_installed`, `installing`, `running`, `stopped`, `error`
## Code Examples

#### Console

```console
GET /api/entity_store/status
```

#### curl

```curl
curl -X GET "https://{kibana_url}/api/entity_store/status"
```

## Response Examples

#### Entity Store running with two engines

The Entity Store is running with both host and user engines started and using default settings.

```json
{
  "engines": [
    {
      "delay": "1m",
      "fieldHistoryLength": 10,
      "frequency": "1m",
      "indexPattern": "",
      "lookbackPeriod": "24h",
      "status": "started",
      "timeout": "180s",
      "timestampField": "@timestamp",
      "type": "host"
    },
    {
      "delay": "1m",
      "fieldHistoryLength": 10,
      "frequency": "1m",
      "indexPattern": "",
      "lookbackPeriod": "24h",
      "status": "started",
      "timeout": "180s",
      "timestampField": "@timestamp",
      "type": "user"
    }
  ],
  "status": "running"
}
```