Skip to main content
GET
/
helm
/
{helmId}
Get helm by ID
curl --request GET \
  --url https://api.qovery.com/helm/{helmId} \
  --header 'Authorization: Bearer <token>'
import requests

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

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

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

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

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
{
  "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

helmId
string<uuid>
required

Helm ID

Response

Get helm by ID

id
string<uuid>
required
read-only
created_at
string<date-time>
required
read-only
environment
object
required
name
string
required

name is case insensitive

auto_preview
boolean
required

Indicates if the 'environment preview option' is enabled.
If enabled, a preview environment will be automatically cloned when /preview endpoint is called.
If not specified, it takes the value of the auto_preview property from the associated environment.

auto_deploy
boolean
required

Specify if the service will be automatically updated after receiving a new image tag or a new commit according to the source type.

source
object
required
arguments
string[]
required

The extra arguments to pass to helm

allow_cluster_wide_resources
boolean
default:false
required

If we should allow the chart to deploy object outside his specified namespace. Setting this flag to true, requires special rights

values_override
object
required

Specify helm values you want to set or override

icon_uri
string<uri>
required

Icon URI representing the helm service.

service_type
enum<string>
required

type of the service (application, database, job, ...)

Available options:
APPLICATION,
DATABASE,
CONTAINER,
JOB,
HELM,
TERRAFORM,
ARGOCD_APP
updated_at
string<date-time>
read-only
description
string
timeout_sec
integer
default:600

Maximum number of seconds allowed for helm to run before killing it and mark it as failed

Required range: x >= 0
ports
object[]
blueprint_id
string<uuid> | null

The blueprint ID the service has been created from