latestOpenAPI 3.1.02026-08-223391355.6 KB

aa8d44585147

deploy-domains

Publish project

Plan: All plans

Builds and deploys the project. Asynchronous: returns 202 with a deployment_id; poll GET /v1/projects/{project_id}/publish/{deployment_id} until status is completed or error. Optionally sets who can view the published app first: public (anyone with the link), workspace (workspace members only), or custom (only the groups/users in audience). Omit visibility to keep the current setting. Visibility changes apply to the currently published version immediately, before the new deployment finishes.

post/v1/projects/{project_id}/publish

Path parameters

project_idstring required

Project ID

Request body

namestring

Project slug for the published URL

visibility'public' | 'workspace' | 'custom'

Who can view the published app: public (anyone with the link), workspace (workspace members only), or custom (only the groups/users in audience). Omit to keep the project's current setting. Clients must tolerate new values.

Response

deployment_idstring

Deployment ID

statusstring required

Deployment status

urlstring

Published project URL

visibilitystring required

Resolved visibility of the published app