Child pages
  • Manage2 API Functions - Add a Pickup Phrase
Skip to end of metadata
Go to start of metadata

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=hi+there+have+you+met+ted?
JSON
https://manage2.cpanel.net/XMLaddPickupPass.cgi?output=json&pickup=hi+there+have+you+met+ted?
YAML
https://manage2.cpanel.net/XMLaddPickupPass.cgi?output=yaml&pickup=hi+there+have+you+met+ted?
 cPanel Licensing PHP Class
<?php
include("cpl.inc.php");
$cpl = new cPanelLicensing("barney@example.com", "12345luggage");
$response = $cpl->addPickupPass(array(
	"pickup" => "hi there have you met ted?"
	)
);
?>
 cPanel Licensing Perl Module
use cPanelLicensing;
my $cpl = cPanelLicensing->new(user => 'barney\@example.com', pass => '12345luggage');
my $response = $cpl->addPickupPass(
	'pickup' => 'hi there have you met ted?'
	);
 Output (XML)
<XMLaddPickupPass reason="Successfully added pickup phrase 'hi there have you met ted?' for barney@example.com" status="1" />
 Output (JSON)
{
  "status": 1,
  "reason": "Successfully added pickup phrase 'hi there have you met ted?' for barney@example.com"
} 
 Output (YAML)
 ---
status: 1
reason: Successfully added pickup phrase 'hi there have you met ted?' for barney@example.com

Parameters

ParameterTypeDescriptionPossible valuesExample
pickupstring

Required

The pickup phrase to add.

A valid string.hi there have you met ted?

Returns

ReturnTypeDescriptionPossible valuesExample
reasonstringA message of success or a reason for failure.A string value.Successfully added pickup phrase 'hi there have you met ted?' for barney@example.com
statusBooleanWhether the function succeeded.
  • 1 — Success.

  • 0 — Failure.
1