@bpmnkit/camunda-docspack 0.0.0

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.suspend-process-instances-batch-operation.api.md

@@ -0,0 +1,28 @@
+# Suspend process instances (batch)
+
+`POST /process-instances/suspension`
+
+Suspends multiple running process instances.
+Since only ACTIVE root instances can be suspended, any given
+filters for state and parentProcessInstanceKey are ignored and overridden during this batch operation.
+This is done asynchronously, the progress can be tracked using the batchOperationKey from the response and the batch operation status endpoint (/batch-operations/{batchOperationKey}).
+
+- Added in Camunda 8.10.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: ProcessInstanceSuspensionBatchOperationRequest (required)
+    filter (ProcessInstanceFilter, required) — The process instance filter.
+    operationReference (OperationReference)
+
+Responses:
+  200 BatchOperationCreatedResult — The batch operation request was created.
+  400 ProblemDetail — The process instance batch operation failed. More details are provided in the response body.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/suspend-process-instances-batch-operation.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.sync-runtime-backup-state.api.md

@@ -0,0 +1,24 @@
+# Force-write runtime backup state
+
+`POST /backups/runtime/state/sync`
+
+Force-writes the checkpoint and backup metadata of every partition of the physical
+tenant to the backup store, independent of any backup being taken or confirmed, and
+returns the updated state.
+
+- Required permissions: CREATE on BACKUP.
+- Added in Camunda 8.10.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Responses:
+  200 RuntimeBackupState — The updated runtime backup state.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  500 ProblemDetail — An internal error occurred while processing the request.
+  503 ProblemDetail — 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 .
+  504 ProblemDetail — The request from gateway to broker timed out.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/sync-runtime-backup-state.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.take-history-backup.api.md

@@ -0,0 +1,33 @@
+# Take a history backup
+
+`POST /backups/history`
+
+Triggers a backup of the physical tenant's history, by scheduling a snapshot of every
+secondary storage index it owns.
+
+Unlike runtime backups, history backups have no generated-id mode: `backupId` is always
+required.
+
+Only available on clusters whose secondary storage is Elasticsearch or OpenSearch.
+
+- Required permissions: CREATE on BACKUP.
+- Added in Camunda 8.10.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: TakeHistoryBackupRequest (required)
+    backupId (BackupId, required) — The id of the backup to take.
+
+Responses:
+  202 TakeHistoryBackupResponse — The backup has been successfully scheduled.
+  400 ProblemDetail — The provided data is not valid.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — The request is forbidden, either because the authenticated caller lacks the required `BACKUP` permission, or because the cluster's secondary storage is neither Elasticsearch nor OpenSearch and therefore cannot serve history backups. The problem detail says which of the two applies.
+  409 ProblemDetail — A backup with the given id already exists, or another backup is already running. The "already running" check is best-effort and node-local: it only observes backups started by the gateway that serves the request. Two concurrent requests reaching different gateways are narrowed by the duplicate-id check alone.
+  500 ProblemDetail — An internal error occurred while processing the request.
+  503 ProblemDetail — 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 .
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/take-history-backup.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.take-runtime-backup.api.md

@@ -0,0 +1,32 @@
+# Take a runtime backup
+
+`POST /backups/runtime`
+
+Triggers a backup of runtime data on all partitions of the physical tenant.
+
+The `backupId` must be omitted if continuous backups and/or a backup or checkpoint
+schedule is enabled for the physical tenant, as the id is generated automatically.
+Otherwise, `backupId` is required.
+
+- Required permissions: CREATE on BACKUP.
+- Added in Camunda 8.10.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: TakeRuntimeBackupRequest
+    backupId (BackupId) — The id of the backup to take. Must be omitted if continuous backups and/or a backup or checkpoint schedule is enabled for the physical tenant.
+
+Responses:
+  202 TakeRuntimeBackupResponse — The backup has been successfully scheduled.
+  400 ProblemDetail — The provided data is not valid.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  409 ProblemDetail — A backup with the same or a higher id already exists.
+  500 ProblemDetail — An internal error occurred while processing the request.
+  503 ProblemDetail — 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 .
+  504 ProblemDetail — The request from gateway to broker timed out.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/take-runtime-backup.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.throw-job-error.api.md

