Qovery Environments API
The Environments API from Qovery — 4 operation(s) for environments.
Qovery Environments API is one of 94 APIs that Qovery publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Environments. 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 5 operations across 4 paths, and defines 24 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Qovery Environments 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 5
Across 4 paths, the API surfaces 5 operations — 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Schemas 24
The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are EnvironmentStatus (11 properties), EnvironmentOverviewResponse (8 properties), StageStepMetric (4 properties), ClusterOverviewResponse (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Qovery 12
Other APIs Qovery publishes across the network.