Description

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

Examples


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

{  
   "data":{  
      "links":[  
         {  
            "group":"Group1"
         },
         {  
            "group":"Group2"
         },
         {  
            "group":"Group3"
         }
      ]
   },
   "metadata":{  
      "version":1,
      "reason":"OK",
      "result":"1",
      "command":"list_integration_groups"
   }
}
<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>

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