Skip to main content
PATCH
Change fleet lifecycle or name

Authorizations

Authorization
string
header
required

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

Headers

If-Match
string
required

Required current strong resource tag.

Path Parameters

workspace_id
string
required

UUIDv7 of the workspace.

fleet_id
string
required

UUIDv7 of the fleet.

Body

application/json

PATCH fleets changes lifecycle or name under its required resource tag.

name
string | null

Validated instance slug, omitted to retain it.

status
null | enum<string>

Supported lifecycle target, omitted to keep current state.

Available options:
active,
stopped,
killed

Response

Current fleet

Shared fleet resource, returned by create, read and lifecycle changes.

budget_used_nanos
string
required

Exact lifetime spend in nanos.

created_at
integer<int64>
required

Creation time in Unix milliseconds.

definition
object
required

Complete validated native setup, with no private transcript.

etag
string
required

Strong resource tag for name/status changes.

events_processed
string
required

Exact lifetime event count.

id
string
required

Fleet identity.

memory_access
object
required

Current independent shared-memory permissions.

name
string
required

Validated instance slug.

needs_re_review
boolean
required

Effective authority changed since review.

pending_approvals
integer<int64>
required

Current unanswered approval gates.

policy_semantics
string
required

Pinned policy interpretation.

schedules
object[]
required

Actual stored schedule observations.

setup
object
required

Live prerequisites and authorized recovery actions.

setup_etag
string
required

Strong setup tag for reviewed improvement application.

setup_revision
string
required

Exact decimal immutable setup revision.

start
object
required

Explicit initial-run progress.

status
string
required

Current lifecycle state.

updated_at
integer<int64>
required

Last mutation in Unix milliseconds.

webhook_urls
object[]
required

Manual webhook addresses from the declared setup.