latestOpenAPI 3.0.12026-08-10234260964.0 KB

6cc88fde6435

Environment Variables

Add an environment variable

Add a variable to an environment. 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 Environment Variables section in our documentation for more information.

post/projects/{projectId}/environments/{environmentId}/variables

Path parameters

projectIdstring required
environmentIdstring required

Request body

namestring required

Name of the variable

attributesobject

Arbitrary attributes attached to this resource

valuestring required

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