Skip to content
Workloom
Menu

Registry API

Workspaces

Create workspaces, update them, roll them back and read their rendered output.

A workspace is the desired state for one repository or home directory. Every update increases its revision; rollback returns it to an earlier one.

The rendered and preview operations return the files the workspace renders, the same output `wl pull` produces, and the drift operation returns the drift reports recorded for it.

Operations

Workspaces operations
RequestWhat it does
GET /api/v1/workspacesList workspaces
POST /api/v1/workspacesCreate a workspace
GET /api/v1/workspaces/templatesList workspace templates
POST /api/v1/workspaces/from-templateCreate workspace from template
GET /api/v1/workspaces/{id}Get workspace manifest
PATCH /api/v1/workspaces/{id}Update workspace config
GET /api/v1/workspaces/{id}/revisionsList workspace revisions
POST /api/v1/workspaces/{id}/rollbackRollback workspace to a revision
GET /api/v1/workspaces/{id}/driftGet workspace drift reports
GET /api/v1/workspaces/{id}/renderedGet rendered workspace output
GET /api/v1/workspaces/{id}/previewPreview rendered workspace output (CLI parity)

Paths and summaries come from apps/api/openapi.json, which CI regenerates from the route definitions; this site checks its list against that file. Only the Public operations work without a token; everything else needs a signed-in session or an API token.