Skip to main content
POST
/
environment
/
{environmentId}
/
terraform
Create a terraform
curl --request POST \
  --url https://api.qovery.com/environment/{environmentId}/terraform \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "auto_approve": true,
  "auto_deploy": true,
  "terraform_files_source": {
    "git_repository": {
      "url": "<string>",
      "branch": "<string>",
      "root_path": "<string>",
      "git_token_id": "<string>"
    }
  },
  "terraform_variables_source": {
    "tf_var_file_paths": [
      "<string>"
    ],
    "tf_vars": [
      {
        "key": "<string>",
        "value": "<string>",
        "secret": true
      }
    ]
  },
  "backend": {
    "kubernetes": {}
  },
  "provider": "TERRAFORM",
  "provider_version": {
    "read_from_terraform_block": true,
    "explicit_version": "<string>"
  },
  "timeout_sec": 123,
  "icon_uri": "<string>",
  "job_resources": {
    "cpu_milli": 123,
    "ram_mib": 123,
    "gpu": 1,
    "storage_gib": 123
  },
  "use_cluster_credentials": true,
  "action_extra_arguments": {}
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "timeout_sec": 600,
  "auto_approve": true,
  "auto_deploy": true,
  "terraform_files_source": {
    "git": {
      "git_repository": {
        "has_access": true,
        "provider": "BITBUCKET",
        "owner": "John Doe",
        "url": "<string>",
        "name": "simple-node-app",
        "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>"
      }
    }
  },
  "icon_uri": "<string>",
  "service_type": "APPLICATION",
  "terraform_variables_source": {
    "tf_var_file_paths": [
      "<string>"
    ]
  },
  "provider": "TERRAFORM",
  "backend": {
    "kubernetes": {}
  },
  "provider_version": {
    "read_from_terraform_block": true,
    "explicit_version": "<string>"
  },
  "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": {}
}

Authorizations

​
Authorization
string
header
required

Token API are generated by Qovery to manage machine to machine interaction and do not have a TTL. Prefix your token with "Token ". Curl Example: curl https://console.qovery.com/organization -H "Authorization: Token $qovery_token"

Path Parameters

​
environmentId
string<uuid>
required

Body

application/json
​
name
string
required
​
description
string
required
​
auto_approve
boolean
required
​
auto_deploy
boolean
required
​
terraform_files_source
object
required
​
terraform_variables_source
object
required
​
backend
object
required

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

  • Option 1
  • Option 2
​
provider
enum<string>
required
Available options:
TERRAFORM
​
provider_version
object
required
​
job_resources
object
required
​
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

Response

Create terraform

A Terraform service

​
id
string<uuid>
required
​
created_at
string<date-time>
required
​
name
string
required

name is case insensitive

​
timeout_sec
integer
default:600
required
Required range: x >= 0
​
auto_approve
boolean
required
​
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
​
terraform_variables_source
object
required
​
provider
enum<string>
required
Available options:
TERRAFORM
​
backend
object
required

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

  • Option 1
  • Option 2
​
provider_version
object
required
​
job_resources
object
required
​
environment
object
required
​
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

​
updated_at
string<date-time>
​
description
string
​
terraform_files_source
object