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

The Clusters API from Qovery — 24 operation(s) for clusters.

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

Tagged areas include Cluster. 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 31 operations across 24 paths, and defines 94 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.

31 operations 24 paths 94 schemas 2 DELETE17 GET6 POST6 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 Clusters 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 31

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

Clusters 31
GET
/organization/{organizationId}/cluster
List organization clusters
listOrganizationCluster 1 param → 200401403404
POST
/organization/{organizationId}/cluster
Create a cluster
createCluster 1 param body → 201400401403404
GET
/organization/{organizationId}/cluster/status
List all clusters statuses
getOrganizationClusterStatus 1 param → 200401403404
DELETE
/organization/{organizationId}/cluster/{clusterId}
Delete a cluster
deleteCluster 3 params → 204401403404
PUT
/organization/{organizationId}/cluster/{clusterId}
Edit a cluster
editCluster 2 params body → 200400401403404
GET
/organization/{organizationId}/cluster/{clusterId}/status
Get cluster status
getClusterStatus 2 params → 200401403404
GET
/organization/{organizationId}/cluster/{clusterId}/installationHelmValues
Get cluster helm values for self managed installation
getInstallationHelmValues 2 params → 200401403404
GET
/organization/{organizationId}/cluster/{clusterId}/kubeconfig
Get cluster kubeconfig
getClusterKubeconfig 3 params → 200401403404
PUT
/organization/{organizationId}/cluster/{clusterId}/kubeconfig
Edit cluster kubeconfig
editClusterKubeconfig 2 params body → 204401403404
GET
/organization/{organizationId}/cluster/{clusterId}/advancedSettings
Get advanced settings
getClusterAdvancedSettings 2 params → 200401403404
PUT
/organization/{organizationId}/cluster/{clusterId}/advancedSettings
Edit advanced settings
editClusterAdvancedSettings 2 params body → 201400401403404
GET
/organization/{organizationId}/cluster/{clusterId}/routingTable
Get routing table
getRoutingTable 2 params → 200401403404
PUT
/organization/{organizationId}/cluster/{clusterId}/routingTable
Edit routing table
editRoutingTable 2 params body → 201400401403404
GET
/organization/{organizationId}/cluster/{clusterId}/logs
List Cluster Logs
listClusterLogs 2 params → 200401403404
GET
/organization/{organizationId}/cluster/{clusterId}/cloudProviderInfo
Get cluster cloud provider info and credentials
getOrganizationCloudProviderInfo 2 params → 200401403404
POST
/organization/{organizationId}/cluster/{clusterId}/cloudProviderInfo
Specify cluster cloud provider info and credentials
specifyClusterCloudProviderInfo 2 params body → 201400401403404
GET
/organization/{organizationId}/cluster/{clusterId}/isReady
Know if a cluster is ready to be deployed or not
getClusterReadinessStatus 2 params → 200401403404
POST
/organization/{organizationId}/cluster/{clusterId}/deploy
Deploy a cluster
deployCluster 3 params → 201400401403404
GET
/organization/{organizationId}/cluster/{clusterId}/eks-anywhere/commits
List EKS Anywhere commits
listEksAnywhereCommits 2 params → 200401403404
PUT
/organization/{organizationId}/cluster/{clusterId}/eks-anywhere/commit
Update selected EKS Anywhere commit
updateEksAnywhereCommit 2 params body → 200400401403404
GET
/organization/{organizationId}/cluster/{clusterId}/eks-anywhere/jwt
Get latest EKS Anywhere cluster JWT
getEksAnywhereClusterJwt 2 params → 200400401403404
POST
/cluster/{clusterId}/upgrade
Upgrade a cluster
upgradeCluster 1 param → 201400401403404
PUT
/organization/{organizationId}/cluster/{clusterId}/karpenterPrivateSubnetIds
Update karpenter private fargate subnet ids
updateKarpenterPrivateFargateSubnetIds 2 params body → 200400401403404
POST
/organization/{organizationId}/cluster/{clusterId}/stop
Stop cluster
StopCluster 2 params → 202401403404409
GET
/defaultClusterAdvancedSettings
List default cluster advanced settings
getDefaultClusterAdvancedSettings → 200401403
GET
/cluster/{clusterId}/environments
List environments services by cluster id
get-environments-by-cluster-id 1 param → 200401403404
POST
/cluster/{clusterId}/lock
Lock Cluster
lockCluster 1 param body → 200401403404
DELETE
/cluster/{clusterId}/lock
Unlock Cluster
unlock-cluster 1 param → 204401403404
GET
/cluster/{clusterId}/events
List Cluster Kubernetes Events
get-cluster-kubernetes-events 6 params → 200
GET
/cluster/{clusterId}/metrics
Fetch cluster metrics
get-cluster-metrics 17 params → 200
GET
/cluster/{clusterId}/logs
Fetch cluster logs
get-cluster-logs 11 params → 200

Schemas 94

The contract defines 94 schemas that model the data the API accepts and returns. The most detailed are ClusterAdvancedSettings (55 properties), ClusterRequest (20 properties), ClusterFeatureAwsExistingVpc (17 properties), ClusterFeatureResponse (14 properties). Each schema is shown below with its type and property counts.

