opschain admin migrate-logs pause
Included from Basic tier
Pauses the active phase — the purge when one is running, otherwise the migration — and refuses when nothing is running. The worker finishes the family it is committing and stops at the durable cursor, so a pause is always clean: no owner is ever left half-visible.
Use it for off-peak windowing (pause before business hours, resume in the
next window) or to hold the estate still while you verify blob-store backups
before a purge. A phase that hit an error pauses itself with the error on its
state row — status shows it.
Flags
| Flag | Meaning |
|---|---|
--server <url> | Server base URL (default: the active context / OPSCHAIN_SERVER). |
--auth-token <token> | Admin bearer token override (default: your opschain login session, then $OPSCHAIN_ADMIN_TOKEN, then the token stored by opschain admin login). |
Prints the status document after the flip (-o json / -o yaml).
Exit codes
| Code | Meaning |
|---|---|
| 0 | The phase was paused. |
| 1 | Refused (nothing is running), request failed, or the token was rejected. |
| 2 | Usage error — no server or no credential resolvable. |
Examples
opschain admin migrate-logs pause
See also
opschain docs cli/admin-migrate-logs-resume— picking the sweep back up.