Sign in

v1

latestOpenAPI 3.0.02026-07-17493090.2 KB
Splinter Registry

List nodes in the registry

This endpoint can be used to view all or some of the nodes in the registry. If metadata filters are provided via the "filter" query parameter, only nodes that match the given filters will be returned. See the Splinter registry documentation for details on metadata filters.

This endpoint requires the permission "registry.read".

get/registry/nodes

Query parameters

offsetinteger

paging offset

limitinteger

maximum number of items to return (max 100)

filterstring

url-encodeded stringified JSON containing property filters on the node's metadata properties in the format {METADATA_PROPERTY:[{"operator":OPERATOR,"value":VALUE}]}

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

The list of nodes was successfully retrieved

Example response

{
  "data": [
    {
      "identity": "node-123123-asdf",
      "endpoints": [
        "tcps://12.0.0.123:8431"
      ],
      "display_name": "Cargill - Node 1",
      "keys": [
        "03e0e5086beffc640ec0d149d4f1197fdde0f338afac774541831281c6fd91cbe0"
      ],
      "metadata": {
        "company": "Cargill",
        "status": "Up"
      }
    }
  ],
  "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"
  }
}