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 Project Environment Variable API

The Project Environment Variable API from Qovery — 4 operation(s) for project environment variable.

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

Tagged areas include Project Environment Variable. 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 4 paths, and defines 12 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 4 paths 12 schemas 1 DELETE1 GET3 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 Project Environment Variable 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 4 paths, the API surfaces 6 operations — 1 DELETE, 1 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Project Environment Variable 6
POST
/project/{projectId}/environmentVariable
Add an environment variable to the project
createProjectEnvironmentVariable 1 param body → 201400401403404
GET
/project/{projectId}/environmentVariable
List project environment variables
listProjectEnvironmentVariable 1 param → 200401403404
DELETE
/project/{projectId}/environmentVariable/{environmentVariableId}
Delete an environment variable from a project
deleteProjectEnvironmentVariable 2 params → 204401403404
PUT
/project/{projectId}/environmentVariable/{environmentVariableId}
Edit an environment variable belonging to the project
editProjectEnvironmentVariable 2 params body → 200400401403404
POST
/project/{projectId}/environmentVariable/{environmentVariableId}/override
Create an environment variable override at the project level
createProjectEnvironmentVariableOverride 2 params body → 201400401403404
POST
/project/{projectId}/environmentVariable/{environmentVariableId}/alias
Create an environment variable alias at the project level
createProjectEnvironmentVariableAlias 2 params body → 201400401403404

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are EnvironmentVariableAlias (6 properties), EnvironmentVariableOverride (6 properties), EnvironmentVariableRequest (5 properties), EnvironmentVariableEditRequest (5 properties). Each schema is shown below with its type and property counts.

EnvironmentVariableAlias
object
6 properties 6 required
EnvironmentVariable
EnvironmentVariableRequest
object
5 properties 1 required
APIVariableTypeEnum
string
type of the environment variable (VALUE, FILE, ALIAS, OVERRIDE or BUITIN)
Value
object
3 properties
LinkedServiceTypeEnum
string
type of the service (application, database, job, gateway...)
EnvironmentVariableOverride
object
6 properties 6 required
EnvironmentVariableResponseList
object
1 property
EnvironmentVariableEditRequest
object
5 properties 1 required
APIVariableScopeEnum
string
Key
object
3 properties 1 required
Base
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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