Restore an archived workflow state machine
POST/v1/projects/:project_id/workflows/:workflow_id/versions/:version/restore
Writes an archived version's state machine back as the workflow's live definition, which archives it again as a new version rather than rewinding the counter — so a task pinned to any version in between still runs on the machine it entered on.
The restore runs through the ordinary update path, so the archived definition goes through the same validation as an authored one. That includes resolving every on_enter dispatch target, so restoring a version whose agent or orchestration has since been deleted fails with 400 rather than writing a definition that would strand a task on entry. Restoring the definition the workflow already holds is a no-op and archives nothing. Tasks already in flight are unaffected either way — a restore is an ordinary edit, and pinning is what keeps it from reaching them.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 413
- 429
- 500
- 502
- 4XX
The workflow, at its new version
Bad request — version is not a positive integer, or the restored definition is invalid
Unauthorized
Forbidden
Not found
The resource has moved past the version this write read (VERSION_CONFLICT): a stated expected_version or If-Match no longer matches, or a concurrent write took the version first. meta.current_version names the version in force. Nothing is written.
REQUEST_REJECTED — the request body is over the size the body parser accepts
QUOTA_EXCEEDED — a requests quota on the calling API key or its project is spent for the window; Retry-After says when it reopens
Response Headers
Seconds until the quota window admits a request again
Unexpected server error — INTERNAL_ERROR, with the raw message never forwarded
The deployment's admission service is asked about this write and did not answer — ADMISSION_UNAVAILABLE; the write did not happen
The deployment's admission service refused this write — answered under the service's own 4xx status, with its code (matching ^[A-Za-z_][A-Za-z0-9_]{0,63}$, not necessarily an ERROR_CODES key), message and meta; the write did not happen. A status this operation also declares on its own is documented there