Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qovery Terraforms API

The Terraforms API from Qovery — 3 operation(s) for terraforms.

Qovery Terraforms API is one of 94 APIs that Qovery publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Terraforms. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, authentication docs, and rate-limit docs.

This API exposes 4 operations across 3 paths, and defines 25 schemas. It is described by OpenAPI 3.0.0, at version 1.0.4.

Requests are made against a single base URL, https://api.qovery.com.

4 operations 3 paths 25 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.4
Base URL
https://api.qovery.com
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Qovery Terraforms API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • bearerAuth — 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 ' cu…
  • ApiKeyAuth — Token API are generated by Qovery to manage machine to machine interaction and do not have a TTL. Curl Example ' curl https://console.qovery.com/organization -…

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Terraforms 4
GET
/environment/{environmentId}/terraform
List terraforms
listTerraforms 1 param → 200401403404
POST
/environment/{environmentId}/terraform
Create a terraform
createTerraform 1 param body → 201400401403404409
GET
/defaultTerraformAdvancedSettings
List default terraform advanced settings
getDefaultTerraformAdvancedSettings → 200401403
POST
/terraform/{terraformId}/clone
Clone terraform
cloneTerraform 1 param body → 202401403404409

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are TerraformRequest (14 properties), ApplicationGitRepository (13 properties), TerraformAdvancedSettings (8 properties), TerraformGitRepositoryRequest (4 properties). Each schema is shown below with its type and property counts.

TerraformProviderVersion
object
2 properties 1 required
TerraformResponseList
object
1 property
ReferenceObject
object
1 property 1 required
TerraformGitRepositoryRequest
object
4 properties 1 required
DockerfileFragmentFile
object
Reference a Dockerfile fragment file from your Git repository.
2 properties 2 required
GitProviderEnum
string
TerraformResponse
A Terraform service
TerraformEngineEnum
TerraformAutoDeployConfig
object
2 properties 2 required
TerraformRequest
object
14 properties 9 required
ApplicationGitRepository
object
13 properties 4 required
CloneServiceRequest
object
2 properties 2 required
TerraformVariablesSourceResponse
object
2 properties 2 required
TerraformVarKeyValue
object
A Terraform input variable
3 properties
TerraformJobResourcesResponse
object
4 properties 4 required
DockerfileFragmentInline
object
Define Dockerfile commands directly in the configuration.
2 properties 2 required
ServiceTypeEnum
string
type of the service (application, database, job, ...)
TerraformAdvancedSettings
object
8 properties
TerraformBackendKubernetes
object
Kubernetes-specific backend configuration
TerraformVariablesSourceRequest
object
2 properties 2 required
TerraformBackend
Configuration for Terraform backend - exactly one backend type must be specified
TerraformBackendUserProvided
object
User-provided backend configuration
TerraformRequestJobResources
object
4 properties 4 required
TerraformFilesSource
object
1 property
Base
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qovery-terraforms-api-openapi.yml Raw ↑

Other APIs Qovery publishes across the network.

Qovery Account Info API
Qovery Alert Receivers API
Qovery Alert Rules API
Qovery Application Actions API
Qovery Application Configuration API
Qovery Application Custom Domain API
Qovery Application Deployment History API
Qovery Application Deployment Restriction API
Qovery Application Environment Variable API
Qovery Application Logs API
Qovery Application Main Calls API
Qovery Application Secret API