Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
WHM API 1 Functions - list_integration_groups - Developer Documentation - cPanel Documentation
Child pages
  • WHM API 1 Functions - list_integration_groups
Skip to end of metadata
Go to start of metadata

Description

This function lists the groups of integration links in the cPanel interface.

Examples


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


Notes:

  • Unless otherwise noted, 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":[  
         {  
            "group":"Group1"
         },
         {  
            "group":"Group2"
         },
         {  
            "group":"Group3"
         }
      ]
   },
   "metadata":{  
      "version":1,
      "reason":"OK",
      "result":"1",
      "command":"list_integration_groups"
   }
}
 Output (XML)
<result>
    <data>
        <links>
            <group>Group1</group>
        </links>
        <links>
            <group>Group2</group>
        </links>
        <links>
            <group>Group3</group>
        </links>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>list_integration_groups</command>
    </metadata>
</result>


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The cPanel account name.

A valid cPanel username.username

Returns

ReturnTypeDescriptionPossible valuesExample
linksarray of hashesAn array of hashes of the integration link groups.Each hash includes the group return. 

group

string

The group ID.

The function returns this value in the links array.

A valid string.Group3