WHM API.
Download OpenAPI description
Overview
URL
WebPros International, LLC
License
Languages
Servers
Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/
A server running WHM.
https://{host}:{port}/json-api/
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/abort_transfer_session
- A server running WHM.
https://whm-server.tld:2087/json-api/abort_transfer_session
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/abort_transfer_session?transfer_session_id=exampleservercopya20140206192428NtyW'Response
application/json
{ "metadata": { "command": "abort_transfer_session", "reason": "OK", "result": 1, "version": 1 } }
Request
This function creates a transfer session as the root user.
Important:
For information about the ports that cPanel & WHM uses, read our How to Configure Your Firewall for cPanel Services documentation.
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.
There are several methods that you can use to authenticate a transfer session with the remote server:
If you use SSH to authenticate as the root user, the remote server's SSH must accept root logins. For more information read OpenSSH's sshd_config documentation.
The following table displays the correct parameters and values for this authentication method:
| Parameter | Value |
|---|---|
user | root |
password | root's password |
You can also use an SSH public key to authenticate the root user. If the SSH public key is encrypted, include the SSH key's passphrase.
The following table displays the correct parameters and values for this authentication method:
| Parameter | Value if the SSH Key is not encrypted | Value if the SSH Key is encrypted |
|---|---|---|
user | root | root |
sshkey_name | The root user's SSH key. | The root user's SSH key. |
sshkey_passphrase | (none) | The root user's SSH key passphrase. |
Many server administrators do not permit direct root logins via SSH on their servers.
- If the remote server forbids root logins, you must use another user and their password on the remote server, and then escalate to the
rootuser. For more information read OpenSSH'ssshd_configdocumentation. - If the system administrator used WHM's Manage Wheel Group Users interface (WHM >> Home >> Security Center >> Manage Wheel Group Users) to grant the user
suaccess, then you will need to specifysuand therootpassword. - If the user has
sudoaccess, you do not need therootpassword.
The following table displays the correct parameters and values for this authentication method:
| Parameter | Value if the user has sudo access | Value if the user has su access |
|---|---|---|
user | The username. | The username. |
password | The user's password. | The user's password. |
root_escalation_method | sudo | su |
root_password | (none) | The root user's password. |
You can also use an SSH public key instead of a password to authenticate that user. If the SSH public key is encrypted, include the SSH key's passphrase.
The following table displays the correct parameters and values for this authentication method:
| Parameter | sudo | su |
|---|---|---|
user | The username. | The username. |
sshkey_name | The user's SSH key. | The user's SSH key. |
sshkey_passphrase (If encrypted) | The user's SSH key passphrase. | The user's SSH key passphrase. |
root_escalation_method | sudo | su |
root_password | (none) | The root user's password. |
Security
BasicAuth
Query
The method by which the transfer system will execute commands on the remote system.
ssh— Use SSH. The function uses the remote server's indicated SSHportvalue.whostmgr— Use the remote server's secure WHM port. This will reject invalid TLS handshakes.whostmgr_insecure— Use the remote server's secure WHM port, but ignores any TLS verification failures.
Default "ssh"
Enum"ssh""whostmgr""whostmgr_insecure"
Example: comm_transport=ssh
Whether to compress data before transfer.
1— Compress.0— Do not compress.
Enum01
Example: compressed=1
Whether to transfer reseller privileges.
1— Transfer.0— Do not transfer.
Enum01
Example: copy_reseller_privs=1
Whether to use a custom pkgacct scripts on the remote server for the transfer session.
1— Use a custompkgacctscript.0— Do not use a custom script.
Enum01
Example: enable_custom_pkgacct=1
The remote server's hostname or IP address.
Example: host=192.168.0.0
Any of:
A valid IP address.
string(ipv4)
A valid IP address.
Whether to run the remote server processes at low priority in order to reduce impact on server performance.
1— Run at low priority.0— Run at high priority.
Enum01
Example: low_priority=1
The number of CPU threads to use for restore sessions.
Example: restore_threads=1
The number of CPU threads to use for transfer sessions.
Example: transfer_threads=1
Whether to not use SSL to encrypt data.
1— Do not use SSL.0— Use SSL.
Enum01
Example: unencrypted=0
Whether to skip the Restricted Restore system.
1— Skip.0— Do not skip.
Note:
If you want to pass the force parameter in the WHM API 1 enqueue_transfer_item function, you must set this parameter to a value of 0.
Enum01
Example: unrestricted_restore=1
Whether to use an existing backup instead of packaging the data again if the backup is less than 24 hours old.
1— Use an existing backup.0— Package the data.
Enum01
Example: use_backups=1
The username's password.
Note:
Use this parameter if you will authenticate to the remote server with a password. Do not use this parameter if you will authenticate to the remote server with an SSH key.
Example: password=123456luggage
The escalation method to use to connect to the remote server.
susudo
Note:
Use this parameter if the sshd_config file's PermitRootLogin value is No.
Enum"su""sudo"
Example: root_escalation_method=sudo
root's password on the remote server.
Note:
Use this parameter if the sshd_config file's PermitRootLogin value is No and you will use the root user's password to escalate access.
Example: root_password=123456luggage
The SSH key's name.
Note:
- Use this parameter if you will authenticate to the remote server with an SSH key. Do not use this parameter if you will authenticate to the remote server with a password.
- SSH keys are available in WHM's Manage root's SSH Keys interface (WHM >> Home >> Security Center >> Manage root’s SSH Keys).
Example: sshkey_name=FrancisScott
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/create_remote_root_transfer_session
- A server running WHM.
https://whm-server.tld:2087/json-api/create_remote_root_transfer_session
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/create_remote_root_transfer_session?comm_transport=ssh&compressed=1©_reseller_privs=1&enable_custom_pkgacct=1&host=192.168.0.0&low_priority=1&restore_threads=1&transfer_threads=1&unencrypted=0&unrestricted_restore=1&use_backups=1&user=root&password=123456luggage&port=22&root_escalation_method=sudo&root_password=123456luggage&sshkey_name=FrancisScott&sshkey_passphrase=kkwtoowoygidsa'Response
application/json
{ "data": { "analyze_rawout": "Fetching information from remote host: \\u201c10.1.100.35\\u201d \\u2026 \\u2026\\nDone\\nFetching information from remote host: \\u201c10.1.100.35\\u201d \\u2026 \\u2026\\nDone\\n\",", "create_rawout": "Basic credential check \\u2026 \\u2026\\nDone\\nFetching information from remote host: \\u201c10.1.100.35\\u201d \\u2026 \\u2026\\nDone\\nFetching WHM Version \\u2026\\nDone\\nTesting \\u201cvm5.docs.cpanel.net\\u201d for transfer streaming support with password authentication....<strong>Streaming Supported</strong>\\nRemote Server Type: \\u201cWHM1130\\u201d\\n\",", "transfer_session_id": "vm5docscpanelcopya20140430200606V06z" }, "metadata": { "command": "create_remote_root_transfer_session", "reason": "OK", "result": 1, "version": 1 } }
Request
This function creates a transfer session with a non-root user to a remote server.
Important:
- The source and target servers must be able to communicate over port
2087to use this feature. - The source and target servers must also be able to communicate over the port that your servers use for SSH connections.
- For more information about the ports that cPanel & WHM uses, read our How to Configure Your Firewall for cPanel & WHM Services documentation.
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.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/create_remote_user_transfer_session
- A server running WHM.
https://whm-server.tld:2087/json-api/create_remote_user_transfer_session
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/create_remote_user_transfer_session?host=hostname.example.com&password=12345luggage&unrestricted_restore=1'Response
application/json
{ "data": { "transfer_session_id": "vm5docscpanelnoroo201402251939519hmy" }, "metadata": { "command": "create_remote_user_transfer_session", "reason": "OK", "result": 1, "version": 1 } }