Skip to content
Yagra

apply_reclassify

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

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

The changes to make.

object
items
required

At most 5,000. A node named twice counts once, and its last entry is the one used.

Array<object>

One change to make, echoing what the screen showed.

object
from_profile_id

The profile the screen showed the node on; null ⇒ it had none. The change is skipped if the node has moved since.

string | null format: uuid
node_id
required
string format: uuid
to_profile_id
required

The profile the screen proposed. The change is skipped if the rules no longer choose it.

string format: uuid
Examplegenerated
{
  "items": [
    {
      "from_profile_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "node_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "to_profile_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

How many nodes moved and why the rest did not

Media typeapplication/json

What an apply did. The four counts add up to the number of distinct nodes named.

object
applied
required

Nodes moved to the profile the rules choose.

integer
skipped_changed
required

Nodes no longer on the profile the screen showed, or for which the rules no longer choose the profile the screen proposed.

integer
skipped_hidden
required

Nodes the caller may not see, that are not device nodes, or that do not exist.

integer
skipped_locked
required

Nodes someone locked.

integer
Examplegenerated
{
  "applied": 1,
  "skipped_changed": 1,
  "skipped_hidden": 1,
  "skipped_locked": 1
}

400

Section titled “400”

More than 5,000 items

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

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