Child pages
  • cPanel API 1 - Return Data

Versions Compared

Key

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

 

Introduction

Include Page
LIB:_cPanelAPI1Deprecated
LIB:_cPanelAPI1Deprecated

Excerpt

cPanel API 1 outputs data to the cPanel interface in multiple formats.

 The output format depends on the specific function that you call. For information about a function's output, see the documentation for that function.

Output formats

cPanel API 1 function calls return data in a variety of formats. For example:

  • HTML.

  • Plaintext or strings.
  • Integers.
  • Generated images.
Note
titleNotes:
  • Because some cPanel API 1 functions return HTML output, calls that you make through the WHM API will cause parsing errors in most XML parsers. We strongly recommend that you use cPanel API 2 instead.
    • Multiexcerpt include
      MultiExcerptNameLong Warning
      PageWithExcerptLIB:_XMLDeprecated
    • Include Page
      LIB:_XMLWarning
      LIB:_XMLWarning

  • Some cPanel API 1 functions return a portion of an HTML form. The output of these functions does not include all of the necessary form elements for a functional form.