CAcargill
Diagnostics

GET /status

Changed on

Used to check if server is successfully running

This endpoint requires the permission "status.read".

Request

  • Base URL
    http://localhost:9000/api
  • URL
    http://localhost:9000/api/status
  • 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.

Response

Server is running correctly and accepting connections

versionstring required

Rest API version

node_idstring

Node id

display_namestring

Human-readable name for the node

service_endpointstring

The node's service endpoint

network_endpointsstring[]

The node's locally-bound network endpoints

advertised_endpointsstring[]

The node's network endpoints that are publicly accessible

Example response

{
  "version": "0.7.1",
  "node_id": "node-009",
  "display_name": "Cargill Node 009",
  "service_endpoint": "tcp://foo.bar.biz",
  "network_endpoints": [
    "tcp://foo.bar.biz"
  ],
  "advertised_endpoints": [
    "tcp://foo.bar.biz"
  ]
}

Changes