Skip to content

Get connected peers

GET
/api/v1/network/peers
curl --request GET \
--url http://localhost:8080/api/v1/network/peers \
--header 'X-Signature: <X-Signature>'

Get list of connected peers in the mesh network

Peer list retrieved successfully

Media typeapplication/json
object
success
boolean
count

Number of connected peers

integer
peers
Array<object>
object
peerId

Peer ID

string
addresses

Network addresses

Array<string>
connected

Connection status

boolean
lastSeen

Last seen timestamp

string format: date-time
chunkCount

Number of chunks stored on peer

integer
Example
{
"success": true,
"count": 5,
"peers": [
{
"peerId": "QmPeer1...",
"addresses": [
"/ip4/192.168.1.1/tcp/9000"
],
"connected": true,
"lastSeen": "2025-12-10T11:00:00Z"
}
]
}

Internal Server Error

Media typeapplication/json
object
error

Error type

string
message

Human-readable error description

string
code

Optional error code

string
Example
{
"error": "Internal server error",
"message": "An unexpected error occurred"
}