• cPanel XMLAPI
• DESCRIPTION
• VARIABLES
• INPUT
• OUTPUT
• EXAMPLES
• COPYRIGHT

cPanel XMLAPI

DESCRIPTION

This document describes the use of cPanel's XMLAPI calls within WebHost Manager (WHM)

VARIABLES

INPUT

name (string)

Name of the XMLAPI call.

?

A ? is used to append information to the call.

variable=value (string)

Variables and their values can then be passed to the call. Format: variable=value

&

A & is used to add more variables and values to the call

OUTPUT

output format

The output is an call container that contains a result container. The containers will be in the format:

For calls that perform an action:

<name_of_XMLAPI_call>

<result (status of the request) />

</name_of_XML_API_call>

For calls which only request data:

<name_of_XMLAPI_call>

<item (information about the item) />. (Where the item is the item request, i.e. a package, acct, etc)

</name_of_XML_API_call>

EXAMPLES

Calling this URL in WebHost Manager: /xml-api/setupreseller?user=bob&makeowner=1

will produce XML similar to:

<setupreseller>

<result status=``1'' statusmsg=``''/>

</setupreseller>

COPYRIGHT

Copyright 2007 cPanel Inc.