Child pages
  • WHM API 1 Functions - package_manager_is_performing_actions
Skip to end of metadata
Go to start of metadata

Description

This function checks the activity of the process that you executed in the WHM API 1 package_manager_submit_actions function. 

Examples  


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


Notes:

  • 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":{  
      "active":1
   },
   "metadata":{  
      "version":1,
      "result":1,
      "reason":"OK",
      "command":"package_manager_is_performing_actions"
   }
}
 Output (XML)
<result>
    <data>
        <action>1</action>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <command>package_manager_is_performing_actions</command>
        <result>1</result>
    </metadata>
</result>


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
buildinteger

Required

The process's build number.

WHM API 1 package_manager_submit_actions function returns the build number.

A valid build number.

installed

Returns

ReturnTypeDescriptionPossible valuesExample
actionBooleanWhether the process is active.
  • 1 — Active.
  • 0 — Inactive.
 1