Skip to navigation

Get a cost estimate for a Kubernetes cluster

Returns the estimated cost for a cluster with the given configuration without creating it. Accepts the same body as create.

Authentication

AuthorizationBearer

API token, for example amcld_.... Create one in the dashboard.

Request

This endpoint expects an object.
namestringRequired
Name of the cluster
regionstringRequired
Region where to deploy the cluster
versionstringRequired

Kubernetes version to use (semantic version)

controlNodesdoubleRequired>=1

Number of control plane nodes: a whole number, 1 or more.

workerNodesdoubleRequired>=1

Number of worker nodes: a whole number, 1 or more.

packagestringOptional
Package label to use for every node in the cluster. Use controlPackage or workerPackage to give one node type a different package. Required unless you send both controlPackage and workerPackage. Leave it out when you send both.
controlPackagestringOptional

Package label for the control-plane nodes. Overrides package.

workerPackagestringOptional
Package label for the worker nodes. Overrides package.
descriptionstringOptional
Description of the cluster
networkIdstringOptionalformat: "uuid"
Network ID to use for the cluster
keypairstringOptional
SSH keypair name to use for cluster nodes

Response

Cost estimate for the Kubernetes cluster
estimatesobject
Cost estimates for the resource
discount_appliedobjectOptional

Discount applied to the estimate (if any)

billing_notestringOptional
Additional billing information or notes about pricing structure
meteredobjectOptional

The usage rate, for a resource that is billed by usage (object storage only).

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error