Kubernetes

Managed Kubernetes clusters — create, list, scale, start/stop and destroy. Lifecycle operations are asynchronous; poll List Cluster for the cluster state.

Resource base path: /restapi/kubernetes

Method	Path	Description
`POST`	`/restapi/kubernetes/createKubernetes`	Create Kubernetes
`GET`	`/restapi/kubernetes/listCluster`	List Cluster
`GET`	`/restapi/kubernetes/listNodes`	List Nodes
`PUT`	`/restapi/kubernetes/startKubernetes`	Start Kubernetes
`PUT`	`/restapi/kubernetes/stopKubernetes`	Stop Kubernetes
`PUT`	`/restapi/kubernetes/scaleKubernetes`	Scale Kubernetes
`DELETE`	`/restapi/kubernetes/destroyKubernetes`	Destroy Kubernetes

note

apikey and secretkey are required HTTP headers on every request and are omitted from the parameter tables below. See Authentication.

Create Kubernetes

Create Kubernetes.

POST /restapi/kubernetes/createKubernetes

Request body

Field	Type	Required	Description
`dockerRegistryUsername`	string	No
`dockerRegistryUrl`	string	No
`kubernetesSupportedVersionUuid`	string	No
`domainUuid`	string	No
`controlNodes`	integer (int64)	No
`zoneUuid`	string	No	UUID of the zone the resource belongs to.
`description`	string	No	Human-readable description.
`dockerRegistryPassword`	string	No
`computeOfferingUuid`	string	No	UUID of the compute offering.
`transNetworkUuid`	string	No
`haEnabled`	boolean	No
`sshKeyName`	string	No	Name of the SSH key pair.
`nodeRootDiskSize`	integer (int64)	No
`size`	integer (int64)	No
`externalLoadbalancerIpaddress`	string	No
`name`	string	No	Name of the resource.

{
  "dockerRegistryUsername": "example-name",
  "dockerRegistryUrl": "string",
  "kubernetesSupportedVersionUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "domainUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "controlNodes": 1,
  "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "description": "string",
  "dockerRegistryPassword": "string",
  "computeOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "transNetworkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "haEnabled": true,
  "sshKeyName": "example-name",
  "nodeRootDiskSize": 1,
  "size": 1,
  "externalLoadbalancerIpaddress": "string",
  "name": "example-name"
}

Example request

curl -X POST \
  "https://portal.your-domain.com/restapi/kubernetes/createKubernetes" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "dockerRegistryUsername": "example-name",
  "dockerRegistryUrl": "string",
  "kubernetesSupportedVersionUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "domainUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "controlNodes": 1,
  "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "description": "string",
  "dockerRegistryPassword": "string",
  "computeOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "transNetworkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "haEnabled": true,
  "sshKeyName": "example-name",
  "nodeRootDiskSize": 1,
  "size": 1,
  "externalLoadbalancerIpaddress": "string",
  "name": "example-name"
}'

Responses

Code	Description
`200`	Successful operation.
`401`	Invalid authentication credentials.
`550`	Permission denied.

