Skip to main content

Update properties of a Kubernetes cluster client​

Select

SaaS
Customer Managed

API to update the properties of a Kubernetes cluster with clusterId

Path Parameters
  • clusterId int32 required

    clusterId is the ID of the Kubernetes cluster client

Request Body
  • apiServer string

    API Server Endpoint of the cluster

  • serviceAccount string

    Name of the Service Account to authenticate with the cluster

  • serviceToken string

    Secret token to authenticate with the cluster

  • accessNodes object[]
  • id int32
  • name string
  • type string
  • name string

    Name of the Kubernetes Cluster

  • serviceType KubernetesServiceTypes

    Possible values: [ONPREM, AKS]

    Default value: ONPREM

    The Service Type of the Kubernetes cluster

  • etcdProtection object

    Enable ETCD Protection on the Kubernetes Cluster

  • id int32
  • name string
  • enabled boolean

    Denote if etcd protection is enabled

  • plan object
  • id int32
  • name string
  • tags object[]

    Modify or add tags on the cluster

  • name string
  • value string
  • region object

    Update the workload region of the cluster

  • id int32
  • name string
  • activityControl object

    Request definition changing activity control options for cluster

  • enableBackup boolean

    Enable or disable backup for cluster

  • enableRestore boolean

    Enable or disable restore for cluster

  • enableBackupAfterADelay int32

    Enabling backup after a delay. Provide UTC Time in Unix format

  • enableRestoreAfterADelay int32

    Enabling restore after a delay. Provide UTC Time in Unix format

  • options object

    Request definition for cluster advanced options

  • imageRegistry object

    Request definition changing image registry options for cluster

  • url string

    Specify image registry URL for internal image repository

  • pullSecret string

    Specify image pull secret to authenticate with the image repository

  • configNamespace string

    Specify the name of the Namespace where Commvault resources will be deployed

  • jobStepWaitTime object

    Request definition changing job step wait time options for cluster

  • workerPodStartup int32

    Specify wait time (in minutes) for Worker Pod to start

  • resourceCleanup int32

    Specify wait time (in minutes) for resources to be deleted

  • snapshotReady int32

    Specify wait time (in minutes) for snapshot to be Ready

  • snapshotCleanup int32

    Specify wait time (in minutes) for snapshot to be deleted

Responses

OK

Schema
  • errorMessage string
  • errorCode int32
Loading...