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

The Applications API from Qovery — 4 operation(s) for applications.

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

Tagged areas include Applications. 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 5 operations across 4 paths, and defines 55 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.

5 operations 4 paths 55 schemas 3 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 Applications 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 5

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

Applications 5
GET
/environment/{environmentId}/application
List applications
listApplication 2 params → 200401403404
POST
/environment/{environmentId}/application
Create an application
createApplication 1 param body → 201400401403404409
GET
/environment/{environmentId}/application/status
List all environment applications statuses
getEnvironmentApplicationStatus 1 param → 200401403404
GET
/defaultApplicationAdvancedSettings
List default application advanced settings
getDefaultApplicationAdvancedSettings → 200401403
POST
/application/{applicationId}/clone
Clone application
cloneApplication 1 param body → 202401403404409

Schemas 55

The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are ApplicationAdvancedSettings (42 properties), ApplicationGitRepository (13 properties), Status (10 properties), ServicePort (9 properties). Each schema is shown below with its type and property counts.

ReferenceObject
object
1 property 1 required
ServicePortResponseList
array
GitProviderEnum
string
ServiceLabelRequest
object
1 property 1 required
ServiceStorage
object
1 property
OrganizationAnnotationsGroupScopeEnum
string
Annotations Group Scope
KedaAutoscalingResponse
BuildModeEnum
string
DOCKER requires dockerfilepath
Application
ServiceAnnotationsRequestList
array
KedaScalerRole
string
OrganizationLabelsGroupResponse
ApplicationGitRepository
object
13 properties 4 required
StorageTypeEnum
string
Healthcheck
object
2 properties
CloneServiceRequest
object
2 properties 2 required
ApplicationRequest
ServiceAnnotationRequest
object
1 property 1 required
ServiceTypeEnum
string
type of the service (application, database, job, ...)
KedaAutoscalingRequest
object
4 properties 2 required
OrganizationAnnotationsGroupResponse
ReferenceObjectStatusResponseList
object
1 property
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 properties 3 required
Probe
object
6 properties
ServiceSubActionEnum
string
ApplicationResponseList
object
1 property
KedaScalerRequest
object
6 properties 2 required
PortProtocolEnum
string
KedaTriggerAuthenticationRequest
object
2 properties 1 required
KedaTriggerAuthenticationResponse
ServiceLabelsRequestList
array
OrganizationLabelsGroupResponseList
array
ServiceStepMetric
object
3 properties
Annotation
object
2 properties 2 required
AutoscalingPolicyResponse
KedaScalerResponse
ServiceDeploymentStatusEnum
string
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…
ServiceStepMetrics
object
3 properties 3 required
ServiceActionEnum
string
ApplicationGitRepositoryRequest
object
5 properties 4 required
ReferenceObjectStatus
AutoscalingPolicyRequest
AutoscalingMode
string
ServicePortRequest
object
1 property
StateEnum
string
ServiceStorageRequest
object
1 property
ServicePort
object
9 properties 4 required
OrganizationAnnotationsGroupResponseList
array
Status
object
10 properties 7 required
ServiceActionStatusEnum
string
ApplicationAdvancedSettings
object
42 properties
Base
object
3 properties 2 required
StatusDetails
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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