Skip to main content
PUT
Update environment

Authorizations

Authorization
string
header
required

Personal access token is obtained through your profile

Path Parameters

environmentId
string<uuid>
required

ID of the environment to update

projectId
string<uuid>
required

ID of the project containing the environment

Body

application/json
name
string
required

New name for the environment

key
string | null

New key for BRMS type environments

approvalMode
enum<string> | null
default:none

Approval mode for deployments to this environment

Available options:
require_one_per_team,
none_create_request,
require_any,
none,
null
approvalGroups
string<uuid>[]

List of group IDs that can approve deployments

Group ID

Response

200 - application/json

The updated environment

The updated environment

id
string<uuid>
required

Unique identifier of the environment

name
string
required

Name of the environment

type
enum<string>
required

Type of environment (brms or deployment)

Available options:
brms,
deployment
projectId
string<uuid>
required

ID of the project

requiredReviewers
boolean
required

Whether reviewers are required

addToWorkflow
boolean
required

Whether the environment is part of the deployment workflow

approvalGroups
object[]
required

Groups that can approve deployments

approvalMode
enum<string>
required

Approval mode for deployments to this environment

Available options:
require_one_per_team,
none_create_request,
require_any,
none
createdAt
string
required

Timestamp when the environment was created

updatedAt
string
required

Timestamp when the environment was last updated

accessToken
string | null

Access token for the environment

key
string | null

Unique key for BRMS type environments

release
object | null

Currently deployed release information

releaseId
string<uuid> | null

ID of the currently deployed release

deploymentId
string<uuid> | null

ID of the associated deployment

deployment
object | null

Deployment configuration for the environment

project
object | null

Project the environment belongs to

reviewers
object[]

List of members assigned as reviewers

workflowOrder
number | null

Order position in the deployment workflow

changeRequests
object[]

Pending change requests for this environment

deletedAt
string | null

Timestamp when the environment was deleted

metadata
object

Additional metadata from the deployment provider