QOqovery
Variable Main Calls

Create a variable alias

  • Allows you to create an alias of one of the existing variables.
  • You have to specify an alias (key) in the request body, the scope and the parent id of the alias (project id, environment id or service id)
  • The system will create a new variable at the requested level with the same value as the one corresponding to the variable id passed as path parameter.
  • The response body will contain the newly created variable
  • Information regarding the aliased_variable will be exposed in the "aliased_variable" or in the "aliased_secret" field of the newly created variable
  • You can't create an alias on an alias
post/variable/{variableId}/alias

Request

Path parameters

variableIdstring uuid required

Variable ID

Request body

keystring required

the value to be used as Alias of the targeted environment variable.

alias_scope'APPLICATION' | 'BUILT_IN' | 'ENVIRONMENT' | 'PROJECT' | 'CONTAINER' | 'JOB' | 'HELM' | 'TERRAFORM' required
alias_parent_idstring uuid required

the id of the variable that is aliased.

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
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.