Puck Admin

Published Pucks

No pucks published. Push one with puck push.

Listing Visibility

Select which lifecycle states appear on the public listing page.

INWORK DRAFT STAGE PUBLISHED DEPRECATED RETIREDSave

Running Instances

No warm instances.

Design Systems

No design systems registered.

Upload Puck

Upload

Upload an .oci.tar file built by puck build. The puck will be ingested and a route auto-created.

API Reference

All endpoints return JSON. GET endpoints can be opened directly in the browser.

Health

• GET /api/v1/health — server health check

Routes

• GET /api/v1/routes — list all routes
• POST /api/v1/routes — create a route
  {"id":"myid","path_prefix":"/mypath","puck_ref":"name:tag","strip_prefix":true}
• DELETE /api/v1/routes/{id} — delete a route
• PUT /api/v1/routes/{id}/state — set lifecycle state
  {"state":"published"}

Settings

• GET /api/v1/settings/visible-states — get visible lifecycle states
• PUT /api/v1/settings/visible-states — set visible states
  {"states":["published","stage"]}

Instances

• GET /api/v1/instances — list running instances

Design Systems

• GET /api/v1/ds — list design systems
• POST /api/v1/ds — register a design system
• DELETE /api/v1/ds/{id} — remove a design system

OCI Registry

• GET /v2/ — registry version check
• GET /v2/{name}/tags/list — list tags for an image
• GET /v2/{name}/manifests/{ref} — get manifest
• PUT /v2/{name}/manifests/{ref} — push manifest