Update product

curl --request PATCH \
  --url https://api.cnap.tech/v1/products/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "PostgreSQL Managed",
  "sources": [
    {
      "chart": {
        "repo_url": "<string>",
        "target_revision": "<string>",
        "chart": "<string>",
        "path": "<string>"
      },
      "values": {},
      "metadata": {}
    }
  ],
  "cluster_ids": [
    "<string>"
  ],
  "stripe_price_ids": [
    "<string>"
  ],
  "settings": {
    "custom_image": "<string>",
    "custom_description": "<string>",
    "show_sources": true
  }
}
'

import requests

url = "https://api.cnap.tech/v1/products/{id}"

payload = {
    "name": "PostgreSQL Managed",
    "sources": [
        {
            "chart": {
                "repo_url": "<string>",
                "target_revision": "<string>",
                "chart": "<string>",
                "path": "<string>"
            },
            "values": {},
            "metadata": {}
        }
    ],
    "cluster_ids": ["<string>"],
    "stripe_price_ids": ["<string>"],
    "settings": {
        "custom_image": "<string>",
        "custom_description": "<string>",
        "show_sources": True
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'PostgreSQL Managed',
    sources: [
      {
        chart: {
          repo_url: '<string>',
          target_revision: '<string>',
          chart: '<string>',
          path: '<string>'
        },
        values: {},
        metadata: {}
      }
    ],
    cluster_ids: ['<string>'],
    stripe_price_ids: ['<string>'],
    settings: {custom_image: '<string>', custom_description: '<string>', show_sources: true}
  })
};

fetch('https://api.cnap.tech/v1/products/{id}', 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/products/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'PostgreSQL Managed',
    'sources' => [
        [
                'chart' => [
                                'repo_url' => '<string>',
                                'target_revision' => '<string>',
                                'chart' => '<string>',
                                'path' => '<string>'
                ],
                'values' => [
                                
                ],
                'metadata' => [
                                
                ]
        ]
    ],
    'cluster_ids' => [
        '<string>'
    ],
    'stripe_price_ids' => [
        '<string>'
    ],
    'settings' => [
        'custom_image' => '<string>',
        'custom_description' => '<string>',
        'show_sources' => 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/products/{id}"

	payload := strings.NewReader("{\n  \"name\": \"PostgreSQL Managed\",\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    }\n  ],\n  \"cluster_ids\": [\n    \"<string>\"\n  ],\n  \"stripe_price_ids\": [\n    \"<string>\"\n  ],\n  \"settings\": {\n    \"custom_image\": \"<string>\",\n    \"custom_description\": \"<string>\",\n    \"show_sources\": true\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.cnap.tech/v1/products/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"PostgreSQL Managed\",\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    }\n  ],\n  \"cluster_ids\": [\n    \"<string>\"\n  ],\n  \"stripe_price_ids\": [\n    \"<string>\"\n  ],\n  \"settings\": {\n    \"custom_image\": \"<string>\",\n    \"custom_description\": \"<string>\",\n    \"show_sources\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cnap.tech/v1/products/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"PostgreSQL Managed\",\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    }\n  ],\n  \"cluster_ids\": [\n    \"<string>\"\n  ],\n  \"stripe_price_ids\": [\n    \"<string>\"\n  ],\n  \"settings\": {\n    \"custom_image\": \"<string>\",\n    \"custom_description\": \"<string>\",\n    \"show_sources\": true\n  }\n}"

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

{
  "product_id": "<string>",
  "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>"
  }
}

PATCH

products

{id}

Update product

curl --request PATCH \
  --url https://api.cnap.tech/v1/products/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "PostgreSQL Managed",
  "sources": [
    {
      "chart": {
        "repo_url": "<string>",
        "target_revision": "<string>",
        "chart": "<string>",
        "path": "<string>"
      },
      "values": {},
      "metadata": {}
    }
  ],
  "cluster_ids": [
    "<string>"
  ],
  "stripe_price_ids": [
    "<string>"
  ],
  "settings": {
    "custom_image": "<string>",
    "custom_description": "<string>",
    "show_sources": true
  }
}
'

import requests

url = "https://api.cnap.tech/v1/products/{id}"

payload = {
    "name": "PostgreSQL Managed",
    "sources": [
        {
            "chart": {
                "repo_url": "<string>",
                "target_revision": "<string>",
                "chart": "<string>",
                "path": "<string>"
            },
            "values": {},
            "metadata": {}
        }
    ],
    "cluster_ids": ["<string>"],
    "stripe_price_ids": ["<string>"],
    "settings": {
        "custom_image": "<string>",
        "custom_description": "<string>",
        "show_sources": True
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'PostgreSQL Managed',
    sources: [
      {
        chart: {
          repo_url: '<string>',
          target_revision: '<string>',
          chart: '<string>',
          path: '<string>'
        },
        values: {},
        metadata: {}
      }
    ],
    cluster_ids: ['<string>'],
    stripe_price_ids: ['<string>'],
    settings: {custom_image: '<string>', custom_description: '<string>', show_sources: true}
  })
};

fetch('https://api.cnap.tech/v1/products/{id}', 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/products/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'PostgreSQL Managed',
    'sources' => [
        [
                'chart' => [
                                'repo_url' => '<string>',
                                'target_revision' => '<string>',
                                'chart' => '<string>',
                                'path' => '<string>'
                ],
                'values' => [
                                
                ],
                'metadata' => [
                                
                ]
        ]
    ],
    'cluster_ids' => [
        '<string>'
    ],
    'stripe_price_ids' => [
        '<string>'
    ],
    'settings' => [
        'custom_image' => '<string>',
        'custom_description' => '<string>',
        'show_sources' => 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/products/{id}"

	payload := strings.NewReader("{\n  \"name\": \"PostgreSQL Managed\",\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    }\n  ],\n  \"cluster_ids\": [\n    \"<string>\"\n  ],\n  \"stripe_price_ids\": [\n    \"<string>\"\n  ],\n  \"settings\": {\n    \"custom_image\": \"<string>\",\n    \"custom_description\": \"<string>\",\n    \"show_sources\": true\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.cnap.tech/v1/products/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"PostgreSQL Managed\",\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    }\n  ],\n  \"cluster_ids\": [\n    \"<string>\"\n  ],\n  \"stripe_price_ids\": [\n    \"<string>\"\n  ],\n  \"settings\": {\n    \"custom_image\": \"<string>\",\n    \"custom_description\": \"<string>\",\n    \"show_sources\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cnap.tech/v1/products/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"PostgreSQL Managed\",\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    }\n  ],\n  \"cluster_ids\": [\n    \"<string>\"\n  ],\n  \"stripe_price_ids\": [\n    \"<string>\"\n  ],\n  \"settings\": {\n    \"custom_image\": \"<string>\",\n    \"custom_description\": \"<string>\",\n    \"show_sources\": true\n  }\n}"

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

{
  "product_id": "<string>",
  "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

Path Parameters

string

required

Product ID

Body

application/json

name

string

required

Required string length: 2 - 32

Example:

"PostgreSQL Managed"

sources

object[]

required

Minimum array length: 1

Show child attributes

cluster_ids

string[]

required

Minimum array length: 1

stripe_price_ids

string[]

settings

object

Show child attributes

Response

Product updated

product_id

string

required

template_id

string

required

Overview

Endpoints

Update product

Authorizations

Path Parameters

Body

Response