Create agent instanceAdded in 8.10

POST 
/agent-instances

Strongly Consistent About endpoint data consistency

Creates a new agent instance. The returned key identifies the instance and must be used in subsequent update and query calls.

Required permissions

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

Resource type	Permission
PROCESS_DEFINITION	UPDATE_PROCESS_INSTANCE

Request

Responses

200

The agent instance was created.

400

The provided data is not valid.

401

The request lacks valid authentication credentials.

Response Headers

WWW-Authenticate

403

Forbidden. The request is not allowed.

404

The elementInstanceKey does not correspond to an active element instance. More details are provided in the response body.

409

An agent instance already exists for the given element instance.

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 .