Skip to main content
POST
/
environment
/
{environmentId}
/
deploymentBuildUsageReport
Generate a Grafana snapshot report showing build runner pod usage for a specific deployment
curl --request POST \
  --url https://api.qovery.com/environment/{environmentId}/deploymentBuildUsageReport \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "execution_id": "<string>",
  "report_expiration_in_seconds": 86400
}
'
import requests

url = "https://api.qovery.com/environment/{environmentId}/deploymentBuildUsageReport"

payload = {
"execution_id": "<string>",
"report_expiration_in_seconds": 86400
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({execution_id: '<string>', report_expiration_in_seconds: 86400})
};

fetch('https://api.qovery.com/environment/{environmentId}/deploymentBuildUsageReport', 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}/deploymentBuildUsageReport",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'execution_id' => '<string>',
'report_expiration_in_seconds' => 86400
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.qovery.com/environment/{environmentId}/deploymentBuildUsageReport"

payload := strings.NewReader("{\n \"execution_id\": \"<string>\",\n \"report_expiration_in_seconds\": 86400\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.qovery.com/environment/{environmentId}/deploymentBuildUsageReport")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"execution_id\": \"<string>\",\n \"report_expiration_in_seconds\": 86400\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/environment/{environmentId}/deploymentBuildUsageReport")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"execution_id\": \"<string>\",\n \"report_expiration_in_seconds\": 86400\n}"

response = http.request(request)
puts response.read_body
{
  "report_url": "<string>",
  "delete_report_url": "<string>"
}

Authorizations

Authorization
string
header
required

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

environmentId
string<uuid>
required

Environment ID

Body

application/json
execution_id
string
required

The deployment execution ID (format environment_id-version)

report_expiration_in_seconds
integer
required

The number of seconds the report will be publicly available

Example:

86400

Response

Build usage report snapshot has been successfully generated

report_url
string

The publicly accessible URL of the Grafana snapshot report showing build pod resource usage

delete_report_url
string

The URL to pro-actively delete the report before it expires