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/
Request
This function retrieves the state of a transfer session.
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/get_transfer_session_state
- A server running WHM.
https://whm-server.tld:2087/json-api/get_transfer_session_state
- 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/get_transfer_session_state?transfer_session_id=exampleservercopya20140206192428NtyW'Response
application/json
{ "data": { "state_name": "TRANSFER_INPROGRESS" }, "metadata": { "command": "get_transfer_session_state", "reason": "OK", "result": 1, "version": 1 } }
Request
This function analyzes a transfer session.
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/retrieve_transfer_session_remote_analysis
- A server running WHM.
https://whm-server.tld:2087/json-api/retrieve_transfer_session_remote_analysis
- 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/retrieve_transfer_session_remote_analysis?transfer_session_id=exampleservercopya20140206192428NtyW'Response
application/json
{ "data": { "config": { … }, "items": { … }, "local": { … }, "modules": { … }, "options": { … }, "remote": { … }, "transfer_session_id": "exampleservercopya20140206192428NtyW" }, "metadata": { "command": "retrieve_transfer_session_remote_analysis", "reason": "OK", "result": 1, "version": 1 } }