accounts/suspendaccount
Description
Suspends an active SPanel account.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| token | string | Yes | Authorizing API token – check API Basics for more information. |
| action | string | Yes | The category and function being executed. |
| username | string|array | Yes | Account username to be suspended. Array with multiple usernames is supported as well. |
| reason | string | No | An optional reason to be set for the suspended accounts. Will be visible inside SPanel Admin interface. |
Example
$endpointUrl = 'https://123.123.123.123/spanel/api.php';
$postData = [
'token' => 'provided_auth_token',
'action' => 'accounts/suspendaccount',
'username' => 'testuser',
//'username' => ['testuser', 'testuser2'],
'reason' => 'Test reason provided',
];
$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
{
"result": "success",
"msg": "Suspend successful"
}