Self Help Documentation
accounts/grantSSH
Description
Enables or disables the SSH access of an 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 | Yes | The username of the account being manipulated. |
status | bool | Yes | The new SSH state for the selected account (true or false). |
Example
$endpointUrl = 'https://123.123.123.123/spanel/api.php';
$postData = [
'token' => 'provided_auth_token',
'action' => 'accounts/grantSSH',
'username' => 'testuser',
'status' => true,
];
$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 );
Code language: PHP (php)
You can find more information about the Endpoint URL in our API Basics article.
Output
{
"result": "success"
}
Code language: JSON / JSON with Comments (json)