> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cnap.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# Create product install

> Deploys a product to a region. Pass an `Idempotency-Key` header to safely retry on timeout.



## OpenAPI

````yaml /openapi.json post /v1/installs
openapi: 3.1.0
info:
  title: CNAP API
  version: 1.0.0
  description: >-
    Public API for managing CNAP workspaces, clusters, templates, products, and
    deployments.


    Authenticate with a Personal Access Token via the `Authorization: Bearer
    cnap_pat_...` header.


    Workspace-scoped endpoints require the `X-Workspace-Id` header.
servers:
  - url: https://api.cnap.tech
    description: Production
security: []
paths:
  /v1/installs:
    post:
      tags:
        - Installs
      summary: Create product install
      description: >-
        Deploys a product to a region. Pass an `Idempotency-Key` header to
        safely retry on timeout.
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 256
            description: >-
              Unique key to prevent duplicate operations. If the same key is
              sent again, the existing workflow is returned instead of creating
              a new one.
            example: deploy-prod-2024-03-15
          required: false
          description: >-
            Unique key to prevent duplicate operations. If the same key is sent
            again, the existing workflow is returned instead of creating a new
            one.
          name: idempotency-key
          in: header
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                product_id:
                  type: string
                  minLength: 1
                  description: Product ID
                region_id:
                  type: string
                  minLength: 1
                  description: Region ID
                overrides:
                  type: array
                  items:
                    type: object
                    properties:
                      template_helm_source_id:
                        type: string
                        minLength: 1
                        description: Helm source ID to override
                      values:
                        type: object
                        additionalProperties: {}
                        description: Helm values
                    required:
                      - template_helm_source_id
                      - values
                  description: Initial value overrides per helm source
              required:
                - product_id
                - region_id
      responses:
        '202':
          description: Install workflow started
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Missing or invalid workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - BearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: not_found
            message:
              type: string
              example: Resource not found
            param:
              type: string
              description: The request field that caused the error
              example: name
            suggestion:
              type: string
              example: Run `cnap clusters list` to see available clusters
            details: {}
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Personal Access Token (cnap_pat_...) or OAuth2 JWT. Create tokens at
        https://cnap.tech/account/tokens

````