Child pages
  • WHM API 1 Functions - get_users_with_backup_metadata
Skip to end of metadata
Go to start of metadata

Description

This function lists users with backup metadata.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/get_users_with_backup_metadata?api.version=1
 Command Line
whmapi1 get_users_with_backup_metadata


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.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
   "metadata":{
      "command":"get_users_with_backup_metadata",
      "result":1,
      "version":1,
      "reason":"OK"
   },
   "data":{
      "accounts":[
         "username",
         "username2",
         "username3",
         "username4"
      ]
   }
}


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
accountsarrayThe cPanel user accounts on the server that contain backup metadata.

An array of cPanel usernames.

username