Skip to content

peer/list

Experimental

Lists the viewing session’s live local peers from the registry
snapshot, minus the viewer, ordered by session id — one row per
live entry with its authority-joined name, label, status, age,
and eligibility.

Type: PeerListParams

peer/list params: the viewing session, excluded from its own rows. Unknown fields are invalidParams.

Field Type Stability Presence Description
sessionId string Experimental required The viewing session (required; need not be loaded — reads never take the lease).
Source

schema/msp/experimental/msp.schema.json#/methods/peer~2Flist

{
"description": "Lists the viewing session's live local peers from the registry \\\n snapshot, minus the viewer, ordered by session id — one row per \\\n live entry with its authority-joined name, label, status, age, \\\n and eligibility.",
"params": {
"$ref": "#/$defs/PeerListParams"
},
"result": {
"$ref": "#/$defs/PeerListResult"
},
"x-msp-descriptor": "peer/list",
"x-msp-stability": "experimental"
}