> ## 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 live node-pool catalog for a managed cluster

> Bearer PAT authentication; RBAC permission `clusters.read`. For Kapsule, provider_cluster_id is the opaque region-qualified `regions/{region}/clusters/{id}` reference. CNI is immutable. Imported/unknown provenance is disconnect-only; provider deletion is allowed by default only for created clusters.



## OpenAPI

````yaml https://platform.ankra.app/openapi.json get /api/v1/clusters/managed/{provider}/{cluster_id}/node-pools/catalog
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers:
  - url: https://platform.ankra.app
security: []
tags:
  - 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: 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: Stack Profiles
    description: Reusable stack definitions, their versions and sharing.
  - 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 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 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: Security
    description: Findings, advisories, SBOMs, compliance and posture.
  - name: Cost
    description: Cluster and fleet cost, rate cards and cost settings.
  - name: Billing
    description: Subscription and spend caps.
  - name: Organisation
    description: Members, invitations, audit logs and organisation settings.
  - name: Account Tokens
    description: Personal access tokens for the API and CLI.
  - name: Credentials
    description: The shared credential store.
  - 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: OVH Credentials
    description: OVH credentials and SSH keys.
  - 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: DNS
    description: DNS zones and records, including custom organisation zones.
  - name: Cloudflare
    description: Cloudflare domains and the credentials behind them.
  - name: Variables
    description: Organisation- and cluster-scoped variables.
  - 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.
paths:
  /api/v1/clusters/managed/{provider}/{cluster_id}/node-pools/catalog:
    get:
      tags:
        - Managed Clusters
      summary: List live node-pool catalog for a managed cluster
      description: >-
        Bearer PAT authentication; RBAC permission `clusters.read`. For Kapsule,
        provider_cluster_id is the opaque region-qualified
        `regions/{region}/clusters/{id}` reference. CNI is immutable.
        Imported/unknown provenance is disconnect-only; provider deletion is
        allowed by default only for created clusters.
      operationId: managed_cluster_pool_catalog_pat
      parameters:
        - in: path
          name: provider
          required: true
          schema:
            $ref: '#/components/schemas/ManagedProvider'
        - in: path
          name: cluster_id
          required: true
          schema:
            format: uuid
            type: string
        - description: PAT organisation override.
          in: header
          name: x-ankra-organisation-id
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ManagedPoolCatalog'
          description: Successful response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Invalid request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Unauthenticated
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Permission or CSRF check failed
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Resource not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Request validation failed
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractDetailError'
          description: Provider or internal failure
      security:
        - BearerAuth: []
components:
  schemas:
    ManagedProvider:
      enum:
        - doks
        - uks
        - gke
        - ovh_mks
        - aks
        - eks
        - kapsule
      example: kapsule
      type: string
    ManagedPoolCatalog:
      properties:
        capabilities:
          $ref: '#/components/schemas/ManagedCapabilities'
        incomplete:
          type: boolean
        incomplete_regions:
          items:
            type: string
          type: array
        pricing_unavailable:
          type: boolean
        private_networks:
          items:
            properties:
              id:
                type: string
              name:
                type: string
              provider_reference:
                type: string
              region:
                type: string
            required:
              - id
              - name
              - region
              - provider_reference
            type: object
          type: array
        root_volume_types:
          items:
            type: string
          type: array
        security_groups:
          items:
            $ref: '#/components/schemas/ManagedSecurityGroupOption'
          type: array
        sizes:
          items:
            $ref: '#/components/schemas/ManagedSizeOption'
          type: array
        zones:
          items:
            properties:
              region:
                type: string
              slug:
                type: string
            required:
              - slug
              - region
            type: object
          type: array
      required:
        - sizes
        - zones
        - private_networks
        - security_groups
        - root_volume_types
        - capabilities
        - pricing_unavailable
        - incomplete
        - incomplete_regions
      type: object
    ContractDetailError:
      example:
        detail: Cluster not found
      properties:
        detail:
          oneOf:
            - type: string
            - additionalProperties: true
              properties: {}
              type: object
      required:
        - detail
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ManagedCapabilities:
      additionalProperties: false
      properties:
        supports_autopilot:
          type: boolean
        supports_autoscaling:
          type: boolean
        supports_ha_control_plane:
          type: boolean
        supports_maintenance_window:
          type: boolean
        supports_pool_autohealing:
          type: boolean
        supports_pool_autohealing_update:
          type: boolean
        supports_pool_public_ip:
          type: boolean
        supports_pool_public_ip_update:
          type: boolean
        supports_pool_root_volume:
          type: boolean
        supports_pool_root_volume_update:
          type: boolean
        supports_pool_security_group_update:
          type: boolean
        supports_pool_security_groups:
          type: boolean
        supports_pool_upgrade_policy:
          type: boolean
        supports_pool_upgrade_policy_update:
          type: boolean
        supports_pool_zone_update:
          type: boolean
        supports_pool_zones:
          type: boolean
        supports_private_endpoint:
          type: boolean
        supports_spot:
          type: boolean
        supports_stop_start:
          type: boolean
        supports_retention_policy:
          type: boolean
      required:
        - supports_spot
        - supports_autopilot
        - supports_private_endpoint
        - supports_autoscaling
        - supports_ha_control_plane
        - supports_maintenance_window
        - supports_pool_zones
        - supports_pool_root_volume
        - supports_pool_security_groups
        - supports_pool_autohealing
        - supports_pool_public_ip
        - supports_pool_upgrade_policy
        - supports_pool_zone_update
        - supports_pool_root_volume_update
        - supports_pool_security_group_update
        - supports_pool_public_ip_update
        - supports_pool_autohealing_update
        - supports_pool_upgrade_policy_update
        - supports_stop_start
        - supports_retention_policy
      type: object
    ManagedSecurityGroupOption:
      properties:
        id:
          type: string
        name:
          type: string
        provider_reference:
          type: string
        region:
          type: string
        zone:
          type: string
      required:
        - id
        - name
        - region
        - zone
        - provider_reference
      type: object
    ManagedSizeOption:
      properties:
        category:
          type: string
        disk_gb:
          anyOf:
            - type: integer
            - type: 'null'
        gpu_count:
          anyOf:
            - type: integer
            - type: 'null'
        gpu_model:
          type: string
        is_gpu:
          type: boolean
        label:
          type: string
        memory_gb:
          anyOf:
            - type: number
            - type: 'null'
        price_monthly:
          anyOf:
            - type: number
            - type: 'null'
        region:
          type: string
        slug:
          type: string
        vcpus:
          anyOf:
            - type: integer
            - type: 'null'
      required:
        - slug
        - label
        - region
        - is_gpu
        - vcpus
        - memory_gb
        - disk_gb
        - price_monthly
        - category
        - gpu_count
        - gpu_model
      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
  securitySchemes:
    BearerAuth:
      bearerFormat: PAT
      scheme: bearer
      type: http

````