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

The ArgoCD API from Qovery — 4 operation(s) for argocd.

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

Tagged areas include ArgoCD. 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 7 operations across 4 paths, and defines 15 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.

7 operations 4 paths 15 schemas 1 DELETE3 GET3 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 ArgoCD 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 7

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

ArgoCD 7
POST
/cluster/{clusterId}/argoCdConfig
Save ArgoCD credentials for a cluster
saveArgoCdCredentials 1 param body → 200400401403404
GET
/cluster/{clusterId}/argoCdConfig
Get ArgoCD credentials for a cluster
getArgoCdCredentials 1 param → 200401403404
DELETE
/cluster/{clusterId}/argoCdConfig
Delete ArgoCD credentials for a cluster
deleteArgoCdCredentials 1 param → 204401403404
POST
/cluster/{clusterId}/argoCdConfig/check
Check ArgoCD connection
checkArgoCdConnection 1 param body → 200400401403404
POST
/organization/{organizationId}/argoCdDestinationClusterMapping
Save an ArgoCD destination cluster mapping
saveArgoCdDestinationClusterMapping 1 param body → 200400401403404
GET
/organization/{organizationId}/argoCdDestinationClusterMapping
List ArgoCD instance mappings for an organization
listArgoCdDestinationClusterMappings 1 param → 200401403404
GET
/argocdApp/{argocdAppId}
Get ArgoCD app by ID
getArgoCdApp 1 param → 200401403404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are ArgoCdInstanceMappingResponse (9 properties), ArgoCdLinkedClusterDetails (7 properties), ArgoCdCredentialsResponse (7 properties), Base (3 properties). Each schema is shown below with its type and property counts.

ArgoCdConnectionCheckResponse
object
3 properties 1 required
CloudVendorEnum
string
ArgoCdCredentialsRequest
object
2 properties 2 required
KubernetesEnum
string
ArgocdAppResponse
An ArgoCD service
ServiceTypeEnum
string
type of the service (application, database, job, ...)
ArgoCdDestinationClusterMappingRequest
object
3 properties 3 required
ArgoCdCredentialsResponse
object
7 properties 6 required
ArgoCdLinkedClusterDetails
object
7 properties 7 required
ArgoCdDestinationClusterMappingResponse
object
3 properties 3 required
ArgoCdInstanceMappingResponseList
object
1 property 1 required
ArgoCdInstanceMappingResponse
object
9 properties 9 required
ArgoCdUnlinkedClusterDetails
object
3 properties 3 required
ArgoCdConnectionStatusEnum
string
Connection status of an ArgoCD instance
Base
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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