QOqovery
Environment Variable

Edit an environment variable belonging to the environment

  • 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
  • An override can only have a scope lower to the variable it is overriding (hierarchy is BUILT_IN > PROJECT > ENVIRONMENT > APPLICATION)
put/environment/{environmentId}/environmentVariable/{environmentVariableId}

Request

Path parameters

environmentIdstring uuid required

Environment ID

environmentVariableIdstring uuid required

Environment Variable ID

Request body

keystring required

key is case sensitive

valuestring

value of the env variable.

mount_pathstring nullable
descriptionstring nullable

optional variable description (255 characters maximum)

enable_interpolation_in_fileboolean nullable

Response

Edited the environment variable value

idstring uuid required
created_atstring date-time required
updated_atstring date-time
keystring required

key is case sensitive.

valuestring

value of the env variable.

mount_pathstring nullable

should be set for file only. variable mount path makes variable a file (where file should be mounted).

descriptionstring nullable

optional variable description (255 characters maximum)

enable_interpolation_in_fileboolean 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
service_namestring
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)

Example response

{
  "aliased_variable": {
    "key": "QOVERY_DATABASE_PSQL_NAME"
  }
}

Changes

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