API reference
Deployments
Trigger publishes and check the state of your live sites.
These endpoints let you publish a project and see what has been published before — the same actions the Deploy tab in the Studio does, but from your own code.
Publish a project#
| Method | Path | Returns |
|---|---|---|
| POST | /v2/apps/{appId}/deploy/web | A deployment object with status and URL |
Note
The API returns as soon as the deploy is queued, not when it's finished. Poll the status endpoint below (every few seconds) to see when it's live.
Check deploy status#
| Method | Path | Returns |
|---|---|---|
| GET | /v2/apps/{appId}/deploy/status | The current deploy state (queued, building, deployed, failed) |
Get deploy history#
| Method | Path | Returns |
|---|---|---|
| GET | /v2/apps/{appId}/deploy/history | An array of past deploys, newest first |
Unpublish#
Takes your live site offline. The project stays in your account — you can publish it again later.
| Method | Path | Returns |
|---|---|---|
| DELETE | /v2/apps/{appId}/deploy/web | A success confirmation |
Last updated · April 11, 2026