Self Help Documentation
< All Topics

software/listnodejsapps

Posted
Updated

Description

Lists all deployed Node.js applications for a given SPanel user account.

Parameters

FieldTypeRequiredDescription
tokenstringYesAuthorizing API token – check API Basics for more information.
accountuserstringYesThe SPanel user account that is being managed or viewed.
actionstringYesThe category and function being executed.

Example

PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
$endpointUrl = 'https://123.123.123.123/spanel/api.php';
 
$postData = [
  'token' => 'provided_auth_token',
  'accountuser' => 'spanelio',
  'action' => 'software/listnodejsapps',
];
 
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $endpointUrl);
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt( $ch, CURLOPT_POST, true);
curl_setopt( $ch, CURLOPT_POSTFIELDS, http_build_query($postData));
curl_setopt( $ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt( $ch, CURLOPT_SSL_VERIFYHOST, false);
$jsonOutput = curl_exec( $ch );

You can find more information about the Endpoint URL in our API Basics article.

Output

PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
    "result": "success",
    "data": [
        {
            "nodejsapp_name": "myapp",
            "app_homedir": "/home/spanelio/nodejsapps/myapp",
            "domain": "example.com",
            "application_url": "/myapp",
            "port": "3001",
            "status": "online",
            "uptime": 1765548491, //Timestamp since the app is online
            "cpu": "0.2",
            "memory": 128,
            "appid": "12345",
            "application_type": "n8n",
            "updates": 0
        }
    ]
}
Table of Contents