We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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

Description

This function lists all users and their domains that have backup metadata.

Examples 


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


Notes:

  • Unless otherwise noted, 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)
{
   "data":{
      "username":"example.com",
      "username2":"example.net",
      "username3":"example.org"
   },
   "metadata":{
      "version":1,
      "result":1,
      "reason":"OK",
      "command":"get_users_and_domains_with_backup_metadata"
   }
}


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
ACCOUNTstring

The cPanel user account that contains backup metadata.

Note:

The return's name is the cPanel user account's name.

A valid cPanel account.

username
DOMAINstring

The cPanel user account's associated domain.

Note:

The return's name is the domain name.

A valid domain that the account owns.example.com