WHM xmlApi call UAPI functions

I am trying to call UAPI from xmlapi_query as I understood from:
https://documentation.cpanel.net/display/SDK/UAPI+-+Calls+from+the+WHM+API

Then I call:

Code:

$this->object->xmlapi_query("ModSecurity", array("cpanel_xmlapi_version"=>"3",
                                                                           "api.version"=>"3",
                                                                       "cpanel_jsonapi_user"=>"dominable", 
                                                                        "cpanel_jsonapi_module"=>"ModSecurity", 
                                                                      "cpanel_jsonapi_func"=>"list_domains",
                                                                  "cpanel_jsonapi_apiversion"=>"3"
  ));

And the debug:

Code:

.URL: /https://s1.domain.com:2087/xml-api/ModSecurity
DATA: api.version=3&cpanel_jsonapi_user=domain&cpanel_jsonapi_module=ModSecurity&cpanel_jsonapi_func=list_domains&cpanel_jsonapi_apiversion=3
Authentication Header: Authorization: Basic **I manually changed it**

I received the response:

Code:

SimpleXMLElement Object
(
  [metadata] => SimpleXMLElement Object
  (
  [version] => 3
  [reason] => Unknown app requested for this version (3) of the api.
  [result] => 0
  [command] => ModSecurity
  )

)

I have changed losts of things, tried lots of combinations but nothing worked properly.

I need to disable mod_security sometimes to let my customers install applications that mod_security detects as false positive.

Thank you in advance

 

Hi Alex,

As far as I can tell, support for this doesn't exist yet, as of cPanel 11.48. The best suggestion I can offer is to create one user session, then re-use it for that user for subsequent API calls. Sessions expire 15 minutes after their most recent use.

David Nielson
Integration Developer, cPanel

 

Hi David:

Thank you for your answer but
could you please point me out which api commands should I use to "create user session and then re-use it". I may imagine or find them but it takes me tons of hours because the documentation is a bit messy.

Thank you cPanel people for your extraordinary products.

Alex

 

Mister Hodge is correct; support for UAPI (as "API version 3") is in 11.48. I don't know what I was doing wrong before, when I couldn't get it to work, but it's working for me now.

As of cPanel & WHM 11.48, it's no longer necessary to create user sessions just to make API calls on behalf of a user.

 

Yes, I know this is an old thread, but since I found it and it helped me after realising there were som errors in the code, I thought I'd put the working version out there if anyone else is looking for a solution to this.

It works fine calling cpanel UAPI via xmlapi class from 11.48

The example cPAndrewHodge gave had only a minor error that made it not work. (ModSecurity instead of cpanel as function).
This will work:

Code:

$this->object->xmlapi_query("cpanel", array("api.version"=>"1",
                                          "cpanel_xmlapi_user"=>"dominable",
                                          "cpanel_xmlapi_module"=>"ModSecurity",
                                          "cpanel_xmlapi_func"=>"list_domains",
                                          "cpanel_xmlapi_apiversion"=>"3"
  ));

or if you prefer json:

Code:

$this->object->xmlapi_query("cpanel", array("api.version"=>"1",
                                          "cpanel_jsonapi_user"=>"dominable",
                                          "cpanel_jsonapi_module"=>"ModSecurity",
                                          "cpanel_jsonapi_func"=>"list_domains",
                                          "cpanel_jsonapi_apiversion"=>"3"
  ));