network

Get registered nodes

Changed on

Returns the list of registered nodes

get/api/v1/network/registered-nodes

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/network/registered-nodes
  • Auth
    none declared

Query parameters

limitinteger

The maximum number of items to return

order'asc' | 'desc'

The order in which items are listed

registerednode.idstring

The ID of the registered node

type'BLOCK_NODE' | 'GENERAL_SERVICE' | 'MIRROR_NODE' | 'RPC_RELAY'

Registered node type.

Example:BLOCK_NODE

Response

OK

Example response

{
  "registered_nodes": [
    {
      "admin_key": {
        "_type": "ProtobufEncoded",
        "key": "421050820e1485acdd59726088e0e4a2130ebbbb70009f640ad95c78dd5a7b38"
      },
      "created_timestamp": "1586567700.453054001",
      "description": "alpha",
      "registered_node_id": 1,
      "service_endpoints": [
        {
          "ip_address_v4": "128.0.0.6",
          "port": 50216
        }
      ],
      "timestamp": {
        "from": "187654.000123457",
        "to": null
      }
    }
  ]
}

Changes

  • v1e66ce065c590Revision changes
    • info

      removed subschema #2 from the /// response property allOf list for the response status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

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

  • v1b3d1ffa9701eRevision changes
    • info

      endpoint added