Skip to main content
POST
/
variable
/
{variableId}
/
alias
Create a variable alias
curl --request POST \
  --url https://api.qovery.com/variable/{variableId}/alias \
  --header 'Authorization: <api-key>' \
  --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
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "key": "<string>",
  "value": "<string>",
  "mount_path": "<string>",
  "overridden_variable": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "key": "<string>",
    "value": "<string>",
    "mount_path": "<string>",
    "scope": "APPLICATION",
    "variable_type": "VALUE"
  },
  "aliased_variable": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "key": "DATABASE_PSQL_NAME",
    "value": "<string>",
    "mount_path": "<string>",
    "scope": "APPLICATION",
    "variable_type": "VALUE"
  },
  "scope": "APPLICATION",
  "variable_type": "VALUE",
  "service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "service_name": "<string>",
  "service_type": "APPLICATION",
  "owned_by": "<string>",
  "is_secret": true,
  "description": "<string>",
  "enable_interpolation_in_file": true
}

Authorizations

​
Authorization
string
header
required

Token API are generated by Qovery to manage machine to machine interaction and do not have a TTL. Prefix your token with "Token ". Curl Example: curl https://console.qovery.com/organization -H "Authorization: Token $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 length: 255
​
enable_interpolation_in_file
boolean | null

Response

Create variable alias

​
id
string<uuid>
required
​
created_at
string<date-time>
required
​
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 or BUIT_IN)

Available options:
VALUE,
ALIAS,
OVERRIDE,
BUILT_IN,
FILE
​
is_secret
boolean
required
​
updated_at
string<date-time>
​
mount_path
string | null
​
overridden_variable
object
​
aliased_variable
object
​
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