Stop transforms Generally available; Added in 7.5.0

POST /_transform/{transform_id}/_stop
Api key auth Basic auth Bearer auth

Stops one or more transforms.

Required authorization

  • Cluster privileges: manage_transform

Path parameters

  • transform_id string Required

    Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression. To stop all transforms, use _all or * as the identifier.

Query parameters

  • allow_no_match boolean

    Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the _all string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches.

    If it is true, the API returns a successful acknowledgement message when there are no matches. When there are only partial matches, the API stops the appropriate transforms.

    If it is false, the request returns a 404 status code when there are no matches or only partial matches.

  • force boolean

    If it is true, the API forcefully stops the transforms.

  • timeout string

    Period to wait for a response when wait_for_completion is true. If no response is received before the timeout expires, the request returns a timeout exception. However, the request continues processing and eventually moves the transform to a STOPPED state.

    Values are -1 or 0.

  • wait_for_checkpoint boolean

    If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false, the transform stops as soon as possible.

  • wait_for_completion boolean

    If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns immediately and the indexer is stopped asynchronously in the background.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • acknowledged boolean Required

      For a successful response, this value is always true. On failure, an exception is returned instead.
POST /_transform/{transform_id}/_stop 
curl \
 --request POST 'http://api.example.com/_transform/{transform_id}/_stop' \
 --header "Authorization: $API_KEY"
Response examples (200)
A successful response when a transform stops. 
{
  "acknowledged": true
}