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 Deployment Stage Main Calls API

The Deployment Stage Main Calls API from Qovery — 6 operation(s) for deployment stage main calls.

Qovery Deployment Stage 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 Deployment Stage 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 9 operations across 6 paths, and defines 7 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.

9 operations 6 paths 7 schemas 1 DELETE3 GET1 POST4 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 Deployment Stage 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 9

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

Deployment Stage Main Calls 9
GET
/environment/{environmentId}/deploymentStage
List environment deployment stage
ListEnvironmentDeploymentStage 1 param → 200401403404
POST
/environment/{environmentId}/deploymentStage
Create environment deployment stage
CreateEnvironmentDeploymentStage 1 param body → 200401403404
GET
/deploymentStage/{deploymentStageId}
Get Deployment Stage
getDeploymentStage 1 param → 200401403404
DELETE
/deploymentStage/{deploymentStageId}
Delete deployment stage
DeleteDeploymentStage 1 param → 204401403404
PUT
/deploymentStage/{deploymentStageId}
Edit deployment stage
EditDeploymentStage 1 param body → 200401403404
PUT
/deploymentStage/{deploymentStageId}/service/{serviceId}
Attach service to deployment stage
AttachServiceToDeploymentStage 2 params body → 200401403404
PUT
/deploymentStage/{deploymentStageId}/moveBefore/{stageId}
Move deployment stage before requested stage
MoveBeforeDeploymentStage 2 params → 200401403404
PUT
/deploymentStage/{deploymentStageId}/moveAfter/{stageId}
Move deployment stage after requested stage
MoveAfterDeploymentStage 2 params → 200401403404
GET
/service/{serviceId}/deploymentStage
Get Service Deployment Stage
getServiceDeploymentStage 1 param → 200401403404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Base (3 properties), DeploymentStageRequest (2 properties), DeploymentStageResponseList (1 property), ReferenceObject (1 property). Each schema is shown below with its type and property counts.

DeploymentStageRequest
object
2 properties 1 required
ReferenceObject
object
1 property 1 required
DeploymentStageServiceResponse
Base
object
3 properties 2 required
DeploymentStageResponse
DeploymentStageResponseList
object
1 property
DeploymentStageServiceResponseList
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qovery-deployment-stage-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