Skip to navigation

Restore a previous live version

Restores an existing publication if expected_live_version_id still matches. Keeps current draft and admitted calls unchanged. Does not restore revoked tool authority or historical model placements. Current platform eligibility still applies. Selecting already-live target is invalid_request; same-key replay returns original activation. Rollback never re-enables a revoked credential version; tools pinned to one refuse with credential_unavailable. If expected_live_version_id is no longer live, returns 409 conflict with details.reason=live_version_changed and details.current_live_version_id. An archived agent is refused with agent_archived. The target keeps its existing publication ID; rollback creates a new activation receipt, not a new publication.

Authentication

AuthorizationBearer

Create and manage workspace-owned keys through the existing app session routes, outside this public API. Creator and manager identities are audit actors only. Key validity follows workspace policy, expiry and explicit revocation, independently of creator membership. Do not include a workspace-selection header.

Path parameters

agent_idstringRequired1-128 characters
Resource identity within the authenticated workspace.

Headers

Idempotency-KeystringRequired1-255 characters

Stable key per logical intent, 1–255 printable characters. Persist it before sending. Retry the same key/body after an uncertain result for 24 hours. A changed body conflicts. Beyond retention, reconcile the resource before retrying; this is not permanent deduplication. Current authorization is rechecked on replay. Evaluation order: authenticate and check current authorization; look up intent; replay its stored receipt before checking the current revision; only a new intent evaluates If-Match and executes. Fingerprint includes method, path, body and original If-Match. A changed request returns idempotency_key_reused. The server stores only a keyed (HMAC) fingerprint, and no error or response ever returns a fingerprint or hash of a request. In-flight intent returns 409 idempotency_in_progress with Retry-After; retry the same intent after reconciliation. Receipts describe that attempt, not current resource state. A replay returns the original status code and body, with the response header Idempotent-Replayed: true.

Request

This endpoint expects an object.
version_idstringRequired<=128 characters
Opaque pub identifier. Do not parse its contents.
expected_live_version_idstringRequired<=128 characters
Opaque pub identifier. Do not parse its contents.

Response headers

X-Request-IdstringOptional
Safe server request correlation ID.
RateLimit-LimitintegerOptional
Requests allowed in the current window for the tightest applicable limit.
RateLimit-RemainingintegerOptional
Requests left in the current window.
RateLimit-ResetintegerOptional
Seconds until the current window resets.
Idempotent-ReplayedstringOptional

true when this response replays a stored Idempotency-Key result. The status and body equal the original.

Response

Restore a previous live version.
idstring<=128 characters
Opaque activation identifier. Do not parse its contents.
agent_idstring<=128 characters
Opaque agent identifier. Do not parse its contents.
from_version_idstring<=128 characters
Opaque pub identifier. Do not parse its contents.
to_version_idstring<=128 characters
Opaque pub identifier. Do not parse its contents.
created_atdatetime
warningslist of objects
Known problems with the activated version, for example tools that pin a revoked credential version and will refuse. Empty when none.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
413
Content Too Large Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error