Get an Entity Engine

GET /api/entity_store/engines/{entityType}

Path parameters

  • entityType string Required

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

    Values are user, host, service, or universal.

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

      Additional properties are allowed.

    • 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 universal.
GET /api/entity_store/engines/{entityType} 
curl \
 --request GET https://localhost:5601/api/entity_store/engines/{entityType}
Response examples (200) 
{
  "delay": "1m",
  "docsPerSecond": 42,
  "error": {},
  "fieldHistoryLength": 42,
  "filter": "string",
  "frequency": "1m",
  "indexPattern": "string",
  "lookbackPeriod": "24h",
  "status": "installing",
  "timeout": "180s",
  "timestampField": "string",
  "type": "user"
}