---
title: "Get all pods"
method: GET
path: "/pods"
tags: ["Support API Key Authentication"]
---

# Get all pods

`GET /pods`

Endpoint to get all available pods.

## Query parameters

- `machine_names` string, nullable
- `price_lte` number, nullable
- `price_gte` number, nullable
- `gpu_count_lte` integer, nullable
- `gpu_count_gte` integer, nullable
- `lat` number, nullable
- `lon` number, nullable
- `max_distance_mile` number, nullable
- `bookmarked` boolean, nullable
- `machine_request_id` string, nullable
- `collateral_deposited` boolean, nullable
- `ncu_profiling_enabled` boolean, nullable
- `only_favorites` boolean, nullable

## Response `200`

Pods retrieved successfully

- PodListItemResponse[]
  - `executor_id` string, uuid, required
  - `ports_mapping` union, required
    - object
    - string
  - `pod_name` string, required
  - `ssh_connect_cmd` string, required
  - `gpu_name` string, required
  - `gpu_count` string, required
  - `cpu_name` string, required
  - `cpu_count` integer, required
  - `ram_total` integer, required
  - `status` string, required
  - `is_favorite` boolean, nullable, required
  - `updated_at` string, date-time, nullable, required
  - `created_at` string, date-time, nullable, required
  - `removal_scheduled_at` string, date-time, nullable, required
  - `termination_hours` integer, nullable, required
  - `jupyter_installation_status` 'INSTALLING' | 'SUCCESS' | 'FAILED', required
  - `jupyter_url` string, nullable, required
  - `enable_jupyter` boolean, nullable, required
  - `enable_volume_encryption` boolean, nullable, required
  - `volume_encryption_status` 'ENABLED' | 'UNSUPPORTED_IMAGE' | 'DISABLED' | 'FAILED', required
  - `price` number, nullable
  - `cluster_id` string, uuid, nullable
  - `cluster_node_index` integer, nullable
  - `id` string, uuid, required
  - `template` TemplateBaseResponse
    - `id` string, uuid, nullable, required
    - `name` string, required
    - `description` string, nullable, required
    - `docker_image` string, required
    - `docker_image_tag` string, required
    - `category` 'DOCKER' | 'PYTORCH' | 'NVIDIA' | 'TENSOR_FLOW' | 'OPEN_AI' | 'UBUNTU', required
    - `docker_image_digest` string, nullable, required
    - `volumes` string[], nullable, required
    - `environment` object, nullable, required
    - `entrypoint` string, nullable, required
    - `internal_ports` integer[], nullable, required
    - `is_private` boolean, required
    - `startup_commands` string, nullable, required
  - `executor` ExecutorForPodResponse, required
    - `id` string, uuid, required
    - `machine_name` string, nullable
    - `price_per_gpu` number, nullable
    - `pending_price_per_hour` number, nullable
    - `price_change_effective_date` string, date-time, nullable
    - `executor_ip_address` string, required
    - `validator_hotkey` string, required
    - `gpu_count` integer, nullable
    - `available_gpu_count` integer, nullable
    - `specs` object, required
    - `active` boolean, nullable
    - `uptime_in_minutes` integer, nullable
    - `miner_hotkey` string, nullable
    - `collateral_deposited` boolean, nullable
    - `location` LocationResponseForExecutor
      - `id` string, uuid
      - `created_at` string, date-time
      - `updated_at` string, date-time, nullable
      - `country` string, required
      - `country_code` string, nullable
      - `region` string, nullable
      - `region_name` string, nullable
      - `city` string, nullable
      - `zip` string, nullable
      - `lat` number, nullable
      - `lon` number, nullable
      - `timezone` string, required
    - `is_slow_machine` boolean
    - `effective_upload_speed_mbps` number, nullable
    - `effective_download_speed_mbps` number, nullable
    - `tier` string, nullable
    - `reliability_score` number, nullable
    - `ncu_profiling_enabled` boolean, required
    - `on_infiniband_fabric` boolean, required
    - `on_roce_fabric` boolean, required
  - `volume` VolumeForPodResponse — Volume information for pod responses (without circular pod reference)
    - `id` string, uuid, required
    - `name` string, required
    - `description` string, nullable
    - `bucket_name` string, required
    - `plugin` string, required
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
  - `ssh_keys` SshKeyForPodResponse[], nullable
    - `name` string, required
    - `public_key` string, required
  - `notice_period` NoticePeriodResponse
    - `id` string, uuid, required
    - `executor_id` string, uuid, required
    - `period_in_minute` integer, required
    - `reason` string, nullable
    - `opt_finished` boolean
    - `starting_at` string, date-time, required
    - `expiring_at` string, date-time, required
    - `permanent_removal` boolean
  - `skip_add_agent_ssh_key` boolean, nullable
  - `cluster_overlay_ip` string, nullable, required — This node's address on the cluster's private overlay — where its peers reach it.

## Other responses

- `422` — Validation Error
- `500` — Internal server error

---

[API](https://skmtc.dev/lium/apis/lium-backend-api.md) · [All operations](https://skmtc.dev/lium/apis/lium-backend-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/lium/lium-backend-api/revisions/57db0a9348db/schema)