v1
latestOpenAPI 3.0.02026-07-17493090.2 KBFetches a list of circuits that the node belongs to
This endpoint can be used to view all or some of the circuits that the node is a member of. If a node ID is provided via the "filter" query parameter, only circuits that have the given node ID as a member will be returned. If a circuit status is provided via the "status" query parameter, only circuits that have the given circuit status will be returned; if no filter is provided, all of the node's Active circuits will be returned.
This endpoint requires the permission "circuit.read".
Query parameters
paging offset
maximum number of items to return (max 100)
Node ID that must be present in the returned circuits
Circuit status of the returned circuits
Headers
The client's authorization, which the server resolves to an identity. Currently supports Biome JWT (if Biome credentials is enabled), Cylinder JWT, and OAuth2 bearer tokens.
The protocol version which the client can understand. If not provided, the node will respond using its latest protocol version.
Response
Successfully retrieved the list of circuits
Example response
{
"data": [
{
"id": "01234-ABCDE",
"members": [
{
"node_id": "alpha-node-000",
"endpoints": [
"tcps://12.0.0.123:8431"
],
"public_key": "026c889058c2d22558ead2c61b321634b74e705c42f890e6b7bc2c80abb4713118"
}
],
"roster": [
{
"service_id": "abcd",
"service_type": "scabbard",
"node_id": "alpha-node-000"
}
],
"management_type": "gameroom"
}
],
"paging": {
"current": "/registry/nodes?offset=10&limit=10",
"offset": 10,
"limit": 10,
"total": 50,
"first": "/registry/nodes?offset=0&limit=10",
"prev": "/registry/nodes?offset=0&limit=10",
"next": "/registry/nodes?offset=20&limit=10",
"last": "/registry/nodes?offset=40&limit=10"
}
}