Reference06 / API
API reference
The same operations the dashboard and CLI perform, over HTTP. Authenticate with an API key as a bearer token.
Endpoints
| Method | Path | Returns |
|---|---|---|
| GET | /v1/account | The authenticated account, its workspaces and current plan. |
| GET | /v1/plans | Every plan with its flat price in the request currency. |
| POST | /v1/deploy | Create a deployment for a project. Returns immediately with a build id. |
| GET | /v1/deployments | Deployment history for a project, newest first. |
| GET | /v1/deployments/:id/status | Build state, duration and the resulting address. |
| GET | /v1/deployments/:id/logs | Build and runtime logs for a deployment. |
| POST | /v1/deployments/:id/rollback | Restore a previous deployment, configuration included. |
| GET | /v1/env | Environment variables for a project. Secret values are never returned. |
| PUT | /v1/env | Create or update environment variables as a set. |
| DELETE | /v1/env | Remove named environment variables from a project. |
Errors
401
Missing or invalid API key.
404
No such project or deployment.
429
Rate limited. Back off and retry.