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 Helm Main Calls API

The Helm Main Calls API from Qovery — 5 operation(s) for helm main calls.

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

Tagged areas include Helm Main Calls. 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 5 paths, and defines 38 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 5 paths 38 schemas 1 DELETE5 GET1 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 Helm Main Calls 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 5 paths, the API surfaces 7 operations — 1 DELETE, 5 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Helm Main Calls 7
GET
/helm/{helmId}
Get helm by ID
getHelm 1 param → 200401403404
PUT
/helm/{helmId}
Edit helm
editHelm 1 param body → 200400401403404409
DELETE
/helm/{helmId}
Delete helm
deleteHelm 1 param → 204401403404
GET
/helm/{helmId}/commit
List last helm commits
listHelmCommit 2 params → 200401403404
GET
/helm/{helmId}/status
Get helm status
getHelmStatus 1 param → 200401403404
GET
/helm/{helmId}/link
List all URLs of the helm
listHelmLinks 1 param → 200401403404
GET
/helm/{helmId}/listServices
Get helm kubernetes services
getHelmKubernetesServices 1 param → 200401403404

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are ApplicationGitRepository (13 properties), Status (10 properties), HelmPortResponseBase (8 properties), Link (7 properties). Each schema is shown below with its type and property counts.

HelmPortResponseBase
object
8 properties 4 required
ReferenceObject
object
1 property 1 required
HelmPortProtocolEnum
string
Link
object
7 properties 7 required
GitProviderEnum
string
HelmKeyValues
array
The input is in json array format: [ [$KEY,$VALUE], [...] ]
HelmPortResponseWithServiceName
HelmSourceRepositoryResponse
object
3 properties 3 required
HelmRequest
ApplicationGitRepository
object
13 properties 4 required
KubernetesServiceResponseList
object
1 property
KubernetesService
object
2 properties 2 required
KubernetesServiceSpec
object
3 properties
ServiceTypeEnum
string
type of the service (application, database, job, ...)
KubernetesMetadata
object
1 property
StepMetricStatusEnum
string
The status of completion for the step: - SUCCESS: The step completed successfully. - ERROR: The step completed with an error. - CANCEL: The step was canceled.…
LinkResponseList
object
1 property
ServiceSubActionEnum
string
HelmSourceGitResponse
object
1 property 1 required
HelmGitRepositoryRequest
object
4 properties 4 required
ServiceStepMetric
object
3 properties
ServiceDeploymentStatusEnum
string
ServiceStepMetricNameEnum
string
The name of the deployment step at the service level: - REGISTRYCREATEREPOSITORY: The step to create the repository in the registry. - GITCLONE: The step to cl…
HelmPortRequest
object
1 property
ServiceStepMetrics
object
3 properties 3 required
ApplicationGitRepositoryRequest
object
5 properties 4 required
ServiceActionEnum
string
HelmResponse
KubernetesSelector
object
2 properties 2 required
KubernetesServicePort
object
2 properties 1 required
StateEnum
string
Commit
object
7 properties 5 required
HelmPortResponseWithServiceSelectors
Status
object
10 properties 7 required
CommitResponseList
object
1 property
ServiceActionStatusEnum
string
Base
object
3 properties 2 required
StatusDetails
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qovery-helm-main-calls-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