Manage2 API Function - Add a Pickup Phrase
Last modified: March 12, 2021
Description
This function creates a pickup phrase that you use to authenticate with the Manage2 API.
Examples
Browser-based calls
XML
https://manage2.cpanel.net/XMLaddPickupPass.cgi?pickup=this+is+an+example+pickup+phrase?
JSON
https://manage2.cpanel.net/XMLaddPickupPass.cgi?output=json&pickup=this+is+an+example+pickup+phrase?
YAML
https://manage2.cpanel.net/XMLaddPickupPass.cgi?output=yaml&pickup=this+is+an+example+pickup+phrase?
cPanelLicensing PHP Class
|
|
cPanelLicensing Perl Module
|
|
Output (XML)
<XMLaddPickupPass reason="Successfully added pickup phrase 'this is an example pickup phrase' for [email protected]" status="1" />
Output (JSON)
|
|
Output (YAML)
|
|
Parameters
This function accepts the following parameters:
Parameter | Type | Description | Example |
---|---|---|---|
pickup |
string | Required The pickup phrase to add. | this is an example pickup phrase |
Returns
This function returns the following values:
Return | Type | Description | Example |
---|---|---|---|
reason |
string | A message of success or failure. | Successfully added pickup phrase 'this is an example pickup phrase' for [email protected] |
status |
Boolean | Whether the function succeeded:
|
1 |