{
  "nodeRootDiskSize": 1,
  "size": 1,
  "controlNodes": 1,
  "externalLoadbalancerIpaddress": "string",
  "name": "example-name",
  "description": "string",
  "state": "Running",
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "transNetworkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

List Cluster

List Cluster.

GET /restapi/kubernetes/listCluster

Parameters

Parameter	In	Type	Required	Description
`clusterUuid`	query	string	No	UUID of the Kubernetes cluster.

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/kubernetes/listCluster" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
`200`	Successful operation.
`401`	Invalid authentication credentials.
`550`	Permission denied.

[
  {
    "nodeRootDiskSize": 1,
    "size": 1,
    "controlNodes": 1,
    "externalLoadbalancerIpaddress": "string",
    "name": "example-name",
    "description": "string",
    "state": "Running",
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "transNetworkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
]

List Nodes

List Nodes.

GET /restapi/kubernetes/listNodes

Parameters

Parameter	In	Type	Required	Description
`clusterUuid`	query	string	✅ Yes	UUID of the Kubernetes cluster.

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/kubernetes/listNodes?clusterUuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
`200`	Successful operation.
`401`	Invalid authentication credentials.
`550`	Permission denied.

{
  "listInstanceResponse": [
    {
      "templateUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "instanceOwnerName": "example-name",
      "memory": "string",
      "displayName": "example-name",
      "rootDiskSize": 1,
      "networkName": "example-name",
      "zoneUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "sshUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "description": "string",
      "computeOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "volumeSize": "string",
      "diskSize": 1,
      "templateName": "example-name",
      "name": "example-name",
      "state": "Running",
      "instancePrivateIp": "string",
      "networkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "storageOfferingUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "cpuCore": "string",
      "status": "Active"
    }
  ],
  "count": 1
}

Start Kubernetes

Start Kubernetes.

PUT /restapi/kubernetes/startKubernetes

Parameters

Parameter	In	Type	Required	Description
`uuid`	query	string	✅ Yes	UUID of the resource.

Example request

curl -X PUT \
  "https://portal.your-domain.com/restapi/kubernetes/startKubernetes?uuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
`200`	Successful operation.
`401`	Invalid authentication credentials.
`550`	Permission denied.

{
  "nodeRootDiskSize": 1,
  "size": 1,
  "controlNodes": 1,
  "externalLoadbalancerIpaddress": "string",
  "name": "example-name",
  "description": "string",
  "state": "Running",
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "transNetworkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Stop Kubernetes

Stop Kubernetes.

PUT /restapi/kubernetes/stopKubernetes

Parameters

Parameter	In	Type	Required	Description
`uuid`	query	string	✅ Yes	UUID of the resource.

Example request

curl -X PUT \
  "https://portal.your-domain.com/restapi/kubernetes/stopKubernetes?uuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
`200`	Successful operation.
`401`	Invalid authentication credentials.
`550`	Permission denied.

{
  "nodeRootDiskSize": 1,
  "size": 1,
  "controlNodes": 1,
  "externalLoadbalancerIpaddress": "string",
  "name": "example-name",
  "description": "string",
  "state": "Running",
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "transNetworkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Scale Kubernetes

Scale Kubernetes.

PUT /restapi/kubernetes/scaleKubernetes

Parameters

Parameter	In	Type	Required	Description
`uuid`	query	string	✅ Yes	UUID of the resource.
`autoscalingEnabled`	query	boolean	✅ Yes
`size`	query	integer (int64)	✅ Yes

Example request

curl -X PUT \
  "https://portal.your-domain.com/restapi/kubernetes/scaleKubernetes?uuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890&autoscalingEnabled=VALUE&size=VALUE" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
`200`	Successful operation.
`401`	Invalid authentication credentials.
`550`	Permission denied.

{
  "nodeRootDiskSize": 1,
  "size": 1,
  "controlNodes": 1,
  "externalLoadbalancerIpaddress": "string",
  "name": "example-name",
  "description": "string",
  "state": "Running",
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "transNetworkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Destroy Kubernetes

Destroy Kubernetes.

DELETE /restapi/kubernetes/destroyKubernetes

Parameters

Parameter	In	Type	Required	Description
`uuid`	query	string	✅ Yes	UUID of the resource.

Example request

curl -X DELETE \
  "https://portal.your-domain.com/restapi/kubernetes/destroyKubernetes?uuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
`200`	Successful operation.
`401`	Invalid authentication credentials.
`550`	Permission denied.

{
  "nodeRootDiskSize": 1,
  "size": 1,
  "controlNodes": 1,
  "externalLoadbalancerIpaddress": "string",
  "name": "example-name",
  "description": "string",
  "state": "Running",
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "transNetworkUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Create Kubernetes​

Request body​

Example request​

Responses​

List Cluster​

Parameters​

Example request​

Responses​

List Nodes​

Parameters​

Example request​

Responses​

Start Kubernetes​

Parameters​

Example request​

Responses​

Stop Kubernetes​

Parameters​

Example request​

Responses​

Scale Kubernetes​

Parameters​

Example request​

Responses​

Destroy Kubernetes​

Parameters​

Example request​

Responses​

Create Kubernetes

Request body

Example request

Responses

List Cluster

Parameters

Example request

Responses

List Nodes

Parameters

Example request

Responses

Start Kubernetes

Parameters

Example request

Responses

Stop Kubernetes

Parameters

Example request

Responses

Scale Kubernetes

Parameters

Example request

Responses

Destroy Kubernetes

Parameters

Example request

Responses