How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qovery Environment Main Calls API

The Environment Main Calls API from Qovery — 7 operation(s) for environment main calls.

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.2.0, at version 1.0.4.

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

9 operations 7 paths 100 schemas 1 DELETE7 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

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.

Environment Main Calls 9
GET
/environment/{environmentId}
Get environment by ID
getEnvironment 1 param → 200401403404
PUT
/environment/{environmentId}
Edit an environment
editEnvironment 1 param body → 200400401403404409
DELETE
/environment/{environmentId}
Delete an environment
deleteEnvironment 1 param → 204401403404
GET
/environment/{environmentId}/status
Get environment status
getEnvironmentStatus 1 param → 200401403404
GET
/environment/{environmentId}/statuses
Get environment statuses with services status
getEnvironmentStatuses 1 param → 200401403404
GET
/environment/{environmentId}/statusesWithStages
Get environment statuses with stages
getEnvironmentStatusesWithStages 1 param → 200401403404
GET
/environment/{environmentId}/services
List Services By EnvironmentId
listServicesByEnvironmentId 1 param → 200
GET
/environment/{environmentId}/deploymentQueue
List Deployment Queue Request By EnvironmentId
listDeploymentRequestByEnvironmentId 1 param → 200
GET
/service/{serviceId}/deploymentQueue
List Deployment Queue Request By ServiceId
listDeploymentRequestByServiceId 1 param → 200

Schemas 100

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.

ServiceActionEnum
string
Probe
objectnull
6 properties
ServiceActionStatusEnum
string
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…
OrganizationLabelsGroupResponseList
array
ContainerRegistryKindEnum
string
The type of your container registry
OrganizationAnnotationsGroupResponse
KedaScalerRole
string
Environment
EnvironmentEditRequest
object
2 properties
Healthcheck
object
2 properties
TerraformBackendKubernetes
object
Kubernetes-specific backend configuration
ServiceSubActionEnum
string
BaseJobResponse
HelmPortResponseWithServiceName
ContainerRegistryProviderDetailsResponse
object
4 properties 4 required
TerraformBackend
Configuration for Terraform backend - exactly one backend type must be specified
ServiceDeploymentStatusEnum
string
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.…
JobLifecycleTypeEnum
AutoscalingPolicyResponse
HelmSourceGitResponse
object
1 property 1 required
StageStepMetrics
object
3 properties
EnvironmentStatusesWithStages
object
3 properties
DatabaseModeEnum
string
TerraformJobResourcesResponse
object
4 properties 4 required
KedaScalerResponse
HelmPortResponseBase
object
8 properties 4 required
ApplicationGitRepository
object
13 properties 4 required
KedaAutoscalingResponse
HelmPortResponseWithServiceSelectors
Database
StageStepMetric
object
4 properties
HelmResponse
TerraformVariablesSourceResponse
object
2 properties 2 required
HelmPortProtocolEnum
string
StorageTypeEnum
string
TerraformEngineEnum
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…
TerraformAutoDeployConfig
object
2 properties 2 required
OrganizationAnnotationsGroupScopeEnum
string
Annotations Group Scope
GitProviderEnum
string
TerraformVarKeyValue
object
A Terraform input variable
3 properties
EnvironmentDeploymentStatusEnum
ServiceAnnotationsRequestList
array
DockerfileFragmentInline
object
Define Dockerfile commands directly in the configuration.
2 properties 2 required
ServiceStorage
object
1 property
ServiceLabelRequest
object
1 property 1 required
StatusDetails
object
3 properties 3 required
JobResponse
TerraformProviderVersion
object
2 properties 1 required
ServiceStepMetric
object
3 properties
DeploymentStageWithServicesStatuses
object
7 properties
JobSourceDockerResponse
object
4 properties
DatabaseRequest
object
13 properties 4 required
ServicePort
object
9 properties 4 required
DatabaseAccessibilityEnum
string
ServiceStepMetrics
object
3 properties 3 required
Status
object
10 properties 7 required
KubernetesSelector
object
2 properties 2 required
EnvironmentModeEnum
string
JobTypeEnum
string
type of job
CronJobResponse
BuildModeEnum
string
DOCKER requires dockerfilepath
Annotation
object
2 properties 2 required
ServiceTypeEnum
string
type of the service (application, database, job, ...)
ContainerSource
object
4 properties 3 required
KedaTriggerAuthenticationResponse
EnvironmentStatus
object
11 properties 3 required
StageStatusEnum
string
Application
PortProtocolEnum
string
ContainerResponse
HelmSourceRepositoryResponse
object
3 properties 3 required
DockerfileFragmentFile
object
Reference a Dockerfile fragment file from your Git repository.
2 properties 2 required
QueuedDeploymentRequestWithStages
object
4 properties 4 required
Base
object
3 properties 2 required
EnvironmentStatusEventOriginEnum
stringnull
Origin of the organization event
ServiceLabelsRequestList
array
TerraformResponse
A Terraform service
AutoscalingMode
string
OrganizationEventOrigin
string
Origin of the organization event
ServicePortResponseList
array
ServiceAnnotationRequest
object
1 property 1 required
EnvironmentStatuses
object
7 properties 7 required
Label
object
3 properties 3 required
CreateEnvironmentModeEnum
string
LifecycleJobResponse
OrganizationLabelsGroupResponse
ArgocdAppResponse
An ArgoCD service
OrganizationAnnotationsGroupResponseList
array
TerraformBackendUserProvided
object
User-provided backend configuration
QueuedDeploymentRequestForService
object
4 properties 4 required
HelmKeyValues
array
The input is in json array format: [ [$KEY,$VALUE], [...] ]
TerraformFilesSource
object
1 property
DatabaseTypeEnum
string
Stage
object
5 properties 3 required
StateEnum
string
DeploymentHistoryTriggerAction
ReferenceObject
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qovery-environment-main-calls-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
Where this information came from

This is an independent, third-party profile of Qovery Environment Main Calls API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.