v1

latestOpenAPI 3.0.02026-07-17493090.2 KB
Admin Service

Register the handler for a circuit management type

This endpoint requires the permission "circuit.read".

get/ws/admin/register/{type}

Path parameters

typestring required

The circuit management type is the type of circuit the handler will manage

Query parameters

lastinteger

A timestamp in milliseconds from the Unix Epoch, indicating the last received event.

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

Registration request was successfully submitted

status'OK' | 'ERROR'

Registration status

circuit_management_typestring

Circuit management type

error_reasonstring

Error message if the registration failed

Example response

{
  "circuit_management_type": "gameroom"
}