Child pages
  • WHM API 1 Functions - list_integration_groups

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

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

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/list_integration_groups?api.version=1&user=username
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/list_integration_groups?api.version=1&user=username
Expand
titleCommand Line
Code Block
languagebash
whmapi1 list_integration_groups user=username

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagexml
linenumberstrue
{  
   "data":{  
      "links":[  
         {  
            "group":"Group1"
         },
         {  
            "group":"Group2"
         },
         {  
            "group":"Group3"
         }
      ]
   },
   "metadata":{  
      "version":1,
      "reason":"OK",
      "result":"1",
      "command":"list_integration_groups"
   }
}
Expand
titleOutput (XML)
Code Block
languagexml
linenumberstrue
<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>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

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