-
Getting Started
-
API functions
-
-
- email/listemailaccounts
- email/changeemailquota
- email/createemailaccount
- email/removeemailaccount
- email/emailaccountpassword
- email/listemailforwarders
- email/addemailforwarder
- email/removeemailforwarder
- email/getmailroute
- email/setmailroute
- email/listemailautoresponders
- email/addemailautoresponder
- email/removeemailautoresponder
- email/editemailautoresponder
- email/togglespamassassin
- email/setspamassassinscore
- email/listspamassassinsenders
- email/addspamassassinsender
- email/removespamassassinsender
- email/getdefaultaddressstatus
- email/setdefaultaddressstatus
- email/listemailfilters
- email/addemailfilter
- email/removeemailfilter
- Show all articles ( 9 ) Collapse Articles
-
- domain/listdomains
- domain/adddomain
- domain/changedomainpath
- domain/changemodsecurity
- domain/removedomain
- domain/listsubdomains
- domain/addsubdomain
- domain/changesubdomainpath
- domain/removesubdomain
- domain/listredirects
- domain/createredirect
- domain/removeredirect
- domain/listdnszone
- domain/adddnsrecord
- domain/editdnszone
-
-
-
- accounts/listaccounts
- accounts/wwwacct
- accounts/changeuserpassword
- accounts/changedomain
- accounts/changeuseremail
- accounts/changequota
- accounts/suspendaccount
- accounts/unsuspendaccount
- accounts/terminateaccount
- accounts/listpackages
- accounts/createpackage
- accounts/modifypackage
- accounts/removepackage
- accounts/grantSSH
-
< All Topics
accounts/grantSSH
Posted
Updated
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 );
You can find more information about the Endpoint URL in our API Basics article.
Output
{
"result": "success"
}
Table of Contents