---
title: "returns a list of Nodes"
method: GET
path: "/api/v1/node"
---

# returns a list of Nodes

`GET /api/v1/node`

## Query parameters

- `filterBy` string
- `sortBy` string
- `itemsPerPage` string
- `page` string
- `metricNames` string
- `aggregations` string

## Response `200`

OK

- NodeNodeList
  - `cumulativeMetrics` ApiMetric[], required
    - `aggregation` string
    - `dataPoints` ApiDataPoint[], required
      - `x` integer, required
      - `y` integer, required
    - `metricName` string, required
    - `metricPoints` ApiMetricPoint[], required
      - `timestamp` string, date-time, required
      - `value` integer, required
  - `errors` Error[], required
    - unknown
  - `listMeta` TypesListMeta, required
    - `totalItems` integer, required
  - `nodes` NodeNode[], required
    - `allocatedResources` NodeNodeAllocatedResources, required
      - `allocatedPods` integer, required
      - `cpuCapacity` integer, required
      - `cpuLimits` integer, required
      - `cpuLimitsFraction` number, double, required
      - `cpuRequests` integer, required
      - `cpuRequestsFraction` number, double, required
      - `memoryCapacity` integer, required
      - `memoryLimits` integer, required
      - `memoryLimitsFraction` number, double, required
      - `memoryRequests` integer, required
      - `memoryRequestsFraction` number, double, required
      - `podCapacity` integer, required
      - `podFraction` number, double, required
    - `objectMeta` TypesObjectMeta, required
      - `annotations` object
      - `creationTimestamp` V1Time
        - `Time` string, date-time, required
      - `labels` object
      - `name` string
      - `namespace` string
      - `uid` string
    - `ready` string, required
    - `typeMeta` TypesTypeMeta, required
      - `kind` string
      - `restartable` boolean
      - `scalable` boolean

---

[API](https://skmtc.net/karmada-io/apis/kubernetes-dashboard-api.md) · [All operations](https://skmtc.net/karmada-io/apis/kubernetes-dashboard-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/karmada-io/kubernetes-dashboard-api/versions/8521b53800a7/schema)