Get an Entity Engine

GET /api/entity_store/engines/{entityType}
Api key auth

Path parameters

  • entityType string Required

    The entity type of the engine (either 'user' or 'host').

    Values are user, host, service, or generic.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response 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.
GET /api/entity_store/engines/{entityType} 
curl \
 --request GET 'https://<KIBANA_URL>/api/entity_store/engines/{entityType}' \
 --header "Authorization: $API_KEY"