v1

latestOpenAPI 3.0.02026-07-17493090.2 KB

Proposals

Fetches a list of pending circuit proposals for this node

This endpoint can be used to view all of the circuit proposals that the node is a proposed member of. If a circuit management type is provided via the "management_type" query parameter, only circuit proposals that have the given circuit management type will be returned. If a node ID is provided via the "member" query parameter, only circuit proposals that have the given node as a member will be returned. If no filter is provided, all of the node's circuit proposals will be returned.

This endpoint requires the permission "circuit.read".

get/admin/proposals

Query parameters

offsetinteger

paging offset

limitinteger

maximum number of items to return (max 100)

management_typestring

Only show proposed circuits matching the given circuit management type

memberstring

Only show proposed circuits that have a member with the given node ID

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 proposals

Example response

{
  "data": [
    {
      "circuit_id": "01234-ABCDE",
      "circuit_hash": "8ce518770b962429a953b10220905ac9adf86a855f0b085695f444edf991b8ca",
      "circuit": {
        "circuit_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"
      },
      "votes": [
        {
          "public_key": "026c889058c2d22558ead2c61b321634b74e705c42f890e6b7bc2c80abb4713118",
          "voter_node_id": "alpha-node-000"
        }
      ],
      "requester": "026c889058c2d22558ead2c61b321634b74e705c42f890e6b7bc2c80abb4713118",
      "requester_node_id": "alpha-node-000"
    }
  ],
  "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"
  }
}