Skip to main content
PUT
Set the cluster agent's sizing

Authorizations

Authorization
string
header
required

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

Headers

authorization
string | null
x-ankra-organisation-id
string | null

Path Parameters

cluster_id
string<uuid4>
required

Body

application/json

Name at least one member. A Kubernetes quantity holds it, an empty string stops holding it, and an absent member is unchanged.

memory_limit
string

Memory limit, 512Mi to 16Gi, or an empty string.

memory_request
string

Memory request, 128Mi to 2Gi, or an empty string. Must not exceed the memory limit.

cpu_limit
string

CPU limit, 100m to 8, or an empty string.

cpu_request
string

CPU request, 50m to 2, or an empty string. Must not exceed the CPU limit.

Response

Successful Response

memory_limit
string | null
required

The held memory limit as a Kubernetes quantity, or null when Ankra holds none.

memory_request
string | null
required

The held memory request, or null when Ankra holds none.

cpu_limit
string | null
required

The held CPU limit, or null when Ankra holds none.

cpu_request
string | null
required

The held CPU request, or null when Ankra holds none.

updated_at
string<date-time> | null
required

When a held value last changed, or null before the first.

apply_state
enum<string>
required

What the held sizing is doing on the cluster now.

Available options:
not_set,
applied,
pending_upgrade,
agent_offline
message
string
required

A sentence describing the apply state, to show verbatim.