QOqovery
Environment Variable

Create an environment variable alias at the environment level

  • Allows you to add an alias at environment level on an existing environment variable having higher scope, in order to customize its key.
  • You only have to specify a key in the request body
  • The system will create a new environment variable at environment level with the same value as the one corresponding to the variable id in the path
  • The response body will contain the newly created variable
  • Information regarding the aliased_variable will be exposed in the "aliased_variable" field of the newly created variable
  • You can't create an alias on an alias
post/environment/{environmentId}/environmentVariable/{environmentVariableId}/alias

Request

Path parameters

environmentIdstring uuid required

Environment ID

environmentVariableIdstring uuid required

Environment Variable ID

Request body

keystring required
descriptionstring nullable

optional variable description (255 characters maximum)

enable_interpolation_in_fileboolean nullable

Response

Create variable alias

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.