Create template

curl --request POST \
  --url https://api.cnap.tech/v1/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "PostgreSQL HA",
  "sources": [
    {
      "chart": {
        "repo_url": "<string>",
        "target_revision": "<string>",
        "chart": "<string>",
        "path": "<string>"
      },
      "values": {},
      "metadata": {
        "artifact_hub_helm_package": {},
        "auto_deploy": true
      }
    }
  ]
}
'

import requests

url = "https://api.cnap.tech/v1/templates"

payload = {
    "name": "PostgreSQL HA",
    "sources": [
        {
            "chart": {
                "repo_url": "<string>",
                "target_revision": "<string>",
                "chart": "<string>",
                "path": "<string>"
            },
            "values": {},
            "metadata": {
                "artifact_hub_helm_package": {},
                "auto_deploy": True
            }
        }
    ]
}
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: 'PostgreSQL HA',
    sources: [
      {
        chart: {
          repo_url: '<string>',
          target_revision: '<string>',
          chart: '<string>',
          path: '<string>'
        },
        values: {},
        metadata: {artifact_hub_helm_package: {}, auto_deploy: true}
      }
    ]
  })
};

fetch('https://api.cnap.tech/v1/templates', 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.cnap.tech/v1/templates",
  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' => 'PostgreSQL HA',
    'sources' => [
        [
                'chart' => [
                                'repo_url' => '<string>',
                                'target_revision' => '<string>',
                                'chart' => '<string>',
                                'path' => '<string>'
                ],
                'values' => [
                                
                ],
                'metadata' => [
                                'artifact_hub_helm_package' => [
                                                                
                                ],
                                'auto_deploy' => true
                ]
        ]
    ]
  ]),
  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.cnap.tech/v1/templates"

	payload := strings.NewReader("{\n  \"name\": \"PostgreSQL HA\",\n  \"sources\": [\n    {\n      \"chart\": {\n        \"repo_url\": \"<string>\",\n        \"target_revision\": \"<string>\",\n        \"chart\": \"<string>\",\n        \"path\": \"<string>\"\n      },\n      \"values\": {},\n      \"metadata\": {\n        \"artifact_hub_helm_package\": {},\n        \"auto_deploy\": true\n      }\n    }\n  ]\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.cnap.tech/v1/templates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"PostgreSQL HA\",\n  \"sources\": [\n    {\n      \"chart\": {\n        \"repo_url\": \"<string>\",\n        \"target_revision\": \"<string>\",\n        \"chart\": \"<string>\",\n        \"path\": \"<string>\"\n      },\n      \"values\": {},\n      \"metadata\": {\n        \"artifact_hub_helm_package\": {},\n        \"auto_deploy\": true\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cnap.tech/v1/templates")

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\": \"PostgreSQL HA\",\n  \"sources\": [\n    {\n      \"chart\": {\n        \"repo_url\": \"<string>\",\n        \"target_revision\": \"<string>\",\n        \"chart\": \"<string>\",\n        \"path\": \"<string>\"\n      },\n      \"values\": {},\n      \"metadata\": {\n        \"artifact_hub_helm_package\": {},\n        \"auto_deploy\": true\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "template_id": "<string>"
}

{
  "error": {
    "code": "not_found",
    "message": "Resource not found",
    "param": "name",
    "suggestion": "Run `cnap clusters list` to see available clusters",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Resource not found",
    "param": "name",
    "suggestion": "Run `cnap clusters list` to see available clusters",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Resource not found",
    "param": "name",
    "suggestion": "Run `cnap clusters list` to see available clusters",
    "details": "<unknown>"
  }
}

POST

templates

Create template

curl --request POST \
  --url https://api.cnap.tech/v1/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "PostgreSQL HA",
  "sources": [
    {
      "chart": {
        "repo_url": "<string>",
        "target_revision": "<string>",
        "chart": "<string>",
        "path": "<string>"
      },
      "values": {},
      "metadata": {
        "artifact_hub_helm_package": {},
        "auto_deploy": true
      }
    }
  ]
}
'

import requests

url = "https://api.cnap.tech/v1/templates"

payload = {
    "name": "PostgreSQL HA",
    "sources": [
        {
            "chart": {
                "repo_url": "<string>",
                "target_revision": "<string>",
                "chart": "<string>",
                "path": "<string>"
            },
            "values": {},
            "metadata": {
                "artifact_hub_helm_package": {},
                "auto_deploy": True
            }
        }
    ]
}
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: 'PostgreSQL HA',
    sources: [
      {
        chart: {
          repo_url: '<string>',
          target_revision: '<string>',
          chart: '<string>',
          path: '<string>'
        },
        values: {},
        metadata: {artifact_hub_helm_package: {}, auto_deploy: true}
      }
    ]
  })
};

fetch('https://api.cnap.tech/v1/templates', 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.cnap.tech/v1/templates",
  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' => 'PostgreSQL HA',
    'sources' => [
        [
                'chart' => [
                                'repo_url' => '<string>',
                                'target_revision' => '<string>',
                                'chart' => '<string>',
                                'path' => '<string>'
                ],
                'values' => [
                                
                ],
                'metadata' => [
                                'artifact_hub_helm_package' => [
                                                                
                                ],
                                'auto_deploy' => true
                ]
        ]
    ]
  ]),
  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.cnap.tech/v1/templates"

	payload := strings.NewReader("{\n  \"name\": \"PostgreSQL HA\",\n  \"sources\": [\n    {\n      \"chart\": {\n        \"repo_url\": \"<string>\",\n        \"target_revision\": \"<string>\",\n        \"chart\": \"<string>\",\n        \"path\": \"<string>\"\n      },\n      \"values\": {},\n      \"metadata\": {\n        \"artifact_hub_helm_package\": {},\n        \"auto_deploy\": true\n      }\n    }\n  ]\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.cnap.tech/v1/templates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"PostgreSQL HA\",\n  \"sources\": [\n    {\n      \"chart\": {\n        \"repo_url\": \"<string>\",\n        \"target_revision\": \"<string>\",\n        \"chart\": \"<string>\",\n        \"path\": \"<string>\"\n      },\n      \"values\": {},\n      \"metadata\": {\n        \"artifact_hub_helm_package\": {},\n        \"auto_deploy\": true\n      }\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cnap.tech/v1/templates")

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\": \"PostgreSQL HA\",\n  \"sources\": [\n    {\n      \"chart\": {\n        \"repo_url\": \"<string>\",\n        \"target_revision\": \"<string>\",\n        \"chart\": \"<string>\",\n        \"path\": \"<string>\"\n      },\n      \"values\": {},\n      \"metadata\": {\n        \"artifact_hub_helm_package\": {},\n        \"auto_deploy\": true\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "template_id": "<string>"
}

{
  "error": {
    "code": "not_found",
    "message": "Resource not found",
    "param": "name",
    "suggestion": "Run `cnap clusters list` to see available clusters",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Resource not found",
    "param": "name",
    "suggestion": "Run `cnap clusters list` to see available clusters",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Resource not found",
    "param": "name",
    "suggestion": "Run `cnap clusters list` to see available clusters",
    "details": "<unknown>"
  }
}

Authorizations

Authorization

string

header

required

Personal Access Token (cnap_pat_...) or OAuth2 JWT. Create tokens at https://cnap.tech/account/tokens

Body

application/json

name

string

required

Required string length: 1 - 100

Example:

"PostgreSQL HA"

sources

object[]

required

Minimum array length: 1

Show child attributes

registry_proxy_mode

enum<string>

Available options:

auto,

always,

never

Response

Template created

template_id

string

required

Overview

Endpoints

Create template

Authorizations

Body

Response