Edit a variable

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

import requests

url = "https://api.qovery.com/variable/{variableId}"

payload = {
    "key": "<string>",
    "value": "<string>",
    "description": "<string>",
    "enable_interpolation_in_file": True,
    "secret_manager_access_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    key: '<string>',
    value: '<string>',
    description: '<string>',
    enable_interpolation_in_file: true,
    secret_manager_access_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.qovery.com/variable/{variableId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.qovery.com/variable/{variableId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'key' => '<string>',
    'value' => '<string>',
    'description' => '<string>',
    'enable_interpolation_in_file' => true,
    'secret_manager_access_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.qovery.com/variable/{variableId}"

	payload := strings.NewReader("{\n  \"key\": \"<string>\",\n  \"value\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enable_interpolation_in_file\": true,\n  \"secret_manager_access_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.qovery.com/variable/{variableId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"key\": \"<string>\",\n  \"value\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enable_interpolation_in_file\": true,\n  \"secret_manager_access_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/variable/{variableId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"key\": \"<string>\",\n  \"value\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enable_interpolation_in_file\": true,\n  \"secret_manager_access_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

PUT

variable

{variableId}

Edit a variable

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

import requests

url = "https://api.qovery.com/variable/{variableId}"

payload = {
    "key": "<string>",
    "value": "<string>",
    "description": "<string>",
    "enable_interpolation_in_file": True,
    "secret_manager_access_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    key: '<string>',
    value: '<string>',
    description: '<string>',
    enable_interpolation_in_file: true,
    secret_manager_access_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.qovery.com/variable/{variableId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.qovery.com/variable/{variableId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'key' => '<string>',
    'value' => '<string>',
    'description' => '<string>',
    'enable_interpolation_in_file' => true,
    'secret_manager_access_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.qovery.com/variable/{variableId}"

	payload := strings.NewReader("{\n  \"key\": \"<string>\",\n  \"value\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enable_interpolation_in_file\": true,\n  \"secret_manager_access_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.qovery.com/variable/{variableId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"key\": \"<string>\",\n  \"value\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enable_interpolation_in_file\": true,\n  \"secret_manager_access_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/variable/{variableId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"key\": \"<string>\",\n  \"value\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enable_interpolation_in_file\": true,\n  \"secret_manager_access_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "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

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 key of the environment variable

value

string | null

the value of the environment variable

description

string | null

optional variable description (255 characters maximum)

Maximum string length: 255

enable_interpolation_in_file

boolean | null

secret_manager_access_id

string<uuid> | null

Response

Edited variable value

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,

AGENTIC_WORKFLOW

variable_type

enum<string>

required

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

Available options:

VALUE,

ALIAS,

OVERRIDE,

BUILT_IN,

FILE,

EXTERNAL_SECRET,

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