Skip to main content
GET
/
environment
/
{environmentId}
/
helm
List helms
curl --request GET \
  --url https://api.qovery.com/environment/{environmentId}/helm \
  --header 'Authorization: Bearer <token>'
import requests

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

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}/helm', 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}/helm",
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}/helm"

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}/helm")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

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

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
{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "environment": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "name": "<string>",
      "auto_preview": true,
      "auto_deploy": true,
      "source": {
        "git": {
          "git_repository": {
            "owner": "John Doe",
            "url": "<string>",
            "name": "simple-node-app",
            "has_access": true,
            "branch": "<string>",
            "root_path": "<string>",
            "deployed_commit_id": "<string>",
            "deployed_commit_date": "2023-11-07T05:31:56Z",
            "deployed_commit_contributor": "<string>",
            "deployed_commit_tag": "v1.0.1",
            "git_token_id": "<string>",
            "git_token_name": "<string>"
          }
        }
      },
      "arguments": [
        "<string>"
      ],
      "allow_cluster_wide_resources": false,
      "values_override": {
        "set": [
          [
            "<string>"
          ]
        ],
        "set_string": [
          [
            "<string>"
          ]
        ],
        "set_json": [
          [
            "<string>"
          ]
        ],
        "file": {
          "raw": {
            "values": [
              {
                "name": "<string>",
                "content": "<string>"
              }
            ]
          },
          "git": {
            "git_repository": {
              "owner": "John Doe",
              "url": "<string>",
              "name": "simple-node-app",
              "has_access": true,
              "branch": "<string>",
              "root_path": "<string>",
              "deployed_commit_id": "<string>",
              "deployed_commit_date": "2023-11-07T05:31:56Z",
              "deployed_commit_contributor": "<string>",
              "deployed_commit_tag": "v1.0.1",
              "git_token_id": "<string>",
              "git_token_name": "<string>"
            },
            "paths": [
              "<string>"
            ]
          }
        }
      },
      "icon_uri": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "timeout_sec": 600,
      "ports": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "port_type": "<string>",
          "internal_port": 8080,
          "protocol": "HTTP",
          "service_name": "<string>",
          "name": "<string>",
          "external_port": 8080,
          "namespace": "<string>",
          "is_default": true
        }
      ],
      "blueprint_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

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

Response

List helms

results
object[]