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

# List kubernetes cluster node pools

> Returns every node pool seen in the period, plus the pools AutoPilot created, grouped by the autoscaler that runs them. Per pool: its shape, whether its autoscaler can add the first node to an empty pool, whether CostGraph created it, its GPU models, its current nodes and their spot and on-demand mix. projected_monthly_cost is projected from the pool's nodes in the period's last recorded hour at their hourly price over a 730-hour month; it is not billed spend. A node without a price adds nothing, and the pool's cost is null when none of its nodes could be priced. Autoscaler and cluster totals add up the pools that have a projected cost, and cost shares are percentages of the cluster's projected total. from and to are RFC 3339 and truncated to the hour, to is exclusive; the default is the last 30 days ending at the last closed hour; a period over 400 days is rejected.



## OpenAPI

````yaml /api-reference/costgraph/openapi.json get /api/v1/tenant/clusters/{cluster_id}/node-pools
openapi: 3.0.0
info:
  description: Read and manage your CostGraph organization, spend, alerts, and settings.
  title: CostGraph API
  contact: {}
  version: '1.0'
servers:
  - url: https://api.costgraph.ai
security: []
tags:
  - name: ai
    x-group: AI
  - name: ai-serving
    x-group: AI serving
  - name: anomalies
    x-group: Anomalies
  - name: auth
    x-group: Auth
  - name: billing
    x-group: Billing
  - name: billing-export
    x-group: Billing export
  - name: budgets
    x-group: Budgets
  - name: ci
    x-group: CI
  - name: compute-recommendations
    x-group: Compute recommendations
  - name: config
    x-group: Config
  - name: context-graph
    x-group: Context graph
  - name: cost
    x-group: Cost
  - name: gpus
    x-group: GPUs
  - name: graphai
    x-group: Graph AI
  - name: integrations
    x-group: Integrations
  - name: invitations
    x-group: Invitations
  - name: kubernetes-clusters
    x-group: Kubernetes clusters
  - name: marketplace
    x-group: Marketplace
  - name: network
    x-group: Network
  - name: network-requests
    x-group: Network requests
  - name: notifications
    x-group: Notifications
  - name: oauth
    x-group: OAuth
  - name: oauth-clients
    x-group: OAuth clients
  - name: opencost
    x-group: OpenCost
  - name: organization
    x-group: Audit log
  - name: organizations
    x-group: Organizations
  - name: placement-alternatives
    x-group: Placement alternatives
  - name: reports
    x-group: Reports
  - name: sandboxes
    x-group: Sandboxes
  - name: settings
    x-group: Settings
  - name: sso
    x-group: Single sign-on
  - name: tenants
    x-group: Tenants
  - name: ticketing
    x-group: Ticketing
  - name: user
    x-group: Users
  - name: virtual-machines
    x-group: Virtual machines
  - name: virtual-tags
    x-group: Virtual tags
  - name: workflows
    x-group: Workflows
paths:
  /api/v1/tenant/clusters/{cluster_id}/node-pools:
    get:
      tags:
        - kubernetes-clusters
      summary: List kubernetes cluster node pools
      description: >-
        Returns every node pool seen in the period, plus the pools AutoPilot
        created, grouped by the autoscaler that runs them. Per pool: its shape,
        whether its autoscaler can add the first node to an empty pool, whether
        CostGraph created it, its GPU models, its current nodes and their spot
        and on-demand mix. projected_monthly_cost is projected from the pool's
        nodes in the period's last recorded hour at their hourly price over a
        730-hour month; it is not billed spend. A node without a price adds
        nothing, and the pool's cost is null when none of its nodes could be
        priced. Autoscaler and cluster totals add up the pools that have a
        projected cost, and cost shares are percentages of the cluster's
        projected total. from and to are RFC 3339 and truncated to the hour, to
        is exclusive; the default is the last 30 days ending at the last closed
        hour; a period over 400 days is rejected.
      parameters:
        - description: Tenant ID
          name: X-CostGraph-Tenant-ID
          in: header
          required: true
          schema:
            type: string
        - description: Kubernetes cluster ID
          name: cluster_id
          in: path
          required: true
          schema:
            type: string
        - description: Period start (RFC 3339, inclusive)
          name: from
          in: query
          schema:
            type: string
        - description: Period end (RFC 3339, exclusive)
          name: to
          in: query
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/responses.SuccessResponse'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/operator.ClusterNodePoolList'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/responses.ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    responses.SuccessResponse:
      type: object
      required:
        - message
        - status
      properties:
        data: {}
        message:
          type: string
          example: some message
        status:
          type: string
          example: success
    operator.ClusterNodePoolList:
      type: object
      required:
        - autoscalers
        - cost_share
        - from
        - node_count
        - pool_count
        - pools
        - to
      properties:
        autopilot_enabled:
          type: boolean
        autoscalers:
          type: array
          items:
            $ref: '#/components/schemas/operator.ClusterNodePoolAutoscaler'
        cost_share:
          type: array
          items:
            $ref: '#/components/schemas/operator.NodePoolCostShare'
        from:
          type: string
        node_count:
          type: integer
        pool_count:
          type: integer
        pools:
          type: array
          items:
            $ref: '#/components/schemas/operator.ClusterNodePool'
        projected_monthly_cost:
          type: number
          x-semantic: costAmount
          nullable: true
        to:
          type: string
    responses.ErrorResponse:
      type: object
      required:
        - message
        - status
      properties:
        message:
          type: string
          example: some message
        status:
          type: string
          example: error
    operator.ClusterNodePoolAutoscaler:
      type: object
      required:
        - kind
        - node_count
        - pool_count
      properties:
        cost_share_pct:
          type: number
          nullable: true
        kind:
          type: string
        node_count:
          type: integer
        pool_count:
          type: integer
        projected_monthly_cost:
          type: number
          x-semantic: costAmount
          nullable: true
    operator.NodePoolCostShare:
      type: object
      required:
        - key
        - label
      properties:
        key:
          type: string
        label:
          type: string
        projected_monthly_cost:
          type: number
          x-semantic: costAmount
          nullable: true
        share_pct:
          type: number
          nullable: true
    operator.ClusterNodePool:
      type: object
      required:
        - autoscaler
        - capacity_mix
        - compute_classes
        - created_by_costgraph
        - gpu_models
        - id
        - name
        - nodes_current
        - scales_from_zero
        - shape
      properties:
        autoscaler:
          type: string
        capacity_mix:
          type: array
          items:
            $ref: '#/components/schemas/operator.NodePoolCapacityShare'
        compute_classes:
          type: array
          items:
            type: string
        cost_share_pct:
          type: number
          nullable: true
        created_by_costgraph:
          type: boolean
        gpu_models:
          type: array
          items:
            type: string
        id:
          type: string
        name:
          type: string
        nodes_current:
          type: integer
        projected_monthly_cost:
          type: number
          x-semantic: costAmount
          nullable: true
        scales_from_zero:
          type: boolean
        shape:
          type: string
    operator.NodePoolCapacityShare:
      type: object
      required:
        - capacity_type
        - share_pct
      properties:
        capacity_type:
          type: string
        share_pct:
          type: number
  securitySchemes:
    BearerAuth:
      description: Enter "Bearer {token}"
      type: apiKey
      name: Authorization
      in: header

````

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