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

The Cloud Provider Credentials API from Qovery — 10 operation(s) for cloud provider credentials.

Qovery Cloud Provider Credentials 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 Credentials. 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 25 operations across 10 paths, and defines 18 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.

25 operations 10 paths 18 schemas 5 DELETE10 GET5 POST5 PUT

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 Credentials 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 25

Across 10 paths, the API surfaces 25 operations — 5 DELETE, 10 GET, 5 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Cloud Provider Credentials 25
GET
/organization/{organizationId}/aws/credentials
List AWS credentials
listAWSCredentials 1 param → 200401403404
POST
/organization/{organizationId}/aws/credentials
Create AWS credentials set
createAWSCredentials 1 param body → 201400401403404
GET
/organization/{organizationId}/aws/credentials/{credentialsId}
Get a set of AWS credentials
getAWSCredentials 2 params → 200400401403404
PUT
/organization/{organizationId}/aws/credentials/{credentialsId}
Edit a set of AWS credentials
editAWSCredentials 2 params body → 200400401403404
DELETE
/organization/{organizationId}/aws/credentials/{credentialsId}
Delete a set of AWS credentials
deleteAWSCredentials 2 params → 204401403404
GET
/organization/{organizationId}/onPremise/credentials
List OnPremise credentials
listOnPremiseCredentials 1 param → 200401403404
POST
/organization/{organizationId}/onPremise/credentials
Create OnPremise credentials set
createOnPremiseCredentials 1 param body → 201400401403404
GET
/organization/{organizationId}/onPremise/credentials/{credentialsId}
Get a set of OnPremise credentials
getOnPremiseCredentials 2 params → 200400401403404
PUT
/organization/{organizationId}/onPremise/credentials/{credentialsId}
Edit a set of OnPremise credentials
editOnPremiseCredentials 2 params body → 200400401403404
DELETE
/organization/{organizationId}/onPremise/credentials/{credentialsId}
Delete a set of OnPremise credentials
deleteOnPremiseCredentials 2 params → 204401403404
GET
/organization/{organizationId}/scaleway/credentials
List Scaleway credentials
listScalewayCredentials 1 param → 200401403404
POST
/organization/{organizationId}/scaleway/credentials
Create Scaleway credentials set
createScalewayCredentials 1 param body → 201400401403404
GET
/organization/{organizationId}/scaleway/credentials/{credentialsId}
Get a set of Scaleway credentials
getScalewayCredentials 2 params → 200400401403404
PUT
/organization/{organizationId}/scaleway/credentials/{credentialsId}
Edit a set of Scaleway credentials
editScalewayCredentials 2 params body → 200400401403404
DELETE
/organization/{organizationId}/scaleway/credentials/{credentialsId}
Delete a set of Scaleway credentials
deleteScalewayCredentials 2 params → 204401403404
GET
/organization/{organizationId}/gcp/credentials
List GCP credentials
listGcpCredentials 1 param → 200401403404
POST
/organization/{organizationId}/gcp/credentials
Create GCP credentials set
createGcpCredentials 1 param body → 201400401403404
GET
/organization/{organizationId}/gcp/credentials/{credentialsId}
Get a set of GCP credentials
getGcpCredentials 2 params → 200400401403404
PUT
/organization/{organizationId}/gcp/credentials/{credentialsId}
Edit a set of GCP credentials
editGcpCredentials 2 params body → 200400401403404
DELETE
/organization/{organizationId}/gcp/credentials/{credentialsId}
Delete a set of GCP credentials
deleteGcpCredentials 2 params → 204401403404
GET
/organization/{organizationId}/azure/credentials
List Azure credentials
listAzureCredentials 1 param → 200401403404
POST
/organization/{organizationId}/azure/credentials
Create Azure credentials set
createAzureCredentials 1 param body → 201400401403404
GET
/organization/{organizationId}/azure/credentials/{credentialsId}
Get a set of Azure credentials
getAzureCredentials 2 params → 200400401403404
PUT
/organization/{organizationId}/azure/credentials/{credentialsId}
Edit a set of Azure credentials
editAzureCredentials 2 params body → 200400401403404
DELETE
/organization/{organizationId}/azure/credentials/{credentialsId}
Delete a set of Azure credentials
deleteAzureCredentials 2 params → 204401403404

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are AzureStaticClusterCredentials (7 properties), EksAnywhereVsphereClusterCredentials (6 properties), ScalewayClusterCredentials (6 properties), EksAnywhereVsphereStaticCredentialsRequest (6 properties). Each schema is shown below with its type and property counts.

AwsCredentialsRequest
GenericClusterCredentials
object
3 properties 3 required
GcpStaticClusterCredentials
object
3 properties 3 required
AzureStaticClusterCredentials
object
7 properties 7 required
GcpCredentialsRequest
object
2 properties 2 required
ClusterCredentials
OnPremiseCredentialsRequest
object
1 property 1 required
AzureCredentialsRequest
object
3 properties 3 required
AwsStaticClusterCredentials
object
4 properties 4 required
EksAnywhereVsphereRoleCredentialsRequest
object
5 properties 5 required
AwsStaticCredentialsRequest
object
4 properties 4 required
EksAnywhereVsphereClusterCredentials
object
6 properties 4 required
AwsRoleCredentialsRequest
object
3 properties 3 required
ClusterCredentialsResponseList
object
1 property
ScalewayCredentialsRequest
object
5 properties 5 required
ScalewayClusterCredentials
object
6 properties 6 required
AwsRoleClusterCredentials
object
4 properties 4 required
EksAnywhereVsphereStaticCredentialsRequest
object
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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