Pause or cancel portfolio work when you need to stop further items, investigate an incident or change the operational plan. These controls preserve recorded outcomes. They do not undo a successful registration, refund a payment or rewind a DNS change that has already reached its provider.
| Method | Resource | Scope | Idempotency-Key |
|---|---|---|---|
POST |
/v2/portfolio/jobs/{jobId}/pause |
domains:operate |
Required |
POST |
/v2/portfolio/jobs/{jobId}/resume |
domains:operate |
Required |
POST |
/v2/portfolio/jobs/{jobId}/cancel |
domains:operate |
Required |
IN THIS ARTICLE
01 Choose the appropriate control
| Action | Purpose | What still needs review |
|---|---|---|
| Pause | Stop taking further work at a durable boundary. | An item already running may finish. |
| Resume | Continue the same paused plan. | Provider conditions and unresolved item failures. |
| Cancel | Cancel pending items and retain completed evidence. | Running work can leave the job cancelling until it settles. |
02 Recover without repeating the portfolio
- Read the current job and all item states. Record successful, failed, unknown, running and pending items.
- Use pause when you expect to continue the same approved plan after diagnosis. Use cancel when the remaining selection should no longer execute.
- Submit the selected control with a unique idempotency key and read the resulting state.
- Investigate any item that was running when the control was issued. Check provider references before deciding whether an external corrective action is needed.
- After fixing the cause, resume only a paused job whose unchanged plan remains appropriate. Create a new reviewed plan for a materially different selection.
Common questions
Why did one domain finish after I clicked pause?
The control applies at a durable item boundary. An in-flight provider action may already have been accepted and cannot be assumed cancelled by a local pause.
Can I cancel a completed job?
Completed and other terminal jobs retain their outcomes. Use the relevant domain, billing or DNS recovery workflow for a corrective action; cancellation is not an undo button.
Should I recreate the job after a worker interruption?
Read the existing durable state first. Resuming the same appropriate job avoids intentionally replaying terminal items. Unknown outcomes require explicit provider reconciliation.
Does a successful DNS portfolio item prove publication?
Some DNS and forwarding items succeed by dispatching a child changeset or deployment. Follow the returned reference and verify that child operation and the public result before declaring the service changed.