API
API
The Clusterz API at api.clusterz.eu, how to call it, and one page for each of its resources.
The API answers at https://api.clusterz.eu/api/v1. The dashboard and the cluz command line both use it, so what they do, you can do from your own code.
Sign in to call it
Every route that needs a person sends one of two things:
- An
Authorization: Bearer <access_token>header. The command line and your scripts use this. - The
clusterz_tokencookie, which the dashboard's sign-in sets. A change made with the cookie must come from the dashboard, which Errors and cookies explains.
Routes that act on a team's apps sit under /api/v1/teams/{teamSlug}.
Amounts
Every amount is in cents of euros: price_cents: 4900 is €49.
The resources
- Authentication: providers, the terms, OAuth sign-in, the command line's sign-in, refresh and sign out.
- User: the signed-in user and the Git providers they connect.
- Teams: a person's teams, and a team's archetype.
- Projects: apps, their database, usage and services.
- Builds: list, start, read and cancel.
- Deployments: list, read, what runs now, and rollback.
- Solutions and prices: what is on offer, what it costs, and how to install it.
- Billing: credit, checkouts and add-ons.
- Platform admin: the staff routes for prices and plans.
- WebSocket: build logs and deployment changes, live.
- Webhooks: the push hooks from your Git provider.
- Health checks: liveness and readiness.
- Errors and cookies: how a refusal looks.