CAcargill
Splinter Registry

Add a node to the registry

This endpoint can be used to add a new node to the Splinter registry. The node must be valid (see the Splinter registry documentation for details on node validity).

This endpoint requires the permission "registry.write".

post/registry/nodes

Request

  • Base URL
    http://localhost:9000/api
  • URL
    http://localhost:9000/api/registry/nodes
  • Auth
    none declared. Required headers: Authorization

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.

Request body

identitystring
endpointsstring[]
display_namestring
keysstring[]
metadataobject

Example request

{
  "identity": "node-123123-asdf",
  "endpoints": [
    "tcps://12.0.0.123:8431"
  ],
  "display_name": "Cargill - Node 1",
  "keys": [
    "03e0e5086beffc640ec0d149d4f1197fdde0f338afac774541831281c6fd91cbe0"
  ],
  "metadata": {
    "company": "Cargill",
    "status": "Up"
  }
}

Response

The node was successfully added to the registry

Changes

No recorded changes to this operation across all 69 revisions of this API.