Skip to main content
POST
/
v1
/
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": {}
    }
  ]
}
'
{
  "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://dash.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

Response

Install workflow started