Skip to content
Yagra

list_meraki_orgs

GET
/api/v1/meraki/orgs
curl --request GET \
  --url https://example.com/api/v1/meraki/orgs \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Every onboarded organization; the credential reference is not included

Media typeapplication/json
Array<object>
object
availability_secs
required
integer format: int32
base_url
required
string
enabled
required
boolean
enabled_tiers
required
Array<string>
group_id
string | null format: uuid
id
required
string format: uuid
inventory_secs
required
integer format: int32
name
required
string
org_id
required
string
target_rps
required
number format: double
traffic_secs
required
integer format: int32
uplink_secs
required
integer format: int32
Examplegenerated
[
  {
    "availability_secs": 1,
    "base_url": "example",
    "enabled": true,
    "enabled_tiers": [
      "example"
    ],
    "group_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "inventory_secs": 1,
    "name": "example",
    "org_id": "example",
    "target_rps": 1,
    "traffic_secs": 1,
    "uplink_secs": 1
  }
]

401

Section titled “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
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Section titled “403”

Role lacks View

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
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}

503

Section titled “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
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example"
  }
}