@@ -0,0 +1,32 @@
+# Throw error for job
+
+`POST /jobs/{jobKey}/error`
+
+Reports a business error (i.e. non-technical) that occurs while processing a job.
+
+- Required permissions: UPDATE_PROCESS_INSTANCE on PROCESS_DEFINITION.
+- Added in Camunda 8.6.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  jobKey (path, string, required)
+
+Request body:
+  application/json: JobErrorRequest (required)
+    errorCode (string, required) — The error code that will be matched with an error catch event.
+    errorMessage (string) — An error message that provides additional context.
+    variables (object) — JSON object that will instantiate the variables at the local scope of the error catch event that catches the thrown error.
+    leaseToken (string) — The token identifying a leased job's activation, obtained from `ActivatedJobResult.leaseToken`. For a leased job, the matching token must be supplied to prove…
+
+Responses:
+  204 — An error is thrown for the job.
+  400 ProblemDetail — The provided data is not valid.
+  404 ProblemDetail — The job with the given key was not found or is not activated.
+  409 ProblemDetail — The job with the given key is in the wrong state currently. More details are provided in the response body.
+  500 ProblemDetail — An internal error occurred while processing the request.
+  503 ProblemDetail — 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 .
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/throw-job-error.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.unassign-client-from-group.api.md

@@ -0,0 +1,27 @@
+# Unassign a client from a group
+
+`DELETE /groups/{groupId}/clients/{clientId}`
+
+Unassigns a client from a group.
+The client is removed as a group member, with associated authorizations, roles, and tenant assignments no longer applied.
+
+- Required permissions: UPDATE on GROUP.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  groupId (path, GroupId, required)
+  clientId (path, ClientId, required)
+
+Responses:
+  204 — The client was unassigned successfully from the group.
+  400 ProblemDetail — The provided data is not valid.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — The group with the given ID was not found, or the client is not assigned to this group.
+  500 ProblemDetail — An internal error occurred while processing the request.
+  503 ProblemDetail — 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 .
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/unassign-client-from-group.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.unassign-client-from-tenant.api.md

@@ -0,0 +1,27 @@
+# Unassign a client from a tenant
+
+`DELETE /tenants/{tenantId}/clients/{clientId}`
+
+Unassigns the client from the specified tenant.
+The client can no longer access tenant data.
+
+- Required permissions: UPDATE on TENANT.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  tenantId (path, TenantId, required)
+  clientId (path, ClientId, required)
+
+Responses:
+  204 — The client was successfully unassigned from the tenant.
+  400 ProblemDetail — The provided data is not valid.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — The tenant does not exist or the client was not assigned to it.
+  500 ProblemDetail — An internal error occurred while processing the request.
+  503 ProblemDetail — 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 .
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/unassign-client-from-tenant.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.unassign-group-from-tenant.api.md

@@ -0,0 +1,27 @@
+# Unassign a group from a tenant
+
+`DELETE /tenants/{tenantId}/groups/{groupId}`
+
+Unassigns a group from a specified tenant.
+Members of the group (users, clients) will no longer have access to the tenant's data - except they are assigned directly to the tenant.
+
+- Required permissions: UPDATE on TENANT.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  tenantId (path, TenantId, required)
+  groupId (path, GroupId, required)
+
+Responses:
+  204 — The group was successfully unassigned from the tenant.
+  400 ProblemDetail — The provided data is not valid.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — Not found. The tenant or group was not found.
+  500 ProblemDetail — An internal error occurred while processing the request.
+  503 ProblemDetail — 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 .
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/unassign-group-from-tenant.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.unassign-mapping-rule-from-group.api.md

