Pause and resume client monitoring
When to use this workflow
“Pause monitoring during the contract break and resume it later.”
Before fetching
Specify the client, stop time, resumption conditions, and retained history. Do not treat the paused interval as zero results or assume it was backfilled.
Stop collection while retaining client history, then verify capacity and settings before resuming.
Prerequisites
Use an authenticated account with permission to manage client workspaces. Confirm the client and current lifecycle status before a write.
Use npm CLI 0.6.0 (the beta tag) or later for this workflow. Follow the installation commands in Agency and client management.
Quick reference
Replace placeholders with the workspace ID and a different idempotency key for each request. Use different keys for the dry-run and committed request.
orc workspaces get YOUR_CLIENT_WORKSPACE_ID --json
orc workspaces pause YOUR_CLIENT_WORKSPACE_ID --idempotency-key YOUR_PAUSE_IDEMPOTENCY_KEY --yes --json
orc workspaces get YOUR_CLIENT_WORKSPACE_ID --json
orc workspaces resume YOUR_CLIENT_WORKSPACE_ID --dry-run --idempotency-key YOUR_DRY_RUN_IDEMPOTENCY_KEY --json
orc workspaces resume YOUR_CLIENT_WORKSPACE_ID --idempotency-key YOUR_RESUME_IDEMPOTENCY_KEY --yes --json
orc workspaces get YOUR_CLIENT_WORKSPACE_ID --json1. Identify what will stop
Use workspaces get to review the client, lifecycle_status, paused_at, and running_runs. Pause is separate from workspace archival and disabling individual prompts. Past history and workspace capacity remain in place.
2. Verify paused state and history
Run workspaces get again after workspaces pause. Confirm that lifecycle_status is paused and no new observations start. Runs that were active at pause time are not cancelled; they continue until running_runs reaches 0.
3. Check capacity and resume
Use workspaces resume --dry-run to read the resulting state, prompt count, AI selection, cadence, and entitlement overages. A dry-run does not change state. If the result is valid, run resume without --dry-run. Collection starts in the next scheduled window and does not backfill the paused interval.
If the operation stops
If you do not receive a pause or resume response, resend that request with the same idempotency key. To inspect the state before resuming, use --dry-run with a new idempotency key. A workspace_archived or workspace_expired response means that the workspace cannot resume.
If a failure remains, report it and verify the fix, including this workflow and the failed step.