Skip to main content
PUT
Edit a variable

Authorizations

Authorization
string
header
required

JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '

Path Parameters

variableId
string<uuid>
required

Variable ID

Body

application/json
key
string
required

the key of the environment variable

value
string | null

the value of the environment variable

description
string | null

optional variable description (255 characters maximum)

Maximum string length: 255
enable_interpolation_in_file
boolean | null
secret_manager_access_id
string<uuid> | null
json_target_key
string | null

Optional JSON member/index path, only supported for EXTERNAL_SECRET variables (not external secret files). Use dots for nested members and numeric indexes for arrays, for example accounts.0.password. Escape literal dots with \. and backslashes with \\; other query characters are treated literally. Members must be non-empty, with no leading or trailing whitespace, control characters, or unescaped trailing backslash. Omit or set to null to clear JSON selection and read the whole secret. Send the current selector on unrelated edits to preserve it.

Required string length: 1 - 256
Example:

"accounts.0.password"

Response

Edited variable value

id
string<uuid>
required
read-only
created_at
string<date-time>
required
read-only
key
string
required
value
string | null
required
scope
enum<string>
required
Available options:
APPLICATION,
BUILT_IN,
ENVIRONMENT,
PROJECT,
CONTAINER,
JOB,
HELM,
TERRAFORM,
AGENTIC_WORKFLOW
variable_type
enum<string>
required

type of the environment variable (VALUE, FILE, ALIAS, OVERRIDE, BUIT_IN, EXTERNAL_SECRET, FILE_EXTERNAL_SECRET)

Available options:
VALUE,
ALIAS,
OVERRIDE,
BUILT_IN,
FILE,
EXTERNAL_SECRET,
FILE_EXTERNAL_SECRET
is_secret
boolean
required
updated_at
string<date-time>
read-only
mount_path
string | null
overridden_variable
object
aliased_variable
object
service_id
string<uuid>

The id of the service referenced by this variable.

service_name
string

The name of the service referenced by this variable.

service_type
enum<string>

type of the service (application, database, job, gateway...)

Available options:
APPLICATION,
CONTAINER,
DATABASE,
JOB,
HELM,
TERRAFORM
owned_by
string

Entity that created/own the variable (i.e: Qovery, Doppler)

is_created_by_qovery
boolean
read-only

True when Qovery created the variable on its own, such as the alias it adds for each output of a job, Terraform service or blueprint. False for variables a user created and for built-in variables, which variable_type already identifies. owned_by does not tell these apart. It stays true after a user edits the variable. Clients that sync variables, such as the Terraform provider, can leave these variables out.

description
string
enable_interpolation_in_file
boolean
secret_manager_access_id
string<uuid> | null
json_target_key
string | null

Optional JSON member/index path, only supported for EXTERNAL_SECRET variables (not external secret files). Use dots for nested members and numeric indexes for arrays, for example accounts.0.password. Escape literal dots with \. and backslashes with \\; other query characters are treated literally. Members must be non-empty, with no leading or trailing whitespace, control characters, or unescaped trailing backslash. Null or absent means that no JSON selection is configured.

Required string length: 1 - 256
Example:

"accounts.0.password"