Skip to content
Yagra

The caller's pinned folders and nodes, narrowed to what the caller may see.

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

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The caller’s pinned folders and nodes, narrowed to what the caller may see

Media typeapplication/json

The caller’s pins, as the inventory tree draws them.

object
group_ids
required

Pinned folders the caller may see. The tree shows each one with everything beneath it.

Array<string>
nodes
required

Pinned nodes the caller may see, as full inventory rows. A pinned node usually sits in a folder the tree has not loaded, so its row cannot come from anywhere else.

Array<object>

One inventory row (mirrors the WebUI NodeSummary).

object
address
required

The node’s address. 0.0.0.0 (or ::) means the node has none — a Meraki device the Dashboard reports no LAN IP for, such as a mesh repeater (ADR-175). The column cannot be empty, so that is how “no address” is stored; it is not an address anything can reach.

string
group_id

The group this node belongs to (for the inventory tree); null ⇒ ungrouped.

string | null format: uuid
id
required

Stable identifier for a monitored node.

A UUID, not a name or address — both of which can change over a node’s life.

string format: uuid
kind
required

What this node is, and therefore how it is polled — the value that distinguishes a URL or DNS monitor from an ordinary ICMP/SNMP device in the inventory.

Resolved by NodeKind::resolve, the same function GET /nodes/{id} and the scheduler ask, so a list row can never disagree with the detail page it opens.

string
Allowed values: wireless_ap meraki url dns device
meraki_product_type

A Meraki node’s product type as the Dashboard names it — wireless (an MR access point), switch, appliance, … — and absent on every other node. What the list’s “AP” badge is read from (ADR-168 decision 11): an MR stays kind: meraki, so the kind alone cannot say it is an access point. The detail page reads the same value from meraki_device.product_type.

string | null
meraki_repeater

true on a Meraki access point that is a mesh repeater: it has no wired uplink, so the Dashboard reports no LAN IP for it and its address is 0.0.0.0 (ADR-175). Absent otherwise. What the list’s “Repeater” badge is read from.

boolean
model
string | null
name
required
string
pool

The node’s own poll-pool; null ⇒ inherited from its folder, else the default pool. The tree’s pool picker edits exactly this value, so it is what marks the active choice — the effective pool (and the poller holding the node) comes from /nodes/:id/assignment.

string | null
sort_order
required

Manual order within the group (the tree sorts members by this, then by name).

number format: double
state
required

The current state of a monitored node or check.

string
Allowed values: ok warning critical unknown unreachable maintenance
vendor

Descriptive maker/model for the “name (addr) (vendor) (model)” display.

string | null
Example
{
  "nodes": [
    {
      "kind": "wireless_ap",
      "state": "ok"
    }
  ]
}

401

Section titled “401”

No valid bearer token — pins are keyed by account, so this stays closed in public-dashboard 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"
  }
}

403

Section titled “403”

An API token names no person, so it has no pins

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”

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