Skip to main content
POST
/
helm
/
{helmId}
/
clone
Clone helm
curl --request POST \
  --url https://api.qovery.com/helm/{helmId}/clone \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
import requests

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

payload = {
"name": "<string>",
"environment_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>', environment_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};

fetch('https://api.qovery.com/helm/{helmId}/clone', 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}/clone",
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>',
'environment_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/helm/{helmId}/clone"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"environment_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/helm/{helmId}/clone")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"environment_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"environment_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

helmId
string<uuid>
required

Helm ID

Body

application/json
name
string
required
environment_id
string<uuid>
required

Response

Helm clone has been requested

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