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

# Browse the add-on catalog

> The add-on-first view of the organisation's charts: one entry per add-on definition with its matching charts, plus manifest add-ons when types names them, paginated with category facets.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json get /api/v1/org/helm/addon-catalog
openapi: 3.1.0
info:
  title: Ankra Platform API
  version: v1
  description: >-
    The Ankra platform HTTP contract. The /api/v1 surface is the public,
    bearer-authenticated API used by the Ankra CLI, MCP clients and automation;
    send a personal or service API token as `Authorization: Bearer <token>`.
    Browser routes under /org and /chat are served on api.platform.ankra.app
    (each declares that server); they and /oauth/access authenticate with the
    ankra_session cookie, and mutations also require the X-Ankra-CSRF header.
    Every operation declares the credential it accepts, and no operation is
    served without one. This document is published deliberately: it describes
    the contract only and carries no organisation data or credentials. Report
    security issues to security@ankra.ai (see /.well-known/security.txt).
servers:
  - url: https://platform.ankra.app
security:
  - BearerAuth: []
tags:
  - name: Onboarding
    description: >-
      Generate a first website from a prompt and deploy it to a new
      organisation's cluster.
  - name: Access Gate
    description: >-
      Private service sign-in and membership checks for trusted Ankra proxy
      relays.
  - name: Canvas Datasets
    description: >-
      Read the fixed, named datasets canvas dashboards bind their charts, tables
      and stats to.
  - name: Canvases
    description: >-
      Keep dashboards and pages in the organisation's canvas library, with
      revision history, undo and pins.
  - name: Canvas Pages
    description: >-
      Publish a chat canvas artifact at a public pages address and take it down
      again.
  - name: Cloud Delegation
    description: >-
      Platform browser consent and organisation-bound connections for Ankra
      Cloud.
  - name: Organisation IAM
    description: >-
      Custom organisation roles and scoped role assignments for member and
      service-account identities.
  - name: Clusters
    description: Create, inspect and manage clusters, and the stacks deployed on them.
  - name: Managed Clusters
    description: Provider-managed control planes, driven through one common surface.
  - name: Playground
    description: >-
      The organisation's playground cluster: order one, read its provisioning
      status, list the orderable sizes, resize it and destroy it.
  - name: Imported Clusters
    description: Clusters that already existed and were connected to Ankra.
  - name: Cluster Access
    description: Kubeconfigs, service-account tokens and per-cluster access grants.
  - name: Cluster Meshes
    description: >-
      Cilium ClusterMeshes that join an organisation's clusters into one
      network: create a mesh, check whether clusters can join, prepare a running
      cluster, and add or remove members.
  - name: Kubernetes
    description: Read and act on the Kubernetes objects inside a cluster.
  - name: AWS Clusters
    description: >-
      Provision and manage self-managed k3s / kubeadm clusters on AWS EC2 in
      your own VPC.
  - name: Ankra Cloud Clusters
    description: >-
      Provision and manage self-managed kubeadm / k3s clusters on Ankra Cloud
      servers: a private network, a NAT router and a bastion per cluster.
  - name: DigitalOcean Clusters
    description: Provision and manage DigitalOcean Kubernetes clusters.
  - name: Hetzner Clusters
    description: Provision and manage Hetzner Kubernetes clusters.
  - name: OVH Clusters
    description: Provision and manage OVH Kubernetes clusters.
  - name: Scaleway Clusters
    description: Provision and manage Scaleway Kapsule clusters.
  - name: UpCloud Clusters
    description: Provision and manage UpCloud Kubernetes clusters.
  - name: Proxmox Clusters
    description: >-
      Self-managed Kubernetes clusters Ankra builds on Proxmox VE VMs: the node,
      storage, bridge, template and size catalogs, create and teardown, start
      and stop, node groups, nodes, standalone VMs, upgrades and the bastion.
  - name: HPE Morpheus Clusters
    description: >-
      Self-managed Kubernetes clusters Ankra builds on HPE Morpheus VMs: the
      group, cloud, plan, layout and network catalogs, create and teardown,
      start and stop, node groups, nodes, standalone VMs, upgrades and the
      bastion.
  - name: Applications
    description: Deploy, configure and observe applications across the fleet.
  - name: Pipelines
    description: >-
      Pipeline definitions, the approval of the authority they declare, and the
      caches pipelines keep between runs.
  - name: Workspaces
    description: >-
      Personal workspaces on the organisation's CI pool where a repository's
      heavy commands run, and the repository profiles they are built from.
  - name: Deploy Targets
    description: >-
      Environments, the hosts registered to receive deployments, and the
      releases deployed to them.
  - name: Deploy Provenance
    description: >-
      Whether an application's deploys verify signed provenance from the
      organisation's own pipeline, the keys that provenance is signed with, and
      a dry-run that verifies images without deploying.
  - name: Backups
    description: >-
      Backup vaults, restore points, protection posture and captures for stacks
      and application deployments; a completed capture is not a verified
      restore.
  - name: Stack Profiles
    description: Reusable stack definitions, their versions and sharing.
  - name: Services
    description: >-
      Versioned service packages and explicit sharing. Runtime admission is
      separate from publication.
  - name: Charts
    description: Browse the chart catalogue behind stacks and addons.
  - name: Helm
    description: Helm registries, credentials and the charts they expose.
  - name: Executions
    description: Long-running platform executions and their jobs.
  - name: Operations
    description: Cancel in-flight cluster operations and their jobs.
  - name: Chat
    description: Conversational sessions, plans and confirmable actions.
  - name: AI Management
    description: >-
      Customer agent lifecycle, authenticated identity and organisation
      automation controls.
  - name: AI Agent Runs
    description: Autonomous agent runs and their outcomes.
  - name: AI Tickets
    description: The AI ticket board, its sync connections and settings.
  - name: AI Playbooks
    description: Reusable playbooks the AI lanes execute.
  - name: AI Conditions
    description: Conditions that gate AI autonomy.
  - name: AI Remediation
    description: >-
      The organisation's auto-remediation policy: what the AI lanes may fix by
      themselves, and who approves the rest.
  - name: AI Engineering Handoffs
    description: Work the AI lanes escalate to a human engineer.
  - name: AI Environment
    description: The environment and base stacks AI demos deploy into.
  - name: AI Memory
    description: >-
      What the assistant has learned about you: your cross-session memories and
      learned profile.
  - name: MCP Servers
    description: >-
      Register the MCP servers the organisation's AI agents can call, choose
      their tools and grant them to roles.
  - name: Security
    description: Findings, advisories, SBOMs, compliance and posture.
  - name: Cost
    description: Cluster and fleet cost, rate cards and cost settings.
  - name: Decisions
    description: >-
      The decision ledger behind the Security and Cost queues: proposals a
      surface computed, the approve and set-aside decisions people took on them,
      and the receipts of running them.
  - name: Usage
    description: >-
      What your organisation used of Ankra - vCPU-hours, playgrounds, managed
      services, hosted logs and metrics, and AI - per meter and period, with how
      completely it was measured and whether a published rate applies.
  - name: Billing
    description: Subscription and spend caps.
  - name: Organisation
    description: Members, invitations, audit logs and organisation settings.
  - name: Projects
    description: >-
      Projects group an organisation's clusters, applications, credentials and
      other resources beneath it: list, create, rename and delete them, switch
      the current project, see who reaches one, and move resources between them.
  - name: Account
    description: >-
      Your own account: the contact email Ankra mails when it differs from your
      sign-in address, and the AI provider keys your own work runs on.
  - name: Account Tokens
    description: Personal access tokens for the API and CLI.
  - name: Credentials
    description: The shared credential store.
  - name: AWS Credentials
    description: >-
      AWS credentials: access keys or CloudFormation-onboarded STS roles for
      cost, EKS and self-managed provisioning.
  - name: Ankra Cloud Credentials
    description: >-
      Ankra Cloud API tokens, shared by the self-managed and managed Ankra Cloud
      lanes.
  - name: Azure Credentials
    description: Azure credentials and SSH keys.
  - name: DigitalOcean Credentials
    description: DigitalOcean credentials and SSH keys.
  - name: Hetzner Credentials
    description: Hetzner credentials and SSH keys.
  - name: HPE Morpheus Credentials
    description: HPE Morpheus credentials and the capacity and quotas behind them.
  - name: OVH Credentials
    description: OVH credentials and SSH keys.
  - name: Proxmox Credentials
    description: Proxmox VE credentials and the capacity and quotas behind them.
  - name: Scaleway Credentials
    description: Scaleway credentials.
  - name: UpCloud Credentials
    description: UpCloud credentials and SSH keys.
  - name: Data Source Credentials
    description: Credentials for metrics and log sources.
  - name: DNS Credentials
    description: Credentials for DNS providers.
  - name: Object Storage Buckets
    description: >-
      Buckets Ankra creates and manages on an organisation's own provider
      credentials.
  - name: DNS
    description: DNS zones and records, including custom organisation zones.
  - name: Cloudflare
    description: Cloudflare domains and the credentials behind them.
  - name: Avura
    description: >-
      The linked Avura organization, the domains it shares with Ankra Platform,
      and their DNS records.
  - name: Variables
    description: Organisation- and cluster-scoped variables.
  - name: Secret Slots
    description: >-
      Store secrets in Vault and reference them by ${SECRET_SLOT:<slot_id>}
      sentinel instead of by value.
  - name: SOPS
    description: Encrypt and decrypt values with the organisation SOPS config.
  - name: Alerts
    description: Alert integrations and ingest credentials.
  - name: Notifications
    description: Notification routes and their delivery targets.
  - name: Support
    description: Support tickets.
  - name: AI Settings
    description: Organisation AI provider, model catalog and per-function model settings
