Stop transforms
- POST /_transform/{transform_id}/_stop
Path Parameters
-
transform_idstring Namerequired -
Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression. To stop all transforms, use
_allor*as the identifier.
Query Parameters
-
allow_no_matchboolean · default: true Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the
_allstring 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.
-
forceboolean · default: false If it is true, the API forcefully stops the transforms.
-
timeoutstring Duration · default: 30s Period to wait for a response when
wait_for_completionistrue. 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.-
wait_for_checkpointboolean · default: false 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_completionboolean · default: false 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.
Response
-
acknowledgedbooleanrequired -
For a successful response, this value is always true. On failure, an exception is returned instead.