Suspend process instanceAdded in 8.10

POST 
/process-instances/:processInstanceKey/suspension

Strongly Consistent About endpoint data consistency

Suspends a running process instance, pausing further processing until it is resumed. Only process instances in the ACTIVE state can be suspended. A child process instance can be suspended independently of its parent or root process instance; suspension does not cascade to or from related instances.

Required permissions

When authorization is enabled, this endpoint requires the following permission. See resources and permissions to learn more.

Resource type	Permission
PROCESS_DEFINITION	SUSPEND_PROCESS_INSTANCE

Request

Responses

204

The process instance is suspended.

400

The provided data is not valid.

404

The process instance is not found.

409

The process instance is not in the ACTIVE state and cannot be suspended. More details are provided in the response body.

500

An internal error occurred while processing the request.

503

The service is currently unavailable. This may happen only on some requests where the system creates backpressure to prevent the server's compute resources from being exhausted, avoiding more severe failures. In this case, the title of the error object contains RESOURCE_EXHAUSTED. Clients are recommended to eventually retry those requests after a backoff period. You can learn more about the backpressure mechanism here: https://docs.camunda.io/docs/components/zeebe/technical-concepts/internal-processing/#handling-backpressure .