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

The Helms API from Qovery — 5 operation(s) for helms.

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

Tagged areas include Helms. 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 6 operations across 5 paths, and defines 35 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.

6 operations 5 paths 35 schemas 3 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 Helms 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 6

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

Helms 6
GET
/defaultHelmAdvancedSettings
List default helm advanced settings
getDefaultHelmAdvancedSettings → 200401403
GET
/environment/{environmentId}/helm
List helms
listHelms 2 params → 200401403404
POST
/environment/{environmentId}/helm
Create a helm
createHelm 1 param body → 201400401403404409
POST
/environment/{environmentId}/helmDefaultValues
Get helm default values
createHelmDefaultValues 1 param body → 201401403404
GET
/environment/{environmentId}/helm/status
List all environment helm statuses
getEnvironmentHelmStatus 1 param → 200401403404
POST
/helm/{helmId}/clone
Clone helm
cloneHelm 1 param body → 202401403404409

Schemas 35

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

ReferenceObject
object
1 property 1 required
HelmPortResponseBase
object
8 properties 4 required
HelmPortProtocolEnum
string
GitProviderEnum
string
HelmKeyValues
array
The input is in json array format: [ [$KEY,$VALUE], [...] ]
HelmPortResponseWithServiceName
HelmSourceRepositoryResponse
object
3 properties 3 required
HelmRequest
HelmAdvancedSettings
object
25 properties
ApplicationGitRepository
object
13 properties 4 required
CloneServiceRequest
object
2 properties 2 required
ServiceTypeEnum
string
type of the service (application, database, job, ...)
ReferenceObjectStatusResponseList
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.…
ServiceSubActionEnum
string
HelmSourceGitResponse
object
1 property 1 required
HelmGitRepositoryRequest
object
4 properties 4 required
ServiceStepMetric
object
3 properties
HelmDefaultValuesRequest
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
ServiceActionEnum
string
ApplicationGitRepositoryRequest
object
5 properties 4 required
HelmResponseList
object
1 property
HelmResponse
ReferenceObjectStatus
KubernetesSelector
object
2 properties 2 required
StateEnum
string
HelmPortResponseWithServiceSelectors
Status
object
10 properties 7 required
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-helms-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