Child pages
  • cPanel API 1 Functions - ProxyUtils::proxyaddress

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function displays the proxy address for a specific application.

Include Page
LIB:_cPanelAPI1NoEquivalent
LIB:_cPanelAPI1NoEquivalent

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$get_proxyaddress = $cpanel->api1('ProxyUtils','proxyaddress', array('cpanel')) ); // Call the function.

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $get_proxyaddress = $cpliveapi->api1('ProxyUtils','proxyaddress', ['cpanel'] ); # Call the function.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="ProxyUtils::proxyaddress($FORM('newapp'))">
Expand
titleCommand Line
Code Block
languagebash
cpapi1 --user=username ProxyUtils proxyaddress cpanel

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote

Expand
titleOutput (plaintext)
Code Block
appname.host.com

Parameters

ParameterTypeDescriptionPossible valuesExample
newappstring

Required

The application's name.

  • cpanel
  • webmail
  • whm
  • webdisk
cpanel

Returns

This function returns the proxy address for the application.