WHM API 1 Functions - create_integration_group

https://hostname.example.com:2087/cpsess##########/json-api/create_integration_group?api.version=1&user=username&group_id=WHMCS&label=WHMCS%2BControl&order=1

XML API

https://hostname.example.com:2087/cpsess##########/xml-api/create_integration_group?api.version=1&user=username&group_id=WHMCS&label=WHMCS%2BControl&order=1

Command Line

whmapi1 create_integration_group user=username group_id=WHMCS label=WHMCS%2BControl order=1

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":{
   },
   "metadata":{
      "version":1,
      "reason":"Ok",
      "result":1,
      "command":"create_integration_group"
   }
}

Output (XML)

<result>
    <data/>
    <metadata>
        <version>1</version>
        <reason>Ok</reason>
        <result>1</result>
        <command>create_integration_group</command>
    </metadata>
</result>

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
`user`	string	Required The cPanel account name.	A valid cPanel username.	`username`
`group_id`	string	Required The group's ID within the system. Warning: If you create a link with a `group_id` value that already exists, the function replaces the existing group with the newly-created group.	A valid alphanumeric string. Note: You may include underscore (`_`) characters.	`WHMCS`
`label`	string	Required The label for the group to display in the cPanel interface.	A valid string.	`WHMCS+Control`
`order`	integer	Required The order in which to display the group in the cPanel interface. Note: By default, the function will automatically create an item under the username menu in the interface header.	A valid non-zero integer.	`1`

Returns

This function only returns metadata.

Function information

API Version:

WHM API 1

Available in:

WHM 54+

Methods:

GET, POST

Required Parameters:

user, group_id, label, order

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

Some functions and parameters may require that you authenticate as the root user.
You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.

Find a function

Related functions

Page:

Guide to WHM API 1 — WHM API 1 accesses the WHM interface's features.
Page:

WHM API 1 - Filter Output — You can use additional variables to filter WHM API 1 output.
Page:

WHM API 1 - Sort Output — You can use additional variables to sort WHM API 1 output.
Page:

WHM API 1 - Paginate Output — You can use additional variables to paginate WHM API 1 output.
Page:

WHM API 1 - Return Data — WHM API 1 outputs data in either JSON or XML format.

Child pages