コンテンツにスキップ
Yagra

move_nodes_by_prefix

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

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Apply what POST /api/v1/nodes/move-preview proposed and the operator accepted: every destination at once, in one transaction (ADR-172 decision 2).

object
moves
required
Array<object>

One destination of an IP-range move: a folder, and the nodes the preview proposed for it.

object
group_id
required
string format: uuid
node_ids
required
Array<string>
Examplegenerated
{
  "moves": [
    {
      "group_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "node_ids": [
        "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
      ]
    }
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

Every destination was written, in one transaction; the counts say how many of each moved

Media typeapplication/json

What an IP-range move did, one entry per destination in the order given.

object
results
required
Array<object>

What one destination of an IP-range move did.

object
group_id
required
string format: uuid
moved
required

Rows that moved. Lower than requested for a node deleted since the preview or outside the caller’s scope — the same meaning as in BulkMoveResult.

integer format: int64
requested
required

Distinct ids named for this folder.

integer
Examplegenerated
{
  "results": [
    {
      "group_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "moved": 1,
      "requested": 1
    }
  ]
}

400

Section titled “400”

An unknown destination folder, a folder named twice (duplicate_destination), a node named for two folders, or more ids in total than one request may carry. Nothing moved

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
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

401

Section titled “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
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Section titled “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
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

Section titled “404”

A destination folder is not one this caller may act on. Nothing moved

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
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

503

Section titled “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
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}