Create a terraform

POST /environment/{environmentId}/terraform

Create a terraform

cURL

curl --request POST \
  --url https://api.qovery.com/environment/{environmentId}/terraform \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "auto_deploy_config": {
    "auto_deploy": true
  },
  "terraform_files_source": {},
  "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
  },
  "timeout_sec": 123,
  "icon_uri": "<string>",
  "use_cluster_credentials": true,
  "action_extra_arguments": {},
  "dockerfile_fragment": {
    "type": "file",
    "path": "/infra/terraform/custom-build.dockerfile"
  },
  "blueprint_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.qovery.com/environment/{environmentId}/terraform"

payload = {
    "name": "<string>",
    "description": "<string>",
    "auto_deploy_config": { "auto_deploy": True },
    "terraform_files_source": {},
    "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
    },
    "timeout_sec": 123,
    "icon_uri": "<string>",
    "use_cluster_credentials": True,
    "action_extra_arguments": {},
    "dockerfile_fragment": {
        "type": "file",
        "path": "/infra/terraform/custom-build.dockerfile"
    },
    "blueprint_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
    name: '<string>',
    description: '<string>',
    auto_deploy_config: {auto_deploy: true},
    terraform_files_source: {},
    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},
    timeout_sec: 123,
    icon_uri: '<string>',
    use_cluster_credentials: true,
    action_extra_arguments: {},
    dockerfile_fragment: {type: 'file', path: '/infra/terraform/custom-build.dockerfile'},
    blueprint_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'auto_deploy_config' => [
        'auto_deploy' => true
    ],
    'terraform_files_source' => [
        
    ],
    '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
    ],
    'timeout_sec' => 123,
    'icon_uri' => '<string>',
    'use_cluster_credentials' => true,
    'action_extra_arguments' => [
        
    ],
    'dockerfile_fragment' => [
        'type' => 'file',
        'path' => '/infra/terraform/custom-build.dockerfile'
    ],
    'blueprint_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/environment/{environmentId}/terraform"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"auto_deploy_config\": {\n    \"auto_deploy\": true\n  },\n  \"terraform_files_source\": {},\n  \"terraform_variables_source\": {\n    \"tf_var_file_paths\": [\n      \"<string>\"\n    ],\n    \"tf_vars\": [\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\",\n        \"secret\": true\n      }\n    ]\n  },\n  \"backend\": {\n    \"kubernetes\": {}\n  },\n  \"provider_version\": {\n    \"explicit_version\": \"<string>\",\n    \"read_from_terraform_block\": true\n  },\n  \"job_resources\": {\n    \"cpu_milli\": 123,\n    \"ram_mib\": 123,\n    \"gpu\": 1,\n    \"storage_gib\": 123\n  },\n  \"timeout_sec\": 123,\n  \"icon_uri\": \"<string>\",\n  \"use_cluster_credentials\": true,\n  \"action_extra_arguments\": {},\n  \"dockerfile_fragment\": {\n    \"type\": \"file\",\n    \"path\": \"/infra/terraform/custom-build.dockerfile\"\n  },\n  \"blueprint_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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/environment/{environmentId}/terraform")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"auto_deploy_config\": {\n    \"auto_deploy\": true\n  },\n  \"terraform_files_source\": {},\n  \"terraform_variables_source\": {\n    \"tf_var_file_paths\": [\n      \"<string>\"\n    ],\n    \"tf_vars\": [\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\",\n        \"secret\": true\n      }\n    ]\n  },\n  \"backend\": {\n    \"kubernetes\": {}\n  },\n  \"provider_version\": {\n    \"explicit_version\": \"<string>\",\n    \"read_from_terraform_block\": true\n  },\n  \"job_resources\": {\n    \"cpu_milli\": 123,\n    \"ram_mib\": 123,\n    \"gpu\": 1,\n    \"storage_gib\": 123\n  },\n  \"timeout_sec\": 123,\n  \"icon_uri\": \"<string>\",\n  \"use_cluster_credentials\": true,\n  \"action_extra_arguments\": {},\n  \"dockerfile_fragment\": {\n    \"type\": \"file\",\n    \"path\": \"/infra/terraform/custom-build.dockerfile\"\n  },\n  \"blueprint_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"auto_deploy_config\": {\n    \"auto_deploy\": true\n  },\n  \"terraform_files_source\": {},\n  \"terraform_variables_source\": {\n    \"tf_var_file_paths\": [\n      \"<string>\"\n    ],\n    \"tf_vars\": [\n      {\n        \"key\": \"<string>\",\n        \"value\": \"<string>\",\n        \"secret\": true\n      }\n    ]\n  },\n  \"backend\": {\n    \"kubernetes\": {}\n  },\n  \"provider_version\": {\n    \"explicit_version\": \"<string>\",\n    \"read_from_terraform_block\": true\n  },\n  \"job_resources\": {\n    \"cpu_milli\": 123,\n    \"ram_mib\": 123,\n    \"gpu\": 1,\n    \"storage_gib\": 123\n  },\n  \"timeout_sec\": 123,\n  \"icon_uri\": \"<string>\",\n  \"use_cluster_credentials\": true,\n  \"action_extra_arguments\": {},\n  \"dockerfile_fragment\": {\n    \"type\": \"file\",\n    \"path\": \"/infra/terraform/custom-build.dockerfile\"\n  },\n  \"blueprint_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

