- Created by Documentation, last modified on Feb 11, 2019
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 retrieves a transfer module's key structure.
Note:
For more information about how this function works with other functions in the transfer and restore process, read our Guide to Transfer and Restore API Functions documentation.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/transfer_module_schema?api.version=1&module=FeatureListsRemoteRoot https://hostname.example.com:2087/cpsess##########/json-api/transfer_module_schema?api.version=1&module=PackageRemoteRoot https://hostname.example.com:2087/cpsess##########/json-api/transfer_module_schema?api.version=1&module=AccountRemoteRoot
https://hostname.example.com:2087/cpsess##########/xml-api/transfer_module_schema?api.version=1&module=AccountRemoteRoot
whmapi1 transfer_module_schema module=AccountRemoteRoot
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": { "schema": { "keys": { "detected_remote_user": { "def": "char(255) DEFAULT NULL" }, "ip": { "def": "int(1) DEFAULT 0" }, "skipbwdata": { "def": "int(1) DEFAULT 0" }, "customip": { "def": "char(255) DEFAULT NULL" }, "size": { "def": "BIGINT UNSIGNED DEFAULT 1" }, "shared_mysql_server": { "def": "int(1) DEFAULT 0" }, "domain": { "def": "char(255) DEFAULT NULL" }, "cpmovefile": { "def": "text" }, "skiphomedir": { "def": "int(1) DEFAULT 0" }, "user": { "def": "char(255) DEFAULT NULL" }, "skipacctdb": { "def": "int(1) DEFAULT 0" }, "skipres": { "def": "int(1) DEFAULT 0" }, "reseller": { "def": "int(1) DEFAULT 0" }, "skipaccount": { "def": "int(1) DEFAULT 0" }, "copypoint": { "def": "text" }, "force": { "def": "int(1) DEFAULT 0" }, "xferpoint": { "def": "int(1) DEFAULT 0" }, "replaceip": { "def": "char(255) DEFAULT NULL" }, "localuser": { "def": "char(255) DEFAULT NULL" } }, "required": [ "user", "localuser" ], "primary": [ "user" ] } }, "metadata": { "version": 1, "reason": "OK", "result": "1", "command": "transfer_module_schema" } }
<result> <data> <schema> <keys> <detected_remote_user> <def>char(255) DEFAULT NULL</def> </detected_remote_user> <ip> <def>int(1) DEFAULT 0</def> </ip> <skipbwdata> <def>int(1) DEFAULT 0</def> </skipbwdata> <customip> <def>char(255) DEFAULT NULL</def> </customip> <size> <def>BIGINT UNSIGNED DEFAULT 1</def> </size> <shared_mysql_server> <def>int(1) DEFAULT 0</def> </shared_mysql_server> <domain> <def>char(255) DEFAULT NULL</def> </domain> <cpmovefile> <def>text</def> </cpmovefile> <skiphomedir> <def>int(1) DEFAULT 0</def> </skiphomedir> <user> <def>char(255) DEFAULT NULL</def> </user> <skipacctdb> <def>int(1) DEFAULT 0</def> </skipacctdb> <skipres> <def>int(1) DEFAULT 0</def> </skipres> <reseller> <def>int(1) DEFAULT 0</def> </reseller> <skipaccount> <def>int(1) DEFAULT 0</def> </skipaccount> <copypoint> <def>text</def> </copypoint> <force> <def>int(1) DEFAULT 0</def> </force> <xferpoint> <def>int(1) DEFAULT 0</def> </xferpoint> <replaceip> <def>char(255) DEFAULT NULL</def> </replaceip> <localuser> <def>char(255) DEFAULT NULL</def> </localuser> </keys> <required>user</required> <required>localuser</required> <primary>user</primary> </schema> </data> <metadata> <version>1</version> <reason>OK</reason> <result>1</result> <command>transfer_module_schema</command> </metadata> </result>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
module | string | Required The transfer module's name. |
| AccountRemoteRoot |
Returns
Return | Type | Description | Possible values | Example |
---|---|---|---|---|
schema | hash | A hash of the schema's keys. | A hash that includes the keys hash and the required and primary arrays. | |
| hash | A hash of the schema's keys. The function returns this hash in the | A hash that includes the key name hash. | |
| hash | A hash of the key's information. Note: The key's name is the parameter name. The function returns this hash in the
| A hash that includes the def return. | |
| string | The key's definition. This function returns this value in the | The first value is the parameter's type and length.
The second value is the default value. | char(255) DEFAULT NULL |
| array | The schema's required keys. This function returns this value in the | Any value or values from the key name field. | user , localuser |
| array | The schema's primary key. This function returns this value in the | Any value from the key name field. | user |
Function information
API Version:
Available in:
cPanel 11.44+
Methods:
GET, POST
Required Parameters:
module
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 - restore_modules_summary — This function lists backup modules and their descriptions.
-
Page:WHM API 1 Functions - abort_transfer_session — This function aborts an active transfer session.
-
Page:WHM API 1 Functions - analyze_transfer_session_remote — This function checks the remote server's credentials, which a transfer session uses to connect.
-
Page:WHM API 1 Functions - available_transfer_modules — This function lists all available transfer modules.
-
Page:WHM API 1 Functions - create_remote_root_transfer_session — This function creates a transfer session as the
root
user.