Skip to main content
POST
Create preview app

Authorizations

Authorization
string
header
required

API key authentication. Pass your API key as a Bearer token in the Authorization header.

Path Parameters

id
string<uuid>
required

Pipeline identifier

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"fb5e5168-4281-4bec-94c5-0d1584e9e657"

Body

application/json
branch
string
required

Git branch the preview app is built from and redeployed on every push

Minimum string length: 1
Example:

"feature/new-checkout"

pull_request_number
integer

Pull request the preview app belongs to. When set, the app is named after the pull request and is deleted when the pull request is merged or closed.

Required range: 1 <= x <= 9007199254740991
Example:

42

Response

Default Response

id
string<uuid>
required

Unique identifier for the application

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"fb5e5168-4281-4bec-94c5-0d1584e9e657"

name
string
required

Unique system name used in URLs and internal references. Auto-generated from the display name and cannot be changed after creation.

Required string length: 1 - 64
Example:

"my-app"

display_name
string
required

Human-readable name shown in the dashboard and API responses

Required string length: 1 - 255
Example:

"My Application"

default_branch
string | null
required

Git branch used for automatic and manual deployments when no branch is explicitly specified

Example:

"main"