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 Environment Actions API

The Environment Actions API from Qovery — 12 operation(s) for environment actions.

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

Tagged areas include Environment Actions. 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 12 operations across 12 paths, and defines 26 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.

12 operations 12 paths 26 schemas 12 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 Environment Actions 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 12

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

Environment Actions 12
POST
/environment/{environmentId}/deploy
Deploy environment
deployEnvironment 1 param → 202401403404409
POST
/environment/{environmentId}/uninstall
Uninstall environment
uninstallEnvironment 2 params → 202401403404409
POST
/environment/{environmentId}/stop
Stop environment
stopEnvironment 1 param → 202401403404409
POST
/environment/{environmentId}/redeploy
Redeploy environment
redeployEnvironment 1 param → 202401403404409
POST
/environment/{environmentId}/cancelDeployment
Cancel environment deployment
cancelEnvironmentDeployment 1 param body → 202401403404409
POST
/environment/{environmentId}/clone
Clone environment
cloneEnvironment 1 param body → 202401403404409
POST
/environment/{environmentId}/service/deploy
Deploy services
deployAllServices 1 param body → 202400401403404409
POST
/environment/{environmentId}/service/restart-service
Reboot services
rebootServices 1 param body → 202400401403404409
POST
/environment/{environmentId}/service/stop
Stop services
stopSelectedServices 1 param body → 200400401403404409
POST
/environment/{environmentId}/service/delete
Delete services
deleteSelectedServices 1 param body → 200400401403404409
POST
/environment/{environmentId}/service/uninstall
Uninstall services
uninstallSelectedServices 2 params body → 200400401403404409
POST
/environment/{environmentId}/cleanFailedJobs
Clean failed jobs within an environment
cleanFailedJobs 1 param body → 200

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are EnvironmentStatus (11 properties), Status (10 properties), DeployAllRequest (6 properties), EnvironmentServiceIdsAllRequest (6 properties). Each schema is shown below with its type and property counts.

ReferenceObject
object
1 property 1 required
Environment
StageStepMetricNameEnum
string
The name of the deployment step at the stage level: - TOTAL: The total duration of the stage deployment. - QUEUEING: The step preceding the actual stage deploy…
EnvironmentDeploymentStatusEnum
CloneEnvironmentRequest
object
5 properties 1 required
EnvironmentStatus
object
11 properties 3 required
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.…
StageStepMetrics
object
3 properties
EnvironmentStatusEventOriginEnum
string
Origin of the organization event
ServiceSubActionEnum
string
StageStepMetric
object
4 properties
EnvironmentModeEnum
string
ServiceStepMetric
object
3 properties
RebootServicesRequest
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…
ServiceStepMetrics
object
3 properties 3 required
TerraformDeployRequest
object
3 properties
ServiceActionEnum
string
DeployAllRequest
object
6 properties
EnvironmentServiceIdsAllRequest
object
6 properties
StateEnum
string
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-environment-actions-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