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.

Changed on
get/pools

Request

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

Query parameters

namespacestring

Name of the namespace to operate in. Defaults to default.

limitinteger

Maximum number of results to return, from 1 to 100. Defaults to 100.

cursorstring

Name of the last pool on the previous page. Pass the pagination.cursor value from the previous response.

Response

A page of node pools.

Example response

{
  "pools": [
    {
      "name": "default"
    }
  ]
}

Changes