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

Create a variable alias

cURL

curl --request POST \
  --url https://api.qovery.com/variable/{variableId}/alias \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "<string>",
  "alias_scope": "APPLICATION",
  "alias_parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "enable_interpolation_in_file": true
}
'

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "key": "<string>",
  "value": "<string>",
  "scope": "APPLICATION",
  "variable_type": "VALUE",
  "is_secret": true,
  "updated_at": "2023-11-07T05:31:56Z",
  "mount_path": "<string>",
  "overridden_variable": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "key": "<string>",
    "mount_path": "<string>",
    "scope": "APPLICATION",
    "variable_type": "VALUE",
    "value": "<string>"
  },
  "aliased_variable": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "key": "DATABASE_PSQL_NAME",
    "mount_path": "<string>",
    "scope": "APPLICATION",
    "variable_type": "VALUE",
    "value": "<string>"
  },
  "service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "service_name": "<string>",
  "service_type": "APPLICATION",
  "owned_by": "<string>",
  "description": "<string>",
  "enable_interpolation_in_file": true,
  "secret_manager_access_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

bearerAuthApiKeyAuth

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 value to be used as Alias of the targeted environment variable.

alias_scope · enum<string> · required

Available options: APPLICATION, BUILT_IN, ENVIRONMENT, PROJECT, CONTAINER, JOB, HELM, TERRAFORM

alias_parent_id · string<uuid> · required

the id of the variable that is aliased.

description · string | null

optional variable description (255 characters maximum)

Maximum string length: 255

enable_interpolation_in_file · boolean | null

Response

201

application/json

Create variable alias

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

variable_type · enum<string> · required

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

Available options: VALUE, ALIAS, OVERRIDE, BUILT_IN, FILE, EXTERNAL_SECRET

is_secret · boolean · required

updated_at · string<date-time> · read-only

mount_path · string | null

overridden_variable · object

Show child attributes

aliased_variable · object

Show child attributes

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)

description · string

enable_interpolation_in_file · boolean

secret_manager_access_id · string<uuid> | null