Stop an Entity Engine

Auth

Stop a running entity engine, pausing transform processing for the given entity type.

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
entityType enum required: The entity type of the engine to stop.; Values: user host service

Successful response

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn:/api/entity_store/engines/host/stop

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/entity_store/engines/host/stop" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

The engine was successfully stopped and is no longer processing data.

{
  "stopped": true
}