Xeonr Developer Docs
API SpecificationWorkspaces

Update Workspace

POST
/containers.api.v1.WorkspaceService/UpdateWorkspace

Sets a workspace's label (empty clears it); everything else is immutable. Refused on a snapshot (FailedPrecondition).

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
label?string

empty clears the label

Lengthlength <= 255
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://containers.xeonr.io/containers.api.v1.WorkspaceService/UpdateWorkspace" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/json" \  -d '{}'
{
  "workspace": {
    "workspaceId": "string",
    "namespace": "string",
    "totalBytes": "string",
    "fileCount": 0,
    "updatedAtUnix": "string",
    "label": "string",
    "revision": "string",
    "ephemeral": true,
    "ownerKind": "string",
    "ownerId": "string"
  }
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}

Truncate File POST

Truncates or zero-extends a file to size bytes. **Access:** namespace OPERATOR or above (write); a workspace-scoped agent key may act only on the trees it was minted for

Write File POST

Client stream: one WriteHeader first, then data frames. Overwrites (default), appends or patches at an offset, then pushes the change into any live sandbox mounting the workspace. Authorization is checked on the header, before any body is buffered. The body is capped at 64 MiB (InvalidArgument); use CreateUpload + ImportZip for bulk data. Refused on a snapshot (FailedPrecondition). **Access:** namespace OPERATOR or above (write); a workspace-scoped agent key may act only on the trees it was minted for