latestOpenAPI 3.1.02026-08-223391355.6 KB

aa8d44585147

deploy-domains

Update publish settings

Plan: All plans

Updates the published app without redeploying. visibility controls who can view it: public (anyone with the link), workspace (workspace members only), or custom (only the groups/users in audience — the list replaces all existing group/user grants; grants managed in the UI such as org access and email invites are preserved). is_published false takes the app offline; settings are kept and apply again on the next publish (already-offline is a no-op). Changes take effect immediately.

patch/v1/projects/{project_id}/publish

Path parameters

project_idstring required

Project ID

Request body

is_publishedboolean

Set to false to take the published app offline; visibility and audience settings are kept and apply again on the next publish. true is rejected: publishing requires a deploy via POST /v1/projects/{project_id}/publish.

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 leave visibility unchanged. Clients must tolerate new values.

Response

is_publishedboolean required

Whether the project is currently published

urlstring

Published project URL

visibilitystring required

Resolved visibility of the published app