Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function lists locked accounts on the server. Only WHM users with root-level privileges can unsuspend locked accounts.

  

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/listlockedaccounts
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/listlockedaccounts
 Command Line
whmapi1 listlockedaccounts

Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (JSON)
{
   "data":{
      "account":[
         "account1",
         "account2",
         "account3"
      ]
   },
   "metadata":{
      "version":1,
      "reason":"OK",
      "result":1,
      "command":"listlockedaccounts"
   }
}
 Output (XML)
<result>
    <data>
        <account>account1</account>
        <account>account2</account>
        <account>account3</account>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>listlockedaccounts</command>
    </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
accountarrayA list of locked accounts on the server.An array of the server's locked accounts' usernames.account1