paths:
  /api/v1/org/helm/addon-catalog:
    get:
      tags:
        - Helm
      summary: Browse the add-on catalog
      description: >-
        The add-on-first view of the organisation's charts: one entry per add-on
        definition with its matching charts, plus manifest add-ons when types
        names them, paginated with category facets.
      operationId: list_helm_addon_catalog_api
      parameters:
        - in: query
          name: page
          required: false
          schema:
            default: 1
            minimum: 1
            type: integer
          description: Page number, from 1.
        - in: query
          name: page_size
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          description: Entries per page.
        - in: query
          name: search
          required: false
          schema:
            maxLength: 200
            type: string
          description: Free-text search.
        - in: query
          name: category
          required: false
          schema:
            type: string
            maxLength: 100
          description: Only this category.
        - in: query
          name: source
          required: false
          schema:
            type: string
            maxLength: 40
          description: Only entries from this source.
        - in: query
          name: connected
          required: false
          schema:
            type: string
          description: Filter on whether a registry is connected.
        - in: query
          name: types
          required: false
          schema:
            maxLength: 200
            type: string
          description: >-
            Comma-separated entry types to include; name manifest_addon to
            receive manifest add-ons.
      responses:
        '200':
          description: A page of catalog entries.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HelmAddonCatalogList'
        '401':
          description: Unauthorized
        '422':
          description: Validation error
        '500':
          description: Internal error
      security:
        - BearerAuth: []
