Skip to main content
PUT
Set the cluster agent's CI settings

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

cluster_id
string<uuid>
required

Body

application/json

Name at least one setting; an omitted setting is left unchanged.

ci_worker_count
integer
ci_storage_class
string

An empty string clears it.

ankra_workspace_storage_class
string
ci_placement
object | null

null clears the placement; an object replaces it whole.

ci_run_reservation
enum<string>
Available options:
off,
shadow,
on
ci_image_prepull
enum<string>
Available options:
off,
on
ci_step_workspaces
enum<string>
Available options:
off,
shadow,
on
ci_max_admitting_runs
integer
ci_reservation_sizing
enum<string>
Available options:
declared,
measured
ci_build_apparmor_profile
string

Response

The CI settings after the write

How the cluster's agent runs pipeline steps, and whether the agent has applied it.

ci_worker_count
integer
required
ci_storage_class
string
required
agent_version
string
required
supports_pipeline_steps
boolean
required
apply_state
enum<string>
required
Available options:
applied,
pending_upgrade,
agent_offline
updated_at
string<date-time> | null
required
ci_placement
object | null
required

Where pipeline pods on this cluster are scheduled.

ci_run_reservation
enum<string>
required
Available options:
off,
shadow,
on
supports_run_reservation
boolean
required
ci_image_prepull
enum<string>
required
Available options:
off,
on
supports_image_prepull
boolean
required
ci_max_admitting_runs
integer
required
ci_max_admitting_runs_effective
integer
required

The cap the dispatcher enforces (read-only).

ci_reservation_sizing
enum<string>
required
Available options:
declared,
measured
ci_build_apparmor_profile
string
required
supports_build_apparmor_profile
boolean
required
ci_step_workspaces
enum<string>
required
Available options:
off,
shadow,
on
supports_step_workspaces
boolean
required
ankra_workspace_storage_class
string
required

Empty inherits ci_storage_class.

applies_live
boolean

Set only by a write whose worker count the agent takes on its next job pull without restarting.

placement_admitting_nodes
integer

Ready, schedulable nodes the placement targets; omitted without a placement or fresh node data.