Skip to main content
POST
Onboard a tenant Fleet library entry

Authorizations

Authorization
string
header
required

Obtain a token via the CLI auth flow (POST /v1/auth/sessions) or GitHub OAuth

Path Parameters

workspace_id
string<uuid>
required

UUIDv7 of the workspace.

Body

application/json
source_kind
enum<string>
required

Where the entry comes from. github and template are fetched and validated server-side; upload carries the SKILL.md (and optional TRIGGER.md) Markdown inline for a skill-only entry.

Available options:
template,
upload,
github
replace
boolean
default:false

Platform tier only. The catalog id comes from the bundle's SKILL.md frontmatter name, not this repository path. So a bundle may declare a name another repository already owns. That is refused with UZ-CATALOG-004, rather than silently swapping the bundle every workspace installs. Retry with replace: true to overwrite it deliberately.

source_ref
string

Required for github (an owner/repo locator) and template (a first-party template id).

Maximum string length: 512
ref
string

Optional branch or tag for github sources; absent fetches the default branch. The dashboard's Fetch-update sends the entry's stored ref, so a ref pinned via the catalog PATCH is honored by the refetch rather than silently reset. Same character rules as a repository segment.

Maximum string length: 100
skill_markdown
string

Raw SKILL.md bytes. Required for upload; ignored for fetched sources.

Maximum string length: 204800
trigger_markdown
string

Optional raw TRIGGER.md bytes for upload. Ignored for fetched sources.

Maximum string length: 204800

Response

Entry onboarded into the workspace catalog.

Result of onboarding a Fleet library entry (platform or tenant tier). Carries the entry identity, its tier in visibility, the content hash, and the derived requirements — never a support-file manifest, an object-store key, or support-file content.

id
string
required

Entry id — the slug for platform entries, a UUIDv7 for tenant entries.

name
string
required
visibility
enum<string>
required

The catalog tier the entry was onboarded into.

Available options:
platform,
tenant
content_hash
string
required

SHA-256 content hash of the onboarded snapshot.

requirements
object
required