Get preview deployment info

GET

/requests/{id}/preview

Returns the current preview deployment information for a request, including preview URL if ready, deployment status, and branch name.

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' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "data": {
        "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
        "branchName": "string",
        "previewUrl": "http://example.com",
        "status": "string",
        "message": "string"
    }
}

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

Trigger preview deployment

Get detailed preview deployment status