@bpmnkit/camunda-docspack 0.0.0

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-process-instance.api.md

@@ -0,0 +1,25 @@
+# Get process instance
+
+`GET /process-instances/{processInstanceKey}`
+
+Get the process instance by the process instance key.
+
+- Required permissions: READ_PROCESS_INSTANCE on PROCESS_DEFINITION.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  processInstanceKey (path, string, required)
+
+Responses:
+  200 ProcessInstanceResult — The process instance is successfully returned.
+  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 process instance with the given key was 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/get-process-instance.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-resource-content-binary.api.md

@@ -0,0 +1,27 @@
+# Get resource content as binary
+
+`GET /resources/{resourceKey}/content/binary`
+
+Returns the content of a deployed resource in binary format (octet-stream).
+:::info
+This endpoint does not return BPMN process definitions, DMN decision definitions, or form
+resources. To query BPMN process definitions or DMN decision definitions, use their
+respective APIs.
+:::
+
+- Required permissions: READ on RESOURCE.
+- Added in Camunda 8.10.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  resourceKey (path, ResourceKey, required)
+
+Responses:
+  200 string — The resource content is successfully returned.
+  404 ProblemDetail — A resource with the given key was 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/get-resource-content-binary.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-resource-content.api.md

@@ -0,0 +1,30 @@
+# Get RPA resource content (deprecated)
+
+`GET /resources/{resourceKey}/content`
+
+**Deprecated** — use `/resources/{resourceKey}/content/binary` instead, which supports all
+resource types and returns content as binary (octet-stream).
+
+Returns the content of a deployed RPA resource as JSON.
+:::info
+This endpoint only supports RPA resources. For generic resource content in binary format,
+use the `/resources/{resourceKey}/content/binary` endpoint.
+:::
+
+- Required permissions: READ on RESOURCE.
+- Added in Camunda 8.7.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  resourceKey (path, ResourceKey, required)
+
+Responses:
+  200 object — The resource content is successfully returned.
+  404 ProblemDetail — A resource with the given key was not found.
+  406 ProblemDetail — The resource exists but is not an RPA resource.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/get-resource-content.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-resource.api.md

@@ -0,0 +1,27 @@
+# Get resource
+
+`GET /resources/{resourceKey}`
+
+Returns a deployed resource.
+:::info
+This endpoint does not return BPMN process definitions, DMN decision definitions, or form
+resources. To query BPMN process definitions or DMN decision definitions, use their
+respective APIs.
+:::
+
+- Required permissions: READ on RESOURCE.
+- Added in Camunda 8.7.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  resourceKey (path, ResourceKey, required)
+
+Responses:
+  200 ResourceResult — The resource is successfully returned.
+  404 ProblemDetail — A resource with the given key was 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/get-resource.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-restore-status.api.md

@@ -0,0 +1,21 @@
+# Get the status of the restore that is currently in progress
+
+`GET /restore`
+
+Returns the status of the restore that is currently in progress, reported per broker and per partition. There is at most one restore in flight at any time. Once the restore has finished this endpoint returns 404; the per-partition detail is not retained after completion.
+
+- Required permissions: RESTORE on BACKUP.
+- Added in Camunda 8.10.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Responses:
+  200 RestoreStatusResponse — The status of the restore that is currently in progress.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 — No restore is currently in progress.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/get-restore-status.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-role.api.md

@@ -0,0 +1,24 @@
+# Get role
+
+`GET /roles/{roleId}`
+
+Get a role by its ID.
+
+- Required permissions: READ on ROLE.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  roleId (path, RoleId, required)
+
+Responses:
+  200 RoleResult — The role is successfully returned.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — The role with the given ID was 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/get-role.api

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

@@ -0,0 +1,24 @@
+# Get runtime backup state
+
+`GET /backups/runtime/state`
+
+Returns the current checkpoint and backup state of every partition of the physical
+tenant. Unlike the `backupRuntime` actuator, this fails the whole request if the
+checkpoint state or the backup ranges cannot be retrieved from any partition, instead
+of silently returning an empty section.
+
+- Required permissions: READ on BACKUP.
+- Added in Camunda 8.10.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Responses:
+  200 RuntimeBackupState — The 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 .
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/get-runtime-backup-state.api

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

@@ -0,0 +1,25 @@
+# Get runtime backup
+
+`GET /backups/runtime/{backupId}`
+
+Returns detailed status of the runtime backup with the given id.
+
+- Required permissions: READ on BACKUP.
+- Added in Camunda 8.10.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  backupId (path, BackupId, required)
+
+Responses:
+  200 BackupInfo — The runtime backup.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — A backup with the given id does not exist.
+  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/get-runtime-backup.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-start-process-form.api.md

