List terraforms
curl --request GET \
--url https://api.qovery.com/environment/{environmentId}/terraform \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.qovery.com/environment/{environmentId}/terraform"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.qovery.com/environment/{environmentId}/terraform', 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/environment/{environmentId}/terraform",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.qovery.com/environment/{environmentId}/terraform"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.qovery.com/environment/{environmentId}/terraform")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qovery.com/environment/{environmentId}/terraform")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"timeout_sec": 600,
"auto_deploy": true,
"icon_uri": "<string>",
"terraform_variables_source": {
"tf_var_file_paths": [
"<string>"
],
"tf_vars": [
{
"key": "<string>",
"value": "<string>",
"secret": true
}
]
},
"backend": {
"kubernetes": {}
},
"provider_version": {
"explicit_version": "<string>",
"read_from_terraform_block": true
},
"job_resources": {
"cpu_milli": 123,
"ram_mib": 123,
"gpu": 1,
"storage_gib": 123
},
"environment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"use_cluster_credentials": true,
"action_extra_arguments": {},
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"auto_deploy_config": {
"auto_deploy": true
},
"terraform_files_source": {
"git": {
"git_repository": {
"owner": "John Doe",
"url": "<string>",
"name": "simple-node-app",
"has_access": true,
"branch": "<string>",
"root_path": "<string>",
"deployed_commit_id": "<string>",
"deployed_commit_date": "2023-11-07T05:31:56Z",
"deployed_commit_contributor": "<string>",
"deployed_commit_tag": "v1.0.1",
"git_token_id": "<string>",
"git_token_name": "<string>"
}
}
},
"dockerfile_fragment": {
"type": "file",
"path": "/infra/terraform/custom-build.dockerfile"
},
"blueprint_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}Terraforms
List terraforms
GET
/
environment
/
{environmentId}
/
terraform
List terraforms
curl --request GET \
--url https://api.qovery.com/environment/{environmentId}/terraform \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.qovery.com/environment/{environmentId}/terraform"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.qovery.com/environment/{environmentId}/terraform', 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/environment/{environmentId}/terraform",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.qovery.com/environment/{environmentId}/terraform"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.qovery.com/environment/{environmentId}/terraform")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qovery.com/environment/{environmentId}/terraform")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"results": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"timeout_sec": 600,
"auto_deploy": true,
"icon_uri": "<string>",
"terraform_variables_source": {
"tf_var_file_paths": [
"<string>"
],
"tf_vars": [
{
"key": "<string>",
"value": "<string>",
"secret": true
}
]
},
"backend": {
"kubernetes": {}
},
"provider_version": {
"explicit_version": "<string>",
"read_from_terraform_block": true
},
"job_resources": {
"cpu_milli": 123,
"ram_mib": 123,
"gpu": 1,
"storage_gib": 123
},
"environment": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"use_cluster_credentials": true,
"action_extra_arguments": {},
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"auto_deploy_config": {
"auto_deploy": true
},
"terraform_files_source": {
"git": {
"git_repository": {
"owner": "John Doe",
"url": "<string>",
"name": "simple-node-app",
"has_access": true,
"branch": "<string>",
"root_path": "<string>",
"deployed_commit_id": "<string>",
"deployed_commit_date": "2023-11-07T05:31:56Z",
"deployed_commit_contributor": "<string>",
"deployed_commit_tag": "v1.0.1",
"git_token_id": "<string>",
"git_token_name": "<string>"
}
}
},
"dockerfile_fragment": {
"type": "file",
"path": "/infra/terraform/custom-build.dockerfile"
},
"blueprint_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
}Authorizations
bearerAuthApiKeyAuth
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
Response
List terraforms
Show child attributes
Show child attributes
Was this page helpful?
⌘I