Skip to content
Workloom
Menu

Registry API

Packages

Create canonical packages, list and read them, and manage their versions.

A canonical package is named by its scope and name; each package version is immutable. These operations create packages, change their status (draft, active, deprecated, yanked) and visibility, publish new versions and move a version through its approval status.

The fixture operation returns a package in the shape the CLI consumes.

Operations

Packages operations
RequestWhat it does
GET /api/v1/packagesList packages
POST /api/v1/packagesCreate a package
GET /api/v1/packages/searchSearch packages
GET /api/v1/packages/{scope}/{name}Get package detail
PATCH /api/v1/packages/{scope}/{name}Update package status
PATCH /api/v1/packages/{scope}/{name}/visibilityChange package visibility
GET /api/v1/packages/{scope}/{name}/versionsList package versions
POST /api/v1/packages/{scope}/{name}/versionsPublish a package version
GET /api/v1/packages/{scope}/{name}/versions/{version}Get a specific version
PATCH /api/v1/packages/{scope}/{name}/versions/{version}Update version approval status
GET /api/v1/packages/{scope}/{name}/fixtureGet package fixture data for CLI

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.