🛠️ThunderEngine API

Retrieve all nodes

get

https://cloud-api.thunderstack.orghttps://cloud-api.test.thunderstack.org

/api/nodes

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

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

A list of nodes

application/json

500

Internall server error

get

/api/nodes

HTTPcURLJavaScriptPython

GET /api/nodes HTTP/1.1
Host: cloud-api.thunderstack.org/
Authorization: Bearer YOUR_SECRET_TOKEN
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

https://cloud-api.thunderstack.orghttps://cloud-api.test.thunderstack.org

/api/nodes

This endpoint allows you to create a new node.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestringRequired

Name of the node.

networkstring · enumRequiredPossible values:

Responses

200

Node created successfully

application/json

messagestringOptional

A message describing the outcome of the action.

400

Validation error

500

Internall server error

post

/api/nodes

HTTPcURLJavaScriptPython

POST /api/nodes HTTP/1.1
Host: cloud-api.thunderstack.org/
Authorization: Bearer YOUR_SECRET_TOKEN
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

https://cloud-api.thunderstack.orghttps://cloud-api.test.thunderstack.org

/api/nodes

This endpoint destroys a node by its identifier.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

destroyNodeIdstringRequired

Unique identifier of the node to be destroyed.

Responses

200

Node destroyed successfully

application/json

messagestringOptional

Confirmation message indicating the node was destroyed.

400

Validation error or node not found

delete

/api/nodes

HTTPcURLJavaScriptPython

DELETE /api/nodes HTTP/1.1
Host: cloud-api.thunderstack.org/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "destroyNodeId": "text"
}

{
  "message": "text"
}

Retrieve a specific node

get

https://cloud-api.thunderstack.orghttps://cloud-api.test.thunderstack.org

/api/nodes/{id}

Returns details of a specific node by node ID.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique identifier of the node.

Responses

200

Details of the node

application/json

initializedbooleanOptional

invoke_urlstringOptional

namestringOptional

nodeIdstringOptional

portintegerOptional

protocolstringOptional

peerDNSstringOptional

peerPortintegerOptional

networkstring · enumOptionalPossible values:

statusstring · enumOptionalPossible values:

400

Invalid node ID supplied

404

Node not found

get

/api/nodes/{id}

HTTPcURLJavaScriptPython

GET /api/nodes/{id} HTTP/1.1
Host: cloud-api.thunderstack.org/
Authorization: Bearer YOUR_SECRET_TOKEN
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

https://cloud-api.thunderstack.orghttps://cloud-api.test.thunderstack.org

/api/webhook-public-key

Returns public key for webhook verification.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

success response

application/json

datastringOptional

public key.

500

Internall server error

get

/api/webhook-public-key

HTTPcURLJavaScriptPython

GET /api/webhook-public-key HTTP/1.1
Host: cloud-api.thunderstack.org/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": "text"
}

Get latest RLN image version

get

https://cloud-api.thunderstack.orghttps://cloud-api.test.thunderstack.org

/api/nodes/latest-rln-image

Returns a latest RLN image version.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

A list of nodes

application/json

datastringOptional

A letest RLN image version.

500

Internall server error

get

/api/nodes/latest-rln-image

HTTPcURLJavaScriptPython

GET /api/nodes/latest-rln-image HTTP/1.1
Host: cloud-api.thunderstack.org/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": "text"
}

Upgrade a node to latest RLN image

post

https://cloud-api.thunderstack.orghttps://cloud-api.test.thunderstack.org

/api/nodes/{id}/upgrade

This endpoint allows you to upgrade a node.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique identifier of the node.

Responses

200

Node upgraded successfully

application/json

messagestringOptional

A message describing the outcome of the action.

400

Validation error

500

Internall server error

post

/api/nodes/{id}/upgrade

HTTPcURLJavaScriptPython

POST /api/nodes/{id}/upgrade HTTP/1.1
Host: cloud-api.thunderstack.org/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "text"
}

Update node settings

post

https://cloud-api.thunderstack.orghttps://cloud-api.test.thunderstack.org

/api/nodes/{id}/settings

This endpoint allows you to Update node settings.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

Responses

200

Node Updated successfully

application/json

messagestringOptional

A message describing the outcome of the action.

400

Validation error

500

Internal

post

/api/nodes/{id}/settings

HTTPcURLJavaScriptPython

POST /api/nodes/{id}/settings HTTP/1.1
Host: cloud-api.thunderstack.org/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "text"
}

Start a Node

post

https://cloud-api.thunderstack.orghttps://cloud-api.test.thunderstack.org

/api/nodes/{id}/start

Start a Node

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique identifier of the node.

Responses

200

Start a Node initiated successfully.

application/json

objectOptional

400

Invalid request parameters.

404

Node not found.

post

/api/nodes/{id}/start

HTTPcURLJavaScriptPython

POST /api/nodes/{id}/start HTTP/1.1
Host: cloud-api.thunderstack.org/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

Stop a Node

post

https://cloud-api.thunderstack.orghttps://cloud-api.test.thunderstack.org

/api/nodes/{id}/stop

Stop a Node

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique identifier of the node.

Responses

200

Stop a Node initiated successfully.

application/json

objectOptional

400

Invalid request parameters.

404

Node not found.

post

/api/nodes/{id}/stop

HTTPcURLJavaScriptPython

POST /api/nodes/{id}/stop HTTP/1.1
Host: cloud-api.thunderstack.org/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

Trigger log export

post

https://cloud-api.thunderstack.orghttps://cloud-api.test.thunderstack.org

/api/nodes/{id}/logs

Initiates an export of logs for a specified node.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

The unique identifier of the node.

Responses

200

Log export initiated successfully.

application/json

taskIdstringOptional

The task ID for tracking the log export process.

400

Invalid request parameters.

404

Node not found.

post

/api/nodes/{id}/logs

HTTPcURLJavaScriptPython

POST /api/nodes/{id}/logs HTTP/1.1
Host: cloud-api.thunderstack.org/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "taskId": "text"
}

Get log download URLs

get

https://cloud-api.thunderstack.orghttps://cloud-api.test.thunderstack.org

/api/nodes/{id}/logs

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

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

datastring[]Optional

An array of download URLs for the logs.

400

Invalid request parameters.

404

Node or task not found.

get

/api/nodes/{id}/logs

HTTPcURLJavaScriptPython

GET /api/nodes/{id}/logs?taskId=text HTTP/1.1
Host: cloud-api.thunderstack.org/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    "text"
  ]
}