Register a cluster (admin)

post/clusters

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/clusters
  • Auth: HTTP bearer

Request body

account_idstring required
namestring required
descriptionstring
environment'development' | 'staging' | 'production'
api_endpointstring required
ca_bundlestring required
sa_tokenstring required
regionstring
auth_mode'sa_token' | 'eks_iam'

Defaults to sa_token. eks_iam requires eks_cluster_name and an account assume-role.

eks_cluster_namestring

Response

Created cluster

idstring required
org_idstring required
account_idstring required
namestring required
descriptionstring required
environment'development' | 'staging' | 'production' required
api_endpointstring required
regionstring required
auth_modestring

sa_token (stored bearer token) or eks_iam (minted from the account role).

eks_cluster_namestring
connection_status'pending' | 'connecting' | 'connected' | 'failed' required
last_connected_atstring date-time nullable required
connection_errorstring required
node_countinteger required
k8s_versionstring required
argocd_sync_statusstring required

Synced | OutOfSync | Unknown | "" (not yet observed).

argocd_health_statusstring required

Healthy | Progressing | Degraded | Missing | ... | "" (not yet observed).

control_plane_statusstring required

ACTIVE | UPDATING | CREATING | DEGRADED | ... | "" (not yet observed).

platform_versionstring required

EKS platform version, e.g. eks.7.

last_health_observed_atstring date-time nullable required
credentials_setboolean required

Whether CA bundle + SA token are stored; the ciphertext never leaves the server.

created_bystring required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 14 revisions of this API.