Get the status of the Entity Store

GET /api/entity_store/status

Query parameters

  • include_components boolean

    If true returns a detailed status of the engine including all it's components

Responses

  • 200 application/json; Elastic-Api-Version=2023-10-31

    Successful response

    Hide response attributes Show response attributes object
    • engines array[object] Required
      Hide engines attributes Show engines attributes object
      • error object

        Additional properties are allowed.

      • fieldHistoryLength integer Required
      • filter string
      • indexPattern string Required
      • status string Required

        Values are installing, started, stopped, updating, or error.

      • type string Required

        Values are user or host.

      • components array[object]
        Hide components attributes Show components attributes object
        • errors array[object]
          Hide errors attributes Show errors attributes object
        • health string

          Values are green, yellow, red, or unknown.

        • id string Required
        • installed boolean Required
        • resource string Required

          Values are entity_engine, entity_definition, index, component_template, index_template, ingest_pipeline, enrich_policy, task, or transform.

    • status string Required

      Values are not_installed, installing, running, stopped, or error.
GET /api/entity_store/status 
curl \
 -X GET https://localhost:5601/api/entity_store/status
Response examples (200) 
{
  "engines": [
    {
      "error": {},
      "fieldHistoryLength": 42,
      "filter": "string",
      "indexPattern": "string",
      "status": "installing",
      "type": "user",
      "components": [
        {
          "errors": [
            {
              "message": "string",
              "title": "string"
            }
          ],
          "health": "green",
          "id": "string",
          "installed": true,
          "resource": "entity_engine"
        }
      ]
    }
  ],
  "status": "not_installed"
}