ClusterStatusResponseList
object
1 property
KarpenterCronjobNodePoolOverride
object
3 properties
SecretManagerAccessResponseList
array
ClusterAdvancedSettings
object
55 properties
KarpenterNodePoolRequirementOperator
Commit
objectnull
7 properties 5 required
RegistryMirroringModeEnum
string
Mirroring mode when deploying a service from a container registry - Cluster: This is not available on Scaleway. Images within the mirroring registry are organi…
CloudVendorEnum
string
AwsSecretManagerEndpointDto
object
2 properties 2 required
ClusterKarpenterPrivateSubnetIdsPutRequest
object
3 properties
KubernetesEnum
string
ClusterStateEnum
string
ClusterLogsResponseList
object
1 property
InfrastructureOutputs
object
1 required
ClusterInfrastructureNginxChartParameters
object
5 properties
InternalNetworkMonitoring
object
1 property 1 required
CloudWatchExportConfig
object
1 property 1 required
ClusterFeatureGcpExistingVpc
object
6 properties 1 required
WeekdayEnum
string
KarpenterNodePoolConsolidation
object
4 properties 4 required
AksInfrastructureOutputs
object
3 properties 3 required
CommitResponseList
object
1 property
ClusterDeploymentStatusEnum
string
ClusterResponseList
object
1 property
MetricsConfigurationManagedByQovery
object
6 properties
ClusterRoutingTableRequest
object
1 property 1 required
ClusterEnvironmentResponse
object
5 properties 5 required
ClusterKeda
object
1 property 1 required
ClusterRequest
object
20 properties 3 required
ClusterInfrastructureMetalLbChartParameters
object
1 property
ClusterFeatureKarpenterParameters
object
6 properties 4 required
SecretManagerAccessRequest
object
4 properties 3 required
ClusterRoutingTable
object
1 property
SecretManagerAuthenticationDto
GcpSecretManagerEndpointDto
object
3 properties 3 required
ClusterFeatureAwsExistingVpcResponse
object
2 properties 2 required
ClusterMetricsResponse
object
1 property
KarpenterGpuNodePoolOverride
object
8 properties
KarpenterStableNodePoolOverride
object
3 properties
ClusterStatus
object
7 properties
CloudProviderEnum
string
GitProviderEnum
string
ClusterDeleteMode
string
Indicates the mode to apply on cluster deletion "hard delete" means that we delete directly from our database, this is different from a "trigger delete" that c…
ClusterInfrastructureEksAnywhereParameters
object
3 properties 2 required
ClusterLogsResponse
object
1 property
SecretManagerEndpointConfigurationDto
SecretManagerAccessRequestList
array
ClusterFeatureResponseTypeEnum
string
EksAnywhereCommitResponse
object
1 property 1 required
ClusterEnvironmentServiceResponse
object
3 properties 3 required
KarpenterNodePoolLimits
object
4 properties 4 required
ClusterEksAnywhereGitRepository
object
5 properties 2 required
ClusterInfrastructureEksAnywhereBackupParameters
object
4 properties 1 required
AwsParameterStoreEndpointDto
object
2 properties 2 required
LinkedServiceTypeEnum
string
type of the service (application, database, job, gateway...)
ClusterFeatureResponse
object
14 properties
ClusterLabelsGroupList
array
ClusterLockRequest
object
2 properties 1 required
ClusterCloudProviderInfoRequest
object
3 properties
EksAnywhereCommitRequest
object
1 property 1 required
ClusterFeatureKarpenterParametersResponse
object
2 properties 2 required
ObservabilityResourceProfile
ClusterInfrastructureEksAnywhereBackupS3Parameters
object
4 properties 3 required
ClusterFeatureGcpExistingVpcResponse
object
2 properties 2 required
ClusterFeatureStringResponse
object
2 properties 2 required
KarpenterNodePoolRequirementKey
ClusterFeatureBooleanResponse
object
2 properties 2 required
MetricsParameters
object
2 properties
KarpenterDefaultNodePoolOverride
object
2 properties
ClusterEnvironmentResponseList
object
1 property
Base
object
3 properties 2 required
KarpenterNodePool
object
5 properties 1 required
ClusterFeatureAwsExistingVpc
object
17 properties 4 required
SecretManagerAccessResponse
object
6 properties 6 required
EksInfrastructureOutputs
object
5 properties 5 required
KarpenterNodePoolRequirement
object
3 properties 3 required
CpuArchitectureEnum
ClusterLabelsGroup
object
1 property
GkeInfrastructureOutputs
object
3 properties 3 required
ClusterInfrastructureChartsParameters
object
4 properties
Cluster
EksAnywhereClusterJwtResponse
object
1 property 1 required
AwsStaticCredentialsAuthDto
object
4 properties 3 required
AutomaticallyConfiguredAuthDto
object
1 property 1 required
KapsuleInfrastructureOutputs
object
2 properties 2 required
GcpJsonCredentialsAuthDto
object
2 properties 1 required
ClusterLock
object
5 properties 4 required
ClusterCloudProviderInfo
object
3 properties
ClusterReadinessStatus
object
1 property
ClusterLogs
object
6 properties
AlertingConfig
object
5 properties 1 required
AwsRoleArnAuthDto
object
2 properties 2 required
ReferenceObject
object
1 property 1 required
ClusterInfrastructureCertManagerChartParameters
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qovery-clusters-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 Clusters 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.