apply_rediscovery

POST

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

curl --request POST \
  --url https://example.com/api/v1/nodes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/rediscover/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "model": { "from": "example", "to": "example" }, "profile": { "from": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "to": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }, "scan_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "vendor": { "from": "example", "to": "example" } }'

Authorizations

• bearer

Parameters

Path Parameters

node_id

required

string format: uuid

Node id

Request Body^required

Media typeapplication/json

The changes a person accepted. Name at least one.

object

model

One of:

null

null

object

One vendor or model change, echoing what the dialog showed.

object

from

The value the dialog showed as current; null ⇒ none.

string | null

to

required

string

profile

One of:

null

null

object

One profile change, echoing what the dialog showed.

object

from

The profile the dialog showed as current; null ⇒ none.

string | null format: uuid

to

required

string format: uuid

scan_id

required

The rediscovery the dialog showed.

string format: uuid

vendor

One of:

null

null

object

One vendor or model change, echoing what the dialog showed.

object

from

The value the dialog showed as current; null ⇒ none.

string | null

to

required

string

Example^generated

{
  "model": {
    "from": "example",
    "to": "example"
  },
  "profile": {
    "from": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "to": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  },
  "scan_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "vendor": {
    "from": "example",
    "to": "example"
  }
}

Responses

200

The accepted changes were written, with the device’s sysObjectID and sysDescr

Media typeapplication/json

What an Apply wrote.

object

applied

required

Array<string>

Allowed values: profile vendor model

Example

{
  "applied": [
    "profile"
  ]
}

400

nothing_to_apply: the body names no field

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

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

409

Nothing was written. not_answered: the device has not answered SNMP. profile_locked: a person locked the profile. node_changed: the node no longer holds what the dialog showed. judgement_changed: the rules no longer derive what the dialog showed

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