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 Environment API

The Environment API from Qovery — 6 operation(s) for environment.

Qovery Environment 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. 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 6 operations across 6 paths, and defines 16 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.

6 operations 6 paths 16 schemas 2 GET4 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 Environment 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 6

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

Environment 6
POST
/environment/{environmentId}/checkDockerfile
Check dockerfile configuration is correct
checkDockerfile 1 param body → 200400401403404
POST
/environment/{environmentId}/checkHelmRepository
Check helm repository configuration is correct
checkHelmRepository 1 param body → 200400401403404
POST
/environment/{environmentId}/checkContainerImage
Check container image configuration is correct
checkContainerImage 1 param body → 200400401403404
POST
/environment/{environmentId}/checkGitFile
Check git file configuration is correct
checkGitFile 1 param body → 200400401403404
GET
/environment/deploymentStatus
Get Deployment Status By DeploymentRequestId
getDeploymentStatusByDeploymentRequestId 1 param → 200
GET
/environment/{environmentId}/link
List environment services links
listEnvironmentServicesLinks 1 param → 200401403404

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are Link (7 properties), ApplicationGitRepositoryRequest (5 properties), HelmGitRepositoryRequest (4 properties), ContainerImageCheckRequest (3 properties). Each schema is shown below with its type and property counts.

GitFileCheckResponse
object
ContainerImageCheckResponse
object
EnvDeploymentStatus
object
3 properties
ContainerImageCheckRequest
object
3 properties 3 required
Link
object
7 properties 7 required
GitProviderEnum
string
DockerfileCheckResponse
object
3 properties 2 required
ServiceTypeEnum
string
type of the service (application, database, job, ...)
LinkResponseList
object
1 property
HelmGitRepositoryRequest
object
4 properties 4 required
HelmCheckResponse
object
ApplicationGitRepositoryRequest
object
5 properties 4 required
StateEnum
string
DockerfileCheckRequest
object
2 properties 2 required
HelmCheckRequest
object
1 property 1 required
GitFileCheckRequest
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qovery-environment-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