---
title: "Lists a page of the namespace's configured node pools, ordered by name. A pool is listed once it is configured, whether or not any node is connected."
method: GET
path: "/pools"
tags: ["pools"]
---

# Lists a page of the namespace's configured node pools, ordered by name. A pool is listed once it is configured, whether or not any node is connected.

`GET /pools`

## Request

- Base URL: `https://api.rivet.dev`
- URL: `https://api.rivet.dev/pools`
- Auth: one of:
  - HTTP bearer
  - API key in header `x-rivet-token`

## Query parameters

- `namespace` string
- `limit` integer
- `cursor` string

## Response `200`

A page of node pools.

- PoolsListResponse
  - `pagination` Pagination, required
    - `cursor` string, nullable, required: Cursor for the next page, or `null` when there are no more results.
  - `pools` Pool[], required
    - `name` string, required: Name of the node pool.
    - `drain_on_version_upgrade` boolean, required: Drain nodes running an older version when a newer version connects.
    - `actor_eviction_delay` integer, required: Seconds to wait before evicting actors from a draining node.
    - `actor_eviction_period` integer, required: Seconds over which actors are evicted from a draining node.
    - `actor_eviction_rate` number, double, required: Rate at which actors are evicted from a draining node. Must be finite and greater than 0.
    - `metadata` unknown, required

## Other responses

- `400`: `actor.invalid_limit`: `limit` is not an integer from 1 to 100. `envoy.invalid_pool_name`: `cursor` is not a valid pool name. `envoy.invalid_namespace_name`: the `namespace` value is not a DNS label of 1 to 63 lowercase letters, digits and hyphens.
- `401`: `auth.invalid_token`: the request carries no token, or the token is not valid. `auth.token_expired`: the token has expired.
- `403`: `auth.insufficient_permissions`: the token's grants do not cover this request.
- `404`: `namespace.not_found`: the namespace does not exist.
- `500`: `core.internal_error`: an unexpected failure. Details are only logged on the server.
- `503`: `auth.verification_unavailable`: token verification keys are temporarily unavailable. Retry the request.

## Changes

- **2026-10-31** `aa8d1a8a5d14`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/rivet-dev/apis/rivet-api-public/changes/pools/get.md)

---

[API](https://skmtc.dev/rivet-dev/apis/rivet-api-public.md) - [All operations](https://skmtc.dev/rivet-dev/apis/rivet-api-public/llms.txt) - [OpenAPI document](https://skmtc.dev/rivet-dev/apis/rivet-api-public/revisions/531e21275aec?raw)
