---
title: "GET /peers"
method: GET
path: "/peers"
tags: ["system"]
---

# GET /peers

`GET /peers`

List discovered peer snapshots (topology view). Wrapped in the canonical
`{ data, ts }` envelope (ADR-008 §0.2); the previous bare top-level array
is retired.

## Response `200`

Peer snapshot list

- PeerSnapshotListEnvelope — Canonical success envelope: `{ "data": T, "ts": <unix millis i64> }`. `ts` is `chrono::Utc::now().timestamp_millis()`, set in the webserver handler via [`ApiEnvelope::now`] (the contract carries only the type + the clock helper, not a hard dependency on when the handler reads the clock). `rename_all = "camelCase"` is a no-op for the single-word fields here but is declared for forward-compat. IMPORTANT (utoipa v4): every concrete `ApiEnvelope<X>` that needs a named OpenAPI component is declared in the `#[aliases(...)]` block below. Add a new alias line whenever a new payload type needs enveloping. NEVER register the bare `ApiEnvelope` in `components(schemas(...))` — utoipa errors on a bare generic, and an un-aliased generic inlines an anonymous schema.
  - `data` PeerSnapshotDto[], required
    - `addresses` string[], required
    - `channel` string, required — Phase 96 INDIC-01:连接通道 4 态 wire 字符串。 取值严格限定 `"direct" | "relay" | "offline" | "unknown"`, 由 application 层 `connection_channel_to_wire` 单点产出, 前端按字符串模式匹配渲染徽章。**禁止**新增枚举值或缩写; "Out of LAN" 灰态由前端基于 `channel + LAN-only setting` 合成,不在 wire 协议里。
    - `connected` boolean, required
    - `connectionAddress` string, nullable — 当前活跃连接地址。直连时为对端 IP:port,中转时为 relay 地址。
    - `deviceName` string, nullable
    - `isPaired` boolean, required
    - `pairingState` string, required
    - `peerId` string, required
  - `ts` integer, required — Server time when the response was built (unix epoch milliseconds).

## Other responses

- `500` — Internal server error

---

[API](https://skmtc.net/uniclipboard/apis/uniclipboard-daemon-api.md) · [All operations](https://skmtc.net/uniclipboard/apis/uniclipboard-daemon-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/uniclipboard/uniclipboard-daemon-api/versions/a5d29889448a/schema)
