get_reclassify

GET

/api/v1/reclassify

curl --request GET \
  --url https://example.com/api/v1/reclassify \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearer

Responses

200

The device nodes whose profile differs from the one the classification rules choose, with counts of locked and not-yet-identified nodes

Media typeapplication/json

What Nodes ▸ Reclassify shows.

object

identified

required

Device nodes the rules were run for, whatever they chose. With proposals empty, 0 here means nothing has been compared yet — not that every node matches.

integer

locked

required

Locked nodes the rules would move. Counted and never listed: a person fixed their profile. A lock is cleared from the node’s edit dialog.

integer

proposals

required

Unlocked device nodes whose profile differs from the one the classification rules choose, ordered by node name. At most 5,000 — total says how many there are.

Array<object>

One node the rules would move.

object

current_profile_id

null ⇒ the node has no profile.

string | null format: uuid

current_profile_name

string | null

model

string | null

node_id

required

string format: uuid

node_name

required

string

rule

One of:

null

null

object

The rule that chose the profile; null ⇒ no rule matched and the device fell through to “Generic SNMP”.

object

id

required

string format: uuid

priority

required

integer format: int32

sysdescr_regex

string | null

sysobjectid_prefix

string | null

suggested_profile_id

required

string format: uuid

suggested_profile_name

string | null

sys_descr

string | null

sys_object_id

required

What the device last said it is — the input the rules ran on.

string

vendor

The vendor and model applying writes onto the node; null leaves the node’s own.

string | null

total

required

How many unlocked device nodes differ.

integer

unidentified

required

Device nodes the rules cannot be run for yet, because no sysObjectID is stored for them. The poller reads it on its hourly identity probe, so a new or just-upgraded deployment fills this in within the hour; a node that is not SNMP-polled never has one.

integer

Example^generated

{
  "identified": 1,
  "locked": 1,
  "proposals": [
    {
      "current_profile_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "current_profile_name": "example",
      "model": "example",
      "node_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "node_name": "example",
      "rule": {
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "priority": 1,
        "sysdescr_regex": "example",
        "sysobjectid_prefix": "example"
      },
      "suggested_profile_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "suggested_profile_name": "example",
      "sys_descr": "example",
      "sys_object_id": "example",
      "vendor": "example"
    }
  ],
  "total": 1,
  "unidentified": 1
}

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