> ## 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. # List cluster add-ons > Returns a paginated list of the add-ons deployed on the cluster, including their live health where available. Answers `404` when the cluster is not in your organisation. ## OpenAPI ````yaml https://platform.ankra.app/openapi.json get /api/v1/clusters/{cluster_id}/addons 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 `. 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: 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: 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: 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: Account description: >- Your own account: the contact email Ankra mails when it differs from your sign-in address. - 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:} 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/clusters/{cluster_id}/addons: get: tags: - Clusters summary: List cluster add-ons description: >- Returns a paginated list of the add-ons deployed on the cluster, including their live health where available. Answers `404` when the cluster is not in your organisation. operationId: list_cluster_addons_endpoint_api_v1_clusters__cluster_id__addons_get parameters: - in: path name: cluster_id required: true schema: format: uuid4 title: Cluster Id type: string - in: query name: page required: false schema: default: 1 title: Page type: integer - in: query name: page_size required: false schema: default: 25 title: Page Size type: integer - in: header name: authorization required: false schema: anyOf: - type: string - type: 'null' title: Authorization - in: header name: x-ankra-organisation-id required: false schema: anyOf: - type: string - type: 'null' title: X-Ankra-Organisation-Id responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListClusterAddonsResponse' description: Successful Response '404': description: Not found '422': content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' description: Validation Error security: - BearerAuth: [] components: schemas: ListClusterAddonsResponse: properties: pagination: $ref: >- #/components/schemas/usecase__cluster__list_cluster_addons__Pagination result: items: $ref: '#/components/schemas/ClusterAddonListItem' title: Result type: array security_advisories_checked_at: anyOf: - type: string format: date-time - type: 'null' description: >- The oldest successful upstream advisory feed read behind this page's advisory answers; null when one has never been read. title: Security Advisories Checked At security_advisories_stale: description: >- True when an advisory feed behind this page has not been read successfully in the last day, or ever. title: Security Advisories Stale type: boolean required: - result - pagination title: ListClusterAddonsResponse type: object HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' title: Detail type: array title: HTTPValidationError type: object usecase__cluster__list_cluster_addons__Pagination: properties: page: title: Page type: integer page_size: title: Page Size type: integer total_count: type: integer title: Total Count total_pages: title: Total Pages type: integer required: - page - page_size - total_pages - total_count title: Pagination type: object ClusterAddonListItem: properties: chart_name: title: Chart Name type: string chart_version: title: Chart Version type: string created_at: type: string format: date-time title: Created At health: anyOf: - type: string - type: 'null' title: Health icon: anyOf: - type: string - type: 'null' title: Icon latest_chart_version: anyOf: - type: string - type: 'null' title: Latest Chart Version name: type: string title: Name namespace: title: Namespace type: string registry_name: anyOf: - type: string - type: 'null' title: Registry Name registry_url: title: Registry Url type: string security_advisories: description: >- Published upstream security advisories covering this add-on's version that have a fix available, most severe first. Empty with security_advisory_status 'checked' means none; read it together with the status. items: $ref: '#/components/schemas/AddonSecurityAdvisory' title: Security Advisories type: array security_advisory_status: description: >- 'checked': the add-on was judged against its upstream's advisories. 'unknown': the add-on's upstream is tracked but its version or the advisory feed could not be read, so an empty list is not a clean answer. 'not_tracked': no advisory source is mapped for this chart. enum: - checked - unknown - not_tracked title: Security Advisory Status type: string security_upgrade_chart_version: anyOf: - type: string - type: 'null' description: >- The nearest chart version in the catalog that fixes every listed advisory: the target of a one-click upgrade. title: Security Upgrade Chart Version stack_name: anyOf: - type: string - type: 'null' title: Stack Name state: anyOf: - $ref: '#/components/schemas/ResourceState' - type: 'null' through_ankra: default: false title: Through Ankra type: boolean updated_at: type: string format: date-time title: Updated At required: - name - chart_name - chart_version - registry_url - namespace - created_at - updated_at title: ClusterAddonListItem type: object ValidationError: properties: loc: items: anyOf: - type: string - type: integer title: Location type: array msg: title: Message type: string type: title: Error Type type: string required: - loc - msg - type title: ValidationError type: object AddonSecurityAdvisory: description: One published security advisory covering an installed add-on's version. properties: advisory_id: description: >- The advisory's id as its maintainers publish it (a GHSA id when GitHub carries it, otherwise a CVE or OSV id). title: Advisory Id type: string affected_version: description: >- The upstream release the add-on was judged as (its app version), which is what the advisory's ranges are written in. title: Affected Version type: string aliases: items: type: string title: Aliases type: array fixed_version: anyOf: - type: string - type: 'null' description: The nearest upstream release that fixes the advisory. title: Fixed Version published_at: anyOf: - type: string format: date-time - type: 'null' title: Published At severity: enum: - critical - high - medium - low - unknown title: Severity type: string summary: type: string title: Summary upgrade_chart_version: anyOf: - type: string - type: 'null' description: The nearest chart version in the catalog whose app version is fixed. title: Upgrade Chart Version url: title: Url type: string required: - advisory_id - aliases - severity - summary - url - published_at - affected_version - fixed_version - upgrade_chart_version title: AddonSecurityAdvisory type: object ResourceState: enum: - creating - updating - stopping - up - down title: ResourceState type: string securitySchemes: BearerAuth: bearerFormat: PAT scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.