Skip to main content

CreateKubernetescluster​

Select

SaaS
Customer Managed

Create Kubernetes cluster

Request Body
  • name string required

    The name of the hypervisor group being created

  • skipCredentialValidation boolean

    Default value: false

    if credential validation has to be skipped.

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

    Display name of the access node

  • type int32

    Type of access node , Ex: 3 - access Node , 28 - Access Node Groups

  • credentials object
  • id int32
  • name string
  • etcdProtection object

    Create an application group etcd (system generated) with pre-defined content

  • enabled boolean

    Denote if etcd protection is enabled

  • plan object
  • id int32
  • name string
  • planEntity object
  • id int32
  • name string
  • enableCloudConfigProtection boolean

    Default value: false

    Protect Cloud Config entities

  • workloadType string
  • workloadRegion object
  • id int32
  • name string
  • hypervisorType string required

    Possible values: [KUBERNETES]

  • endpointurl string

    Endpoint url to connect

  • serviceName string

    Service Name to connect in case authentication mode is service account

  • secretKey string

    SecretKey to connect in case authentication mode is service account. Secret key must be Base64 encoded.

  • userName string

    Username to connect in case authentication mode is Username and password

  • password string

    Username to connect in case authentication mode is Username and password

  • k8ServiceType string

    Possible values: [ONPREM, AZURE, AMAZON]

  • cloudStorage object

    Used to store the cloud storage info of the Kubernetes cluster

  • region object
  • id int32
  • name string
  • storagePool object
  • id int32
  • name string
Responses

Success

Schema
  • clusterId int32
  • warningCode int32
  • errorCode int32
  • clusterName string

    Name of the cluster created

  • errorMessage string

    Response message

  • warningMessage string

    Response message

  • etcdSubclientResponse object[]
  • subclientId int32
  • errorCode int32
  • errorMessage string

    Response message

POST /v4/kubernetes/cluster

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "name": "string",

  "skipCredentialValidation": false,

  "accessNodes": [

    {

      "id": 0,

      "name": "string",

      "displayName": "string",

      "type": 0

    }

  ],

  "credentials": {

    "id": 0,

    "name": "string"

  },

  "etcdProtection": {

    "enabled": true,

    "plan": {

      "id": 0,

      "name": "string"

    }

  },

  "planEntity": {

    "id": 0,

    "name": "string"

  },

  "enableCloudConfigProtection": false,

  "workloadType": "string",

  "workloadRegion": {

    "id": 0,

    "name": "string"

  },

  "hypervisorType": "KUBERNETES",

  "endpointurl": "string",

  "serviceName": "string",

  "secretKey": "string",

  "userName": "string",

  "password": "string",

  "k8ServiceType": "ONPREM",

  "cloudStorage": {

    "region": {

      "id": 0,

      "name": "string"

    },

    "storagePool": {

      "id": 0,

      "name": "string"

    }

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Kubernetes/cluster' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "name": "string",
  "skipCredentialValidation": false,
  "accessNodes": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "type": 0
    }
  ],
  "credentials": {
    "id": 0,
    "name": "string"
  },
  "etcdProtection": {
    "enabled": true,
    "plan": {
      "id": 0,
      "name": "string"
    }
  },
  "planEntity": {
    "id": 0,
    "name": "string"
  },
  "enableCloudConfigProtection": false,
  "workloadType": "string",
  "workloadRegion": {
    "id": 0,
    "name": "string"
  },
  "hypervisorType": "KUBERNETES",
  "endpointurl": "string",
  "serviceName": "string",
  "secretKey": "string",
  "userName": "string",
  "password": "string",
  "k8ServiceType": "ONPREM",
  "cloudStorage": {
    "region": {
      "id": 0,
      "name": "string"
    },
    "storagePool": {
      "id": 0,
      "name": "string"
    }
  }
}'