List the organizations an API key can access, so the operator can multi-select which to monitor. Read-only upstream (`GET /organizations`) and persists nothing.

POST

/api/v1/meraki/orgs/discover

curl --request POST \
  --url https://example.com/api/v1/meraki/orgs/discover \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "api_key": "example", "base_url": "example", "credential_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Authorizations

• bearer

Request Body^required

Media typeapplication/json

object

api_key

A key typed by the operator. Send this or credential_id, never both.

string | null

base_url

string | null

credential_id

A meraki_api credential already stored here, used instead of typing the key again.

string | null format: uuid

Example^generated

{
  "api_key": "example",
  "base_url": "example",
  "credential_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

200

The organizations the key can access, each marked already_added when it is monitored here already

Media typeapplication/json

Array<object>

object

already_added

required

This organization is already monitored here, under this key or another one. It cannot be added a second time: POST /meraki/orgs skips it.

boolean

id

required

string

name

required

string

Example^generated

[
  {
    "already_added": true,
    "id": "example",
    "name": "example"
  }
]

400

No key was named (invalid_api_key), both api_key and credential_id were sent (invalid_request), credential_id is not a stored Meraki API key (invalid_credential), or base_url is not an https allow-listed Meraki host

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, or the account is restricted to folders (scope_unsupported)

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

502

The Dashboard API call failed; the detail is logged, never returned

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