RIrivet-dev
pools

Lists a page of the pool's live nodes in node key order. A node is listed while its heartbeat is recent enough for it to receive actors.

Changed on
get/pools/{pool}/nodes

Request

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

Path parameters

poolstring required

Name of the node pool. A DNS label of 1 to 63 lowercase letters, digits and hyphens.

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

Opaque cursor from the previous response's pagination.cursor.

Response

A page of live nodes.

Example response

{
  "nodes": [
    {
      "key": "node-1",
      "datacenter": "default",
      "version": 3
    }
  ]
}

Changes