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

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

Qovery Variable 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 Variable 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 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 5 paths 15 schemas 1 DELETE1 GET4 POST1 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 Variable 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, 1 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Variable Main Calls 7
GET
/variable
List variables
listVariables 3 params → 200401403404
POST
/variable
Create a variable
createVariable body → 201400401403404
POST
/variable/{variableId}/alias
Create a variable alias
createVariableAlias 1 param body → 201400401403404
POST
/variable/{variableId}/override
Create a variable override
createVariableOverride 1 param body → 201400401403404
DELETE
/variable/{variableId}
Delete a variable
deleteVariable 1 param → 204401403404
PUT
/variable/{variableId}
Edit a variable
editVariable 1 param body → 200400401403404
POST
/variable/import
Import variables
importEnvironmentVariables 2 params body → 201400401403404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are VariableRequest (9 properties), VariableOverride (6 properties), VariableAlias (6 properties), VariableAliasRequest (5 properties). Each schema is shown below with its type and property counts.

VariableResponse
VariableRequest
object
9 properties 5 required
APIVariableTypeEnum
string
type of the environment variable (VALUE, FILE, ALIAS, OVERRIDE or BUITIN)
VariableImport
object
2 properties 2 required
VariableEditRequest
object
5 properties 1 required
LinkedServiceTypeEnum
string
type of the service (application, database, job, gateway...)
VariableOverride
object
6 properties 5 required
VariableResponseList
object
1 property
VariableOverrideRequest
object
5 properties 3 required
VariableAlias
object
6 properties 5 required
APIVariableScopeEnum
string
VariableImportRequest
object
2 properties 2 required
VariableAliasRequest
object
5 properties 3 required
ServiceTypeForVariableEnum
string
type of the service
Base
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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