Sign in

v1

latestOpenAPI 3.1.02026-07-261344388.3 KB
Environment

Update environment

Updates an existing environment configuration including name, key, and approval settings.

put/api/projects/{projectId}/environments/{environmentId}

Path parameters

environmentIdstring uuid required

ID of the environment to update

projectIdstring uuid required

ID of the project containing the environment

Request body

namestring required

New name for the environment

keystring nullable

New key for BRMS type environments

approvalMode'require_one_per_team' | 'none_create_request' | 'require_any' | 'none' | 'null' nullable

Approval mode for deployments to this environment

approvalGroupsstring[]

List of group IDs that can approve deployments

Response

The updated environment

idstring uuid required

Unique identifier of the environment

namestring required

Name of the environment

accessTokenstring nullable

Access token for the environment

type'brms' | 'deployment' required

Type of environment (brms or deployment)

keystring nullable

Unique key for BRMS type environments

releaseIdstring uuid nullable

ID of the currently deployed release

deploymentIdstring uuid nullable

ID of the associated deployment

projectIdstring uuid required

ID of the project

requiredReviewersboolean required

Whether reviewers are required

addToWorkflowboolean required

Whether the environment is part of the deployment workflow

workflowOrdernumber nullable

Order position in the deployment workflow

approvalMode'require_one_per_team' | 'none_create_request' | 'require_any' | 'none' required

Approval mode for deployments to this environment

createdAtstring required

Timestamp when the environment was created

updatedAtstring required

Timestamp when the environment was last updated

deletedAtstring nullable

Timestamp when the environment was deleted

metadataobject

Additional metadata from the deployment provider