CAcargill
Circuits

Fetches a circuit by its ID

Changed on

This endpoint can be used to view a specific circuit that the node is a member of.

This endpoint requires the permission "circuit.read".

get/admin/circuits/{circuit_id}

Request

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

Path parameters

circuit_idstring required

ID of the circuit to fetch

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 requested circuit

idstring
management_typestring
display_namestring nullable

Human readable name for the circuit

circuit_status'Active' | 'Disbanded' | 'Abandoned' nullable

The status of the circuit

Example response

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

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 optional property to the response with the status