Developers

REST API

Everything the dashboard does, scriptable. Auth via the same session cookies the dashboard uses, or short-lived tokens once the API tokens feature ships.
MethodPathDescription
POST/v1/auth/sign-upCreate account + first workspace
POST/v1/auth/sign-inExchange credentials for session cookies
GET/v1/orgsList your workspaces
GET/v1/orgs/:orgId/projectsList projects in a workspace
POST/v1/orgs/:orgId/projectsCreate a project from a Git repo
POST/v1/orgs/:orgId/projects/:projectId/deploymentsTrigger a deploy
GET/v1/orgs/:orgId/deployments/:idGet deployment status + URL
GET/v1/orgs/:orgId/deployments/:id/logs/streamSSE stream of build/runtime logs