@@ -0,0 +1,26 @@
+# Unassign a mapping rule from a group
+
+`DELETE /groups/{groupId}/mapping-rules/{mappingRuleId}`
+
+Unassigns a mapping rule from a group.
+
+- Required permissions: UPDATE on GROUP.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  groupId (path, GroupId, required)
+  mappingRuleId (path, MappingRuleId, required)
+
+Responses:
+  204 — The mapping rule was unassigned successfully from the group.
+  400 ProblemDetail — The provided data is not valid.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — The group or mapping rule with the given ID was not found, or the mapping rule is not assigned to this group.
+  500 ProblemDetail — An internal error occurred while processing the request.
+  503 ProblemDetail — 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 .
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/unassign-mapping-rule-from-group.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.unassign-mapping-rule-from-tenant.api.md

@@ -0,0 +1,26 @@
+# Unassign a mapping rule from a tenant
+
+`DELETE /tenants/{tenantId}/mapping-rules/{mappingRuleId}`
+
+Unassigns a single mapping rule from a specified tenant without deleting the rule.
+
+- Required permissions: UPDATE on TENANT.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  tenantId (path, TenantId, required)
+  mappingRuleId (path, MappingRuleId, required)
+
+Responses:
+  204 — The mapping rule was successfully unassigned from the tenant.
+  400 ProblemDetail — The provided data is not valid.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — Not found. The tenant or mapping rule was not found.
+  500 ProblemDetail — An internal error occurred while processing the request.
+  503 ProblemDetail — 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 .
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/unassign-mapping-rule-from-tenant.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.unassign-role-from-client.api.md

@@ -0,0 +1,26 @@
+# Unassign a role from a client
+
+`DELETE /roles/{roleId}/clients/{clientId}`
+
+Unassigns the specified role from the client. The client will no longer inherit the authorizations associated with this role.
+
+- Required permissions: UPDATE on ROLE.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  roleId (path, RoleId, required)
+  clientId (path, ClientId, required)
+
+Responses:
+  204 — The role was unassigned successfully from the client.
+  400 ProblemDetail — The provided data is not valid.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — The role or client with the given ID or username was not found.
+  500 ProblemDetail — An internal error occurred while processing the request.
+  503 ProblemDetail — 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 .
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/unassign-role-from-client.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.unassign-role-from-group.api.md

@@ -0,0 +1,26 @@
+# Unassign a role from a group
+
+`DELETE /roles/{roleId}/groups/{groupId}`
+
+Unassigns the specified role from the group. All group members (user or client) no longer inherit the authorizations associated with this role.
+
+- Required permissions: UPDATE on ROLE.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  roleId (path, RoleId, required)
+  groupId (path, GroupId, required)
+
+Responses:
+  204 — The role was unassigned successfully from the group.
+  400 ProblemDetail — The provided data is not valid.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — The role or group with the given ID was not found.
+  500 ProblemDetail — An internal error occurred while processing the request.
+  503 ProblemDetail — 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 .
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/unassign-role-from-group.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.unassign-role-from-mapping-rule.api.md

@@ -0,0 +1,26 @@
+# Unassign a role from a mapping rule
+
+`DELETE /roles/{roleId}/mapping-rules/{mappingRuleId}`
+
+Unassigns a role from a mapping rule.
+
+- Required permissions: UPDATE on ROLE.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  roleId (path, RoleId, required)
+  mappingRuleId (path, MappingRuleId, required)
+
+Responses:
+  204 — The role was unassigned successfully from the mapping rule.
+  400 ProblemDetail — The provided data is not valid.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — The role or mapping rule with the given ID was not found.
+  500 ProblemDetail — An internal error occurred while processing the request.
+  503 ProblemDetail — 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 .
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/unassign-role-from-mapping-rule.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.unassign-role-from-tenant.api.md

