---
title: "returns a list of Pods from all namespaces"
method: GET
path: "/api/v1/pod"
---

# returns a list of Pods from all namespaces

`GET /api/v1/pod`

## Query parameters

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

## Response `200`

OK

- PodPodList
  - `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
  - `pods` PodPod[], required
    - `allocatedResources` PodPodAllocatedResources, required
      - `cpuLimits` integer, required
      - `cpuRequests` integer, required
      - `memoryLimits` integer, required
      - `memoryRequests` integer, required
    - `containerImages` string[], required
    - `containerStatuses` PodContainerStatus[], required
      - `name` string, required
      - `ready` boolean, required
      - `state` string, required
    - `metrics` PodPodMetrics, required
      - `cpuUsage` integer, required
      - `cpuUsageHistory` ApiMetricPoint[], required
        - `timestamp` string, date-time, required
        - `value` integer, required
      - `memoryUsage` integer, required
      - `memoryUsageHistory` ApiMetricPoint[], required
        - `timestamp` string, date-time, required
        - `value` integer, required
    - `nodeName` string, required
    - `objectMeta` TypesObjectMeta, required
      - `annotations` object
      - `creationTimestamp` V1Time
        - `Time` string, date-time, required
      - `labels` object
      - `name` string
      - `namespace` string
      - `uid` string
    - `restartCount` integer, required
    - `status` string, required
    - `typeMeta` TypesTypeMeta, required
      - `kind` string
      - `restartable` boolean
      - `scalable` boolean
    - `warnings` CommonEvent[], required
      - `count` integer, required
      - `firstSeen` V1Time, required
        - `Time` string, date-time, required
      - `lastSeen` V1Time, required
        - `Time` string, date-time, required
      - `message` string, required
      - `object` string, required
      - `objectKind` string
      - `objectMeta` TypesObjectMeta, required
        - `annotations` object
        - `creationTimestamp` V1Time
          - `Time` string, date-time, required
        - `labels` object
        - `name` string
        - `namespace` string
        - `uid` string
      - `objectName` string
      - `objectNamespace` string
      - `reason` string, required
      - `sourceComponent` string, required
      - `sourceHost` string, required
      - `type` string, required
      - `typeMeta` TypesTypeMeta, required
        - `kind` string
        - `restartable` boolean
        - `scalable` boolean
  - `status` CommonResourceStatus, required
    - `failed` integer, required
    - `pending` integer, required
    - `running` integer, required
    - `succeeded` integer, required
    - `terminating` integer, required

---

[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)