Skip to content

Conversation

@camunda-docs-pr-automation
Copy link
Contributor

Description

This is an autogenerated PR by the sync api specs workflow.
This PR contains every changes made to the REST api specs in the monorepo in the last week.
This PR contains also all the generated OpenAPI files related to the changes.

When should this change go live?

  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for the next minor and are in /docs directory (aka /next/).
  • My changes require a technical writer review, and I've assigned @camunda/tech-writers as a reviewer.

@camunda-docs-pr-automation camunda-docs-pr-automation bot added the deploy Stand up a temporary docs site with this PR label Jan 29, 2026
@camunda-docs-pr-automation camunda-docs-pr-automation bot requested a review from a team January 29, 2026 15:16
@camunda-docs-pr-automation camunda-docs-pr-automation bot moved this to 👀 In Review in Documentation Team Jan 29, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Jan 29, 2026

👋 🤖 🤔 Hello, @camunda-docs-pr-automation[bot]! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.8/.

  • docs/apis-tools/orchestration-cluster-api-rest/specifications/activate-ad-hoc-sub-process-activities.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/activate-jobs.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/assign-client-to-group.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/assign-client-to-tenant.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/assign-group-to-tenant.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/assign-mapping-rule-to-group.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/assign-mapping-rule-to-tenant.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/assign-role-to-client.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/assign-role-to-group.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/assign-role-to-mapping-rule.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/assign-role-to-tenant.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/assign-role-to-user.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/assign-user-task.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/assign-user-to-group.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/assign-user-to-tenant.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/broadcast-signal.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/cancel-batch-operation.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/cancel-process-instance.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/cancel-process-instances-batch-operation.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/complete-job.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/complete-user-task.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/correlate-message.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/create-admin-user.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/create-authorization.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/create-deployment.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/create-document-link.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/create-document.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/create-documents.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/create-element-instance-variables.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/create-global-cluster-variable.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/create-group.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/create-mapping-rule.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/create-process-instance.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/create-role.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/create-tenant-cluster-variable.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/create-tenant.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/create-user.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/delete-authorization.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/delete-decision-instance.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/delete-decision-instances-batch-operation.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/delete-document.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/delete-global-cluster-variable.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/delete-group.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/delete-mapping-rule.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/delete-process-instance.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/delete-process-instances-batch-operation.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/delete-resource.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/delete-role.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/delete-tenant-cluster-variable.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/delete-tenant.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/delete-user.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/evaluate-conditionals.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/evaluate-decision.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/evaluate-expression.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/fail-job.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-audit-log.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-authentication.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-authorization.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-batch-operation.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-decision-definition-xml.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-decision-definition.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-decision-instance.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-decision-requirements-xml.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-decision-requirements.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-document.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-element-instance.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-global-cluster-variable.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-global-job-statistics.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-group.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-incident.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-license.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-mapping-rule.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-process-definition-instance-statistics.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-process-definition-instance-version-statistics.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-process-definition-message-subscription-statistics.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-process-definition-statistics.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-process-definition-xml.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-process-definition.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-process-instance-call-hierarchy.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-process-instance-sequence-flows.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-process-instance-statistics-by-definition.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-process-instance-statistics-by-error.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-process-instance-statistics.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-process-instance.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-resource-content.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-resource.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-role.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-start-process-form.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-status.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-tenant-cluster-variable.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-tenant.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-topology.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-usage-metrics.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-user-task-form.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-user-task.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-user.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/get-variable.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/migrate-process-instance.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/migrate-process-instances-batch-operation.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/modify-process-instance.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/modify-process-instances-batch-operation.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/pin-clock.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/publish-message.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/reset-clock.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/resolve-incident.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/resolve-incidents-batch-operation.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/resolve-process-instance-incidents.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/resume-batch-operation.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-audit-logs.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-authorizations.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-batch-operation-items.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-batch-operations.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-clients-for-group.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-clients-for-role.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-clients-for-tenant.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-cluster-variables.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-correlated-message-subscriptions.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-decision-definitions.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-decision-instances.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-decision-requirements.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-element-instance-incidents.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-element-instances.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-group-ids-for-tenant.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-groups-for-role.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-groups.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-incidents.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-jobs.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-mapping-rule.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-mapping-rules-for-group.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-mapping-rules-for-role.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-mapping-rules-for-tenant.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-message-subscriptions.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-process-definitions.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-process-instance-incidents.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-process-instances.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-roles-for-group.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-roles-for-tenant.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-roles.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-tenants.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-user-task-audit-logs.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-user-task-variables.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-user-tasks.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-users-for-group.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-users-for-role.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-users-for-tenant.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-users.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/search-variables.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/sidebar.ts
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/suspend-batch-operation.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/throw-job-error.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/unassign-client-from-group.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/unassign-client-from-tenant.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/unassign-group-from-tenant.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/unassign-mapping-rule-from-group.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/unassign-mapping-rule-from-tenant.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/unassign-role-from-client.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/unassign-role-from-group.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/unassign-role-from-mapping-rule.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/unassign-role-from-tenant.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/unassign-role-from-user.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/unassign-user-from-group.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/unassign-user-from-tenant.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/unassign-user-task.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/update-authorization.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/update-group.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/update-job.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/update-mapping-rule.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/update-role.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/update-tenant.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/update-user-task.api.mdx
  • docs/apis-tools/orchestration-cluster-api-rest/specifications/update-user.api.mdx

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@github-actions github-actions bot temporarily deployed to camunda-docs January 29, 2026 15:23 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs February 5, 2026 15:26 Destroyed
@github-actions
Copy link
Contributor

github-actions bot commented Feb 5, 2026

The preview environment relating to the commit 494110b has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-7820/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

deploy Stand up a temporary docs site with this PR

Projects

Status: 👀 In Review

Development

Successfully merging this pull request may close these issues.

1 participant