Skip to main content

Documentation Index

Fetch the complete documentation index at: https://akua-1dce587a.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Manage your Akua clusters from the command line. The clusters commands let you inspect cluster state, update configuration, download kubeconfigs, and delete clusters you no longer need. Alias: cnap cl

​
List clusters

cnap clusters list

​
Get cluster details

cnap clusters get <cluster-id>

​
Update a cluster

cnap clusters update <cluster-id> --name "staging"
cnap clusters update <cluster-id> --region <region-id>
FlagDescription
--nameNew cluster name
--regionNew region ID

​
Delete a cluster

cnap clusters delete <cluster-id> --force
The --force flag is required to confirm deletion.

​
Download kubeconfig

# Print to stdout
cnap clusters kubeconfig <cluster-id>

# Write to file (mode 0600)
cnap clusters kubeconfig <cluster-id> -o kubeconfig.yaml
Downloads the admin kubeconfig for a managed cluster. The cluster must be in RUNNING status.
Pipe directly into kubectl: cnap clusters kubeconfig <id> | kubectl --kubeconfig /dev/stdin get nodes

​
API reference

Clusters API

Endpoints, parameters, response shapes, and try-it playground.

Authentication

Mint API tokens for programmatic access.

Clusters

Understand managed and imported cluster types.

Installs

Deploy products and stream logs from the CLI.

Regions

List the regions available for your clusters.

CLI overview

Authentication, output formats, and configuration.