latestOpenAPI 3.1.02026-08-223391355.6 KB

aa8d44585147

deploy-domains

Get publish status

Plan: All plans

Returns the status of an async publish started with POST /v1/projects/{project_id}/publish, keyed by the deployment_id it returned. Poll until status is completed (url is set) or error (error_message explains the failure). Poll no more than once every 2 seconds and honor Retry-After on 429 responses.

get/v1/projects/{project_id}/publish/{deployment_id}

Path parameters

project_idstring required

Project ID

deployment_idstring required

Deployment ID returned by POST /v1/projects/{project_id}/publish

Response

deployment_idstring required

The deployment being tracked

error_classstring

Failure class when status is error: transient (a retry may succeed) or a user_* class (fix the project before republishing). Clients must tolerate new values.

error_codestring

Machine-readable failure cause when one is recognized. Present only when status is error.

error_messagestring

Human-readable failure reason. Present only when status is error.

status'running' | 'completed' | 'error' | 'unknown' required

Deployment status: running (still building or deploying), completed (published — url is set), error (failed — error_message explains why), or unknown. Clients must tolerate new values.

urlstring

Published project URL. Set once status is completed.