Self Help Documentation
< All Topics

software/togglenodejsappstatus

Posted
Updated

Description

Starts, stops, or restarts a deployed Node.js application from 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. Use software/togglenodejsappstatus.
idstringYesThe application ID in the format domain + application_url (without protocol), for example: example.com/myapp.
statusstringYesAccepted values: start, stop, restart.

Example

PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
$endpointUrl = 'https://123.123.123.123/spanel/api.php';
 
$postData = [
  'token' => 'provided_auth_token',
  'accountuser' => 'spanelio',
  'action' => 'software/togglenodejsappstatus',
  'id' => 'example.com/myapp',
  'status' => 'restart',
];
 
$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
{
    "result": "success",
    "data": {
        "status": "online",
        "msg": "Application <b>/home/spanelio/app.yml</b> at url <b>example.com/myapp</b> is restarted"
    }
}
Table of Contents