Return a transfer module's schema

This function retrieves a transfer module's key structure.

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.

Authorizations:
query Parameters
module
required
string

The transfer module's name.

  • AccountLocal
  • AccountRemoteRoot
  • AccountRemoteUser
  • FeaturesListRemoteRoot
  • LegacyAccountBackup
  • PackageRemoteRoot
Enum: "AccountLocal" "AccountRemoteRoot" "AccountRemoteUser" "FeaturesListRemoteRoot" "LegacyAccountBackup" "PackageRemoteRoot"
Example: module=AccountRemoteRoot

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  transfer_module_schema \
  module='AccountRemoteRoot'

Response samples

Content type
application/json
{
  • "data": {
    • "schema": {
      • "keys": {
        • "copypoint": {
          • "def": "text"
          },
        • "cpmovefile": {
          • "def": "text"
          },
        • "customip": {
          • "def": "char(255) DEFAULT NULL"
          },
        • "detected_remote_user": {
          • "def": "char(255) DEFAULT NULL"
          },
        • "disabled": {
          • "def": "text"
          },
        • "domain": {
          • "def": "char(255) DEFAULT NULL"
          },
        • "files": {
          • "def": "BIGINT UNSIGNED DEFAULT 1"
          },
        • "force": {
          • "def": "int(1) DEFAULT 0"
          },
        • "ip": {
          • "def": "int(1) DEFAULT 0"
          },
        • "live_transfer": {
          • "def": "int(1) DEFAULT 0"
          },
        • "localuser": {
          • "def": "char(255) DEFAULT NULL"
          },
        • "mail_location": {
          • "def": "char(255) DEFAULT NULL"
          },
        • "overwrite_all_dbs": {
          • "def": "int(1) DEFAULT 0"
          },
        • "overwrite_all_dbusers": {
          • "def": "int(1) DEFAULT 0"
          },
        • "overwrite_sameowner_dbs": {
          • "def": "int(1) DEFAULT 0"
          },
        • "overwrite_sameowner_dbusers": {
          • "def": "int(1) DEFAULT 0"
          },
        • "overwrite_with_delete": {
          • "def": "int(1) DEFAULT 0"
          },
        • "prerequisite_user": {
          • "def": "char(255) DEFAULT NULL"
          },
        • "priority": {
          • "def": "int(1) DEFAULT 255"
          },
        • "replaceip": {
          • "def": "char(255) DEFAULT NULL"
          },
        • "reseller": {
          • "def": "int(1) DEFAULT 0"
          },
        • "shared_mysql_server": {
          • "def": "int(1) DEFAULT 0"
          },
        • "size": {
          • "def": "BIGINT UNSIGNED DEFAULT 1"
          },
        • "skipaccount": {
          • "def": "int(1) DEFAULT 0"
          },
        • "skipacctdb": {
          • "def": "int(1) DEFAULT 0"
          },
        • "skipbwdata": {
          • "def": "int(1) DEFAULT 0"
          },
        • "skipemail": {
          • "def": "int(1) DEFAULT 0"
          },
        • "skiphomedir": {
          • "def": "int(1) DEFAULT 0"
          },
        • "skipres": {
          • "def": "int(1) DEFAULT 0"
          },
        • "skipsubdomains": {
          • "def": "int(1) DEFAULT 0"
          },
        • "user": {
          • "def": "char(255) DEFAULT NULL"
          },
        • "xferpoint": {
          • "def": "int(1) DEFAULT 0"
          }
        },
      • "primary": [
        • "user"
        ],
      • "required": [
        • "user",
        • "localuser"
        ]
      }
    },
  • "metadata": {
    • "command": "transfer_module_schema",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}