QOqovery
Variable Main Calls

Edit a variable

  • You can't edit a BUILT_IN variable
  • For an override, you can't edit the key
  • For an alias, you can't edit the value
put/variable/{variableId}

Request

Path parameters

variableIdstring uuid required

Variable ID

Request body

keystring required

the key of the environment variable

valuestring nullable

the value of the environment variable

descriptionstring nullable

optional variable description (255 characters maximum)

enable_interpolation_in_fileboolean nullable

Response

Edited variable value

idstring uuid required
created_atstring date-time required
updated_atstring date-time
keystring required
valuestring nullable required
mount_pathstring nullable
scope'APPLICATION' | 'BUILT_IN' | 'ENVIRONMENT' | 'PROJECT' | 'CONTAINER' | 'JOB' | 'HELM' | 'TERRAFORM' required
variable_type'VALUE' | 'ALIAS' | 'OVERRIDE' | 'BUILT_IN' | 'FILE' required

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

service_idstring uuid

The id of the service referenced by this variable.

service_namestring

The name of the service referenced by this variable.

service_type'APPLICATION' | 'CONTAINER' | 'DATABASE' | 'JOB' | 'HELM' | 'TERRAFORM'

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

owned_bystring

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

is_secretboolean required
descriptionstring
enable_interpolation_in_fileboolean

Example response

{
  "aliased_variable": {
    "key": "DATABASE_PSQL_NAME"
  }
}

Changes

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