API Reference
Core API
- GETGet an mk8s cluster by name
- DELDelete an mk8s cluster by name
- PATCHPerform a Patch on an mk8s cluster by name
- GETGet all mk8s clusters
- POSTCreate an Mk8s Cluster
- POSTGet all mk8s clusters based on a query
- GETCA root for this cluster
- GETCheck if cluster is deployed
- POSTRetrieve a join shell script.
- POSTRetrieve a cloud-init script
- POSTRetrieve a kubeconfig
- GETGet the access report for an mk8s cluster name
- GETGet available permissions for an mk8s cluster resource type
- GET
Audit API
Create an Mk8s Cluster
Copy
Ask AI
curl --request POST \
--url https://api.cpln.io/org/{org}/mk8s \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"tags": {},
"spec": {
"version": "1.26.0",
"firewall": [
{
"sourceCIDR": "<string>",
"description": "<string>"
}
],
"provider": {
"generic": {
"networking": {
"serviceNetwork": "10.43.0.0/16",
"podNetwork": "10.42.0.0/16",
"dnsForwarder": "<string>"
},
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
]
}
]
},
"hetzner": {
"hetznerLabels": {},
"networking": {
"dnsForwarder": "<string>"
},
"preInstallScript": "<string>",
"tokenSecretLink": "<string>",
"firewallId": "<string>",
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
],
"serverType": "<string>",
"overrideImage": "<string>",
"minSize": 123,
"maxSize": 123
}
],
"dedicatedServerNodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
]
}
],
"image": "ubuntu-20.04",
"sshKey": "<string>",
"autoscaler": {
"expander": [
"random"
],
"unneededTime": "10m",
"unreadyTime": "20m",
"utilizationThreshold": 123
},
"floatingIPSelector": {}
},
"aws": {
"awsTags": {},
"skipCreateRoles": true,
"networking": {
"serviceNetwork": "10.43.0.0/16",
"podNetwork": "10.42.0.0/16",
"dnsForwarder": "<string>"
},
"preInstallScript": "<string>",
"image": {
"recommended": "ubuntu/jammy-22.04",
"exact": "<string>"
},
"deployRoleArn": "<string>",
"deployRoleChain": [
{
"roleArn": "<string>",
"externalId": "<string>",
"sessionNamePrefix": "<string>"
}
],
"keyPair": "<string>",
"diskEncryptionKeyArn": "<string>",
"securityGroupIds": [
"<string>"
],
"extraNodePolicies": [
"<string>"
],
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
],
"instanceTypes": [
"<string>"
],
"overrideImage": {
"recommended": "ubuntu/jammy-22.04",
"exact": "<string>"
},
"bootDiskSize": 123,
"minSize": 123,
"maxSize": 123,
"onDemandBaseCapacity": 123,
"onDemandPercentageAboveBaseCapacity": 123,
"spotAllocationStrategy": "lowest-price",
"subnetIds": [
"<string>"
],
"extraSecurityGroupIds": [
"<string>"
]
}
],
"autoscaler": {
"expander": [
"random"
],
"unneededTime": "10m",
"unreadyTime": "20m",
"utilizationThreshold": 123
}
},
"linode": {
"region": "<string>",
"tokenSecretLink": "<string>",
"firewallId": "<string>",
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
],
"serverType": "<string>",
"overrideImage": "<string>",
"subnetId": "<string>",
"minSize": 123,
"maxSize": 123
}
],
"image": "<string>",
"authorizedUsers": [
"<string>"
],
"authorizedKeys": [
"<string>"
],
"vpcId": "<string>",
"preInstallScript": "<string>",
"networking": {
"dnsForwarder": "<string>"
},
"autoscaler": {
"expander": [
"random"
],
"unneededTime": "10m",
"unreadyTime": "20m",
"utilizationThreshold": 123
}
},
"oblivus": {
"datacenter": "MON1",
"tokenSecretLink": "<string>",
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
],
"minSize": 123,
"maxSize": 123,
"flavor": "A100_NVLINK_80GB_x8"
}
],
"sshKeys": [
"<string>"
],
"unmanagedNodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
]
}
],
"autoscaler": {
"expander": [
"random"
],
"unneededTime": "10m",
"unreadyTime": "20m",
"utilizationThreshold": 123
},
"preInstallScript": "<string>"
},
"lambdalabs": {
"region": "asia-northeast-1",
"tokenSecretLink": "<string>",
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
],
"minSize": 123,
"maxSize": 123,
"instanceType": "cpu_4x_general"
}
],
"sshKey": "<string>",
"unmanagedNodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
]
}
],
"autoscaler": {
"expander": [
"random"
],
"unneededTime": "10m",
"unreadyTime": "20m",
"utilizationThreshold": 123
},
"fileSystems": [
"<string>"
],
"preInstallScript": "<string>"
},
"paperspace": {
"region": "AMS1",
"tokenSecretLink": "<string>",
"sharedDrives": [
"<string>"
],
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
],
"minSize": 123,
"maxSize": 123,
"publicIpType": "none",
"bootDiskSize": 123,
"machineType": "A100"
}
],
"autoscaler": {
"expander": [
"random"
],
"unneededTime": "10m",
"unreadyTime": "20m",
"utilizationThreshold": 123
},
"unmanagedNodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
]
}
],
"preInstallScript": "<string>",
"userIds": [
"<string>"
],
"networkId": "<string>"
},
"ephemeral": {
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
],
"count": 123,
"arch": "any",
"flavor": "debian",
"cpu": "<string>",
"memory": "<string>"
}
]
},
"triton": {
"connection": {
"url": "<string>",
"account": "<string>",
"user": "<string>",
"privateKeySecretLink": "<string>"
},
"networking": {
"dnsForwarder": "<string>"
},
"preInstallScript": "<string>",
"loadBalancer": {
"manual": {
"packageId": "<string>",
"imageId": "<string>",
"publicNetworkId": "<string>",
"privateNetworkIds": [
"<string>"
],
"metadata": {},
"tags": {},
"logging": {
"nodePort": 123,
"externalSyslog": "<string>"
},
"count": 123,
"cnsInternalDomain": "<string>",
"cnsPublicDomain": "<string>"
},
"none": {},
"gateway": {}
},
"firewallEnabled": true,
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
],
"packageId": "<string>",
"overrideImageId": "<string>",
"publicNetworkId": "<string>",
"privateNetworkIds": [
"<string>"
],
"tritonTags": {},
"minSize": 123,
"maxSize": 123
}
],
"imageId": "<string>",
"sshKeys": [
"<string>"
],
"autoscaler": {
"expander": [
"random"
],
"unneededTime": "10m",
"unreadyTime": "20m",
"utilizationThreshold": 123
}
},
"azure": {
"subscriptionId": "<string>",
"sdkSecretLink": "<string>",
"resourceGroup": "<string>",
"networking": {
"serviceNetwork": "10.43.0.0/16",
"podNetwork": "10.42.0.0/16",
"dnsForwarder": "<string>"
},
"preInstallScript": "<string>",
"image": {
"recommended": "ubuntu/noble-24.04",
"reference": {
"publisher": "<string>",
"offer": "<string>",
"sku": "<string>",
"version": "<string>"
}
},
"sshKeys": [
"<string>"
],
"tags": {},
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
],
"size": "<string>",
"subnetId": "<string>",
"zones": [
123
],
"overrideImage": {
"recommended": "ubuntu/noble-24.04",
"reference": {
"publisher": "<string>",
"offer": "<string>",
"sku": "<string>",
"version": "<string>"
}
},
"bootDiskSize": 123,
"minSize": 123,
"maxSize": 123
}
],
"autoscaler": {
"expander": [
"random"
],
"unneededTime": "10m",
"unreadyTime": "20m",
"utilizationThreshold": 123
}
},
"digitalocean": {
"digitalOceanTags": [
"<string>"
],
"networking": {
"dnsForwarder": "<string>"
},
"preInstallScript": "<string>",
"tokenSecretLink": "<string>",
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
],
"dropletSize": "<string>",
"overrideImage": "<string>",
"minSize": 123,
"maxSize": 123
}
],
"image": "<string>",
"sshKeys": [
"<string>"
],
"extraSshKeys": [
"<string>"
],
"autoscaler": {
"expander": [
"random"
],
"unneededTime": "10m",
"unreadyTime": "20m",
"utilizationThreshold": 123
},
"reservedIPs": [
"<string>"
]
},
"gcp": {
"projectId": "<string>",
"labels": {},
"tags": [
"<string>"
],
"metadata": {},
"network": "<string>",
"saKeyLink": "<string>",
"networking": {
"serviceNetwork": "10.43.0.0/16",
"podNetwork": "10.42.0.0/16",
"dnsForwarder": "<string>"
},
"preInstallScript": "<string>",
"image": {
"recommended": "ubuntu/jammy-22.04",
"family": {
"project": "<string>",
"family": "<string>"
},
"exact": "<string>"
},
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
],
"machineType": "<string>",
"assignPublicIP": true,
"zone": "<string>",
"overrideImage": {
"recommended": "ubuntu/jammy-22.04",
"family": {
"project": "<string>",
"family": "<string>"
},
"exact": "<string>"
},
"bootDiskSize": 123,
"minSize": 123,
"maxSize": 123,
"preemptible": true,
"subnet": "<string>",
"localPersistentDisks": 123
}
],
"autoscaler": {
"expander": [
"random"
],
"unneededTime": "10m",
"unreadyTime": "20m",
"utilizationThreshold": 123
}
}
},
"addOns": {
"dashboard": {},
"headlamp": {},
"azureWorkloadIdentity": {
"tenantId": "<string>"
},
"awsWorkloadIdentity": {},
"localPathStorage": {},
"metrics": {
"kubeState": true,
"coreDns": true,
"kubelet": true,
"apiserver": true,
"nodeExporter": true,
"cadvisor": true,
"scrapeAnnotated": {
"intervalSeconds": 123,
"includeNamespaces": "<string>",
"excludeNamespaces": "<string>",
"retainLabels": "<string>"
}
},
"logs": {
"auditEnabled": true,
"includeNamespaces": "<string>",
"excludeNamespaces": "<string>",
"docker": true,
"kubelet": true,
"kernel": true,
"events": true
},
"registryMirror": {
"mirrors": [
{
"registry": "<string>",
"mirrors": [
"<string>"
]
}
]
},
"nvidia": {
"taintGPUNodes": true
},
"awsEFS": {
"roleArn": "<string>"
},
"awsECR": {
"roleArn": "<string>"
},
"awsELB": {
"roleArn": "<string>"
},
"azureACR": {
"clientId": "<string>"
},
"sysbox": {},
"byok": {
"ignoreUpdates": true,
"location": "<string>",
"config": {
"actuator": {
"minCpu": "<string>",
"maxCpu": "<string>",
"minMemory": "<string>",
"maxMemory": "<string>",
"logLevel": "trace",
"env": {}
},
"middlebox": {
"enabled": true,
"bandwidthAlertMbps": 123
},
"common": {
"deploymentReplicas": 123,
"pdb": {
"maxUnavailable": 123
}
},
"longhorn": {
"replicas": 123
},
"ingress": {
"cpu": "<string>",
"memory": "<string>",
"targetPercent": 123
},
"istio": {
"istiod": {
"replicas": 123,
"minCpu": "<string>",
"maxCpu": "<string>",
"minMemory": "<string>",
"maxMemory": "<string>",
"pdb": 123
},
"ingressgateway": {
"replicas": 123,
"maxCpu": "<string>",
"maxMemory": "<string>"
},
"sidecar": {
"minCpu": "<string>",
"minMemory": "<string>"
}
},
"logSplitter": {
"minCpu": "<string>",
"maxCpu": "<string>",
"minMemory": "<string>",
"maxMemory": "<string>",
"memBufferSize": "<string>",
"perPodRate": 123
},
"monitoring": {
"minMemory": "<string>",
"maxMemory": "<string>",
"kubeStateMetrics": {
"minMemory": "<string>"
},
"prometheus": {
"main": {
"storage": "<string>"
}
}
},
"redis": {
"minCpu": "<string>",
"maxCpu": "<string>",
"minMemory": "<string>",
"maxMemory": "<string>",
"storage": "<string>"
},
"redisHa": {
"minCpu": "<string>",
"maxCpu": "<string>",
"minMemory": "<string>",
"maxMemory": "<string>",
"storage": 123
},
"redisSentinel": {
"minCpu": "<string>",
"maxCpu": "<string>",
"minMemory": "<string>",
"maxMemory": "<string>",
"storage": 123
},
"tempoAgent": {
"minCpu": "<string>",
"minMemory": "<string>"
},
"internalDns": {
"minCpu": "<string>",
"maxCpu": "<string>",
"minMemory": "<string>",
"maxMemory": "<string>"
}
}
}
}
},
"alias": "<string>"
}
'Copy
Ask AI
{
"status": 123,
"message": "<string>",
"code": "<string>",
"details": {},
"id": "<string>"
}Managed Kubernetes (mk8s)
Create an Mk8s Cluster
POST
/
org
/
{org}
/
mk8s
Create an Mk8s Cluster
Copy
Ask AI
curl --request POST \
--url https://api.cpln.io/org/{org}/mk8s \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"tags": {},
"spec": {
"version": "1.26.0",
"firewall": [
{
"sourceCIDR": "<string>",
"description": "<string>"
}
],
"provider": {
"generic": {
"networking": {
"serviceNetwork": "10.43.0.0/16",
"podNetwork": "10.42.0.0/16",
"dnsForwarder": "<string>"
},
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
]
}
]
},
"hetzner": {
"hetznerLabels": {},
"networking": {
"dnsForwarder": "<string>"
},
"preInstallScript": "<string>",
"tokenSecretLink": "<string>",
"firewallId": "<string>",
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
],
"serverType": "<string>",
"overrideImage": "<string>",
"minSize": 123,
"maxSize": 123
}
],
"dedicatedServerNodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
]
}
],
"image": "ubuntu-20.04",
"sshKey": "<string>",
"autoscaler": {
"expander": [
"random"
],
"unneededTime": "10m",
"unreadyTime": "20m",
"utilizationThreshold": 123
},
"floatingIPSelector": {}
},
"aws": {
"awsTags": {},
"skipCreateRoles": true,
"networking": {
"serviceNetwork": "10.43.0.0/16",
"podNetwork": "10.42.0.0/16",
"dnsForwarder": "<string>"
},
"preInstallScript": "<string>",
"image": {
"recommended": "ubuntu/jammy-22.04",
"exact": "<string>"
},
"deployRoleArn": "<string>",
"deployRoleChain": [
{
"roleArn": "<string>",
"externalId": "<string>",
"sessionNamePrefix": "<string>"
}
],
"keyPair": "<string>",
"diskEncryptionKeyArn": "<string>",
"securityGroupIds": [
"<string>"
],
"extraNodePolicies": [
"<string>"
],
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
],
"instanceTypes": [
"<string>"
],
"overrideImage": {
"recommended": "ubuntu/jammy-22.04",
"exact": "<string>"
},
"bootDiskSize": 123,
"minSize": 123,
"maxSize": 123,
"onDemandBaseCapacity": 123,
"onDemandPercentageAboveBaseCapacity": 123,
"spotAllocationStrategy": "lowest-price",
"subnetIds": [
"<string>"
],
"extraSecurityGroupIds": [
"<string>"
]
}
],
"autoscaler": {
"expander": [
"random"
],
"unneededTime": "10m",
"unreadyTime": "20m",
"utilizationThreshold": 123
}
},
"linode": {
"region": "<string>",
"tokenSecretLink": "<string>",
"firewallId": "<string>",
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
],
"serverType": "<string>",
"overrideImage": "<string>",
"subnetId": "<string>",
"minSize": 123,
"maxSize": 123
}
],
"image": "<string>",
"authorizedUsers": [
"<string>"
],
"authorizedKeys": [
"<string>"
],
"vpcId": "<string>",
"preInstallScript": "<string>",
"networking": {
"dnsForwarder": "<string>"
},
"autoscaler": {
"expander": [
"random"
],
"unneededTime": "10m",
"unreadyTime": "20m",
"utilizationThreshold": 123
}
},
"oblivus": {
"datacenter": "MON1",
"tokenSecretLink": "<string>",
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
],
"minSize": 123,
"maxSize": 123,
"flavor": "A100_NVLINK_80GB_x8"
}
],
"sshKeys": [
"<string>"
],
"unmanagedNodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
]
}
],
"autoscaler": {
"expander": [
"random"
],
"unneededTime": "10m",
"unreadyTime": "20m",
"utilizationThreshold": 123
},
"preInstallScript": "<string>"
},
"lambdalabs": {
"region": "asia-northeast-1",
"tokenSecretLink": "<string>",
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
],
"minSize": 123,
"maxSize": 123,
"instanceType": "cpu_4x_general"
}
],
"sshKey": "<string>",
"unmanagedNodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
]
}
],
"autoscaler": {
"expander": [
"random"
],
"unneededTime": "10m",
"unreadyTime": "20m",
"utilizationThreshold": 123
},
"fileSystems": [
"<string>"
],
"preInstallScript": "<string>"
},
"paperspace": {
"region": "AMS1",
"tokenSecretLink": "<string>",
"sharedDrives": [
"<string>"
],
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
],
"minSize": 123,
"maxSize": 123,
"publicIpType": "none",
"bootDiskSize": 123,
"machineType": "A100"
}
],
"autoscaler": {
"expander": [
"random"
],
"unneededTime": "10m",
"unreadyTime": "20m",
"utilizationThreshold": 123
},
"unmanagedNodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
]
}
],
"preInstallScript": "<string>",
"userIds": [
"<string>"
],
"networkId": "<string>"
},
"ephemeral": {
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
],
"count": 123,
"arch": "any",
"flavor": "debian",
"cpu": "<string>",
"memory": "<string>"
}
]
},
"triton": {
"connection": {
"url": "<string>",
"account": "<string>",
"user": "<string>",
"privateKeySecretLink": "<string>"
},
"networking": {
"dnsForwarder": "<string>"
},
"preInstallScript": "<string>",
"loadBalancer": {
"manual": {
"packageId": "<string>",
"imageId": "<string>",
"publicNetworkId": "<string>",
"privateNetworkIds": [
"<string>"
],
"metadata": {},
"tags": {},
"logging": {
"nodePort": 123,
"externalSyslog": "<string>"
},
"count": 123,
"cnsInternalDomain": "<string>",
"cnsPublicDomain": "<string>"
},
"none": {},
"gateway": {}
},
"firewallEnabled": true,
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
],
"packageId": "<string>",
"overrideImageId": "<string>",
"publicNetworkId": "<string>",
"privateNetworkIds": [
"<string>"
],
"tritonTags": {},
"minSize": 123,
"maxSize": 123
}
],
"imageId": "<string>",
"sshKeys": [
"<string>"
],
"autoscaler": {
"expander": [
"random"
],
"unneededTime": "10m",
"unreadyTime": "20m",
"utilizationThreshold": 123
}
},
"azure": {
"subscriptionId": "<string>",
"sdkSecretLink": "<string>",
"resourceGroup": "<string>",
"networking": {
"serviceNetwork": "10.43.0.0/16",
"podNetwork": "10.42.0.0/16",
"dnsForwarder": "<string>"
},
"preInstallScript": "<string>",
"image": {
"recommended": "ubuntu/noble-24.04",
"reference": {
"publisher": "<string>",
"offer": "<string>",
"sku": "<string>",
"version": "<string>"
}
},
"sshKeys": [
"<string>"
],
"tags": {},
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
],
"size": "<string>",
"subnetId": "<string>",
"zones": [
123
],
"overrideImage": {
"recommended": "ubuntu/noble-24.04",
"reference": {
"publisher": "<string>",
"offer": "<string>",
"sku": "<string>",
"version": "<string>"
}
},
"bootDiskSize": 123,
"minSize": 123,
"maxSize": 123
}
],
"autoscaler": {
"expander": [
"random"
],
"unneededTime": "10m",
"unreadyTime": "20m",
"utilizationThreshold": 123
}
},
"digitalocean": {
"digitalOceanTags": [
"<string>"
],
"networking": {
"dnsForwarder": "<string>"
},
"preInstallScript": "<string>",
"tokenSecretLink": "<string>",
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
],
"dropletSize": "<string>",
"overrideImage": "<string>",
"minSize": 123,
"maxSize": 123
}
],
"image": "<string>",
"sshKeys": [
"<string>"
],
"extraSshKeys": [
"<string>"
],
"autoscaler": {
"expander": [
"random"
],
"unneededTime": "10m",
"unreadyTime": "20m",
"utilizationThreshold": 123
},
"reservedIPs": [
"<string>"
]
},
"gcp": {
"projectId": "<string>",
"labels": {},
"tags": [
"<string>"
],
"metadata": {},
"network": "<string>",
"saKeyLink": "<string>",
"networking": {
"serviceNetwork": "10.43.0.0/16",
"podNetwork": "10.42.0.0/16",
"dnsForwarder": "<string>"
},
"preInstallScript": "<string>",
"image": {
"recommended": "ubuntu/jammy-22.04",
"family": {
"project": "<string>",
"family": "<string>"
},
"exact": "<string>"
},
"nodePools": [
{
"name": "<string>",
"labels": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "NoSchedule"
}
],
"machineType": "<string>",
"assignPublicIP": true,
"zone": "<string>",
"overrideImage": {
"recommended": "ubuntu/jammy-22.04",
"family": {
"project": "<string>",
"family": "<string>"
},
"exact": "<string>"
},
"bootDiskSize": 123,
"minSize": 123,
"maxSize": 123,
"preemptible": true,
"subnet": "<string>",
"localPersistentDisks": 123
}
],
"autoscaler": {
"expander": [
"random"
],
"unneededTime": "10m",
"unreadyTime": "20m",
"utilizationThreshold": 123
}
}
},
"addOns": {
"dashboard": {},
"headlamp": {},
"azureWorkloadIdentity": {
"tenantId": "<string>"
},
"awsWorkloadIdentity": {},
"localPathStorage": {},
"metrics": {
"kubeState": true,
"coreDns": true,
"kubelet": true,
"apiserver": true,
"nodeExporter": true,
"cadvisor": true,
"scrapeAnnotated": {
"intervalSeconds": 123,
"includeNamespaces": "<string>",
"excludeNamespaces": "<string>",
"retainLabels": "<string>"
}
},
"logs": {
"auditEnabled": true,
"includeNamespaces": "<string>",
"excludeNamespaces": "<string>",
"docker": true,
"kubelet": true,
"kernel": true,
"events": true
},
"registryMirror": {
"mirrors": [
{
"registry": "<string>",
"mirrors": [
"<string>"
]
}
]
},
"nvidia": {
"taintGPUNodes": true
},
"awsEFS": {
"roleArn": "<string>"
},
"awsECR": {
"roleArn": "<string>"
},
"awsELB": {
"roleArn": "<string>"
},
"azureACR": {
"clientId": "<string>"
},
"sysbox": {},
"byok": {
"ignoreUpdates": true,
"location": "<string>",
"config": {
"actuator": {
"minCpu": "<string>",
"maxCpu": "<string>",
"minMemory": "<string>",
"maxMemory": "<string>",
"logLevel": "trace",
"env": {}
},
"middlebox": {
"enabled": true,
"bandwidthAlertMbps": 123
},
"common": {
"deploymentReplicas": 123,
"pdb": {
"maxUnavailable": 123
}
},
"longhorn": {
"replicas": 123
},
"ingress": {
"cpu": "<string>",
"memory": "<string>",
"targetPercent": 123
},
"istio": {
"istiod": {
"replicas": 123,
"minCpu": "<string>",
"maxCpu": "<string>",
"minMemory": "<string>",
"maxMemory": "<string>",
"pdb": 123
},
"ingressgateway": {
"replicas": 123,
"maxCpu": "<string>",
"maxMemory": "<string>"
},
"sidecar": {
"minCpu": "<string>",
"minMemory": "<string>"
}
},
"logSplitter": {
"minCpu": "<string>",
"maxCpu": "<string>",
"minMemory": "<string>",
"maxMemory": "<string>",
"memBufferSize": "<string>",
"perPodRate": 123
},
"monitoring": {
"minMemory": "<string>",
"maxMemory": "<string>",
"kubeStateMetrics": {
"minMemory": "<string>"
},
"prometheus": {
"main": {
"storage": "<string>"
}
}
},
"redis": {
"minCpu": "<string>",
"maxCpu": "<string>",
"minMemory": "<string>",
"maxMemory": "<string>",
"storage": "<string>"
},
"redisHa": {
"minCpu": "<string>",
"maxCpu": "<string>",
"minMemory": "<string>",
"maxMemory": "<string>",
"storage": 123
},
"redisSentinel": {
"minCpu": "<string>",
"maxCpu": "<string>",
"minMemory": "<string>",
"maxMemory": "<string>",
"storage": 123
},
"tempoAgent": {
"minCpu": "<string>",
"minMemory": "<string>"
},
"internalDns": {
"minCpu": "<string>",
"maxCpu": "<string>",
"minMemory": "<string>",
"maxMemory": "<string>"
}
}
}
}
},
"alias": "<string>"
}
'Copy
Ask AI
{
"status": 123,
"message": "<string>",
"code": "<string>",
"details": {},
"id": "<string>"
}Authorizations
Service account key can be used as API keys
Path Parameters
Body
application/json
Maximum string length:
250Show child attributes
Show child attributes
Available options:
1.26.0, 1.26.4, 1.27.3, 1.28.2, 1.28.4, 1.29.7, 1.30.3, 1.31.5, 1.31.13, 1.32.1, 1.32.9, 1.33.5 Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The CIDR of the service network
Available options:
10.43.0.0/16, 192.168.0.0/16 The CIDR of the pod network
Available options:
10.42.0.0/16, 172.16.0.0/15, 172.18.0.0/15, 172.20.0.0/15, 172.22.0.0/15, 172.24.0.0/15, 172.26.0.0/15, 172.28.0.0/15, 172.30.0.0/15 DNS forwarder used by the cluster. Can be a space-delimited list of dns servers. Default is /etc/resolv.conf when not specified.
Maximum string length:
100Show child attributes
Show child attributes
Maximum string length:
63Labels to attach to nodes of a node pool
Show child attributes
Show child attributes
Extra labels to attach to servers
Optional shell script that will be run before K8S is installed
Link to a secret holding Hetzner access key
Optional firewall rule to attach to all nodes
List of node pools
Show child attributes
Show child attributes
Maximum string length:
63Labels to attach to nodes of a node pool
Node pools that can configure dedicated Hetzner servers
Show child attributes
Show child attributes
Maximum string length:
63Labels to attach to nodes of a node pool
Taints for the nodes of a pool
Default image for all nodes
SSH key name for accessing deployed nodes
Show child attributes
Show child attributes
If supplied, nodes will get assigned a random floating ip matching the selector
Show child attributes
Show child attributes
Extra tags to attach to all created objects
If true, Control Plane will not create any roles
Show child attributes
Show child attributes
Available options:
10.43.0.0/16, 192.168.0.0/16 Available options:
vpc, 10.42.0.0/16, 172.16.0.0/15, 172.18.0.0/15, 172.20.0.0/15, 172.22.0.0/15, 172.24.0.0/15, 172.26.0.0/15, 172.28.0.0/15, 172.30.0.0/15 DNS forwarder used by the cluster. Can be a space-delimited list of dns servers. Default is /etc/resolv.conf when not specified.
Maximum string length:
100Optional shell script that will be run before K8S is installed. Supports SSM
Default image for all nodes.
Show child attributes
Show child attributes
Available options:
ubuntu/jammy-22.04, ubuntu/jammy-22.04+nvidia, ubuntu/focal-20.04, ubuntu/focal-20.04+nvidia, ubuntu/noble-24.04, ubuntu/noble-24.04+nvidia, ubuntu/bionic-18.04, amazon/amzn2, amazon/al2023 Support SSM
Control Plane will set up the cluster by assuming this role
Name of keyPair. Supports SSM
KMS key used to encrypt volumes. Supports SSM.
Security groups to deploy nodes to. Security groups control if the cluster is multi-zone or single-zon
Supports SSM.
Show child attributes
Show child attributes
Maximum string length:
63Labels to attach to nodes of a node pool
Show child attributes
Show child attributes
Available options:
ubuntu/jammy-22.04, ubuntu/jammy-22.04+nvidia, ubuntu/focal-20.04, ubuntu/focal-20.04+nvidia, ubuntu/noble-24.04, ubuntu/noble-24.04+nvidia, ubuntu/bionic-18.04, amazon/amzn2, amazon/al2023 Support SSM
size in GB
Available options:
lowest-price, capacity-optimized, capacity-optimized-prioritized, price-capacity-optimized Supports SSM.
Supports SSM.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum string length:
63Labels to attach to nodes of a node pool
Optional shell script that will be run before K8S is installed
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
MON1, OSL1 Show child attributes
Show child attributes
Maximum string length:
63Labels to attach to nodes of a node pool
Available options:
A100_NVLINK_80GB_x8, A100_PCIE_80GB_x1, A100_PCIE_80GB_x2, A100_PCIE_80GB_x4, A100_PCIE_80GB_x8, H100_NVLINK_80GB_x8, H100_PCIE_80GB_x1, H100_PCIE_80GB_x2, H100_PCIE_80GB_x4, H100_PCIE_80GB_x8, INTEL_XEON_V3_x16, INTEL_XEON_V3_x4, INTEL_XEON_V3_x8, L40_x1, L40_x2, L40_x4, L40_x8, RTX_A4000_x1, RTX_A4000_x2, RTX_A4000_x4, RTX_A4000_x8, RTX_A5000_x1, RTX_A5000_x2, RTX_A5000_x4, RTX_A5000_x8, RTX_A6000_x1, RTX_A6000_x2, RTX_A6000_x4, RTX_A6000_x8 Show child attributes
Show child attributes
Maximum string length:
63Labels to attach to nodes of a node pool
Show child attributes
Show child attributes
Optional shell script that will be run before K8S is installed
Show child attributes
Show child attributes
Available options:
asia-northeast-1, asia-northeast-2, asia-south-1, australia-southeast-1, europe-central-1, europe-south-1, me-west-1, us-east-1, us-midwest-1, us-south-1, us-west-1, us-west-2, us-west-3 Show child attributes
Show child attributes
Maximum string length:
63Labels to attach to nodes of a node pool
Available options:
cpu_4x_general, gpu_1x_a10, gpu_1x_a100, gpu_1x_a100_sxm4, gpu_1x_a6000, gpu_1x_h100_pcie, gpu_1x_rtx6000, gpu_2x_a100, gpu_2x_a6000, gpu_4x_a100, gpu_4x_a6000, gpu_8x_a100, gpu_8x_a100_80gb_sxm4, gpu_8x_h100_sxm5, gpu_8x_v100 Show child attributes
Show child attributes
Maximum string length:
63Labels to attach to nodes of a node pool
Taints for the nodes of a pool
Show child attributes
Show child attributes
Available options:
random, most-pods, least-waste, price Optional shell script that will be run before K8S is installed
Show child attributes
Show child attributes
Available options:
AMS1, NY2, CA1 Show child attributes
Show child attributes
Maximum string length:
63Labels to attach to nodes of a node pool
Available options:
none, dynamic, static Available options:
A100, A100-80G, A100-80Gx2, A100-80Gx4, A100-80Gx8, A100x2, A100x4, A100x8, A4000, A4000x2, A4000x4, A5000, A5000x2, A5000x4, A6000, A6000x2, A6000x4, C10, C2, C3, C4, C5, C6, C7, C8, C9, GPU+, P4000, P4000x2, P4000x4, P5000, P5000x2, P6000, P6000x2, RTX4000, RTX5000, RTX5000x2, V100, V100-32G, V100-32Gx2, V100-32Gx4 Show child attributes
Show child attributes
Available options:
random, most-pods, least-waste, price Show child attributes
Show child attributes
Maximum string length:
63Labels to attach to nodes of a node pool
Taints for the nodes of a pool
Optional shell script that will be run before K8S is installed
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum string length:
63Labels to attach to nodes of a node pool
Number of nodes to deploy
CPU architecture of the nodes
Available options:
any, arm64, amd64 Linux distro to use for ephemeral nodes
Available options:
debian, ubuntu, fedora Allocated CPU
Maximum string length:
20Allocated memory
Maximum string length:
20Show child attributes
Show child attributes
Optional shell script that will be run before K8S is installed
Show child attributes
Show child attributes
Show child attributes
Show child attributes
If set, machine will also get a public IP
More private networks to join
Extra tags to attach to instances from a node pool
Extra tags to attach to instances from a node pool
Enable firewall for the instances deployed
List of node pools
Show child attributes
Show child attributes
Maximum string length:
63Labels to attach to nodes of a node pool
If set, machine will also get a public IP
More private networks to join
Extra tags to attach to instances from a node pool
Default image for all nodes
Extra SSH keys to provision for user root
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Link to an opaque secret
Show child attributes
Show child attributes
Available options:
10.43.0.0/16, 192.168.0.0/16 Available options:
10.42.0.0/16, 172.16.0.0/15, 172.18.0.0/15, 172.20.0.0/15, 172.22.0.0/15, 172.24.0.0/15, 172.26.0.0/15, 172.28.0.0/15, 172.30.0.0/15 DNS forwarder used by the cluster. Can be a space-delimited list of dns servers. Default is /etc/resolv.conf when not specified.
Maximum string length:
100Optional shell script that will be run before K8S is installed. Supports SSM
Default image for all nodes.
Show child attributes
Show child attributes
Available options:
ubuntu/noble-24.04, ubuntu/jammy-22.04, ubuntu/focal-20.04, debian/bookworm-12, debian/bullseye-11 SSH keys to install for "azureuser" linux user
Extra tags to attach to all created objects
Show child attributes
Show child attributes
Maximum string length:
63Labels to attach to nodes of a node pool
Show child attributes
Show child attributes
Available options:
ubuntu/noble-24.04, ubuntu/jammy-22.04, ubuntu/focal-20.04, debian/bookworm-12, debian/bullseye-11 size in GB
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Extra tags to attach to droplets
Maximum string length:
254Optional shell script that will be run before K8S is installed
Link to a secret holding personal access token
List of node pools
Show child attributes
Show child attributes
Maximum string length:
63Labels to attach to nodes of a node pool
Default image for all nodes
SSH key name for accessing deployed nodes
Extra SSH keys to provision for user root that are not registered in the DigitalOcean
Show child attributes
Show child attributes
Available options:
random, most-pods, least-waste, price Optional set of IPs to assign as extra IPs for nodes of the cluster
Show child attributes
Show child attributes
Extra tags to attach to all created objects
Maximum string length:
63Link to a GCP secret containing the SA json key
Show child attributes
Show child attributes
Available options:
10.43.0.0/16, 192.168.0.0/16 Available options:
vpc, 10.42.0.0/16, 172.16.0.0/15, 172.18.0.0/15, 172.20.0.0/15, 172.22.0.0/15, 172.24.0.0/15, 172.26.0.0/15, 172.28.0.0/15, 172.30.0.0/15 DNS forwarder used by the cluster. Can be a space-delimited list of dns servers. Default is /etc/resolv.conf when not specified.
Maximum string length:
100Optional shell script that will be run before K8S is installed
Default image for all nodes.
Show child attributes
Show child attributes
Available options:
ubuntu/jammy-22.04, ubuntu/noble-24.04, debian/bookworm-12, debian/trixie-13, google/cos-stable Show child attributes
Show child attributes
Maximum string length:
63Labels to attach to nodes of a node pool
Show child attributes
Show child attributes
Available options:
ubuntu/jammy-22.04, ubuntu/noble-24.04, debian/bookworm-12, debian/trixie-13, google/cos-stable size in GB
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Enable kube-state metrics
Enable scraping of core-dns service
Enable scraping kubelet stats
Enable scraping apiserver stats
Enable collecting node-level stats (disk, network, filesystem, etc)
Enable CNI-level container stats
Scrape pods annotated with prometheus.io/scrape=true
Show child attributes
Show child attributes
Collect k8s audit log as log events
Collect docker logs if docker is also running
Collect kubelet logs from journald
Collect kernel logs
Collect K8S events from all namespaces
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum string length:
20Maximum string length:
20Maximum string length:
20Maximum string length:
20Available options:
trace, info, error Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum string length:
20Maximum string length:
20Maximum string length:
20Maximum string length:
20Show child attributes
Show child attributes
Maximum string length:
20Maximum string length:
20Maximum string length:
20Maximum string length:
20Show child attributes
Show child attributes
Maximum string length:
20Maximum string length:
20Show child attributes
Show child attributes
Maximum string length:
20Maximum string length:
20Maximum string length:
20Maximum string length:
20Maximum string length:
20Show child attributes
Show child attributes
Maximum string length:
20Maximum string length:
20Maximum string length:
20Maximum string length:
20Show child attributes
Show child attributes
Maximum string length:
20Maximum string length:
20Maximum string length:
20Maximum string length:
20Show child attributes
Show child attributes
Maximum string length:
20Maximum string length:
20Maximum string length:
20Maximum string length:
20Response
Mk8s Cluster was created successfully
⌘I