Skip to main content
POST
/
environment
/
{environmentId}
/
helm
Create a helm
curl --request POST \
  --url https://api.qovery.com/environment/{environmentId}/helm \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "auto_deploy": true,
  "source": {},
  "arguments": [
    "<string>"
  ],
  "values_override": {
    "set": [
      [
        "<string>"
      ]
    ],
    "set_string": [
      [
        "<string>"
      ]
    ],
    "set_json": [
      [
        "<string>"
      ]
    ],
    "file": {
      "git": {
        "git_repository": {
          "url": "https://github.com/Qovery/simple-node-app",
          "branch": "feat/text_xxx",
          "root_path": "/",
          "git_token_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "paths": [
          "<string>"
        ]
      },
      "raw": {
        "values": [
          {
            "name": "<string>",
            "content": "<string>"
          }
        ]
      }
    }
  },
  "ports": [
    {
      "internal_port": 8080,
      "name": "<string>",
      "external_port": 8080,
      "namespace": "<string>",
      "protocol": "HTTP",
      "is_default": true,
      "service_selectors": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "description": "<string>",
  "timeout_sec": 600,
  "auto_preview": true,
  "allow_cluster_wide_resources": false,
  "icon_uri": "<string>",
  "blueprint_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
import requests

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

payload = {
    "name": "<string>",
    "auto_deploy": True,
    "source": {},
    "arguments": ["<string>"],
    "values_override": {
        "set": [["<string>"]],
        "set_string": [["<string>"]],
        "set_json": [["<string>"]],
        "file": {
            "git": {
                "git_repository": {
                    "url": "https://github.com/Qovery/simple-node-app",
                    "branch": "feat/text_xxx",
                    "root_path": "/",
                    "git_token_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                },
                "paths": ["<string>"]
            },
            "raw": { "values": [
                    {
                        "name": "<string>",
                        "content": "<string>"
                    }
                ] }
        }
    },
    "ports": [
        {
            "internal_port": 8080,
            "name": "<string>",
            "external_port": 8080,
            "namespace": "<string>",
            "protocol": "HTTP",
            "is_default": True,
            "service_selectors": [
                {
                    "key": "<string>",
                    "value": "<string>"
                }
            ]
        }
    ],
    "description": "<string>",
    "timeout_sec": 600,
    "auto_preview": True,
    "allow_cluster_wide_resources": False,
    "icon_uri": "<string>",
    "blueprint_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
    name: '<string>',
    auto_deploy: true,
    source: {},
    arguments: ['<string>'],
    values_override: {
      set: [['<string>']],
      set_string: [['<string>']],
      set_json: [['<string>']],
      file: {
        git: {
          git_repository: {
            url: 'https://github.com/Qovery/simple-node-app',
            branch: 'feat/text_xxx',
            root_path: '/',
            git_token_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
          },
          paths: ['<string>']
        },
        raw: {values: [{name: '<string>', content: '<string>'}]}
      }
    },
    ports: [
      {
        internal_port: 8080,
        name: '<string>',
        external_port: 8080,
        namespace: '<string>',
        protocol: 'HTTP',
        is_default: true,
        service_selectors: [{key: '<string>', value: '<string>'}]
      }
    ],
    description: '<string>',
    timeout_sec: 600,
    auto_preview: true,
    allow_cluster_wide_resources: false,
    icon_uri: '<string>',
    blueprint_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'auto_deploy' => true,
    'source' => [
        
    ],
    'arguments' => [
        '<string>'
    ],
    'values_override' => [
        'set' => [
                [
                                '<string>'
                ]
        ],
        'set_string' => [
                [
                                '<string>'
                ]
        ],
        'set_json' => [
                [
                                '<string>'
                ]
        ],
        'file' => [
                'git' => [
                                'git_repository' => [
                                                                'url' => 'https://github.com/Qovery/simple-node-app',
                                                                'branch' => 'feat/text_xxx',
                                                                'root_path' => '/',
                                                                'git_token_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
                                ],
                                'paths' => [
                                                                '<string>'
                                ]
                ],
                'raw' => [
                                'values' => [
                                                                [
                                                                                                                                'name' => '<string>',
                                                                                                                                'content' => '<string>'
                                                                ]
                                ]
                ]
        ]
    ],
    'ports' => [
        [
                'internal_port' => 8080,
                'name' => '<string>',
                'external_port' => 8080,
                'namespace' => '<string>',
                'protocol' => 'HTTP',
                'is_default' => true,
                'service_selectors' => [
                                [
                                                                'key' => '<string>',
                                                                'value' => '<string>'
                                ]
                ]
        ]
    ],
    'description' => '<string>',
    'timeout_sec' => 600,
    'auto_preview' => true,
    'allow_cluster_wide_resources' => false,
    'icon_uri' => '<string>',
    'blueprint_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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}/helm"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"auto_deploy\": true,\n  \"source\": {},\n  \"arguments\": [\n    \"<string>\"\n  ],\n  \"values_override\": {\n    \"set\": [\n      [\n        \"<string>\"\n      ]\n    ],\n    \"set_string\": [\n      [\n        \"<string>\"\n      ]\n    ],\n    \"set_json\": [\n      [\n        \"<string>\"\n      ]\n    ],\n    \"file\": {\n      \"git\": {\n        \"git_repository\": {\n          \"url\": \"https://github.com/Qovery/simple-node-app\",\n          \"branch\": \"feat/text_xxx\",\n          \"root_path\": \"/\",\n          \"git_token_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n        },\n        \"paths\": [\n          \"<string>\"\n        ]\n      },\n      \"raw\": {\n        \"values\": [\n          {\n            \"name\": \"<string>\",\n            \"content\": \"<string>\"\n          }\n        ]\n      }\n    }\n  },\n  \"ports\": [\n    {\n      \"internal_port\": 8080,\n      \"name\": \"<string>\",\n      \"external_port\": 8080,\n      \"namespace\": \"<string>\",\n      \"protocol\": \"HTTP\",\n      \"is_default\": true,\n      \"service_selectors\": [\n        {\n          \"key\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"timeout_sec\": 600,\n  \"auto_preview\": true,\n  \"allow_cluster_wide_resources\": false,\n  \"icon_uri\": \"<string>\",\n  \"blueprint_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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}/helm")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"auto_deploy\": true,\n  \"source\": {},\n  \"arguments\": [\n    \"<string>\"\n  ],\n  \"values_override\": {\n    \"set\": [\n      [\n        \"<string>\"\n      ]\n    ],\n    \"set_string\": [\n      [\n        \"<string>\"\n      ]\n    ],\n    \"set_json\": [\n      [\n        \"<string>\"\n      ]\n    ],\n    \"file\": {\n      \"git\": {\n        \"git_repository\": {\n          \"url\": \"https://github.com/Qovery/simple-node-app\",\n          \"branch\": \"feat/text_xxx\",\n          \"root_path\": \"/\",\n          \"git_token_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n        },\n        \"paths\": [\n          \"<string>\"\n        ]\n      },\n      \"raw\": {\n        \"values\": [\n          {\n            \"name\": \"<string>\",\n            \"content\": \"<string>\"\n          }\n        ]\n      }\n    }\n  },\n  \"ports\": [\n    {\n      \"internal_port\": 8080,\n      \"name\": \"<string>\",\n      \"external_port\": 8080,\n      \"namespace\": \"<string>\",\n      \"protocol\": \"HTTP\",\n      \"is_default\": true,\n      \"service_selectors\": [\n        {\n          \"key\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"timeout_sec\": 600,\n  \"auto_preview\": true,\n  \"allow_cluster_wide_resources\": false,\n  \"icon_uri\": \"<string>\",\n  \"blueprint_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .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::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"auto_deploy\": true,\n  \"source\": {},\n  \"arguments\": [\n    \"<string>\"\n  ],\n  \"values_override\": {\n    \"set\": [\n      [\n        \"<string>\"\n      ]\n    ],\n    \"set_string\": [\n      [\n        \"<string>\"\n      ]\n    ],\n    \"set_json\": [\n      [\n        \"<string>\"\n      ]\n    ],\n    \"file\": {\n      \"git\": {\n        \"git_repository\": {\n          \"url\": \"https://github.com/Qovery/simple-node-app\",\n          \"branch\": \"feat/text_xxx\",\n          \"root_path\": \"/\",\n          \"git_token_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n        },\n        \"paths\": [\n          \"<string>\"\n        ]\n      },\n      \"raw\": {\n        \"values\": [\n          {\n            \"name\": \"<string>\",\n            \"content\": \"<string>\"\n          }\n        ]\n      }\n    }\n  },\n  \"ports\": [\n    {\n      \"internal_port\": 8080,\n      \"name\": \"<string>\",\n      \"external_port\": 8080,\n      \"namespace\": \"<string>\",\n      \"protocol\": \"HTTP\",\n      \"is_default\": true,\n      \"service_selectors\": [\n        {\n          \"key\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"description\": \"<string>\",\n  \"timeout_sec\": 600,\n  \"auto_preview\": true,\n  \"allow_cluster_wide_resources\": false,\n  \"icon_uri\": \"<string>\",\n  \"blueprint_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

​
environmentId
string<uuid>
required

Environment ID

Body

application/json
​
name
string
required

name is case insensitive

​
auto_deploy
boolean
required

Specify if the helm 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

​
values_override
object
required

Specify helm values you want to set or override

​
ports
object[]
​
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
​
auto_preview
boolean | null

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

​
allow_cluster_wide_resources
boolean
default:false

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

​
icon_uri
string<uri>

Icon URI representing the helm service.

​
blueprint_id
string<uuid> | null

The blueprint ID the service has been created from

Response

Create helm

​
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