---
title: "Add an environment variable to the job"
method: POST
path: "/job/{jobId}/environmentVariable"
tags: ["Job Environment Variable"]
---

# Add an environment variable to the job

`POST /job/{jobId}/environmentVariable`

## Request

- Base URL: `https://api.qovery.com`
- URL: `https://api.qovery.com/job/{jobId}/environmentVariable`
- Auth: one of:
  - API key in header `Authorization`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/qovery/apis/qovery-api/docs/job/:jobId/environmentVariable/post.ts> (a function with typed inputs; its response is checked against the schema)

- Add an environment variable to the job.

## Path parameters

- `jobId` string, uuid, required

## Request body

- EnvironmentVariableRequest
  - `key` string, required: key is case sensitive.
  - `value` string: value of the env variable.
  - `mount_path` string, nullable: should be set for file only. variable mount path makes variable a file (where file should be mounted).
  - `description` string, nullable: optional variable description (255 characters maximum)
  - `enable_interpolation_in_file` boolean, nullable

## Response `201`

Added an environment variable

- EnvironmentVariable
  - `id` string, uuid, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time
  - `key` string, required: key is case sensitive.
  - `value` string: value of the env variable.
  - `mount_path` string, nullable: should be set for file only. variable mount path makes variable a file (where file should be mounted).
  - `description` string, nullable: optional variable description (255 characters maximum)
  - `enable_interpolation_in_file` boolean, nullable
  - `overridden_variable` EnvironmentVariableOverride
    - `id` string, uuid, required
    - `key` string, required
    - `value` string, required
    - `mount_path` string, required
    - `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)
  - `aliased_variable` EnvironmentVariableAlias
    - `id` string, uuid, required
    - `key` string, required
    - `value` string, required
    - `mount_path` string, required
    - `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)
  - `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_id` string, uuid
  - `service_name` string
  - `service_type` 'APPLICATION' | 'CONTAINER' | 'DATABASE' | 'JOB' | 'HELM' | 'TERRAFORM': type of the service (application, database, job, gateway...)
  - `owned_by` string: Entity that created/own the variable (i.e: Qovery, Doppler)

## Other responses

- `400`: Bad request
- `401`: Access token is missing or invalid
- `403`: Access forbidden
- `404`: Resource not found

---

[API](https://skmtc.dev/qovery/apis/qovery-api.md) - [All operations](https://skmtc.dev/qovery/apis/qovery-api/llms.txt) - [OpenAPI document](https://skmtc.dev/qovery/apis/qovery-api/revisions/93c4960a44ba?raw)
