Return suspended cPanel accounts and information

This function lists suspended accounts on the server.

SecurityBasicAuth
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
object
get/listsuspended
Request samples
whmapi1 --output=jsonpretty \
  listsuspended
Response samples
application/json
{
  • "data": {
    • "account": [
      • {
        • "is_locked": 0,
        • "owner": "root",
        • "reason": "Suspended for nonpayment.",
        • "time": "Thu Nov 18 10:34:34 2014",
        • "unixtime": 1416306874,
        • "user": "username"
        }
      ]
    },
  • "metadata": {
    • "command": "listsuspended",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}