EndpointsWorkspaces

Restore a paused workspace from its backup

POST/v2/workspaces/{workspace_id}/restore

Requires an explicitly paused workspace with no remaining pods. Restores into a separate storage claim, preserves the original claim, and leaves the workspace paused. Retry with the same request_id to observe preparation; prepared means the claim was selected, not that the disk has been provisioned. Explicitly start to bind restored storage. Pause and abort the latest restore to return to its source.

Authorization

BearerAuth
AuthorizationBearer <token>

Bearer token issued by Softmax

In: header

Path Parameters

workspace_id*Workspace Id

The workspace, as GET /v2/hermes reports its provisioning_id.

Formatuuid

Request Body

application/json

request_id*Request Id

Reuse this ID when retrying the same restore request.

Formatuuid
snapshot_id*Snapshot Id
Match^snap-[0-9a-f]{17}$
curl -X POST "https://softmax.com/api/observatory/v2/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/restore" \  -H "Content-Type: application/json" \  -d '{    "request_id": "266ea41d-adf5-480b-af50-15b940c2b846",    "snapshot_id": "string"  }'
{  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846",  "snapshot_id": "string",  "phase": "preparing",  "detail": "string"}