Skip to content
Yagra

move_nodes

POST
/api/v1/nodes/move
curl --request POST \
  --url https://example.com/api/v1/nodes/move \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "after": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "before": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "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

Move many nodes into one folder (or null to ungroup them all), optionally placing them at a position inside it rather than at the end.

object
after

Place the nodes immediately after this sibling. See before.

string | null format: uuid
before

Place the nodes immediately before this sibling, keeping the order they were given in. At most one of before/after; both omitted appends to the end, which is what every caller did before ADR-124 Inc.8 and what an N-1 WebUI still sends.

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

Responses

Section titled “Responses”

200

Section titled “200”

How many of the named nodes moved

Media typeapplication/json

What a bulk move actually did.

object
moved
required

Rows that actually moved. 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
Examplegenerated
{
  "moved": 1,
  "requested": 1
}

400

Section titled “400”

Unknown destination folder, both before and after given, 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
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, or the caller cannot see ungrouped nodes

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”

The destination folder is not one this caller may act on

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"
  }
}