Skip to main content
PUT
Error

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

org_id
string
required

The ID of the organization

project_name
string
required

The name of the project

id
string
required

The id of record

Body

application/json
description
string
stackfile_path
string
max_active_previews
integer
git_repository
object
Example:
env
object[]

Env var overrides applied to every preview environment; may use secret references.

labels
object[]
annotations
object[]

Response

Preview config updated successfully

id
string
read-only
organisation_id
string
read-only
project_id
string
read-only
user_id
string
read-only
name
string
description
string
git_repository
object
Example:
stackfile_path
string
max_active_previews
integer
env
object[]

Env var overrides applied to every preview environment; may use secret references.

labels
object[]
annotations
object[]
created_at
string<date-time>
read-only
updated_at
string<date-time>
read-only