- Created by Documentation, last modified on Apr 09, 2018
disable_authentication_provider
disable_failing_authentication_providers
enable_authentication_provider
get_available_authentication_providers
get_provider_client_configurations
get_provider_configuration_fields
get_provider_display_configurations
get_users_authn_linked_accounts
set_provider_client_configurations
set_provider_display_configurations
twofactorauth_generate_tfa_config
twofactorauth_get_user_configs
cpgreylist_is_server_netblock_trusted
cpgreylist_list_entries_for_common_mail_provider
cpgreylist_load_common_mail_providers_config
cpgreylist_save_common_mail_providers_config
cpgreylist_trust_entries_for_common_mail_provider
cpgreylist_untrust_entries_for_common_mail_provider
create_cpgreylist_trusted_host
delete_cpgreylist_trusted_host
block_incoming_email_from_country
block_incoming_email_from_domain
expunge_messages_for_mailbox_guid
get_unique_recipient_count_per_sender_for_user
get_unique_sender_recipient_count_per_user
get_user_email_forward_destination
list_blocked_incoming_email_countries
list_blocked_incoming_email_domains
set_user_email_forward_destination
unblock_incoming_email_from_country
unblock_incoming_email_from_domain
Description
This function creates a group to store integrations links in the cPanel interface.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/create_integration_group?api.version=1&user=username&group_id=WHMCS&label=WHMCS%2BControl&order=1
https://hostname.example.com:2087/cpsess##########/xml-api/create_integration_group?api.version=1&user=username&group_id=WHMCS&label=WHMCS%2BControl&order=1
whmapi1 create_integration_group user=username group_id=WHMCS label=WHMCS%2BControl order=1
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
{ "data":{ }, "metadata":{ "version":1, "reason":"Ok", "result":1, "command":"create_integration_group" } }
<result> <data/> <metadata> <version>1</version> <reason>Ok</reason> <result>1</result> <command>create_integration_group</command> </metadata> </result>
Note:
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 | A valid alphanumeric string. Note: You may include underscore ( | WHMCS |
label | string | Required The label for the group to display in the cPanel interface. | A valid string. | WHMCS+Control |
| 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:
Available in:
WHM 54+
Methods:
GET, POST
Required Parameters:
user
, group_id
, label
, order
Return Formats:
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
or2087
) to call WHM API functions.
Find a function
Related functions
-
Page:WHM API 1 Functions - list_configclusterservers — This function lists the servers in the server's configuration cluster.
-
Page:WHM API 1 Functions - update_configclusterserver — This function updates the username or remote access key for a cluster server.
-
Page:WHM API 1 Functions - delete_configclusterserver — This function removes a server from a configuration cluster.
-
Page:WHM API 1 Functions - add_configclusterserver — This function adds a server to a configuration cluster.
-
Page:WHM API 1 Functions - abort_transfer_session — This function aborts an active transfer session.