> ## 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.

# Get kubernetes cluster node pool detail

> Returns one node pool: its shape and config, current nodes and their spot and on-demand mix, its average nodes, capacity, cost and price per unit over the period, and the capacity AutoPilot sizing freed and added in it (counting only workloads AutoPilot currently runs on). Capacity and price figures are averaged over the period's hours with recorded data; cost_usd is the pool's cost over the period, null when none of its nodes could be priced. Freed and added are capacity, not bill savings. moved_in_cpu_cores and moved_out_cpu_cores are not reported here and are zero. A pool not seen in the period returns 404. 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/detail
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/detail:
    get:
      tags:
        - kubernetes-clusters
      summary: Get kubernetes cluster node pool detail
      description: >-
        Returns one node pool: its shape and config, current nodes and their
        spot and on-demand mix, its average nodes, capacity, cost and price per
        unit over the period, and the capacity AutoPilot sizing freed and added
        in it (counting only workloads AutoPilot currently runs on). Capacity
        and price figures are averaged over the period's hours with recorded
        data; cost_usd is the pool's cost over the period, null when none of its
        nodes could be priced. Freed and added are capacity, not bill savings.
        moved_in_cpu_cores and moved_out_cpu_cores are not reported here and are
        zero. A pool not seen in the period returns 404. 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: Autoscaler that runs the pool
          name: pool_autoscaler
          in: query
          required: true
          schema:
            type: string
        - description: Node pool name
          name: pool
          in: query
          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.NodePoolDetail'
        '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.NodePoolDetail:
      type: object
      required:
        - from
        - pool
        - savings
        - to
      properties:
        from:
          type: string
        pool:
          $ref: '#/components/schemas/operator.ClusterNodePool'
        savings:
          $ref: '#/components/schemas/operator.AutopilotPoolSavings'
        to:
          type: string
    responses.ErrorResponse:
      type: object
      required:
        - message
        - status
      properties:
        message:
          type: string
          example: some message
        status:
          type: string
          example: error
    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.AutopilotPoolSavings:
      type: object
      required:
        - added_cpu_cores
        - added_gpus
        - added_memory_gib
        - autoscaler
        - avg_nodes
        - cpu_cores
        - freed_cpu_cores
        - freed_gpus
        - freed_memory_gib
        - gpus
        - memory_gib
        - moved_in_cpu_cores
        - moved_out_cpu_cores
        - pool
        - spot_share
      properties:
        added_cpu_cores:
          type: number
        added_gpus:
          type: number
        added_memory_gib:
          type: number
        autoscaler:
          type: string
        avg_nodes:
          type: number
        cost_usd:
          type: number
          x-semantic: costAmount
          nullable: true
        cpu_core_usd_per_hour:
          type: number
          x-semantic: costAmount
          nullable: true
        cpu_cores:
          type: number
        estimated_nodes_worth:
          type: number
          nullable: true
        freed_cpu_cores:
          type: number
        freed_gpus:
          type: number
        freed_memory_gib:
          type: number
        gpu_usd_per_hour:
          type: number
          x-semantic: costAmount
          nullable: true
        gpus:
          type: number
        memory_gib:
          type: number
        memory_gib_usd_per_hour:
          type: number
          x-semantic: costAmount
          nullable: true
        moved_in_cpu_cores:
          type: number
        moved_out_cpu_cores:
          type: number
        pool:
          type: string
        spot_share:
          type: number
    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.