Skip to main content
PATCH
Update an environment

Authorizations

Authorization
string
header
required

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

Path Parameters

id
integer
required

Environment ID.

Required range: x >= 1

Body

application/json
name
string

Display name.

slug
string

URL-friendly identifier.

is_disabled
boolean

Whether the environment is disabled.

playwright_projects_match
string[]

Playwright project names to include. Items must not start with '!'.

playwright_projects_ignore
string[]

Playwright project names to exclude.

scheduled_trigger
string | null

Cron expression for scheduled triggers, or null.

Response

The updated environment row (no data envelope).

id
number
required

Unique identifier.

project_id
number
required

Project identifier.

slug
string
required

URL-friendly identifier.

name
string
required

Display name.

playwright_projects_match
string[]
required

Playwright project names to match.

playwright_projects_ignore
string[]
required

Playwright project names to ignore.

is_disabled
boolean | null
required

Whether the environment is disabled.

env_files
string[]
required

Environment file paths.

scheduled_trigger
string | null
required

Cron expression for scheduled triggers.

created_at
string | null
required

ISO 8601 timestamp.

updated_at
string | null
required

ISO 8601 timestamp.