API reference

Automate Kloude with OpenAPI docs and Terraform guides. Create scoped API keys in Settings, call cluster and networking APIs safely, and keep secrets out of source control.

API reference

For machine-readable HTTP schemas and try-it tooling, use the live OpenAPI documentation hosted with the Kloude API (Scalar UI). This portal guide stays product-focused: how automation fits next to the website you use day to day.

Create personal API keys under Settings → API keys. Permissions are enforced per request (for example clusters: read vs clusters: write). Prefer kubeconfig for interactive cluster work and API keys for Terraform or CI.

Tutorial: prepare automation

1

Create a scoped API key

In the portal open Settings → API keys → Create key. Give least privilege for the resources your tool needs. Store the secret in a vault, not in git, tickets, or screenshots.

2

Open the OpenAPI docs

Use the Open API reference control in the docs header, or open the API /docs URL for your environment.

3

Call product APIs

Typical resources include clusters, regions, sizes, VPCs, SSH keys, IPs, and volumes—the same products you manage in the sidebar.

4

Use Terraform guides when needed

Purpose-built Terraform examples live under /docs/terraform on the same API host.

Rotate and revoke:

Revoke keys when pipelines or people change. Never paste live API keys into public documentation.