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

    Successful response

    Hide response attributes Show response attributes object
    • engines array[object] Required
      Hide engines attributes Show engines attributes object
      • delay string

        Format should match the following pattern: [smdh]$. Default value is 1m.

      • docsPerSecond integer
      • error object
        Hide error attributes Show error attributes object
        • action string Required

          Value is init.

        • message string Required
      • fieldHistoryLength integer Required
      • filter string
      • frequency string

        Format should match the following pattern: [smdh]$. Default value is 1m.

      • indexPattern string Required
      • lookbackPeriod string

        Format should match the following pattern: [smdh]$. Default value is 24h.

      • status string Required

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

      • timeout string

        Format should match the following pattern: [smdh]$. Default value is 180s.

      • timestampField string
      • type string Required

        Values are user, host, service, or generic.

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

          Values are green, yellow, red, or unknown.

        • id string Required
        • installed boolean Required
        • metadata object
          Hide metadata attributes Show metadata attributes object
          • delete_time_in_ms integer
          • documents_deleted integer
          • documents_indexed integer Required
          • documents_processed integer Required
          • exponential_avg_checkpoint_duration_ms integer Required
          • exponential_avg_documents_indexed integer Required
          • exponential_avg_documents_processed integer Required
          • index_failures integer Required
          • index_time_in_ms integer Required
          • index_total integer Required
          • pages_processed integer Required
          • processing_time_in_ms integer Required
          • processing_total integer Required
          • search_failures integer Required
          • search_time_in_ms integer Required
          • search_total integer Required
          • trigger_count integer 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 \
 --request GET 'https://<KIBANA_URL>/api/entity_store/status' \
 --header "Authorization: $API_KEY"