CreateKubernetescluster

Create Kubernetes cluster

application/json

Request Body

• name string required

  The name of the hypervisor group being created

• skipCredentialValidation boolean

  Default value: true

  if credential validation has to be skipped.

• accessNodes object[] required

  id int32

  name string
• 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
• 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

• 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]

Responses

• 200
• 400
• 500

---

Success

application/json

• Schema
• Example (from schema)

---

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

{
  "clusterId": 0,
  "warningCode": 0,
  "errorCode": 0,
  "clusterName": "string",
  "errorMessage": "string",
  "warningMessage": "string",
  "etcdSubclientResponse": [
    {
      "subclientId": 0,
      "errorCode": 0,
      "errorMessage": "string"
    }
  ]
}

Internal Server Error

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

Internal Server Error

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

POST /v4/kubernetes/cluster    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://localhost/webconsole/api

token

Body

• Default
• Kubernetes

---

{
  "name": "string",
  "skipCredentialValidation": true,
  "accessNodes": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "credentials": {
    "id": 0,
    "name": "string"
  },
  "etcdProtection": {
    "enabled": true,
    "plan": {
      "id": 0,
      "name": "string"
    }
  },
  "planEntity": {
    "id": 0,
    "name": "string"
  },
  "hypervisorType": "KUBERNETES",
  "endpointurl": "string",
  "serviceName": "string",
  "secretKey": "string",
  "userName": "string",
  "password": "string",
  "k8ServiceType": "ONPREM"
}

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

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

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

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

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

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

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