@@ -0,0 +1,27 @@
+# Get process start form
+
+`GET /process-definitions/{processDefinitionKey}/form`
+
+Get the start form of a process.
+Note that this endpoint will only return linked forms. This endpoint does not support embedded forms.
+
+- Required permissions: READ_PROCESS_DEFINITION on PROCESS_DEFINITION.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  processDefinitionKey (path, string, required)
+
+Responses:
+  200 FormResult — The form is successfully returned.
+  204 — The process was found, but no form is associated with it.
+  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 — 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/get-start-process-form.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-status.api.md

@@ -0,0 +1,15 @@
+# Get physical tenant status
+
+`GET /status`
+
+Checks the health status of the default physical tenant by verifying if there's at least one partition of its group with a healthy leader. This endpoint is scoped to the default physical tenant only: it is available unprefixed and at `/physical-tenants/default/v2/status`, but not for any other physical tenant id (`/physical-tenants/{id}/v2/status` returns 404 for every other id, whether or not a physical tenant with that id exists). On a cluster with only the default physical tenant this endpoint answers the same question as `/cluster/v2/status`, though not with the same response: `/cluster/v2/status` reports its status in a body and so also distinguishes a degraded tenant from a healthy one. Use `/cluster/v2/status` for the aggregated status of the whole cluster, or `/physical-tenants/{id}/v2/topology` for the health of a specific physical tenant's partitions.
+
+- Added in Camunda 8.8.
+- Consistency: strong.
+
+Responses:
+  204 — The default physical tenant is UP and has at least one partition with a healthy leader.
+  503 — The default physical tenant is DOWN and does not have any partition with a healthy leader.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/get-status.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-system-configuration.api.md

@@ -0,0 +1,24 @@
+# System configuration (alpha)
+
+`GET /system/configuration`
+
+Returns the current system configuration. The response is an envelope
+that groups settings by feature area.
+
+:::note
+This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change
+in future releases.
+:::
+
+- Added in Camunda 8.9.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Responses:
+  200 SystemConfigurationResponse — Current system configuration grouped by feature area.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/get-system-configuration.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-tenant-cluster-variable.api.md

@@ -0,0 +1,26 @@
+# Get a tenant-scoped cluster variable
+
+`GET /cluster-variables/tenants/{tenantId}/{name}`
+
+Get a tenant-scoped cluster variable.
+
+- Required permissions: READ on CLUSTER_VARIABLE.
+- Added in Camunda 8.9.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  tenantId (path, TenantId, required)
+  name (path, ClusterVariableName, required)
+
+Responses:
+  200 ClusterVariableResult — Cluster variable found
+  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/get-tenant-cluster-variable.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-tenant.api.md

@@ -0,0 +1,25 @@
+# Get tenant
+
+`GET /tenants/{tenantId}`
+
+Retrieves a single tenant by tenant ID.
+
+- Required permissions: READ on TENANT.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  tenantId (path, TenantId, required)
+
+Responses:
+  200 TenantResult — The tenant was retrieved 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 — Tenant 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/get-tenant.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-topology.api.md

@@ -0,0 +1,18 @@
+# Get cluster topology
+
+`GET /topology`
+
+Obtains the current topology of the cluster the gateway is part of.
+
+- Added in Camunda 8.5.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Responses:
+  200 TopologyResponse — Obtains the current topology of the cluster the gateway is part of.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  500 ProblemDetail — An internal error occurred while processing the request.
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/get-topology.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.get-usage-metrics.api.md

@@ -0,0 +1,27 @@
+# Get usage metrics
+
+`GET /system/usage-metrics`
+
+Retrieve the usage metrics based on given criteria.
+
+- Required permissions: READ_USAGE_METRIC on SYSTEM.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  startTime (query, string, required)
+  endTime (query, string, required)
+  tenantId (query, TenantId)
+  withTenants (query, boolean)
+
+Responses:
+  200 UsageMetricsResponse — The usage metrics search result.
+  400 ProblemDetail — The provided data is not valid.
+  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/get-usage-metrics.api

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

@@ -0,0 +1,26 @@
+# Get user task form
+
+`GET /user-tasks/{userTaskKey}/form`
+
+Get the form of a user task.
+Note that this endpoint will only return linked forms. This endpoint does not support embedded forms.
+
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  userTaskKey (path, string, required)
+
+Responses:
+  200 FormResult — The form is successfully returned.
+  204 — The user task was found, but no form is associated with it.
+  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 — 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/get-user-task-form.api

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

@@ -0,0 +1,24 @@
+# Get user task
+
+`GET /user-tasks/{userTaskKey}`
+
+Get the user task by the user task key.
+
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  userTaskKey (path, string, required)
+
+Responses:
+  200 UserTaskResult — The user task is successfully returned.
+  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 user task with the given key was 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/get-user-task.api

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

@@ -0,0 +1,24 @@
+# Get user
+
+`GET /users/{username}`
+
+Get a user by its username.
+
+- Required permissions: READ on USER.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  username (path, Username, required)
+
+Responses:
+  200 UserResult — The user is successfully returned.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  403 ProblemDetail — Forbidden. The request is not allowed.
+  404 ProblemDetail — The user with the given username was 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/get-user.api

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

