CAcargill
Circuits

Fetches a list of circuits that the node belongs to

Changed on

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".

get/admin/circuits

Request

  • Base URL
    http://localhost:9000/api
  • URL
    http://localhost:9000/api/admin/circuits
  • Auth
    none declared. Required headers: Authorization

Query parameters

offsetinteger

paging offset

limitinteger

maximum number of items to return (max 100)

filterstring

Node ID that must be present in the returned circuits

statusstring

Circuit status of the returned circuits

Headers

Authorizationstring required

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.

SplinterProtocolVersioninteger
Example:2

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"
  }
}

Changes

  • f5e618c6f5dfRevision changes
    • breaking

      the /// response's property type changed from string to object for status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

  • 356e924593ecRevision changes
    • info

      added the new optional query request parameter status

    • info

      added the optional property // to the response with the status