GET
Get the preview environment config

Authorizations

Authorization
string
header
required

Bearer token for authentication. Format: 'Bearer {token}'

Headers

X-Workspace-Id
string

Workspace ID (uses default workspace if not provided)

Path Parameters

uuid
string
required

Application UUID

Response

Get the preview environment config

Api_V1_Entities_PreviewEnvironmentConfig model

enabled
boolean
required

Whether preview environments are created for this application

resource_mode
string
required

parent (reuse the application's resource) or existing (use resource_id)

resource_id
string
required

UUID of the resource preview environments run on, when resource_mode is existing

project_id
string
required

UUID of the project preview environments land in. Null means they follow the parent application

trigger_mode
string
required

pull_request or every_branch

trigger_filter
string
required

auto, label, branch_pattern or pr_name_pattern

trigger_label
string
required

Pull request label that triggers creation, when trigger_filter is label

branch_pattern
string
required

Glob matched against the branch name, when trigger_filter is branch_pattern

pr_name_pattern
string
required

Glob matched against the pull request title, when trigger_filter is pr_name_pattern

auto_deploy_on_push
boolean
required

Redeploy the preview environment on every push to its branch

cleanup_on_pr_merge
boolean
required

Destroy the preview environment when the pull request is merged

cleanup_on_pr_close
boolean
required

Destroy the preview environment when the pull request is closed unmerged

cleanup_on_branch_delete
boolean
required

Destroy the preview environment when its branch is deleted

cleanup_on_inactivity
boolean
required

Destroy the preview environment after inactivity_days without a commit

inactivity_days
integer<int32>
required

Days without a commit before cleanup, when cleanup_on_inactivity is on

retention_days
integer<int32>
required

Days a preview environment is kept before it expires

retention_mode
string
required

after_pr_close (count from PR close) or from_creation

comment_on_github
boolean
required

Post the preview environment URL as a pull request comment. Always off in every_branch mode

clone_settings
object
required

What is copied from the parent application. Keys clone_variables, clone_secret_files and clone_security default to true when absent; addons and cronjobs default to copying all

created_at
string<date-time>
required

Creation timestamp

updated_at
string<date-time>
required

Last update timestamp