Move many nodes to one poll-pool, or clear them all back to inherited (ADR-124 Inc.10).

POST

/api/v1/nodes/pool

curl --request POST \
  --url https://example.com/api/v1/nodes/pool \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "node_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "pool": "example" }'

Re-homing a site onto different pollers is the case the two existing writers cannot serve: the folder-wide PUT /node-groups/{id}/pool only reaches nodes that share a folder, and the per-node PUT /nodes/{node_id}/pool meant one request each.

⚠️ Scoped via Scoped, not Admin alone — the shape POST /nodes/move chose deliberately (ADR-124 decision 8). The single-node writer is NodeScoped too since ADR-158 A8. manage_config is held by Operator, an Operator can be group-scoped, and the pool decides which poller reaches a device, so an unscoped bulk write would let one site’s operator strand another’s inventory on a poller that cannot see it.

Authorizations

• bearer

Request Body^required

Media typeapplication/json

Move MANY nodes to one poll-pool at once.

object

node_ids

required

Array<string>

pool

Absent or "" clears every named node back to inherited, exactly as the single-node form reads it. There is no “leave unchanged” case: the whole request is about this one field.

string | null

Example^generated

{
  "node_ids": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "pool": "example"
}

Responses

200

How many of the named nodes were moved to the pool

Media typeapplication/json

What a bulk pool change actually did.

object

applied

required

Rows actually written. Lower than requested is normal: an id can name a node that has since been deleted, or one outside the caller’s scope. The two are not distinguished.

integer format: int64

requested

required

Distinct ids the request named, after de-duplication.

integer

Example^generated

{
  "applied": 1,
  "requested": 1
}

400

Illegal pool name, or more ids than one request may carry

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

401

No valid bearer token

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Role lacks ManageConfig

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

503

This deployment has no write side (skeleton mode)

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}