Get the status of the Entity Store
https://{kibana_url}
- GET /api/entity_store/status
- GET /s/{space_id}/api/entity_store/status
Refer to Spaces for more information.
Get the overall Entity Store status and per-engine statuses, optionally including component-level health details.
Query Parameters
-
include_componentsboolean If true, returns a detailed status of each engine including all its components.
Response
Successful response
-
enginesobjectrequired -
Per-engine status information.
-
delaystring · pattern: [smdh]$ · default: 1m -
The delay before the transform processes new data, allowing late-arriving documents to be included.
-
docsPerSecondinteger -
Throttle value for the number of documents processed per second. Use -1 for no throttle.
-
errorobject -
Present when the engine status is
error. Describes the failure. -
fieldHistoryLengthintegerrequired -
The number of historical values retained per field.
-
filterstring -
An optional Kibana Query Language (KQL) filter applied to source documents before aggregation.
-
frequencystring · pattern: [smdh]$ · default: 1m -
How often the transform runs.
-
indexPatternstringrequired -
An additional Elasticsearch index pattern to include as a source for entity data. Merged with the default data view indices when the engine runs.
-
lookbackPeriodstring · pattern: [smdh]$ · default: 24h -
How far back the transform looks when calculating aggregations.
-
status -
The current operational status of an entity engine.
-
Values:
installingstartedstoppedupdatingerror -
timeoutstring · pattern: [smdh]$ · default: 180s -
The timeout for initializing the aggregating transform.
-
timestampFieldstring -
The field used as the timestamp for source documents.
-
componentsobject -
Detailed component-level status. Only included when include_components is true.
-
errorsobject -
Errors reported by this component, if any.
-
idstringrequired -
Unique identifier for the component.
-
installedbooleanrequired -
Whether the component is currently installed.
-
resource -
The type of Elasticsearch or Kibana resource backing an engine component.
-
Values:
entity_engineentity_definitionindexcomponent_templateindex_templateingest_pipelineenrich_policytasktransform -
status -
The overall operational status of the Entity Store.
-
Values:
not_installedinstallingrunningstoppederror