List all remote storage.

This function retrieves data on all of the system’s cPanel-managed remote storage directories.

Important:

This function requires a high-availability license.

SecurityBasicAuth
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
object
get/PRIVATE_get_remote_storage
Request samples
whmapi1 --output=jsonpretty \
  PRIVATE_get_remote_storage
Response samples
application/json
{
  • "data": {
    • "payload": [
      • {
        • "host": "nfs.example.com",
        • "local_path": "/opt/cpanel/remote-storage-1234",
        • "options": [
          • "opt1",
          • "opt2"
          ],
        • "remote_path": "/path/on/remote/server",
        • "revision": "3",
        • "type": "nfs"
        }
      ]
    },
  • "metadata": {
    • "command": "PRIVATE_get_remote_storage",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}