---
title: "List known peers"
method: GET
path: "/api/v1/admin/peers"
tags: ["Admin", "Peer"]
---

# List known peers

`GET /api/v1/admin/peers`

List all peers known in the system, and info about their connection.
This includes the endpoint, how we know about the peer, the connection state, and if the connection is alive the amount
of bytes we've sent to and received from the peer.

## Response `200`

Success

- PeerStats[]
  - `endpoint` Endpoint — Identification to connect to a peer
    - `proto` 'tcp' | 'quic' — Protocol used
    - `socketAddr` string — The socket address used
  - `type` 'static' | 'inbound' | 'linkLocalDiscovery' — How we know about this peer
  - `connectionState` 'alive' | 'connecting' | 'dead' — The current state of the connection to the peer
  - `txBytes` integer — The amount of bytes transmitted to this peer
  - `rxBytes` integer — The amount of bytes received from this peer

## Changes

- **2024-03-15** `812e8a8096a2` — 2 warning, 2 info
  - removed the optional property `items/connectionRxBytes` from the response with the `200` status
  - removed the optional property `items/connectionTxBytes` from the response with the `200` status
  - added the optional property `items/rxBytes` to the response with the `200` status
  - added the optional property `items/txBytes` to the response with the `200` status
- **2024-02-27** `6e5b531913cc` — 1 info
  - endpoint added
- **2023-10-26** `1c37c167d50d` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/threefoldtech/apis/mycelium-management/changes/api/v1/admin/peers/get.md)

---

[API](https://skmtc.dev/threefoldtech/apis/mycelium-management.md) · [All operations](https://skmtc.dev/threefoldtech/apis/mycelium-management/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/threefoldtech/mycelium-management/revisions/65042c1a7b84/schema)
