Create preview app
Create a preview app for a branch or pull request in the pipeline preview stage. The app is created from the preview app settings and its first deployment of the latest commit on the branch starts right away, so this returns before the app is live. Use the application deployment endpoints to follow the progress. Preview must be enabled and the preview app settings configured first. Each preview app is a separate billed application.
Authorizations
API key authentication. Pass your API key as a Bearer token in the Authorization header.
Path Parameters
Pipeline identifier
^([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)$"fb5e5168-4281-4bec-94c5-0d1584e9e657"
Body
Git branch the preview app is built from and redeployed on every push
1"feature/new-checkout"
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.
1 <= x <= 900719925474099142
Response
Default Response
Unique identifier for the application
^([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)$"fb5e5168-4281-4bec-94c5-0d1584e9e657"
Unique system name used in URLs and internal references. Auto-generated from the display name and cannot be changed after creation.
1 - 64"my-app"
Human-readable name shown in the dashboard and API responses
1 - 255"My Application"
Git branch used for automatic and manual deployments when no branch is explicitly specified
"main"