Get Preview Deployment

API server

https://app.coolify.io/api/v1

Choose where to send API requests

This changes the request URL and code examples on every endpoint page.

API server type

Requests will use

https://app.coolify.io/api/v1

Use only a Coolify URL you trust. Sending a test request also sends the API token you enter.

GET
/applications/{uuid}/previews/{pull_request_id}

Get a preview deployment by pull request ID.

Authorization

bearerAuth
AuthorizationBearer <token>

Go to Keys & Tokens / API tokens and create a new token. Use the token as the bearer token.

In: header

Path Parameters

uuid*string

UUID of the application.

pull_request_id*integer

Pull request ID of the preview.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://app.coolify.io/api/v1/applications/string/previews/0"
{  "uuid": "string",  "pull_request_id": 0,  "pull_request_html_url": "string",  "git_type": "string",  "status": "string",  "domains": "string",  "docker_compose_domains": [    {      "name": "string",      "domain": "string",      "redirect": "string"    }  ],  "domain_port_overrides": {},  "docker_registry_image_tag": "string",  "last_online_at": "string",  "created_at": "string",  "updated_at": "string"}
{  "message": "Unauthenticated."}
{  "message": "Resource not found."}
{  "message": "Validation error.",  "errors": {    "name": [      "The name field is required."    ],    "api_url": [      "The api url field is required.",      "The api url format is invalid."    ]  }}