Create an environment variable alias at the job level

• Allows you to add an alias at job 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 job 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 /job/{jobId}/environmentVariable/{environmentVariableId}/alias

Create an environment variable alias at the job level

cURL

curl --request POST \
  --url https://api.qovery.com/job/{jobId}/environmentVariable/{environmentVariableId}/alias \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "<string>",
  "description": "<string>",
  "enable_interpolation_in_file": true
}
'

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "key": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "value": "<string>",
  "mount_path": null,
  "description": "<string>",
  "enable_interpolation_in_file": true,
  "overridden_variable": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "key": "<string>",
    "value": "<string>",
    "mount_path": "<string>"
  },
  "aliased_variable": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "key": "QOVERY_DATABASE_PSQL_NAME",
    "value": "<string>",
    "mount_path": "<string>"
  },
  "service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "service_name": "<string>",
  "owned_by": "<string>"
}

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

jobId · string<uuid> · required

Job ID

environmentVariableId · string<uuid> · required

Environment Variable ID

Body

application/json

key · string · required

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

key is case sensitive.

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

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

value · string

value of the env variable.

mount_path · string | null

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

description · string | null

optional variable description (255 characters maximum)

Maximum string length: 255

enable_interpolation_in_file · boolean | null

overridden_variable · object

Show child attributes

aliased_variable · object

Show child attributes

service_id · string<uuid>

service_name · string

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)