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

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?

1
2
3
4
5
6
7
8
<?php
include("cpl.inc.php");
$cpl = new cPanelLicensing("username@example.com", "123456luggage");
$response = $cpl->addPickupPass(array(
    "pickup" => "this is an example pickup phrase"
    )
);
?>

1
2
3
4
5
use cPanelLicensing;
my $cpl = cPanelLicensing->new(user => 'username\@example.com', pass => '123456luggage');
my $response = $cpl->addPickupPass(
    'pickup' => 'this is an example pickup phrase'
    );

<XMLaddPickupPass reason="Successfully added pickup phrase 'this is an example pickup phrase' for username@example.com" status="1" />

1
2
3
4
{
    "status": 1,
    "reason": "Successfully added pickup phrase 'this is an example pickup phrase' for username@example.com"
}

1
2
3
---
status: 1
reason: Successfully added pickup phrase 'this is an example pickup phrase' for username@example.com

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 username@example.com
status Boolean Whether the function succeeded:
  • 1 — Success.
  • 0 — Failure.
1

Additional Documentation