@@ -0,0 +1,28 @@
+# Unassign a role from a tenant
+
+`DELETE /tenants/{tenantId}/roles/{roleId}`
+
+Unassigns a role from a specified tenant.
+Users, Clients or Groups, that have the role assigned, will no longer have access to the
+tenant's data - unless they are assigned directly to the tenant.
+
+- Required permissions: UPDATE on TENANT.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  tenantId (path, TenantId, required)
+  roleId (path, RoleId, required)
+
+Responses:
+  204 — The role was successfully unassigned from the tenant.
+  400 ProblemDetail — The provided data is not valid.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — Not found. The tenant or role was not found.
+  500 ProblemDetail — An internal error occurred while processing the request.
+  503 ProblemDetail — 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 .
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/unassign-role-from-tenant.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.unassign-role-from-user.api.md

@@ -0,0 +1,26 @@
+# Unassign a role from a user
+
+`DELETE /roles/{roleId}/users/{username}`
+
+Unassigns a role from a user. The user will no longer inherit the authorizations associated with this role.
+
+- Required permissions: UPDATE on ROLE.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  roleId (path, RoleId, required)
+  username (path, Username, required)
+
+Responses:
+  204 — The role was unassigned successfully from the user.
+  400 ProblemDetail — The provided data is not valid.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — The role or user with the given ID or username was not found.
+  500 ProblemDetail — An internal error occurred while processing the request.
+  503 ProblemDetail — 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 .
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/unassign-role-from-user.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.unassign-user-from-group.api.md

@@ -0,0 +1,27 @@
+# Unassign a user from a group
+
+`DELETE /groups/{groupId}/users/{username}`
+
+Unassigns a user from a group.
+The user is removed as a group member, with associated authorizations, roles, and tenant assignments no longer applied.
+
+- Required permissions: UPDATE on GROUP.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  groupId (path, GroupId, required)
+  username (path, Username, required)
+
+Responses:
+  204 — The user was unassigned successfully from the group.
+  400 ProblemDetail — The provided data is not valid.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — The group or user with the given ID was not found, or the user is not assigned to this group.
+  500 ProblemDetail — An internal error occurred while processing the request.
+  503 ProblemDetail — 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 .
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/unassign-user-from-group.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.unassign-user-from-tenant.api.md

@@ -0,0 +1,27 @@
+# Unassign a user from a tenant
+
+`DELETE /tenants/{tenantId}/users/{username}`
+
+Unassigns the user from the specified tenant.
+The user can no longer access tenant data.
+
+- Required permissions: UPDATE on TENANT.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  tenantId (path, TenantId, required)
+  username (path, Username, required)
+
+Responses:
+  204 — The user was successfully unassigned from the tenant.
+  400 ProblemDetail — The provided data is not valid.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — Not found. The tenant or user was not found.
+  500 ProblemDetail — An internal error occurred while processing the request.
+  503 ProblemDetail — 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 .
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/unassign-user-from-tenant.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.unassign-user-task.api.md

@@ -0,0 +1,25 @@
+# Unassign user task
+
+`DELETE /user-tasks/{userTaskKey}/assignee`
+
+Removes the assignee of a task with the given key. Unassignment waits for blocking task listeners on this lifecycle transition. If listener processing is delayed beyond the request timeout, this endpoint can return 504. Other gateway timeout causes are also possible. Retry with backoff and inspect listener worker availability and logs when this repeats.
+
+- Added in Camunda 8.5.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  userTaskKey (path, string, required)
+
+Responses:
+  204 — The user task was unassigned successfully.
+  400 ProblemDetail — The provided data is not valid.
+  404 ProblemDetail — The user task with the given key was not found.
+  409 ProblemDetail — The user task with the given key is in the wrong state currently. More details are provided in the response body.
+  500 ProblemDetail — An internal error occurred while processing the request.
+  503 ProblemDetail — 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 .
+  504 ProblemDetail — The request timed out between the gateway and the broker. For these endpoints, this often happens when user task listeners are configured and the corresponding listener job is not completed within the request timeout. Common causes include no available job workers for the listener type, busy or crashed job workers, or delayed job completion. As with any gateway timeout, general timeout causes (for example transient network issues) can also result in a 504 response. Troubleshooting: - verify that job workers for the listener type are running and healthy - check worker logs for crashes, retries, and completion failures - check network connectivity between workers, gateway, and broker - retry with backoff after transient failures - fail without retries if a problem persists
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/unassign-user-task.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.update-agent-instance.api.md

