> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://americancloud.com/docs/api/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://americancloud.com/docs/api/_mcp/server.

# Welcome

# American Cloud API

The American Cloud public API gives you programmatic access to every resource you can manage from the dashboard — virtual machines, block and object storage, snapshots, networks, firewall rules, managed databases, Kubernetes clusters, WordPress sites, and more.

## Authentication

Every request must include **both** of the following headers — they are a required pair, not alternatives:

| Header                | Value                        |
| --------------------- | ---------------------------- |
| `X-API-Client-ID`     | Your API key's client ID     |
| `X-API-Client-Secret` | Your API key's client secret |

### Creating and managing API keys

Create, view, and revoke API keys at **[console.americancloud.com/api-keys](https://console.americancloud.com/api-keys)**. Each key is scoped at creation:

* **`read-only`** — `GET` endpoints only
* **`read-write`** — full access to all resource management endpoints

Both halves of the key (the client ID and the client secret) are shown to you once at creation. Save them securely; the client secret cannot be retrieved later. If you lose a secret, revoke the key from the console and create a new one.

## Versioning

The URL version (`/api/v1`) follows semantic versioning:

* **Breaking changes** ship under a new URL version. v1 will remain available for at least six months after a v2 release.
* **Additive changes** (new endpoints, new optional fields, new enum values) may ship at any time within a version. Build clients that ignore unknown fields and tolerate new enum values gracefully.

## Official SDKs and tooling

Everything below is generated from, or built on, this same specification, so it stays in step with the API.

|                                                                                         | Install                                                                                                       | Docs                                                                                                                                  |
| --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| **TypeScript / JavaScript**                                                             | `npm i @americancloud/sdk`                                                                                    | [Guide](https://americancloud.com/docs/sdks/typescript) · [GitHub](https://github.com/American-Cloud/americancloud-sdk-typescript)    |
| **Python**                                                                              | `pip install americancloud`                                                                                   | [Guide](https://americancloud.com/docs/sdks/python) · [GitHub](https://github.com/American-Cloud/americancloud-sdk-python)            |
| **Go**                                                                                  | `go get github.com/American-Cloud/americancloud-sdk-go`                                                       | [Guide](https://americancloud.com/docs/sdks/go) · [GitHub](https://github.com/American-Cloud/americancloud-sdk-go)                    |
| **MCP server** — drive the platform from Claude, Cursor, Codex, and other AI assistants | `npx @americancloud/mcp`                                                                                      | [Guide](https://americancloud.com/docs/mcp/overview) · [GitHub](https://github.com/American-Cloud/americancloud-mcp)                  |
| **Terraform provider**                                                                  | [`American-Cloud/americancloud`](https://registry.terraform.io/providers/American-Cloud/americancloud/latest) | [Guide](https://americancloud.com/docs/sdks/terraform) · [GitHub](https://github.com/American-Cloud/terraform-provider-americancloud) |

The code samples on every endpoint page show the equivalent call in TypeScript, Python, and Go. Start with the [SDKs overview](https://americancloud.com/docs/sdks/overview) for the language-agnostic picture.

## Browse the API

Use the navigation on the left to explore the available resources. Each endpoint page shows the request shape, response shape, error responses, and runnable code samples.

The same specification is also served as an interactive Swagger UI at [api.americancloud.com/api-v1](https://api.americancloud.com/api-v1), straight from the API itself.