Update an environment
Updates an environment by ID. The project is derived from the entity. Returns the bare updated row (no data envelope), matching the dashboard settings UI it serves.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Environment ID.
x >= 1Body
Display name.
URL-friendly identifier.
Whether the environment is disabled.
Playwright project names to include. Items must not start with '!'.
Playwright project names to exclude.
Cron expression for scheduled triggers, or null.
Concurrency group and policy scheduled runs are triggered with. Omit to keep the current value; null to fall back to the project's legacy concurrency setting.
Reporter configuration for the environment. Slack channel ids must be active registered channels of the project's organization (GET /api/v2/slack/channels).
Response
The updated environment row (no data envelope).
Unique identifier.
Project identifier.
URL-friendly identifier.
Display name.
Playwright project names to match.
Playwright project names to ignore.
Whether the environment is disabled.
Environment file paths.
Cron expression for scheduled triggers.
Concurrency group and policy scheduled runs are triggered with; null uses the project's legacy concurrency setting.
Reporter configuration for runs in this environment.
ISO 8601 timestamp.
ISO 8601 timestamp.