pools

Returns a node pool's configuration.

Changed on
get/pools/{pool}

Request

  • Base URL
    https://api.rivet.dev
  • URL
    https://api.rivet.dev/pools/{pool}
  • 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.

Response

The node pool.

Example response

{
  "pool": {
    "name": "default"
  }
}

Changes