> ## Documentation Index > Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt > Use this file to discover all available pages before exploring further. # Cancel pending (and optionally running) migration jobs for an entity > Operational queue cleanup. Sets `status='cancelled'` on every pending migration job for the entity, and (optionally) every running job. A cancelled job is distinct from a failed job: monitoring should not treat it as an error, and the audit reason is recorded in the job's `errors[]` JSONB so the cancellation context is preserved. Common use cases: - The entity is being abandoned for a fresh entity, so the queue is contaminated. - A buggy bulk-submit needs to be drained before a clean re-run. - The runner is being redeployed and in-flight jobs should not be claimed mid-update. **Body parameters.** - `reason` (optional string) -- audit note stored in each cancelled job's `errors` array. Defaults to `"admin_cancelled"`. - `include_running` (optional boolean) -- also cancel `running` jobs. Default `false`. Risky for live runs (cancels in-flight work); use only when you've confirmed nothing meaningful is in flight. **Scope:** `migration:write`. ## OpenAPI ````yaml /openapi.yaml post /entities/{entity_id}/migration/jobs/cancel openapi: 3.1.0 info: title: Arcus ERP Public API version: 1.0.0 description: > Arcus ERP public REST API. Designed for external integrations and data migration. **Authentication.** Bearer token (API key) via the `Authorization` header. Format: `Authorization: Bearer ark_live_ent__` (or `ark_test_*` for sandbox). API keys are issued per-entity in **Settings > Developers > API Keys**. **Entity scoping.** The entity is encoded in the API key prefix; routes are flat (e.g. `/v1/accounts`, `/v1/orders`, `/v1/products`). A small set of platform endpoints (migration, reconciliation, events, webhook endpoints, API keys) use the `/v1/entities/{entity_id}/...` form -- those are noted in their tags. **Key capabilities.** - Related-resource hydration via `?expand[]=` (see `x-arcus-expand` on each resource). - Cursor-based pagination (`starting_after` / `ending_before` / `limit`). - Idempotency via the `Idempotency-Key` header. - Webhook events for asynchronous notification. - Conditional requests / ETag for cache validation. servers: - url: https://api.arcuserp.com/v1 description: Arcus ERP API (accepts both live `ark_live_*` and test `ark_test_*` keys) - url: https://dev-api.arcuserp.com/v1 description: >- Dev sandbox API (test-only data, accepts `ark_test_*` keys against dev RDS) security: [] paths: /entities/{entity_id}/migration/jobs/cancel: post: tags: - Migration summary: Cancel pending (and optionally running) migration jobs for an entity description: > Operational queue cleanup. Sets `status='cancelled'` on every pending migration job for the entity, and (optionally) every running job. A cancelled job is distinct from a failed job: monitoring should not treat it as an error, and the audit reason is recorded in the job's `errors[]` JSONB so the cancellation context is preserved. Common use cases: - The entity is being abandoned for a fresh entity, so the queue is contaminated. - A buggy bulk-submit needs to be drained before a clean re-run. - The runner is being redeployed and in-flight jobs should not be claimed mid-update. **Body parameters.** - `reason` (optional string) -- audit note stored in each cancelled job's `errors` array. Defaults to `"admin_cancelled"`. - `include_running` (optional boolean) -- also cancel `running` jobs. Default `false`. Risky for live runs (cancels in-flight work); use only when you've confirmed nothing meaningful is in flight. **Scope:** `migration:write`. operationId: postMigrationJobsCancel parameters: - name: entity_id in: path required: true schema: type: string format: uuid requestBody: required: false content: application/json: schema: type: object properties: reason: type: string description: >- Audit note stored in each cancelled job's errors[] JSONB. Defaults to 'admin_cancelled'. example: queue_cleanup_after_entity_abandoned include_running: type: boolean description: >- Also cancel 'running' jobs. Default false. Risky for live runs. default: false example: false examples: cleanup: summary: Cancel only pending jobs after entity abandonment value: reason: queue_cleanup_2026_05_22_abandoned_for_new_entity full_drain: summary: Cancel pending AND running (force-drain before redeploy) value: reason: pre_redeploy_force_drain include_running: true responses: '200': description: Cancel result with the list of cancelled job IDs content: application/json: schema: type: object properties: object: type: string enum: - migration_jobs_cancel_result entity_id: type: string format: uuid cancelled: type: integer description: Number of jobs transitioned to 'cancelled'. job_ids: type: array items: type: string format: uuid description: IDs of jobs that were cancelled (in created_at order). reason: type: string include_running: type: boolean '401': $ref: '#/components/responses/Error' '403': $ref: '#/components/responses/Error' security: - ApiKeyAuth: [] components: responses: Error: description: Error response (400/401/403/404/409/422/429/500) content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' schemas: ErrorEnvelope: type: object description: | Canonical error response envelope. All API errors use this shape. required: - error - code properties: error: type: string description: Machine-readable error key example: not_found code: type: string description: Machine-readable error code (often same as error) example: not_found type: type: string enum: - validation_error - permission_error - not_found - conflict - rate_limit - internal - expand_error - not_implemented example: not_found hint: type: string description: Human-readable one-sentence explanation (English) example: >- The requested order does not exist or does not belong to this entity. param: type: string description: The parameter that caused the error, if applicable example: expand[0] required: type: string description: The scope required (only on insufficient_scope errors) example: accounts:read request_id: type: string description: >- Unique request ID for support tracing (maps to CloudWatch log stream) example: req_abc123 securitySchemes: ApiKeyAuth: type: http scheme: bearer description: | API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent__ Test keys use ark_test_ent__. Both are issued per entity via Settings > Developers > API Keys. ````