Skip to main content
PUT
Update KubeCluster

Response

OK

account
string
required

Account is the ID of the Account to which this KubeCluster belongs.

Example:

"ac_93d76d03-61c2-40e8-b4c3-c7c86936b73e"

created_by
string
required

user who created the record.

created_on
string<date-time>
required

timestamp of when the record was created.

environment
string
required

A string environment tag, defined by the customer to categorize the KubeClusterThe current cluster version for this KubeCluster.

Example:

"staging"

id
string
required

ID is the unique identifier for the KubeCluster.

Example:

"k8scl_83eaa8d5-36ab-4814-9559-77518ec434cf"

last_modified_by
string
required

user who last modified the record.

last_modified_on
string<date-time>
required

timestamp of when the record was last modified.

platform
string
required

The name of the KubePlatform that this KubeCluster was launched in.

Example:

"eks-standard"

title
string
required

Display name for the KubeCluster.

Example:

"Internal App Cluster"

version
string
required

The current cluster version for this KubeCluster.

$schema
string<uri>
read-only

A URL to the JSON Schema for this object.

Example:

"https://example.com/schemas/KubeCluster.json"

description
string

Optional long-form description of the KubeCluster.

external_id
string

Optional cloud provider-specific or customer internal identifier for the KubeCluster

Example:

"arn:aws:eks:us-west-2:111122223333:cluster/my-cluster"

region
string

Optional string identifier of the cloud provider-specific or internal region.

Example:

"us-west-2"