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 Clusters. 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.0.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.
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
POST
/organization/{organizationId}/cluster
Create a cluster
GET
/organization/{organizationId}/cluster/status
List all clusters statuses
DELETE
/organization/{organizationId}/cluster/{clusterId}
Delete a cluster
PUT
/organization/{organizationId}/cluster/{clusterId}
Edit a cluster
GET
/organization/{organizationId}/cluster/{clusterId}/status
Get cluster status
GET
/organization/{organizationId}/cluster/{clusterId}/installationHelmValues
Get cluster helm values for self managed installation
GET
/organization/{organizationId}/cluster/{clusterId}/kubeconfig
Get cluster kubeconfig
PUT
/organization/{organizationId}/cluster/{clusterId}/kubeconfig
Edit cluster kubeconfig
GET
/organization/{organizationId}/cluster/{clusterId}/advancedSettings
Get advanced settings
PUT
/organization/{organizationId}/cluster/{clusterId}/advancedSettings
Edit advanced settings
GET
/organization/{organizationId}/cluster/{clusterId}/routingTable
Get routing table
PUT
/organization/{organizationId}/cluster/{clusterId}/routingTable
Edit routing table
GET
/organization/{organizationId}/cluster/{clusterId}/logs
List Cluster Logs
GET
/organization/{organizationId}/cluster/{clusterId}/cloudProviderInfo
Get cluster cloud provider info and credentials
POST
/organization/{organizationId}/cluster/{clusterId}/cloudProviderInfo
Specify cluster cloud provider info and credentials
GET
/organization/{organizationId}/cluster/{clusterId}/isReady
Know if a cluster is ready to be deployed or not
POST
/organization/{organizationId}/cluster/{clusterId}/deploy
Deploy a cluster
GET
/organization/{organizationId}/cluster/{clusterId}/eks-anywhere/commits
List EKS Anywhere commits
PUT
/organization/{organizationId}/cluster/{clusterId}/eks-anywhere/commit
Update selected EKS Anywhere commit
GET
/organization/{organizationId}/cluster/{clusterId}/eks-anywhere/jwt
Get latest EKS Anywhere cluster JWT
POST
/cluster/{clusterId}/upgrade
Upgrade a cluster
PUT
/organization/{organizationId}/cluster/{clusterId}/karpenterPrivateSubnetIds
Update karpenter private fargate subnet ids
POST
/organization/{organizationId}/cluster/{clusterId}/stop
Stop cluster
GET
/defaultClusterAdvancedSettings
List default cluster advanced settings
GET
/cluster/{clusterId}/environments
List environments services by cluster id
POST
/cluster/{clusterId}/lock
Lock Cluster
DELETE
/cluster/{clusterId}/lock
Unlock Cluster
GET
/cluster/{clusterId}/events
List Cluster Kubernetes Events
GET
/cluster/{clusterId}/metrics
Fetch cluster metrics
GET
/cluster/{clusterId}/logs
Fetch cluster logs
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.
ReferenceObject
object
1 property
1 required
KarpenterNodePoolLimits
object
4 properties
4 required
ClusterRoutingTable
object
1 property
GitProviderEnum
string
ClusterLock
object
5 properties
4 required
ClusterLogs
object
6 properties
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…
Cluster
ClusterReadinessStatus
object
1 property
AwsRoleArnAuthDto
object
2 properties
2 required
InternalNetworkMonitoring
object
1 property
1 required
ClusterInfrastructureEksAnywhereBackupS3Parameters
object
4 properties
3 required
ClusterEnvironmentServiceResponse
object
3 properties
3 required
LinkedServiceTypeEnum
string
type of the service (application, database, job, gateway...)
ClusterLockRequest
object
2 properties
1 required
KarpenterCronjobNodePoolOverride
object
3 properties
KarpenterGpuNodePoolOverride
object
8 properties
GcpJsonCredentialsAuthDto
object
2 properties
1 required
AlertingConfig
object
5 properties
1 required
ClusterFeatureGcpExistingVpc
object
6 properties
1 required
SecretManagerEndpointConfigurationDto
SecretManagerAccessRequest
object
4 properties
3 required
InfrastructureOutputs
object
1 required
ClusterInfrastructureChartsParameters
object
4 properties
ClusterStatus
object
7 properties
ClusterEnvironmentResponse
object
5 properties
5 required
Base
object
3 properties
2 required
ClusterEnvironmentResponseList
object
1 property
KarpenterNodePool
object
5 properties
1 required
EksAnywhereClusterJwtResponse
object
1 property
1 required
ClusterRoutingTableRequest
object
1 property
1 required
ClusterFeatureAwsExistingVpc
object
17 properties
4 required
ClusterRequest
object
20 properties
3 required
ClusterFeatureKarpenterParametersResponse
object
2 properties
2 required
MetricsConfigurationManagedByQovery
object
6 properties
ClusterKarpenterPrivateSubnetIdsPutRequest
object
3 properties
ClusterDeploymentStatusEnum
string
KarpenterDefaultNodePoolOverride
object
2 properties
ClusterEksAnywhereGitRepository
object
5 properties
2 required
ClusterStateEnum
string
KarpenterNodePoolRequirement
object
3 properties
3 required
GcpSecretManagerEndpointDto
object
3 properties
3 required
SecretManagerAccessResponseList
array
Commit
object
7 properties
5 required
ClusterInfrastructureEksAnywhereParameters
object
3 properties
2 required
SecretManagerAuthenticationDto
ClusterLogsResponseList
object
1 property
KarpenterNodePoolConsolidation
object
4 properties
4 required
ClusterFeatureKarpenterParameters
object
6 properties
4 required
AutomaticallyConfiguredAuthDto
object
1 property
1 required
EksInfrastructureOutputs
object
5 properties
5 required
EksAnywhereCommitResponse
object
1 property
1 required
CloudWatchExportConfig
object
1 property
1 required
ClusterFeatureResponseTypeEnum
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…
CloudVendorEnum
string
ClusterLabelsGroup
object
1 property
ClusterCloudProviderInfoRequest
object
3 properties
ClusterFeatureResponse
object
14 properties
KapsuleInfrastructureOutputs
object
2 properties
2 required
CloudProviderEnum
string
KarpenterStableNodePoolOverride
object
3 properties
ClusterInfrastructureEksAnywhereBackupParameters
object
4 properties
1 required
ClusterInfrastructureMetalLbChartParameters
object
1 property
AwsStaticCredentialsAuthDto
object
4 properties
3 required
ClusterFeatureStringResponse
object
2 properties
2 required
ClusterLogsResponse
object
1 property
KarpenterNodePoolRequirementKey
CommitResponseList
object
1 property
ClusterKeda
object
1 property
1 required
SecretManagerAccessRequestList
array
ClusterResponseList
object
1 property
ClusterFeatureAwsExistingVpcResponse
object
2 properties
2 required
ClusterFeatureBooleanResponse
object
2 properties
2 required
ClusterLabelsGroupList
array
ClusterStatusResponseList
object
1 property
EksAnywhereCommitRequest
object
1 property
1 required
KarpenterNodePoolRequirementOperator
WeekdayEnum
string
KubernetesEnum
string
AwsParameterStoreEndpointDto
object
2 properties
2 required
GkeInfrastructureOutputs
object
3 properties
3 required
MetricsParameters
object
2 properties
ObservabilityResourceProfile
ClusterMetricsResponse
object
1 property
ClusterCloudProviderInfo
object
3 properties
ClusterFeatureGcpExistingVpcResponse
object
2 properties
2 required
CpuArchitectureEnum
AwsSecretManagerEndpointDto
object
2 properties
2 required
AksInfrastructureOutputs
object
3 properties
3 required
ClusterInfrastructureCertManagerChartParameters
object
1 property
ClusterInfrastructureNginxChartParameters
object
5 properties
ClusterAdvancedSettings
object
55 properties
SecretManagerAccessResponse
object
6 properties
6 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Qovery 12
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
#Clusters