get_rediscovery

GET

/api/v1/nodes/{node_id}/rediscover/{scan_id}

curl --request GET \
  --url https://example.com/api/v1/nodes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/rediscover/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearer

Parameters

Path Parameters

node_id

required

string format: uuid

Node id

scan_id

required

string format: uuid

The id POST …/rediscover returned

Responses

200

Where the re-read is, and — once the device answered — the node beside what it now says

Media typeapplication/json

What Nodes ▸ Rediscover shows.

object

comparison

One of:

null

null

object

Present exactly when state is answered.

object

model

required

A vendor or model row. found is null when nothing could be derived — Apply never blanks the node’s value.

object

current

string | null

found

string | null

verdict

required

How one row of the comparison reads.

string

Allowed values: same differs undetermined locked

profile

required

The profile row. found_id is chosen by the classification rules from the device’s sysObjectID; with no sysObjectID no profile is proposed (undetermined).

object

current_id

string | null format: uuid

current_name

string | null

found_id

string | null format: uuid

found_name

string | null

rule_id

The rule that chose found_id; null ⇒ the device fell through to “Generic SNMP”, or no profile was suggested at all (the device gave no sysObjectID).

string | null format: uuid

verdict

required

How one row of the comparison reads.

string

Allowed values: same differs undetermined locked

profile_locked

required

A person fixed this node’s profile (ADR-140); the profile row reads locked when it differs.

boolean

sys_descr

string | null

sys_name

string | null

sys_object_id

What the device reported. Apply stores the first two with the accepted changes.

string | null

vendor

required

A vendor or model row. found is null when nothing could be derived — Apply never blanks the node’s value.

object

current

string | null

found

string | null

verdict

required

How one row of the comparison reads.

string

Allowed values: same differs undetermined locked

scan_id

required

string format: uuid

state

required

waiting and reading say nothing about the device yet — never “nothing changed”.

string

Allowed values: waiting reading answered no_snmp_answer no_answer stopped

Example

{
  "comparison": {
    "model": {
      "verdict": "same"
    },
    "profile": {
      "verdict": "same"
    },
    "vendor": {
      "verdict": "same"
    }
  },
  "state": "waiting"
}

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

404

No such device node the caller can see, or (scan_not_found) no such rediscovery of this node on this core

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