Skip to content
Workloom
Menu

Registry API

Workspaces

Create workspaces, manage their targets, packages and config, and read their revisions.

A workspace is the desired state an org distributes: targets, the packages assigned to them and config. Every change creates a revision. Preview renders a plan without writing anything, and config diff shows what a change would do.

Operations

Workspaces operations
RequestWhat it does
POST /api/v1/workspacesCreate workspace
GET /api/v1/workspacesList workspaces
GET /api/v1/workspaces/{id}Get workspace detail
PATCH /api/v1/workspaces/{id}Update workspace
GET /api/v1/workspaces/{id}/targetsList targets
POST /api/v1/workspaces/{id}/targetsCreate target
DELETE /api/v1/workspaces/{id}/targets/{targetId}Delete target
GET /api/v1/workspaces/{id}/revisionsList revisions
GET /api/v1/workspaces/{id}/configGet workspace config
PUT /api/v1/workspaces/{id}/configUpdate workspace config
GET /api/v1/workspaces/{id}/config/diffGet config diff
POST /api/v1/workspaces/{id}/previewGenerate render preview
POST /api/v1/workspaces/{id}/packagesAdd package

Paths and summaries come from apps/api/openapi.json, which CI regenerates from the route definitions; this site checks its list against that file. Telemetry ingest accepts a workspace key without a user session; everything else needs a signed-in user.