> Index of every page on this site: [llms.txt](https://docs.a-line.cloud/llms.txt)

# API reference

> The v1 API: base URL, authentication, limits, errors, pagination and every operation by group.

The public A-Line.cloud API. Authenticate with `Authorization: Bearer alc_...`. Additive changes only within v1; see the deprecation policy.

## Swagger UI and the OpenAPI document

**Swagger UI: [api.a-line.cloud/docs](https://api.a-line.cloud/docs)**, the running API's own explorer.

- [Download the OpenAPI spec](/openapi/v1.json) (OpenAPI 3, JSON): every operation and schema on these pages, from the same release as the docs. Feed it to a client generator such as openapi-generator, or import it into Postman, Insomnia or Bruno to get every request ready to send.
- The running API serves its own copy at [https://api.a-line.cloud/v1/openapi.json](https://api.a-line.cloud/v1/openapi.json) (YAML at `/v1/openapi.yaml`), with the server URL filled in.

## Base URL

Every path starts with `/v1` on `https://api.a-line.cloud`: the full URL of `GET /v1/whoami` is `https://api.a-line.cloud/v1/whoami`. Bodies are JSON. See [versioning](/api/versioning) for what may change within v1.

## Rate limits

Each API key has a request budget per time window. Over it, a request gets `429` with the code `rate_limited` and a `Retry-After` header; see [rate limits](/api/rate-limits).

## Errors

Every non-2xx response has the same JSON body, with a stable `code` to branch on and a `message` for people; see [errors](/api/errors).

## Pagination

List operations return a page at a time: pass `limit` and the previous page's `next_cursor` as `cursor`; see [pagination](/api/pagination).

## Authentication

- `api_key`: HTTP bearer (alc_ API key). An A-Line.cloud API key, sent as `Authorization: Bearer alc_...`. Create keys in the dashboard; sessions are not accepted on /v1.

Each operation names the scheme it needs. See [authentication](/api/authentication).

## Operations by group

- [Actions](/api/reference/actions): 2 operations
- [Apps](/api/reference/apps): 20 operations
- [Clusters](/api/reference/clusters): 5 operations
- [Domains](/api/reference/domains): 16 operations
- [IaC](/api/reference/iac): 8 operations
- [Logs](/api/reference/logs): 2 operations
- [Pricing](/api/reference/pricing): 1 operations
- [Projects](/api/reference/projects): 8 operations
- [Secrets](/api/reference/secrets): 14 operations
- [Whoami](/api/reference/whoami): 1 operations

Each operation shows its parameters, body and responses, with curl, JavaScript and Python samples. Bodies are also listed on the [schemas](/api/reference/schemas) page.
