Xeonr Developer Docs
API SpecificationWorkspaces

Delete Workspace

POST
/containers.api.v1.WorkspaceService/DeleteWorkspace

Deletes a workspace and its content. Snapshots cannot be deleted through this call (FailedPrecondition); use DeleteSnapshot.

Access: namespace OPERATOR or above (write); a workspace-scoped agent key may act only on the trees it was minted for

Authorization

BearerAuth
AuthorizationBearer <token>

A namespace-scoped API key (cpk_…) for machines, or a Xeonr Auth OIDC token for humans. The key's namespace and role are pinned server-side.

In: header

Header Parameters

Connect-Protocol-Version?number

Define the version of the Connect protocol

Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

workspaceId?string
Length1 <= length <= 128
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://containers.xeonr.io/containers.api.v1.WorkspaceService/DeleteWorkspace" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/json" \  -d '{}'
{}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Delete Snapshot POST

Deletes a snapshot. NotFound when the id does not name a snapshot (a live workspace cannot be deleted through this call). **Access:** namespace OPERATOR or above (write); a workspace-scoped agent key may act only on the trees it was minted for

Export Zip POST

Server stream of a workspace subtree as a zip in 64 KiB frames; empty path exports the whole workspace. **Access:** namespace VIEWER or above (read); a workspace-scoped agent key may act only on the trees it was minted for