Import selected devices as nodes, atomically.

POST

/api/v1/meraki/import

curl --request POST \
  --url https://example.com/api/v1/meraki/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "devices": [ { "lan_ip": "example", "model": "example", "name": "example", "network_id": "example", "network_name": "example", "product_type": "example", "serial": "example" } ], "monitored_network_ids": [ "example" ], "org_uuid": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Already-imported serials are skipped rather than rejected, so re-running the wizard after a partial selection does the obvious thing instead of erroring on the ones already there.

Authorizations

• bearer

Request Body^required

Media typeapplication/json

object

devices

required

Array<object>

object

lan_ip

string | null

model

string | null

name

string

network_id

required

string

network_name

string | null

product_type

required

string

serial

required

string

monitored_network_ids

Array<string>

org_uuid

required

string format: uuid

Example^generated

{
  "devices": [
    {
      "lan_ip": "example",
      "model": "example",
      "name": "example",
      "network_id": "example",
      "network_name": "example",
      "product_type": "example",
      "serial": "example"
    }
  ],
  "monitored_network_ids": [
    "example"
  ],
  "org_uuid": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

201

How many devices became nodes; already-imported serials are skipped

Media typeapplication/json

How many devices an import created.

object

imported

required

integer format: int32

Example^generated

{
  "imported": 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"
  }
}

404

No such organization

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

Inventory storage is unavailable (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"
  }
}