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

 

Description

This function lists the reseller accounts on the server.

Examples 


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


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)
{  
   "data":{  
      "reseller":[  
         "bob",
         "bob2",
         "bob3",
         "malcolm"
      ]
   },
   "metadata":{  
      "version":1,
      "reason":"OK",
      "result":1,
      "command":"listresellers"
   }
}
 Output (XML)
<result>
    <data>
        <reseller>bob</reseller>
        <reseller>bob2</reseller>
        <reseller>bob3</reseller>
        <reseller>malcolm</reseller>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>listresellers</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

reseller

array

An array of the server's reseller accounts.

An array of one or more valid usernames.bob