Update cluster
Update selected fields on a CoreWeave CKS cluster using a field mask.
- The API server is
https://api.coreweave.com. - Replace
{API_ACCESS_TOKEN}with your CoreWeave API access token. - For required permissions, see IAM Access Policies.
updateMask
field, to specify which fields to modify. When updateMask
is omitted, all fields in the request body are updated. For
more information on field masks, see the
Google AIP-157 guidance.
Required fields on every PATCH request body:
idversion
updateMask paths is derived from
UpdateClusterRequest in the upstream proto and from the
update_request.json fixture in the CKS API repository.
publicversionauditPolicyoidc(and nested paths such asoidc.issuerUrl,oidc.clientId,oidc.ca)authzWebhook(and nestedauthzWebhook.server,authzWebhook.ca)authnWebhook(and nestedauthnWebhook.server,authnWebhook.ca)network.internalLbCidrNames(append-only)network.serviceNodePortRangedisableOidcInfoPublicationkubeletadditionalServerSanstailscale
Example: upgrade a cluster’s Kubernetes version
To upgrade a cluster, setversion to the new minor version
and include version in updateMask. See
Upgrade Kubernetes
for the end-to-end procedure.
Authorizations
CoreWeave API access token sent as a bearer token.
Path Parameters
The ID of the cluster to update.
Body
The unique identifier for the cluster to update.
The version of Kubernetes to run on the cluster, in minor version format (for example, v1.32). Patch versions are applied automatically by CKS as they are released.
A field mask specifying which fields to update. When omitted, all fields in the request body are updated. See the PATCH operation documentation for the preliminary list of valid paths and Google AIP-157 for field-mask syntax.
Whether the cluster's api-server is publicly accessible from the Internet.
OpenID Connect (OIDC) configuration for authentication to the api-server.
Authorization webhook configuration for the cluster.
Authentication webhook configuration for the cluster.
Audit policy for the cluster. Must be provided as a base64-encoded JSON or YAML string.
Mutable subset of the Kubernetes overlay network configuration. Only internalLbCidrNames and serviceNodePortRange may be updated.
When true, suppresses publication of the /.well-known/openid-configuration and /openid/v1/jwks endpoints to oidc.cks.coreweave.com/id/[CLUSTER-ID], so the cluster cannot be used as a public OIDC provider. Publishing these endpoints exposes the cluster's OIDC configuration and JWKS to the public Internet.
A JSON object of selective overrides applied to every cluster Node's kubelet configuration. A Node reboot is required for changes to take effect. Unknown options are stored but ignored. See the Kubernetes kubelet configuration reference for supported options.
Up to 10 additional Subject Alternative Names to include on the Kubernetes API server certificate. Each entry must be unique.
Tailscale configuration for the cluster.
Response
OK
The cluster.