CAcargill
Proposals

Fetches a circuit proposal by the circuit's ID

Changed on

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

This endpoint requires the permission "circuit.read".

get/admin/proposals/{circuit_id}

Request

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

Path parameters

circuit_idstring required

Circuit ID of the proposal 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 proposal

proposal_type'Create' | 'UpdateRoster' | 'AddNode' | 'RemoveNode' | 'Disband'
circuit_idstring
circuit_hashstring
requesterstring
requester_node_idstring

Example response

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

Changes

  • f5e618c6f5dfRevision changes
    • info

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

  • adf837f0e464Revision changes
    • warning

      added the new Disband enum value to the response property for the response status

    • info

      added the optional property / to the response with the status

    • info

      removed the Destroy enum value from the response property for the response status