🛠ī¸ThunderEngine API

Retrieve all nodes

get

Returns a list of all nodes including their details and builds.

Authorizations
Responses
200
A list of nodes
application/json
get
GET //api/nodes HTTP/1.1
Host: cloud-api.thunderstack.org
Authorization: Bearer JWT
Accept: */*

{
  "nodes": [
    {
      "builds": [
        {
          "action": "text",
          "buildComplete": true,
          "buildNumber": 1,
          "buildStatus": "SUCCESS",
          "currentPhase": "text",
          "id": "text",
          "timestamp": "text"
        }
      ],
      "initialized": true,
      "invoke_url": "text",
      "name": "text",
      "nodeId": "text",
      "port": 1,
      "protocol": "text",
      "peerDNS": "text",
      "peerPort": 1,
      "network": "regtest",
      "status": "STARTING",
      "settings": {
        "webhookUrl": "text"
      }
    }
  ]
}

Create a new node

post

This endpoint allows you to create a new node.

Authorizations
Body
namestringRequired

Name of the node.

networkstring ¡ enumRequiredPossible values:
Responses
200
Node created successfully
application/json
post
POST //api/nodes HTTP/1.1
Host: cloud-api.thunderstack.org
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "name": "text",
  "network": "regtest",
  "settings": {
    "webhookUrl": "text"
  }
}
{
  "data": {
    "builds": [
      {
        "action": "text",
        "buildComplete": true,
        "buildNumber": 1,
        "buildStatus": "SUCCESS",
        "currentPhase": "text",
        "id": "text",
        "timestamp": "text"
      }
    ],
    "initialized": true,
    "invoke_url": "text",
    "name": "text",
    "nodeId": "text",
    "port": 1,
    "protocol": "text",
    "peerDNS": "text",
    "peerPort": 1,
    "network": "regtest",
    "status": "STARTING",
    "settings": {
      "webhookUrl": "text"
    }
  },
  "message": "text"
}

Destroy a node

delete

This endpoint destroys a node by its identifier.

Authorizations
Body
destroyNodeIdstringRequired

Unique identifier of the node to be destroyed.

Responses
200
Node destroyed successfully
application/json
delete
DELETE //api/nodes HTTP/1.1
Host: cloud-api.thunderstack.org
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "destroyNodeId": "text"
}
{
  "message": "text"
}

Retrieve a specific node

get

Returns details of a specific node by node ID.

Authorizations
Path parameters
idstringRequired

The unique identifier of the node.

Responses
200
Details of the node
application/json
get
GET //api/nodes/{id} HTTP/1.1
Host: cloud-api.thunderstack.org
Authorization: Bearer JWT
Accept: */*

{
  "builds": [
    {
      "action": "text",
      "buildComplete": true,
      "buildNumber": 1,
      "buildStatus": "SUCCESS",
      "currentPhase": "text",
      "id": "text",
      "timestamp": "text"
    }
  ],
  "initialized": true,
  "invoke_url": "text",
  "name": "text",
  "nodeId": "text",
  "port": 1,
  "protocol": "text",
  "peerDNS": "text",
  "peerPort": 1,
  "network": "regtest",
  "status": "STARTING",
  "settings": {
    "webhookUrl": "text"
  }
}

Get the ThunderStack public key for webhook verification

get

Returns public key for webhook verification.

Authorizations
Responses
200
success response
application/json
get
GET //api/webhook-public-key HTTP/1.1
Host: cloud-api.thunderstack.org
Authorization: Bearer JWT
Accept: */*

{
  "data": "text"
}

Get latest RLN image version

get

Returns a latest RLN image version.

Authorizations
Responses
200
A list of nodes
application/json
get
GET //api/nodes/latest-rln-image HTTP/1.1
Host: cloud-api.thunderstack.org
Authorization: Bearer JWT
Accept: */*

{
  "data": "text"
}

Upgrade a node to latest RLN image

post

This endpoint allows you to upgrade a node.

Authorizations
Path parameters
idstringRequired

The unique identifier of the node.

Responses
200
Node upgraded successfully
application/json
post
POST //api/nodes/{id}/upgrade HTTP/1.1
Host: cloud-api.thunderstack.org
Authorization: Bearer JWT
Accept: */*

{
  "message": "text"
}

Update node settings

post

This endpoint allows you to Update node settings.

Authorizations
Path parameters
Responses
200
Node Updated successfully
application/json
post
POST //api/nodes/{id}/settings HTTP/1.1
Host: cloud-api.thunderstack.org
Authorization: Bearer JWT
Accept: */*

{
  "message": "text"
}

Start a Node

post

Start a Node

Authorizations
Path parameters
idstringRequired

The unique identifier of the node.

Responses
200
Start a Node initiated successfully.
application/json
Responseobject
post
POST //api/nodes/{id}/start HTTP/1.1
Host: cloud-api.thunderstack.org
Authorization: Bearer JWT
Accept: */*

{}

Stop a Node

post

Stop a Node

Authorizations
Path parameters
idstringRequired

The unique identifier of the node.

Responses
200
Stop a Node initiated successfully.
application/json
Responseobject
post
POST //api/nodes/{id}/stop HTTP/1.1
Host: cloud-api.thunderstack.org
Authorization: Bearer JWT
Accept: */*

{}

Trigger log export

post

Initiates an export of logs for a specified node.

Authorizations
Path parameters
idstringRequired

The unique identifier of the node.

Responses
200
Log export initiated successfully.
application/json
post
POST //api/nodes/{id}/logs HTTP/1.1
Host: cloud-api.thunderstack.org
Authorization: Bearer JWT
Accept: */*

{
  "taskId": "text"
}

Get log download URLs

get

Retrieves the download URLs for logs related to a specific task ID.

Authorizations
Path parameters
idstringRequired

The unique identifier of the node.

Query parameters
taskIdstringRequired

The task ID associated with the log export.

Responses
200
List of log download URLs retrieved successfully.
application/json
get
GET //api/nodes/{id}/logs HTTP/1.1
Host: cloud-api.thunderstack.org
Authorization: Bearer JWT
Accept: */*

{
  "data": [
    "text"
  ]
}

PreviousGeneralNextAccess Token Authorization

Last updated