201

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

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

environmentId · string<uuid> · required

Body

application/json

name · string · required

description · string · required

auto_deploy_config · TerraformAutoDeployConfig · object · required

Show child attributes

terraform_files_source · object · required

Show child attributes

terraform_variables_source · TerraformVariablesSourceRequest · object · required

Show child attributes

backend · object · required

Configuration for Terraform backend - exactly one backend type must be specified

Option 1

Option 2

Option 3

Show child attributes

engine · enum<string> · required

Available options: TERRAFORM, OPEN_TOFU

provider_version · TerraformProviderVersion · object · required

Show child attributes

job_resources · TerraformRequestJobResources · object · required

Show child attributes

timeout_sec · integer

icon_uri · string<uri>

use_cluster_credentials · boolean

action_extra_arguments · object

The key represent the action command name i.e: "plan" The value represent the extra arguments to pass to this command

i.e: {"apply", ["-lock=false"]} is going to prepend -lock=false to terraform apply commands

Show child attributes

dockerfile_fragment · DockerfileFragmentFile · object

Custom Dockerfile fragment to inject during build. Optional field. When null, no custom fragment is injected.

DockerfileFragmentFile

DockerfileFragmentInline

Show child attributes

blueprint_id · string<uuid> | null

The blueprint ID the service has been created from

Response

201

application/json

Create terraform

A Terraform service

id · string<uuid> · required · read-only

created_at · string<date-time> · required · read-only

name · string · required

name is case insensitive

timeout_sec · integer · default: 600 · required

Required range: x >= 0

auto_deploy · boolean · required

icon_uri · string<uri> · required

Icon URI representing the terraform service.

service_type · enum<string> · required

type of the service (application, database, job, ...)

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

terraform_variables_source · TerraformVariablesSourceResponse · object · required

Show child attributes

engine · enum<string> · required

Available options: TERRAFORM, OPEN_TOFU

backend · object · required

Configuration for Terraform backend - exactly one backend type must be specified

Option 1

Option 2

Option 3

Show child attributes

provider_version · TerraformProviderVersion · object · required

Show child attributes

job_resources · TerraformJobResourcesResponse · object · required

Show child attributes

environment · object · required

Show child attributes

use_cluster_credentials · boolean · required

action_extra_arguments · object · required

The key represent the action command name i.e: "plan" The value represent the extra arguments to pass to this command

i.e: {"apply", ["-lock=false"]} is going to prepend -lock=false to terraform apply commands

Show child attributes

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

description · string

auto_deploy_config · TerraformAutoDeployConfig · object

Show child attributes

terraform_files_source · TerraformFilesSource · object

Show child attributes

dockerfile_fragment · DockerfileFragmentFile · object

Custom Dockerfile fragment to inject during build. When null, no custom fragment is injected.

DockerfileFragmentFile

DockerfileFragmentInline

Show child attributes

blueprint_id · string<uuid> | null

The blueprint ID the service has been created from