Skip to main content
POST
Create a fleet

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
required

UUIDv7 of the workspace.

Body

application/json

POST /v1/workspaces/{workspace_id}/fleets — install one.

name
string | null

The operator's name for this instance, when they want one.

The same bundle backs many fleets in a workspace, each with its own name and its own webhooks. Absent means the bundle's declared name.

platform_library_id
string | null

A published platform entry, by slug.

tenant_library_id
string | null

This workspace's own entry, by identifier.

Response

Created

What an install answers with.

fleet_id
string
required

The new fleet's identifier.

name
string
required

The name it was stored under — the drawn one, when a default collided.

status
string
required

Where it stands. active: the stream exists, so it is already leasable.

webhook_urls
object[]
required

One entry per webhook trigger the bundle declared, each naming its source and the URL the provider is pointed at.

An empty array where the fleet declares none, never null: a client iterating it should not have to branch on its absence first.