Get detailed preview deployment status

GET

/requests/{id}/preview/status

Returns detailed status information about a preview deployment. This endpoint is designed to be polled by the frontend to track deployment progress. Returns status updates, preview URL when ready, error details if failed, and build metrics.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Path Params

Responses

🟢200OK

application/json

Successful response

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/requests/123/preview/status' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "data": {
        "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
        "status": "not_started",
        "branchName": "string",
        "previewUrl": "http://example.com",
        "deploymentId": "string",
        "error": {
            "code": "string",
            "message": "string",
            "suggestion": "string"
        },
        "buildDurationMs": 0,
        "createdAt": "string",
        "readyAt": "string"
    }
}

Modified at 2026-02-08 16:57:15

Get preview deployment info

Get available transitions