Import variables

Import environment variables in a defined scope, with a defined visibility.

POST /variable/import

Import variables

cURL

curl --request POST \
  --url https://api.qovery.com/variable/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "overwrite": false,
  "vars": [
    {
      "name": "<string>",
      "value": "<string>",
      "is_secret": true
    }
  ]
}
'

import requests

url = "https://api.qovery.com/variable/import"

payload = {
    "overwrite": False,
    "vars": [
        {
            "name": "<string>",
            "value": "<string>",
            "is_secret": True
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    overwrite: false,
    vars: [{name: '<string>', value: '<string>', is_secret: true}]
  })
};

fetch('https://api.qovery.com/variable/import', 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/import",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'overwrite' => false,
    'vars' => [
        [
                'name' => '<string>',
                'value' => '<string>',
                'is_secret' => true
        ]
    ]
  ]),
  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/import"

	payload := strings.NewReader("{\n  \"overwrite\": false,\n  \"vars\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"is_secret\": true\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.qovery.com/variable/import")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"overwrite\": false,\n  \"vars\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"is_secret\": true\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/variable/import")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"overwrite\": false,\n  \"vars\": [\n    {\n      \"name\": \"<string>\",\n      \"value\": \"<string>\",\n      \"is_secret\": true\n    }\n  ]\n}"

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

201

{
  "total_variables_to_import": 123,
  "successful_imported_variables": [
    {
      "name": "<string>",
      "is_secret": true,
      "value": "<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" '

Query Parameters

service_id · string<uuid> · required

service id

service_type · enum<string> · required

service type type of the service

Available options: APPLICATION, CONTAINER, JOB, HELM, TERRAFORM

Body

application/json

overwrite · boolean · default: false · required

vars · object[] · required

Show child attributes

Response

201

application/json

Import environment variables

total_variables_to_import · number · required

successful_imported_variables · object[] · required

Show child attributes