v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

File Restoration

Return cPanel accounts with backup metadata

This function lists a reseller's users that have existing backup metadata.

Note:

When you disable the File Storage role, the system disables this function.

get/Restore/get_users

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "get_users",
  "module": "Restore",
  "result": {
    "data": [
      "username"
    ],
    "metadata": {
      "transformed": 1
    },
    "status": 1
  }
}