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 Cloud Provider API

The Cloud Provider API from Qovery — 18 operation(s) for cloud provider.

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

Tagged areas include Cloud Provider. 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 18 operations across 18 paths, and defines 34 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.

18 operations 18 paths 34 schemas 18 GET

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 Cloud Provider 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 18

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

Cloud Provider 18
GET
/cloudProvider
List Cloud providers available
listCloudProvider → 200401403404
GET
/aws/region
List AWS regions
listAWSRegions → 200401403404
GET
/aws/clusterFeature
List AWS features available
listAWSFeatures → 200401403404
GET
/aws/instanceType
List AWS available instance types
listAWSInstanceType → 200401403404
GET
/aws/managedDatabase/type
List AWS available managed database types
listAWSManagedDatabaseType → 200401403404
GET
/aws/managedDatabase/instanceType/{region}/{databaseType}
List AWS available managed database instance types
listAWSManagedDatabaseInstanceType 2 params → 200401403404
GET
/azure/aks/instanceType/{region}
List Azure AKS available instance types
listAzureAKSInstanceType 4 params → 200401403404
GET
/aws/eks/instanceType/{region}
List AWS EKS available instance types
listAWSEKSInstanceType 4 params → 200401403404
GET
/scaleway/region
List Scaleway regions
listScalewayRegions → 200401403404
GET
/scaleway/clusterFeature
List Scaleway features available
listScalewayFeatures → 200401403404
GET
/scaleway/instanceType
List Scaleway available instance types
listScalewayInstanceType → 200401403404
GET
/scaleway/managedDatabase/type
List Scaleway available managed database types
listSCWManagedDatabaseType → 200401403404
GET
/scaleway/instanceType/{zone}
List Scaleway Kapsule available instance types
listScalewayKapsuleInstanceType 1 param → 200401403404
GET
/gcp/region
List GCP regions
listGcpRegions → 200401403404
GET
/gcp/clusterFeature
List GCP features available
listGcpFeatures → 200401403404
GET
/gcp/instanceType/{region}
List GCP GKE available instance types
listGcpGkeInstanceType 1 param → 200401403404
GET
/azure/region
List Azure regions
listAzureRegions → 200401403404
GET
/azure/clusterFeature
List Azure features available
listAzureFeatures → 200401403404

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are ClusterFeatureAwsExistingVpc (17 properties), ClusterFeatureResponse (14 properties), KarpenterGpuNodePoolOverride (8 properties), ClusterFeatureKarpenterParameters (6 properties). Each schema is shown below with its type and property counts.

ClusterFeatureKarpenterParameters
object
6 properties 4 required
ManagedDatabaseTypeResponseList
object
1 property
CloudProvider
object
4 properties
ClusterFeatureAwsExistingVpcResponse
object
2 properties 2 required
KarpenterNodePoolLimits
object
4 properties 4 required
ClusterRegion
object
5 properties 4 required
ClusterFeatureBooleanResponse
object
2 properties 2 required
KarpenterNodePool
object
5 properties 1 required
ClusterFeatureResponseTypeEnum
string
ClusterFeatureAwsExistingVpc
object
17 properties 4 required
ManagedDatabaseInstanceTypeResponse
object
1 property 1 required
ClusterFeatureKarpenterParametersResponse
object
2 properties 2 required
KarpenterNodePoolRequirementOperator
WeekdayEnum
string
ClusterInstanceGpuInfo
object
4 properties
CloudProviderResponseList
object
1 property
ClusterFeatureResponse
object
14 properties
KarpenterCronjobNodePoolOverride
object
3 properties
ClusterFeatureGcpExistingVpcResponse
object
2 properties 2 required
ManagedDatabaseTypeResponse
object
1 property 1 required
KarpenterGpuNodePoolOverride
object
8 properties
CpuArchitectureEnum
KarpenterStableNodePoolOverride
object
3 properties
KarpenterDefaultNodePoolOverride
object
2 properties
ClusterFeatureGcpExistingVpc
object
6 properties 1 required
ManagedDatabaseInstanceTypeResponseList
object
1 property
ClusterInstanceTypeResponseList
object
1 property
ClusterFeatureStringResponse
object
2 properties 2 required
ClusterFeatureResponseList
object
1 property
KarpenterNodePoolRequirement
object
3 properties 3 required
ClusterRegionResponseList
object
1 property
KarpenterNodePoolRequirementKey
KarpenterNodePoolConsolidation
object
4 properties 4 required
ClusterInstanceAttributes
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qovery-cloud-provider-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