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

This function lists integration links in the cPanel interface.


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


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":{  
      "links":[  
         {  
            "app":"WHMCS_billing"
         },
         {  
            "app":"WHMCS_support"
         }
      ]
   },
   "metadata":{  
      "version":1,
      "reason":"OK",
      "result":"1",
      "command":"list_integration_links"
   }
}
 Output (XML)
<result>
    <data>
        <links>
            <app>WHMCS_billing</app>
        </links>
        <links>
            <app>WHMCS_support</app>
        </links>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>list_integration_links</command>
    </metadata>
</result>


Note:

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

ParametersTypeDescriptionPossible valuesExample
userstring

Required

The cPanel account name.

A valid cPanel username.username
ReturnsTypeDescriptionPossible valuesExample

links

array of hashesAn array of hashes of the integration links.Each hash includes the app return. 

app

string

The integration link's app name.

The function returns this value in the links array.

A valid alphanumeric string.

WHMCS_billing