API reference

Every part of Basaltic is an HTTP API. The console and the CLI are clients of these same endpoints — there is nothing in the product they can reach that you cannot.

​

How this reference is generated

These pages are generated from the OpenAPI specifications the services are built and verified against, not written by hand alongside them. An operation appears here because it exists, with the request and response shapes the service actually implements — including the error responses, which are documented rather than left to be discovered.

​

Conventions

Versioning. Every path is prefixed /v1. Identifiers. Resources carry a UUID id and a crn — a Cloud Resource Name that is unique platform-wide and is what IAM policies are written against. Errors. Failures return a JSON body with a stable, machine-readable code. Match on the code, not on the human-readable message, which may change. Idempotency and async work. Operations that hand off to a background workflow answer 202 Accepted rather than pretending the work is done. Poll the resource until it reaches a terminal state; a 202 followed by a read that still shows the old state is the contract working, not a bug. Pagination. List operations page. Follow the pagination fields in the response rather than assuming you got everything.

​

Getting started

​

The APIs

Identity and account — IAM, Quota, Audit, Billing. Global: one identity and one bill wherever you build. Compute — Compute (instances, images, flavors, keypairs, instance pools), Database (managed clusters), Registry (private container images). Networking — Network (VPCs, subnets, gateways, floating IPs), Load balancer, DNS, Certificate. Storage — Storage (block volumes, snapshots, buckets). The S3 wire protocol is served separately; see object storage. Security — KMS (encryption keys), Secrets. Messaging — Queue, Notifications, Email. Observability — Telemetry (logs, metrics, traces).