Sign in

v1

latestOpenAPI 3.0.22026-07-26207170320.9 KB
Projects & Environments

Update environment

Update the details of the environment with the provided ID.

patch/environments/{environmentId}

Path parameters

environmentIdstring required

Request body

namestring
networkIsolationEnabledboolean

Indicates whether network connections across environments are allowed.

protectedStatus'unprotected' | 'protected'

Indicates whether an environment is unprotected or protected. Only admin users can perform destructive actions in protected environments.

Response

Updated

idstring required
namestring required
projectIdstring required
databasesIdsstring[] required
redisIdsstring[] required
serviceIdsstring[] required
envGroupIdsstring[] required
protectedStatus'unprotected' | 'protected' required

Indicates whether an environment is unprotected or protected. Only admin users can perform destructive actions in protected environments.

networkIsolationEnabledboolean required

Indicates whether network connections across environments are allowed.