π οΈThunderEngine API
Returns a list of all nodes including their details and builds.
A list of nodes
Internall server error
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"
}
}
]
}
This endpoint allows you to create a new node.
Name of the node.
Node created successfully
Validation error
Internall server error
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"
}
This endpoint destroys a node by its identifier.
Unique identifier of the node to be destroyed.
Node destroyed successfully
Validation error or node not found
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"
}
Returns details of a specific node by node ID.
The unique identifier of the node.
Details of the node
Invalid node ID supplied
Node not found
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"
}
}
Returns public key for webhook verification.
success response
Internall server error
GET //api/webhook-public-key HTTP/1.1
Host: cloud-api.thunderstack.org
Authorization: Bearer JWT
Accept: */*
{
"data": "text"
}
This endpoint allows you to upgrade a node.
The unique identifier of the node.
Node upgraded successfully
Validation error
Internall server error
POST //api/nodes/{id}/upgrade HTTP/1.1
Host: cloud-api.thunderstack.org
Authorization: Bearer JWT
Accept: */*
{
"message": "text"
}
This endpoint allows you to Update node settings.
Node Updated successfully
Validation error
Internal
POST //api/nodes/{id}/settings HTTP/1.1
Host: cloud-api.thunderstack.org
Authorization: Bearer JWT
Accept: */*
{
"message": "text"
}
Start a Node
The unique identifier of the node.
Start a Node initiated successfully.
Invalid request parameters.
Node not found.
POST //api/nodes/{id}/start HTTP/1.1
Host: cloud-api.thunderstack.org
Authorization: Bearer JWT
Accept: */*
{}
Stop a Node
The unique identifier of the node.
Stop a Node initiated successfully.
Invalid request parameters.
Node not found.
POST //api/nodes/{id}/stop HTTP/1.1
Host: cloud-api.thunderstack.org
Authorization: Bearer JWT
Accept: */*
{}
Initiates an export of logs for a specified node.
The unique identifier of the node.
Log export initiated successfully.
Invalid request parameters.
Node not found.
POST //api/nodes/{id}/logs HTTP/1.1
Host: cloud-api.thunderstack.org
Authorization: Bearer JWT
Accept: */*
{
"taskId": "text"
}
Retrieves the download URLs for logs related to a specific task ID.
The unique identifier of the node.
The task ID associated with the log export.
List of log download URLs retrieved successfully.
Invalid request parameters.
Node or task not found.
GET //api/nodes/{id}/logs HTTP/1.1
Host: cloud-api.thunderstack.org
Authorization: Bearer JWT
Accept: */*
{
"data": [
"text"
]
}
Last updated