Skip to content

Overview

The Aether HTTP API for managing organizations, Kubernetes clusters, node pools, container registries, and billing on the Aether platform.

Base URL

All endpoints are served under https://api.aetherplatform.cloud. Versioned routes live under the /api/v1 prefix.

Authentication

Requests authenticate with an API token of the form aether_<hex>, sent in the Authorization header as a Bearer credential:

Authorization: Bearer aether_0123456789abcdef...

Tokens are created per organization (see the API Tokens endpoints) and the raw secret is shown only once, at creation time. Unauthenticated requests receive 401.

Rate limiting

Requests are rate-limited to 100 requests per minute per key (token-bucket with a small burst allowance). Exceeding the limit returns 429.

Pagination

List endpoints use opaque cursor pagination via query parameters:

?cursor=<UUID>&limit=<N>

limit defaults to 50 and is capped at 100. The response envelope carries the items plus a next_cursor field; when next_cursor is absent there are no further pages. Pass the returned next_cursor value back as cursor to fetch the next page.

Errors

Errors are returned as a JSON object with an error member containing a stable code, a human-readable message, and (for validation failures) a details array.

Packages

A cluster is billed either from a package or per resource (“custom”). The choice is made when the cluster is created — the plan field on the create request — and is fixed for the cluster’s lifetime. The catalogue currently offers four packages (dev, starter, growth, scale), and a retired package can still appear on an existing cluster; each is a flat monthly fee per cluster covering an allowance of vCPUs, memory and node disk, and anything above the allowance is charged per resource, each dimension on its own. Omitting plan bills the cluster entirely per resource. Either way load balancers, persistent volumes, registry storage and the public API endpoint — which every cluster is required to have, and which no package fee includes — are charged separately. The current package prices and allowances are shown in the portal when you create a cluster (and, once published, on the pricing page).

Information

  • OpenAPI version: 3.1.0

An Aether API token of the form aether_<hex>, sent as Authorization: Bearer <token>.

Security scheme type: http