pools

Creates or replaces a node pool's configuration. Omitted fields take their defaults. Nodes pick up the new configuration on their next connection.

put/pools/{pool}

Request

poolstring required

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

namespacestring

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

drain_on_version_upgradeboolean

Drain nodes running an older version when a newer version connects.

actor_eviction_delayinteger

Seconds to wait before evicting actors from a draining node.

actor_eviction_periodinteger

Seconds over which actors are evicted from a draining node.

actor_eviction_ratenumber double

Rate at which actors are evicted from a draining node. Must be finite and greater than 0.

metadataunknown

The stored node pool.

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