- 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
Description
This function checks the remote server's credentials, which a transfer session uses to connect.
Examples
https://hostname.example.com:2087/cpsess##########/json-api/analyze_transfer_session_remote?api.version=1&transfer_session_id=exampleservercopya20140206192428NtyW
https://hostname.example.com:2087/cpsess##########/xml-api/analyze_transfer_session_remote?api.version=1&transfer_session_id=exampleservercopya20140206192428NtyW
whmapi1 analyze_transfer_session_remote transfer_session_id=exampleservercopya20140206192428NtyW
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
{ "metadata": { "version": 1, "reason": "OK", "result": "1", "command": "analyze_transfer_session_remote" } }
<result> <metadata> <version>1</version> <reason>OK</reason> <result>1</result> <command>analyze_transfer_session_remote</command> </metadata> </result>
Note:
Parameters
Parameter | Type | Description | Possible values | Example |
---|---|---|---|---|
transfer_session_id | string | Required The transfer session's ID. | A valid string. | exampleservercopya20140206192428NtyW
|
Returns
This function only returns metadata.
Function information
API Version:
Available in:
WHM 11.44+
Methods:
GET, POST
Required Parameters:
transfer_session_id
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.