Software Development Kit

cPanel & WHM's API [+] cPanel & WHM's API [-]


Modules and Plugins [+] Modules and Plugins [-]


cPanel & WHM Hooks [+] cPanel & WHM Hooks [-]


cPAddons (Site Software) [+] cPAddons (Site Software) [-]


System Administration [+] System Administration [-]


Developer Software [+] Developer Software [-]


Back to All Documentation

Remove Reseller Privileges — unsetupreseller

This function removes reseller status from an account.

note Note: This function will not delete the account; it will only remove its reseller status.

Calling Functions

Using the XML API

To use the XML API to perform the unsetupreseller function from within your custom script:

  • Append the /xml-api/unsetupreseller function call name, plus the required variables (see below), to a URL which includes the address of your server.

  • For example, on a server whose hostname is example.com, you would include the following string in your script: https://example.com:2087/xml-api/unsetupreseller

  • You need to be logged in with the proper permissions in order to call a function. See our document about Authenticating API Function Calls for more information about authenticating APIs from within a script.

  • You can also perform the function by entering the string in your web browser's address bar. This may be useful for testing the function call and viewing its output.

Using the JSON API

To use the JSON API to perform the unsetupreseller function from within your custom script:

  • Append the /json-api/unsetupreseller function call name, plus the required variables (see below), to a URL which includes the address of your server.

  • For example, on a server whose hostname is example.com, you would include the following string in your script: https://example.com:2087/json-api/unsetupreseller

  • You need to be logged in with the proper permissions in order to call a function. See our document about Authenticating API Function Calls for more information about authenticating APIs from within a script.

  • You can also perform the function by entering the string in your web browser's address bar. This may be useful for testing the function call and viewing its output.

Variables

Input

The unsetupreseller function takes the following required variable as input:
  • user — Name of the user from whom to remove reseller status.

Output

  • unsetupreseller — Root-level XML tag for the output of the unsetupreseller function.
    • result — Container for the results of the function.
      • status (boolean) — Whether or not the operation succeeded.
        • 1 — yes.
        • 0 — no.
      • statusmsg (string) — Message about the result of the operation.

Examples

XML API

Calling the URL https://example.com:2087/xml-api/unsetupreseller?user=bob in WebHost Manager will produce output similar to:

<unsetupreseller>
     <result>
            <status>1</status>
            <statusmsg/>
      </result>
</unsetupreseller>

JSON API

Calling the URL https://example.com:2087/json-api/unsetupreseller?user=bob in WebHost Manager will produce output similar to:

{
   "result":[
      {
         "status":1,
         "statusmsg":null
      }
   ]
}

Topic revision: r6 - 29 Sep 2009 - 18:04:39 - MelanieSeibert