components:
  schemas:
    HelmAddonCatalogList:
      type: object
      properties:
        result:
          type: array
          items:
            anyOf:
              - $ref: '#/components/schemas/HelmAddonCatalogItem'
              - type: 'null'
        pagination:
          $ref: '#/components/schemas/HelmPagination'
        categories:
          type: array
          items:
            $ref: '#/components/schemas/HelmAddonCategoryFacet'
        category_options:
          type: array
          items:
            type: string
      required:
        - result
        - pagination
        - categories
        - category_options
      description: The wire shape of the catalog listing.
      title: HelmAddonCatalogList
    HelmAddonCatalogItem:
      type: object
      properties:
        type:
          type: string
        name:
          type: string
        display_name:
          type: string
        description:
          type:
            - string
            - 'null'
        website_url:
          type:
            - string
            - 'null'
        documentation_url:
          type:
            - string
            - 'null'
        icon_url:
          type:
            - string
            - 'null'
        category:
          type:
            - string
            - 'null'
        source:
          type:
            - string
            - 'null'
        chart_count:
          type: integer
        installed_count:
          type: integer
        charts:
          type: array
          items:
            anyOf:
              - $ref: '#/components/schemas/HelmAddonCatalogChart'
              - type: 'null'
        manifest_addon:
          anyOf:
            - $ref: '#/components/schemas/HelmAddonCatalogManifestAddon'
            - type: 'null'
      required:
        - type
        - name
        - display_name
        - description
        - website_url
        - documentation_url
        - icon_url
        - category
        - source
        - chart_count
        - installed_count
        - charts
      description: >-
        One catalog entry: a curated addon definition with its matched charts
        (type "addon"), a derived entry for a chart no definition matches (type
        "chart", where charts holds the chart itself and the definition-level
        fields are null), or a published application manifest set (type
        "manifest_addon", where the manifest_addon payload replaces the charts
        slot).
      title: HelmAddonCatalogItem
    HelmPagination:
      type: object
      properties:
        page:
          type: integer
        page_size:
          type: integer
        total_pages:
          type: integer
        total_count:
          type: integer
      required:
        - page
        - page_size
        - total_pages
        - total_count
      title: HelmPagination
    HelmAddonCategoryFacet:
      type: object
      properties:
        name:
          type: string
        count:
          type: integer
      required:
        - name
        - count
      description: One entry of the category filter facet.
      title: HelmAddonCategoryFacet
    HelmAddonCatalogChart:
      type: object
      properties:
        name:
          type: string
        version:
          type: string
        registry_name:
          type: string
        registry_url:
          type: string
        description:
          type:
            - string
            - 'null'
        icon:
          type:
            - string
            - 'null'
        is_deprecated:
          type: boolean
        is_private:
          type: boolean
        is_global:
          type: boolean
        installed_count:
          type: integer
      required:
        - name
        - version
        - registry_name
        - registry_url
        - description
        - icon
        - is_deprecated
        - is_private
        - is_global
        - installed_count
      description: >-
        One chart grouped under a catalog entry. IsPrivate reports that the
        chart's registry pulls with a credential, so the catalog can mark it as
        private without disclosing which credential.
      title: HelmAddonCatalogChart
    HelmAddonCatalogManifestAddon:
      type: object
      properties:
        id:
          type: string
        version:
          type: string
        source_repo:
          type: string
        source_application_id:
          type: string
        options_count:
          type: integer
        file_count:
          type: integer
      required:
        - id
        - version
        - source_repo
        - source_application_id
        - options_count
        - file_count
      description: >-
        The manifest-addon payload of a catalog item (the twin of the Charts
        slot on chart-backed entries).
      title: HelmAddonCatalogManifestAddon
  securitySchemes:
    BearerAuth:
      bearerFormat: PAT
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.