Create product install

curl --request POST \
  --url https://api.cnap.tech/v1/installs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_id": "<string>",
  "region_id": "<string>",
  "overrides": [
    {
      "template_helm_source_id": "<string>",
      "values": {}
    }
  ]
}
'

import requests

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

payload = {
    "product_id": "<string>",
    "region_id": "<string>",
    "overrides": [
        {
            "template_helm_source_id": "<string>",
            "values": {}
        }
    ]
}
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({
    product_id: '<string>',
    region_id: '<string>',
    overrides: [{template_helm_source_id: '<string>', values: {}}]
  })
};

fetch('https://api.cnap.tech/v1/installs', 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/installs",
  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([
    'product_id' => '<string>',
    'region_id' => '<string>',
    'overrides' => [
        [
                'template_helm_source_id' => '<string>',
                'values' => [
                                
                ]
        ]
    ]
  ]),
  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/installs"

	payload := strings.NewReader("{\n  \"product_id\": \"<string>\",\n  \"region_id\": \"<string>\",\n  \"overrides\": [\n    {\n      \"template_helm_source_id\": \"<string>\",\n      \"values\": {}\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/installs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"product_id\": \"<string>\",\n  \"region_id\": \"<string>\",\n  \"overrides\": [\n    {\n      \"template_helm_source_id\": \"<string>\",\n      \"values\": {}\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"product_id\": \"<string>\",\n  \"region_id\": \"<string>\",\n  \"overrides\": [\n    {\n      \"template_helm_source_id\": \"<string>\",\n      \"values\": {}\n    }\n  ]\n}"

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

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

installs

Create product install

curl --request POST \
  --url https://api.cnap.tech/v1/installs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_id": "<string>",
  "region_id": "<string>",
  "overrides": [
    {
      "template_helm_source_id": "<string>",
      "values": {}
    }
  ]
}
'

import requests

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

payload = {
    "product_id": "<string>",
    "region_id": "<string>",
    "overrides": [
        {
            "template_helm_source_id": "<string>",
            "values": {}
        }
    ]
}
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({
    product_id: '<string>',
    region_id: '<string>',
    overrides: [{template_helm_source_id: '<string>', values: {}}]
  })
};

fetch('https://api.cnap.tech/v1/installs', 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/installs",
  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([
    'product_id' => '<string>',
    'region_id' => '<string>',
    'overrides' => [
        [
                'template_helm_source_id' => '<string>',
                'values' => [
                                
                ]
        ]
    ]
  ]),
  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/installs"

	payload := strings.NewReader("{\n  \"product_id\": \"<string>\",\n  \"region_id\": \"<string>\",\n  \"overrides\": [\n    {\n      \"template_helm_source_id\": \"<string>\",\n      \"values\": {}\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/installs")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"product_id\": \"<string>\",\n  \"region_id\": \"<string>\",\n  \"overrides\": [\n    {\n      \"template_helm_source_id\": \"<string>\",\n      \"values\": {}\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"product_id\": \"<string>\",\n  \"region_id\": \"<string>\",\n  \"overrides\": [\n    {\n      \"template_helm_source_id\": \"<string>\",\n      \"values\": {}\n    }\n  ]\n}"

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

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

Headers

idempotency-key

string

Unique key to prevent duplicate operations. If the same key is sent again, the existing workflow is returned instead of creating a new one.

Required string length: 1 - 256

Example:

"deploy-prod-2024-03-15"

Body

application/json

product_id

string

required

Product ID

Minimum string length: 1

region_id

string

required

Region ID

Minimum string length: 1

overrides

object[]

Initial value overrides per helm source

Show child attributes

Response

Install workflow started

Overview

Endpoints

Create product install

Authorizations

Headers

Body

Response