@@ -0,0 +1,29 @@
+# Get variable
+
+`GET /variables/{variableKey}`
+
+Get a variable by its key.
+
+This endpoint returns both process-level and local (element-scoped) variables.
+The variable's scopeKey indicates whether it's a process-level variable or scoped to a
+specific element instance.
+
+- Required permissions: READ_PROCESS_INSTANCE on PROCESS_DEFINITION.
+- Added in Camunda 8.8.
+- Consistency: eventual.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  variableKey (path, string, required)
+
+Responses:
+  200 VariableResult — The variable is successfully returned.
+  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 — 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/get-variable.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.list-history-backups.api.md

@@ -0,0 +1,29 @@
+# List history backups
+
+`GET /backups/history`
+
+Returns a list of all available history backups of the physical tenant, with their state
+and additional info, most recent first by snapshot start time.
+
+Only available on clusters whose secondary storage is Elasticsearch or OpenSearch.
+
+- Required permissions: READ on BACKUP.
+- Added in Camunda 8.10.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  prefix (query, BackupIdPrefix)
+  verbose (query, boolean)
+
+Responses:
+  200 HistoryBackupInfo[] — The list of history backups.
+  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.
+  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/list-history-backups.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.list-runtime-backups.api.md

@@ -0,0 +1,26 @@
+# List runtime backups
+
+`GET /backups/runtime`
+
+Returns a list of all available runtime backups of the physical tenant, with their
+state and additional info, sorted in descending order of backupId.
+
+- Required permissions: READ on BACKUP.
+- Added in Camunda 8.10.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  prefix (query, BackupIdPrefix)
+
+Responses:
+  200 BackupInfo[] — The list of runtime backups.
+  400 ProblemDetail — The provided data is not valid.
+  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 .
+
+---
+Source: https://docs.camunda.io/docs/next/apis-tools/orchestration-cluster-api-rest/specifications/list-runtime-backups.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.list-secrets.api.md

@@ -0,0 +1,34 @@
+# List secrets (alpha)
+
+`POST /secrets/list`
+
+List the `camunda.secrets.*` references known for the caller's physical tenant.
+
+Only references the caller holds `SECRET:READ` on are returned. This endpoint never
+returns secret values, only the reference names.
+
+The references are read from the secret stores configured for the caller's physical tenant.
+Secret names that cannot form a valid `camunda.secrets.<name>` reference (for example names
+containing a dot or a dash) are omitted, since they could neither be resolved nor be used in
+a BPMN expression.
+
+This endpoint is an [alpha feature](/components/early-access/alpha/alpha-features.md) and may be subject to change in future releases.
+
+- Required permissions: READ on SECRET.
+- Added in Camunda 8.10.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: SecretListRequest
+
+Responses:
+  200 SecretListResult — The references the caller is authorized to see.
+  400 ProblemDetail — The provided data is not valid.
+  401 ProblemDetail — The request lacks valid authentication credentials.
+  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/list-secrets.api

package/.llms/chunks/apis-tools.orchestration-cluster-api-rest.specifications.migrate-process-instance.api.md

@@ -0,0 +1,37 @@
+# Migrate process instance
+
+`POST /process-instances/{processInstanceKey}/migration`
+
+Migrates a process instance to a new process definition.
+This request can contain multiple mapping instructions to define mapping between the active
+process instance's elements and target process definition elements.
+
+Use this to upgrade a process instance to a new version of a process or to
+a different process definition, e.g. to keep your running instances up-to-date with the
+latest process improvements.
+
+- Required permissions: UPDATE_PROCESS_INSTANCE on PROCESS_DEFINITION.
+- Added in Camunda 8.6.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Parameters:
+  processInstanceKey (path, string, required)
+
+Request body:
+  application/json: ProcessInstanceMigrationInstruction (required)
+    targetProcessDefinitionKey (ProcessDefinitionKey, required) — The key of process definition to migrate the process instance to.
+    mappingInstructions (MigrateProcessInstanceMappingInstruction[], required) — Element mappings from the source process instance to the target process instance.
+    operationReference (OperationReference)
+
+Responses:
+  204 — The process instance is migrated.
+  400 ProblemDetail — The provided data is not valid.
+  404 ProblemDetail — The process instance is not found.
+  409 ProblemDetail — The process instance migration failed. 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/migrate-process-instance.api

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

@@ -0,0 +1,29 @@
+# Migrate process instances (batch)
+
+`POST /process-instances/migration`
+
+Migrate multiple process instances.
+Since only process instances with ACTIVE state can be migrated, any given
+filters for state 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.8.
+- Consistency: strong.
+
+Authentication: bearerAuth or basicAuth
+
+Request body:
+  application/json: ProcessInstanceMigrationBatchOperationRequest (required)
+    filter (ProcessInstanceFilter, required) — The process instance filter.
+    migrationPlan (ProcessInstanceMigrationBatchOperationPlan, required) — The migration plan.
+    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/migrate-process-instances-batch-operation.api