We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Child pages
  • Guide to the LiveAPI System - The get_result() Method
Skip to end of metadata
Go to start of metadata

Description

The get_result() method fetches the most recent data result node for cPanel API 1 and cPanel API 2 functions.

Important:

  • This method does not fetch UAPI data.
  • This method only functions in the LiveAPI PHP Class. Do not attempt to use it in the LiveAPI Perl Module.


Example  


LiveAPI PHP Class

// Get the last data result node.
$cpanel->get_result();

LiveAPI Perl Module

This method is not available in the LiveAPI Perl Module.

Parameters

This method does not accept parameters.

Returns

This method returns the ['cpanelresult']['result']['data'] node of the last response that the system returned. The format of this data varies based on the last call that the system performed.