Skip to main content

Node API

This is a reference page for the Actyx Node API.

The Node HTTP API is designed to provide node-specific information.

The Node API is reachable at the following base URI: http://localhost:4454/api/v2/node.

Request Node ID

You can request the ID of the node backing the Events API.

Request

  • Endpoint: http://localhost:4454/api/v2/node/id
  • HTTP method: GET
    • HTTP headers:
    • (optional) Accept, must be text/plain, default: text/plain

There is no request body.

Response

  • HTTP headers:
    • Content-Type is text/plain

The response body will contain the node ID in plain text:

See the following example using cURL:

Example node ID request
curl -s http://localhost:4454/api/v2/node/id
Example node ID response
1g1UOqdpvBB1KHsGWGZiK3Vi8MYGDZZ1oylpOajUk.s

Request Node Information

You can request some additional information of the Actyx node. This API will likely be extended with additional properties in the future. Note that this API call requires a valid auth token.

Request

  • Endpoint: http://localhost:4454/api/v2/node/info
  • HTTP method: GET
    • HTTP headers:
    • Authorization
    • (optional) Accept, must be application/json, default: application/json

There is no request body.

Response

  • HTTP headers:
    • Content-Type is application/json

The response body will contain the number of connected nodes, the node's version, and uptime.

{
"connectedNodes": 42,
"uptime": {
"secs": 39,
"nanos": 900657761
},
"version": "2.31-75493e4637bff572d9a05ac0946f95c3d275b511-linux-x86_64-release"
}

See the following example using cURL:

Example node info request
curl \
-s \
-H "Authorization: Bearer $AUTH_TOKEN" \
-H "Content-Type: application/json" \
http://localhost:4454/api/v2/node/info
Example node info response
{
"connectedNodes": 42,
"uptime": {
"secs": 39,
"nanos": 900657761
},
"version": "2.31-75493e4637bff572d9a05ac0946f95c3d275b511-linux-x86_64-release"
}