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 Deployment History API

The Environment Deployment History API from Qovery — 3 operation(s) for environment deployment history.

Qovery Environment Deployment History 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 Deployment History. 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 3 operations across 3 paths, and defines 32 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.

3 operations 3 paths 32 schemas 2 GET1 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 Deployment History 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 3

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

Environment Deployment History 3
GET
/environment/{environmentId}/deploymentHistory
List environment deployments
listEnvironmentDeploymentHistory 2 params → 200401403404
GET
/environment/{environmentId}/deploymentHistoryV2
List environment deployments
listEnvironmentDeploymentHistoryV2 2 params → 200401403404
POST
/environment/{environmentId}/deploymentBuildUsageReport
Generate a Grafana snapshot report showing build runner pod usage for a specific deployment
generateDeploymentBuildUsageReport 1 param body → 201400401403404

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are DeploymentHistoryService (7 properties), DeploymentHistoryEnvironmentV2 (7 properties), Commit (7 properties), DeploymentHistoryStage (4 properties). Each schema is shown below with its type and property counts.

DeploymentHistoryEnvironmentPaginatedResponseListV2
DeploymentHistoryTriggerAction
StageStatusEnum
string
JobCronSchedule
object
4 properties 3 required
OrganizationEventOrigin
string
Origin of the organization event
PaginationData
object
2 properties 2 required
JobScheduleEvent
string
On which event the job is going to run. ONSTART means when a deployment is requested for the environment ONSTOP means when a stop of the environment is request…
DeploymentHistoryAuditingData
object
4 properties 3 required
DeploymentHistoryApplication
DeploymentHistoryEnvironmentPaginatedResponseList
ServiceTypeEnum
string
type of the service (application, database, job, ...)
DeploymentHistoryJobResponse
ServiceSubActionEnum
string
DeploymentHistoryEnvironmentV2
object
7 properties 7 required
JobLifecyleSchedule
object
2 properties 1 required
DeploymentBuildUsageReportRequest
object
2 properties 2 required
DeploymentHistoryActionStatus
DeploymentHistoryService
object
7 properties 6 required
DeploymentHistoryHelmResponse
ServiceActionEnum
string
DeploymentHistoryEnvironment
DeploymentHistoryContainer
DeploymentHistoryStage
object
4 properties 4 required
StateEnum
string
Commit
object
7 properties 5 required
DeploymentHistoryServiceDetails
object
DeploymentHistoryDatabase
JobLifecycleTypeEnum
DeploymentBuildUsageReportResponse
object
2 properties
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-deployment-history-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