import_discovered

POST

/api/v1/discovery/import

curl --request POST \
  --url https://example.com/api/v1/discovery/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "nodes": [ { "address": "example", "credential_id": "example", "model": "example", "name": "example", "profile_id": "example", "vendor": "example" } ] }'

Authorizations

• bearer

Request Body^required

Media typeapplication/json

Import body: the selected devices to create as nodes.

object

nodes

required

Array<object>

One discovered device the operator chose to add.

object

address

required

string

credential_id

string | null

model

string | null

name

required

string

profile_id

string | null

vendor

Maker/model pre-filled from discovery’s sysDescr classification (editable before import).

string | null

Example^generated

{
  "nodes": [
    {
      "address": "example",
      "credential_id": "example",
      "model": "example",
      "name": "example",
      "profile_id": "example",
      "vendor": "example"
    }
  ]
}

Responses

201

Nodes created, in one transaction

Media typeapplication/json

How many nodes an import created.

object

created

required

integer format: int32

Example^generated

{
  "created": 1
}

400

An unparseable address, an empty name, or a binding id that is not a UUID

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 below Admin

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

Skeleton mode has no write side

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