@@ -0,0 +1,39 @@
+# Update agent instance
+
+`PATCH /agent-instances/{agentInstanceKey}`
+
+Updates the mutable fields of an agent instance (status, metric counters, and
+tools) and appends a batch of history items to its conversation history. Metric
+values are treated as deltas and applied immediately to the aggregate counters.
+Tool updates replace the existing tool list. Each history item created for this
+request is echoed back in the response.
+
+- Required permissions: UPDATE_PROCESS_INSTANCE on PROCESS_DEFINITION.
+- Added in Camunda 8.10.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  agentInstanceKey (path, string, required)
+
+Request body:
+  application/json: AgentInstanceUpdateRequest (required)
+    elementInstanceKey (ElementInstanceKey, required) — The key of the currently-active element instance for this agent instance. Used for ownership/equality validation against the stored agent instance and, when…
+    status (AgentInstanceUpdateStatusEnum) — The new status of the agent instance.
+    metrics (AgentInstanceMetricsDelta) — Metric increments to apply to the aggregate counters.
+    tools (AgentTool[]) — The complete list of tools available to the agent, replacing any previously stored tools. When provided, the engine replaces the existing tool list with this…
+    jobKey (JobKey) — The key of the job activation during which this update is being made. Required whenever history is provided.
+    jobLease (string) — Opaque lease token received from the job activation response. Disambiguates this activation from any other activation of the same job: if the job is later…
+    history (AgentInstanceHistoryItem[]) — A batch of history items to append to the agent instance's conversation history, in request order. Each created item is echoed back in the response's…
+
+Responses:
+  200 AgentInstanceUpdateResult — The agent instance was updated successfully.
+  400 ProblemDetail — The provided data is not valid.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — The agent instance with the given key was not found. More details are provided in the response body.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/update-agent-instance.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.update-authorization.api.md

@@ -0,0 +1,27 @@
+# Update authorization
+
+`PUT /authorizations/{authorizationKey}`
+
+Update the authorization with the given key.
+
+- Required permissions: UPDATE on AUTHORIZATION.
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  authorizationKey (path, AuthorizationKey, required)
+
+Request body:
+  application/json: AuthorizationRequest (required)
+
+Responses:
+  204 — The authorization was updated successfully.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  404 ProblemDetail — The authorization with the authorizationKey was not found.
+  500 ProblemDetail — An internal error occurred while processing the request.
+  503 ProblemDetail — 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 .
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/update-authorization.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.update-global-cluster-variable.api.md

@@ -0,0 +1,31 @@
+# Update a global-scoped cluster variable
+
+`PUT /cluster-variables/global/{name}`
+
+Updates the value of an existing global cluster variable.
+The variable must exist, otherwise a 404 error is returned.
+
+- Required permissions: UPDATE on CLUSTER_VARIABLE.
+- Added in Camunda 8.9.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  name (path, ClusterVariableName, required)
+
+Request body:
+  application/json: UpdateClusterVariableRequest (required)
+    value (object, required) — The new value of the cluster variable. Can be any JSON object or primitive value. Will be serialized as a JSON string in responses.
+    metadata (object) — A generic key-value metadata bag attached to the cluster variable. Values must be strings or numbers. Limited to 100 entries and a configurable maximum…
+
+Responses:
+  200 ClusterVariableResult — Cluster variable updated successfully
+  400 ProblemDetail — The provided data is not valid.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — Cluster variable not found
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/update-global-cluster-variable.api