v1
latestOpenAPI 3.0.02026-07-17493090.2 KBSplinter Registry
Add or replace a node in the registry
This endpoint can be used to add a new node to the registry, or replace an existing node. When replacing an existing node, the node identity cannot be changed. This action is idempotent.
This endpoint requires the permission "registry.write".
put/registry/nodes/{identity}
Path parameters
identitystring required
identity of node to add/replace
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
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 has been added or replaced