UPupsun
Environment Variables

Update an environment variable

Update a single user-defined environment variable. The value can be either a string or a JSON object (default: string), as specified by the is_json boolean flag. Additionally, the inheritability of an environment variable can be determined through the is_inheritable flag (default: true). See the Variables section in our documentation for more information.

patch/projects/{projectId}/environments/{environmentId}/variables/{variableId}

Request

Path parameters

projectIdstring required
environmentIdstring required
variableIdstring required

Request body

namestring

Name of the variable

attributesobject

Arbitrary attributes attached to this resource

valuestring

Value of the variable

is_jsonboolean

The variable is a JSON string

is_sensitiveboolean

The variable is sensitive

visible_buildboolean

The variable is visible during build

visible_runtimeboolean

The variable is visible at runtime

application_scopestring[]

Applications that have access to this variable

is_enabledboolean

The variable is enabled on this environment

is_inheritableboolean

The variable is inheritable to child environments

Response

statusstring required

The status text of the response

codeinteger required

The status code of the response

Changes

No recorded changes to this operation across all 1 revision of this API.