Skip to content

Breqwatr Cloud API

Manage organisations, projects, members and quotas, and read invoices, usage and audit logs, over HTTPS and JSON.

curl https://dashboard.breqwatr.cloud/api/v1/me \
  -H "Authorization: Bearer $BREQWATR_API_KEY"

Which API do I need?

Breqwatr Cloud has two sets of APIs, with different credentials.

You want to Use Credential
Manage organisations, projects, members and quota requests, or read invoices, usage and audit logs This API API key
Run instances, volumes, networks, load balancers and clusters The OpenStack APIs Application credential

This API creates and provisions projects. What runs inside a project goes through OpenStack.

Make your first calls

Create an API key as described in Authentication, then keep it in an environment variable.

export BREQWATR_API_KEY=bw_...
export BASE=https://dashboard.breqwatr.cloud/api/v1

List your organisations:

curl -s "$BASE/orgs" -H "Authorization: Bearer $BREQWATR_API_KEY"

{
  "data": [
    {
      "id": "3f1a6c52-8d4e-4b0f-9a77-2e5c1d90b8a4",
      "name": "Acme",
      "slug": "acme",
      "status": "active",
      "role": "owner",
      "created_at": "2026-09-14T15:04:05Z"
    }
  ],
  "next_cursor": null
}

Use an organisation's id to list its projects:

curl -s "$BASE/orgs/$ORG_ID/projects" -H "Authorization: Bearer $BREQWATR_API_KEY"

Then create one. Project creation finishes in the background, as Background operations explains.

curl -s -X POST "$BASE/orgs/$ORG_ID/projects" \
  -H "Authorization: Bearer $BREQWATR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"name": "web", "description": "Storefront"}'