Stop an Entity Engine

Base URL: https://{kibana_url}

POST /api/entity_store/engines/{entityType}/stop
POST /s/{space_id}/api/entity_store/engines/{entityType}/stop

Refer to Spaces for more information.

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

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Response

Successful response

application/json

Base URL: https://{kibana_url}

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
}