website.publish
Deploys the latest checkpoint of a website and sets its visibility. Deployment is asynchronous — poll website.status until publish_status becomes published or failed. To change metadata (title, visibility) without redeploying, use website.update instead. See the Website guide.
Headers
API key for direct authentication. Provide either this or Authorization, not both. See Authentication.
Body
Session UID. Mutually exclusive with website_id — exactly one must be provided.
Unique website ID. Mutually exclusive with task_id — exactly one must be provided.
Who can access the published site. Replaces the site's current visibility.
public(default) — anyone. An empty string also meanspublic.team— current team members only. Requires a team account.private— owner and invited collaborators only.
Sites may cap the maximum allowed visibility; requests above the cap return 403 permission_denied.
public, team, private Response
Publish triggered successfully. The response includes the website title current when the request was accepted. Deployment is still in progress — poll website.status for the final state and effective visibility. This response does not echo visibility.
Whether the request was successful.
true
Unique identifier for this API request.
Unique website ID.
Display title of the website when the publish request was accepted. For historical websites without a stored title, this falls back to the internal project name. Always present.
version_id of the checkpoint being deployed — always the latest checkpoint of the site.