Qovery Environment Main Calls API is one of 94 APIs that Qovery publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Environment Main Calls. 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
9 operations
across 7 paths,
and defines 100 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.
9 operations7 paths100 schemas1 DELETE7 GET1 PUT
Metadata
The identity and technical contract details declared by the specification.
Qovery Environment Main Calls 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 9
Across 7 paths, the API surfaces 9 operations — 1 DELETE, 7 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 100 schemas that model the data the API accepts and returns. The most detailed are ApplicationGitRepository (13 properties), DatabaseRequest (13 properties), EnvironmentStatus (11 properties), Status (10 properties). Each schema is shown below with its type and property counts.
ReferenceObject
object
1 property1 required
HelmPortResponseBase
object
8 properties4 required
Environment
GitProviderEnum
string
DeploymentHistoryTriggerAction
ServiceAnnotationsRequestList
array
BuildModeEnum
string
DOCKER requires dockerfilepath
DatabaseAccessibilityEnum
string
KedaScalerRole
string
EnvironmentDeploymentStatusEnum
JobTypeEnum
string
type of job
ContainerSource
object
4 properties3 required
DatabaseTypeEnum
string
TerraformVarKeyValue
object
A Terraform input variable
3 properties
StageStepMetrics
object
3 properties
StageStepMetric
object
4 properties
Annotation
object
2 properties2 required
TerraformBackend
Configuration for Terraform backend - exactly one backend type must be specified
AutoscalingPolicyResponse
TerraformBackendUserProvided
object
User-provided backend configuration
AutoscalingMode
string
TerraformFilesSource
object
1 property
BaseJobResponse
Status
object
10 properties7 required
EnvironmentStatuses
object
7 properties7 required
ServiceDeploymentStatusEnum
string
Base
object
3 properties2 required
DatabaseModeEnum
string
HelmKeyValues
array
The input is in json array format: [ [$KEY,$VALUE], [...] ]
HelmSourceRepositoryResponse
object
3 properties3 required
JobSourceDockerResponse
object
4 properties
TerraformEngineEnum
OrganizationAnnotationsGroupScopeEnum
string
Annotations Group Scope
KedaAutoscalingResponse
OrganizationLabelsGroupResponse
ContainerResponse
CreateEnvironmentModeEnum
string
ServiceSubActionEnum
string
EnvironmentStatusesWithStages
object
3 properties
HelmSourceGitResponse
object
1 property1 required
PortProtocolEnum
string
EnvironmentModeEnum
string
KedaTriggerAuthenticationResponse
ServiceStepMetric
object
3 properties
ServiceActionEnum
string
HelmResponse
StateEnum
string
TerraformProviderVersion
object
2 properties1 required
QueuedDeploymentRequestWithStages
object
4 properties4 required
DeploymentStageWithServicesStatuses
object
7 properties
HelmPortProtocolEnum
string
ServicePortResponseList
array
StageStatusEnum
string
ServiceStorage
object
1 property
ContainerRegistryProviderDetailsResponse
object
4 properties4 required
StageStepMetricNameEnum
string
The name of the deployment step at the stage level: - TOTAL: The total duration of the stage deployment. - QUEUEING: The step preceding the actual stage deploy…
ArgocdAppResponse
An ArgoCD service
TerraformVariablesSourceResponse
object
2 properties2 required
DockerfileFragmentInline
object
Define Dockerfile commands directly in the configuration.
2 properties2 required
ServiceTypeEnum
string
type of the service (application, database, job, ...)
OrganizationAnnotationsGroupResponse
StepMetricStatusEnum
string
The status of completion for the step: - SUCCESS: The step completed successfully. - ERROR: The step completed with an error. - CANCEL: The step was canceled.…
Label
object
3 properties3 required
TerraformBackendKubernetes
object
Kubernetes-specific backend configuration
ServiceLabelsRequestList
array
DatabaseRequest
object
13 properties4 required
EnvironmentEditRequest
object
2 properties
KedaScalerResponse
QueuedDeploymentRequestForService
object
4 properties4 required
ServiceStepMetricNameEnum
string
The name of the deployment step at the service level: - REGISTRYCREATEREPOSITORY: The step to create the repository in the registry. - GITCLONE: The step to cl…
CronJobResponse
KubernetesSelector
object
2 properties2 required
JobLifecycleTypeEnum
ServicePort
object
9 properties4 required
OrganizationAnnotationsGroupResponseList
array
ServiceActionStatusEnum
string
DockerfileFragmentFile
object
Reference a Dockerfile fragment file from your Git repository.
2 properties2 required
HelmPortResponseWithServiceName
ServiceLabelRequest
object
1 property1 required
OrganizationEventOrigin
string
Origin of the organization event
TerraformResponse
A Terraform service
TerraformAutoDeployConfig
object
2 properties2 required
Application
ApplicationGitRepository
object
13 properties4 required
Healthcheck
object
2 properties
StorageTypeEnum
string
ServiceAnnotationRequest
object
1 property1 required
TerraformJobResourcesResponse
object
4 properties4 required
EnvironmentStatus
object
11 properties3 required
EnvironmentStatusEventOriginEnum
string
Origin of the organization event
Probe
object
6 properties
OrganizationLabelsGroupResponseList
array
ContainerRegistryKindEnum
string
The type of your container registry
Database
ServiceStepMetrics
object
3 properties3 required
JobResponse
HelmPortResponseWithServiceSelectors
Stage
object
5 properties3 required
LifecycleJobResponse
StatusDetails
object
3 properties3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
