Get the status of the Entity Store

Base URL
https://{kibana_url}
  • GET /api/entity_store/status
  • GET /s/{space_id}/api/entity_store/status
Auth

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

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.

Query parameters

include_components boolean

If true, returns a detailed status of each engine including all its components.

Response

Successful response

application/json
engines object[] required

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 required

The lifecycle action that caused the error.

Values: init
message string required

A human-readable error message.

fieldHistoryLength integer required

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 required

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 required

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 required

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 required

Unique identifier for the component.

installed boolean required

Whether the component is currently installed.

resource enum required

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 required

The overall operational status of the Entity Store.

Values: not_installed installing running stopped error
Base URL
https://{kibana_url}