Developer Documentation
Child pages
  • WHM API 1 Functions - _getpkgextensionform
Skip to end of metadata
Go to start of metadata

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Call cPanel API 2 and UAPI

 

 

Description


This function retrieves a hosting plan's package extension templates.

 When you call this function, the system checks the hosting plan's  _PACKAGE_EXTENSIONS value.


The function returns the contents of the /var/cpanel/packages/extensions/name.tt2 file for each package extension in the list, where name represents the package extension's name.

For more information, read our Guide to Package Extensions.

Examples 

 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/_getpkgextensionform?api.version=1&pkg=package1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/_getpkgextensionform?api.version=1&pkg=package1
 Command Line
whmapi1 _getpkgextensionform pkg=package1


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.

  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{  
   "data":{  
      "html":"<div class="fatBorder" id="dog_Extension">\n<fieldset class="groupEditor">\n<div class="propertyGroup">\n<h3>Dog Settings</h3>\n<div class="propertyEditor">\n    <div class="propertyLabel">Dog Species</div>\n    <div class="propertyValue"><input id="dog_species" type="text" name="dog_species" value="dalmatian"></div>\n</div>\n\n<div class="propertyEditor">\n    <div class="propertyLabel">Tail Length</div>\n    <div class="propertyValue">\n            <input type="radio" id="dogTailLengthTiny" name="dog_tail_length" value="tiny">\n            <label for="dogTailLengthTiny">Tiny</label><br>\n            <input type="radio" id="dogTailLengthNormal" name="dog_tail_length" value="normal">\n            <label for="dogTailLengthNormal">Normal</label><br>\n            <input type="radio" id="dogTailLengthLong" name="dog_tail_length" value="long">\n            <label for="dogTailLengthLong">Long</label>\n    </div>\n</div>\n\n<div class="propertyEditor">\n    <div class="propertyLabel"><label for="dog_spots">Has Spots</label></div>\n    <div class="propertyValue">\n            <input id="dog_spots" type="checkbox" name="dog_spots" value="y" checked="checked">\n    </div>\n</div>\n\n</div>\n</fieldset>\n</div>\n"
   },
   "metadata":{  
      "version":1,
      "reason":"OK",
      "result":1,
      "command":"_getpkgextensionform"
   }
}
 Output (XML)
<result>
   <data>
      <html>
         <div class="fatBorder" id="dog_Extension"> <fieldset class="groupEditor"> <div class="propertyGroup"> <h3>Dog Settings</h3> <div class="propertyEditor"> <div class="propertyLabel">Dog Species</div> <div class="propertyValue"><input id="dog_species" type="text" name="dog_species" value="dalmatian"></div> </div> <div class="propertyEditor"> <div class="propertyLabel">Tail Length</div> <div class="propertyValue"> <input type="radio" id="dogTailLengthTiny" name="dog_tail_length" value="tiny"> <label for="dogTailLengthTiny">Tiny</label><br> <input type="radio" id="dogTailLengthNormal" name="dog_tail_length" value="normal"> <label for="dogTailLengthNormal">Normal</label><br> <input type="radio" id="dogTailLengthLong" name="dog_tail_length" value="long"> <label for="dogTailLengthLong">Long</label> </div> </div> <div class="propertyEditor"> <div class="propertyLabel"><label for="dog_spots">Has Spots</label></div> <div class="propertyValue"> <input id="dog_spots" type="checkbox" name="dog_spots" value="y" checked="checked"> </div> </div> </div> </fieldset> </div>
      </html>
   </data>
   <metadata>
      <version>1</version>
      <reason>OK</reason>
      <result>1</result>
      <command>_getpkgextensionform</command>
   </metadata>
</result>


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

Parameters

ParameterTypeDescriptionPossible valuesExample
pkgstring

Required

The hosting plan's name.

A valid hosting plan name on the server.package1

 

Returns

Note:

This function returns only metadata if the hosting plan does not use package extensions, or if the extensions' template files are empty. 

ReturnTypeDescriptionPossible valuesExample
htmlstringThe source code for the hosting plan's extensions' templates.

HTML and Template Toolkit code for one or more package extension forms.

 Click to view...
<div class="fatBorder" id="dog_Extension"> <fieldset class="groupEditor"> <div class="propertyGroup"> <h3>Dog Settings</h3> <div class="propertyEditor"> <div class="propertyLabel">Dog Species</div> <div class="propertyValue"><input id="dog_species" type="text" name="dog_species" value="dalmatian"></div> </div> <div class="propertyEditor"> <div class="propertyLabel">Tail Length</div> <div class="propertyValue"> <input type="radio" id="dogTailLengthTiny" name="dog_tail_length" value="tiny"> <label for="dogTailLengthTiny">Tiny</label><br> <input type="radio" id="dogTailLengthNormal" name="dog_tail_length" value="normal"> <label for="dogTailLengthNormal">Normal</label><br> <input type="radio" id="dogTailLengthLong" name="dog_tail_length" value="long"> <label for="dogTailLengthLong">Long</label> </div> </div> <div class="propertyEditor"> <div class="propertyLabel"><label for="dog_spots">Has Spots</label></div> <div class="propertyValue"> <input id="dog_spots" type="checkbox" name="dog_spots" value="y" checked="checked"> </div> </div> </div> </fieldset> </div>

Function information

API Version:

WHM API 1

Available in:

WHM 11.40+

Methods:

GET, POST

Required Parameters:

pkg

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

  • Some functions and parameters may require that you authenticate as the root user.
  • You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.
  

Find a function

Related functions