List environment deployments
curl --request GET \
--url https://api.qovery.com/environment/{environmentId}/deploymentHistoryV2 \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.qovery.com/environment/{environmentId}/deploymentHistoryV2"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.qovery.com/environment/{environmentId}/deploymentHistoryV2', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.qovery.com/environment/{environmentId}/deploymentHistoryV2",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.qovery.com/environment/{environmentId}/deploymentHistoryV2"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.qovery.com/environment/{environmentId}/deploymentHistoryV2")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qovery.com/environment/{environmentId}/deploymentHistoryV2")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"page": 1,
"page_size": 20,
"results": [
{
"identifier": {
"execution_id": "<string>",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"auditing_data": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"triggered_by": "<string>",
"origin": "API"
},
"total_duration": "<string>",
"stages": [
{
"name": "<string>",
"duration": "<string>",
"services": [
{
"identifier": {
"name": "<string>",
"service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"execution_id": "<string>"
},
"auditing_data": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"triggered_by": "<string>",
"origin": "API"
},
"details": {
"commit": {
"created_at": "2023-11-07T05:31:56Z",
"git_commit_id": "<string>",
"tag": "v2.1.1",
"message": "<string>",
"author_name": "<string>",
"author_avatar_url": "<string>",
"commit_page_url": "<string>"
},
"build_pod_name": "<string>"
},
"status_details": {
"sub_action": "NONE"
},
"icon_uri": "<string>",
"total_duration": "<string>"
}
]
}
]
}
]
}Environment Deployment History
List environment deployments
List previous and current environment deployments with the status deployment and the related services. By default it returns the 20 last results. The response is paginated. In order to request the next page, you can use the startId query parameter
GET
/
environment
/
{environmentId}
/
deploymentHistoryV2
List environment deployments
curl --request GET \
--url https://api.qovery.com/environment/{environmentId}/deploymentHistoryV2 \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.qovery.com/environment/{environmentId}/deploymentHistoryV2"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.qovery.com/environment/{environmentId}/deploymentHistoryV2', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.qovery.com/environment/{environmentId}/deploymentHistoryV2",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.qovery.com/environment/{environmentId}/deploymentHistoryV2"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.qovery.com/environment/{environmentId}/deploymentHistoryV2")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qovery.com/environment/{environmentId}/deploymentHistoryV2")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"page": 1,
"page_size": 20,
"results": [
{
"identifier": {
"execution_id": "<string>",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"auditing_data": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"triggered_by": "<string>",
"origin": "API"
},
"total_duration": "<string>",
"stages": [
{
"name": "<string>",
"duration": "<string>",
"services": [
{
"identifier": {
"name": "<string>",
"service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"execution_id": "<string>"
},
"auditing_data": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"triggered_by": "<string>",
"origin": "API"
},
"details": {
"commit": {
"created_at": "2023-11-07T05:31:56Z",
"git_commit_id": "<string>",
"tag": "v2.1.1",
"message": "<string>",
"author_name": "<string>",
"author_avatar_url": "<string>",
"commit_page_url": "<string>"
},
"build_pod_name": "<string>"
},
"status_details": {
"sub_action": "NONE"
},
"icon_uri": "<string>",
"total_duration": "<string>"
}
]
}
]
}
]
}Authorizations
bearerAuthApiKeyAuth
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 ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '
Path Parameters
Query Parameters
The number of deployments to return in the current page
Was this page helpful?
List environment deploymentsGenerate a Grafana snapshot report showing build runner pod usage for a specific deployment
⌘I