Get information about the deployed committee

GET 
/v1/chains/:chainID/committee

Get information about the deployed committee

Request

Path Parameters

chainID stringrequired

ChainID (Bech32)

Query Parameters

block string

Block index or trie root

Responses

200

A list of all nodes tied to the chain

application/json

Schema

Schema

accessNodes CommitteeNode[]required
A list of all access nodes and their peering info.
Array [
accessAPI stringrequired
node PeeringNodeStatusResponserequired
isAlive booleanrequired
Whether or not the peer is activated
isTrusted booleanrequired
name stringrequired
numUsers int32required
The amount of users attached to the peer
peeringURL stringrequired
The peering URL of the peer
publicKey stringrequired
The peers public key encoded in Hex
]
active booleanrequired

Whether or not the chain is active.

candidateNodes CommitteeNode[]required
A list of all candidate nodes and their peering info.
Array [
accessAPI stringrequired
node PeeringNodeStatusResponserequired
isAlive booleanrequired
Whether or not the peer is activated
isTrusted booleanrequired
name stringrequired
numUsers int32required
The amount of users attached to the peer
peeringURL stringrequired
The peering URL of the peer
publicKey stringrequired
The peers public key encoded in Hex
]
chainId stringrequired

ChainID (Bech32-encoded).

committeeNodes CommitteeNode[]required
A list of all committee nodes and their peering info.
Array [
accessAPI stringrequired
node PeeringNodeStatusResponserequired
isAlive booleanrequired
Whether or not the peer is activated
isTrusted booleanrequired
name stringrequired
numUsers int32required
The amount of users attached to the peer
peeringURL stringrequired
The peering URL of the peer
publicKey stringrequired
The peers public key encoded in Hex
]
stateAddress stringrequired

Example (from schema)

{
  "candidateNodes": [
    {
      "node": {
        "isAlive": true,
        "peeringURL": "peeringURL",
        "name": "name",
        "publicKey": "publicKey",
        "numUsers": 0,
        "isTrusted": true
      },
      "accessAPI": "accessAPI"
    },
    {
      "node": {
        "isAlive": true,
        "peeringURL": "peeringURL",
        "name": "name",
        "publicKey": "publicKey",
        "numUsers": 0,
        "isTrusted": true
      },
      "accessAPI": "accessAPI"
    }
  ],
  "committeeNodes": [
    {
      "node": {
        "isAlive": true,
        "peeringURL": "localhost:4000",
        "name": "name",
        "publicKey": 0,
        "numUsers": 1,
        "isTrusted": true
      },
      "accessAPI": "accessAPI"
    },
    {
      "node": {
        "isAlive": true,
        "peeringURL": "localhost:4000",
        "name": "name",
        "publicKey": 0,
        "numUsers": 1,
        "isTrusted": true
      },
      "accessAPI": "accessAPI"
    }
  ],
  "chainId": "tst1pqm5ckama06xhkl080mmvz6l3xy8c8lulrwy7mx4ll0fc69krxfgka70j0e",
  "accessNodes": [
    {
      "node": {
        "isAlive": true,
        "peeringURL": "peeringURL",
        "name": "name",
        "publicKey": "publicKey",
        "numUsers": 0,
        "isTrusted": true
      },
      "accessAPI": "accessAPI"
    },
    {
      "node": {
        "isAlive": true,
        "peeringURL": "peeringURL",
        "name": "name",
        "publicKey": "publicKey",
        "numUsers": 0,
        "isTrusted": true
      },
      "accessAPI": "accessAPI"
    }
  ],
  "stateAddress": 1.1560770162548097e+77,
  "active": true
}

401

Unauthorized (Wrong permissions, missing token)

application/json

Schema

Schema

error stringrequired
missingPermission stringrequired

Example (from schema)

{
  "error": "string",
  "missingPermission": "string"
}

Loading...