openapi: 3.2.0 info: contact: email: cs@cpanel.net name: WebPros International, LLC url: https://cpanel.net/support/ description: WHM API. license: name: cPanel License url: https://cpanel.net/legal-notices/ termsOfService: https://cpanel.net/legal-notices/ title: WHM Backups API version: 11.137.9999.106 x-api-evangelist-provenance: 'Harvested verbatim from cPanel''s developer portal on 2026-09-05 via the MCP tool get-full-api-description at https://api.docs.cpanel.net/mcp. ONE mechanical change was made before storage: example values containing PEM private-key or certificate blocks, and AWS-access-key-shaped example strings, were replaced with REDACTED_* placeholders so the file can be stored in a public git repository without tripping secret scanning. No path, operation, parameter, schema or description was altered, added or removed.' servers: - description: A server running WHM. url: https://{host}:{port}/json-api variables: host: default: whm-server.tld description: The hostname of a server running WHM. port: default: '2087' description: The WHM port. security: - BasicAuth: [] tags: - description: The Backups module for WHM API 1. name: Backups paths: /backup_config_get: get: description: This function retrieves your backup destination configuration file data. operationId: Backup-backup_config_get parameters: [] responses: '200': content: application/json: schema: properties: data: properties: backup_config: description: A list of backup configuration data. properties: backup_daily_enable: description: 'Whether daily backups are enabled. * `1` — Enabled. * `0` — Disabled.' enum: - 0 - 1 example: 1 type: integer backup_daily_retention: description: The number of retained daily backups. example: 5 minimum: 1 type: integer backup_monthly_dates: description: A comma-seprated list of the days of the month on which the system runs monthly backups. example: 1,15,22 type: string backup_monthly_enable: description: 'Whether monthly backups are enabled. * `1` — Enabled. * `0` — Disabled.' enum: - 0 - 1 example: 0 type: integer backup_monthly_retention: description: The number of retained monthly backups. example: 5 minimum: 1 type: integer backup_weekly_day: description: 'The day of the week on which the system runs weekly backups. * `0` — Sunday. * `1` — Monday. * `2` — Tuesday. * `3` — Wednesday. * `4` — Thursday. * `5` — Friday. * `6` — Saturday.' example: 1,3,5 type: string backup_weekly_enable: description: 'Whether weekly backups are enabled. * `1` — Enable. * `0` — Disable.' enum: - 0 - 1 example: 0 type: integer backup_weekly_retention: description: The number of retained weekly backups. example: 4 minimum: 1 type: integer backupaccts: description: 'Whether to back up accounts. * `1` — Back up. * `0` — Do **not** back up. **Note:** This setting affects whether the system enables the *File and Directory Restoration* interface in cPanel & WHM. For more information, read the [How to Manage Metadata Settings](https://go.cpanel.net/MetadataSettings) documentation.' enum: - 1 - 0 example: 1 type: integer backupbwdata: description: 'Whether bandwidth tracking data backups are enabled. * `1` — Enabled. * `0` — Disabled.' enum: - 0 - 1 example: 1 type: integer backupdays: description: 'The days of the week on which the system runs daily backups. * `0` — Sunday. * `1` — Monday. * `2` — Tuesday. * `3` — Wednesday. * `4` — Thursday. * `5` — Friday. * `6` — Saturday.' example: 0,2,4,6 type: string backupdir: description: The aboslute file path to the server's local backup directory. example: /backup type: string backupenable: description: 'Whether backups are enabled. * `1` — Enabled. * `0` — Disabled.' enum: - 1 - 0 example: 1 type: integer backupfiles: description: 'Whether system file backups are enabled. * `1` — Enabled. * `0` — Disabled.' enum: - 0 - 1 example: 1 type: integer backuplogs: description: 'Whether error log backups are enabled. * `1` — Enabled. * `0` — Disabled.' enum: - 0 - 1 example: 0 type: integer backupmount: description: 'Whether the system mounts backup partitions as part of the backup process. * `1` — Mounted. * `0` — **Not** mounted. **Note:** This setting affects whether the system enables the *File and Directory Restoration* interface in cPanel & WHM. For more information, read the [How to Manage Metadata Settings](https://go.cpanel.net/MetadataSettings) documentation.' enum: - 0 - 1 example: 0 type: integer backupsuspendedaccounts: description: 'Whether suspended account backups are enabled. * `1` — Enabled. * `0` — Disabled.' enum: - 0 - 1 example: 0 type: integer backuptype: description: 'The type of backup file the system creates. * `compressed` — A compressed `.tar` file. * `uncompressed` — An uncompressed `.tar` file. * `incremental` — A full tree of files and directories.' enum: - compressed - uncompressed - incremental example: compressed type: string check_min_free_space: description: 'Whether the system performs a check of the minimum free disk space available on the destination server. * `1` — Check the free disk space on the destination server. * `0` — Do **not** check the free disk space on the destination server.' enum: - 0 - 1 example: 1 type: integer disable_metadata: description: 'Whether the backup system creates metadata when a backup runs. * `1` — Disables metadata creation. * `0` — Enables metadata creation.' enum: - 1 - 0 example: 0 type: integer errorthreshhold: description: The number of times that the system attempts to use the additional backup destination. example: 3 minimum: 1 type: integer force_prune_daily: description: 'Whether the `backup_daily_retention` parameter is strictly enforced. * `1` — Enforced. * `0` — The system **only** enforces the `backup_daily_retention` setting after a backup successfully completes.' enum: - 0 - 1 example: 0 type: integer force_prune_monthly: description: 'Whether the `backup_monthly_retention` parameter is strictly enforced. * `1` — Enforced. * `0` — The system **only** enforces the `backup_monthly_retention` setting after a backup successfully completes.' enum: - 0 - 1 example: 0 type: integer force_prune_weekly: description: 'Whether the `backup_weekly_retention` parameter is strictly enforced. * `1` — Enforced. * `0` — The system **only** enforces the `backup_weekly_retention` setting after a backup successfully completes.' enum: - 0 - 1 example: 0 type: integer gziprsyncopts: description: The environment variables passed to the `gzip` application. The system uses these variables to adjust how the `gzip` application runs when compressing backups. example: --rysncable type: string keeplocal: description: 'Whether the system deletes backups from the local directory. * `1` — The system does not delete backups from the local backup directory. * `0` — The system **deletes** backups from the local directory. **Note:** The `backupdir` return value contains the local backup directory.' enum: - 0 - 1 example: 1 type: integer linkdest: description: 'Whether the system checks the `rsync` function for hardlink support. * `1` — Enabled. * `0` — Disabled.' enum: - 0 - 1 example: 0 type: integer localzonesonly: description: 'Whether the system uses a local zone file from the `dnsadmin` daemon or `/var/named/domain.tld` file, where `domain.tld` is the target domain. * `1` — The system uses the `/var/named/domain.tld` file. * `0` — The system uses the `dnsadmin` daemon.' enum: - 0 - 1 example: 0 type: integer maximum_restore_timeout: description: The maximum interval, in seconds, that the restoration attempts a run to completion. If the restoration takes longer than this interval, the system terminates the restoration. example: 21600 minimum: 1 type: integer maximum_timeout: description: The maximum interval, in seconds, that the backup attempts a run to completion. If the backup takes longer than this interval, the system terminates the backup. example: 7200 minimum: 1 type: integer min_free_space: description: The minimum amount of free disk space the system checks for on the destination server before attempting a backup to that server. example: 1024 minimum: 1 type: integer min_free_space_unit: description: 'The unit of measure of disk space for the `min_free_space` return. * `MB` — Megabytes. * `percent` — Percentages.' enum: - MB - percent example: MB type: string mysqlbackup: description: 'The method that the system uses to back up MySQL® databases. * `accounts` — Backs up databases into each account''s archive. * `dir` — Backs up the entire MySQL directory. * `both` — Back up databases into each account''s archive **and** the entire MySQL directory.' example: accounts type: string postbackup: description: 'Whether the `/usr/local/cpanel/scripts/postcpbackup` script runs after the backup completes. * `1` — Enabled. * `0` — Disabled.' enum: - 0 - 1 example: 0 type: integer prebackup: description: 'Whether the `/usr/local/cpanel/scripts/precpbackup` script runs before the system processes backups. * `1` — Enabled. * `0` — Disabled.' enum: - 0 - 1 example: 1 type: integer psqlbackup: description: 'Whether backups of PostgreSQL® databases are enabled. * `1` — Enabled. * `0` — Disabled.' enum: - 0 - 1 example: 0 type: integer remote_restore_staging_dir: description: 'The directory on the local server where the system temporarily stores a remote server''s backup file during a backup restoration.' example: /backup type: string type: object type: object metadata: properties: command: description: The method name called. example: backup_config_get type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return backup configuration file data tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n backup_config_get\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/backup_config_get?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.38' /backup_config_set: get: description: This function configures a server's backup system. The system saves these settings in the `/var/cpanel/backups/config` file. operationId: Backup-backup_config_set parameters: - description: 'Whether to enable daily backups. * `1` — Enable. * `0` — Disable.' in: query name: backup_daily_enable required: false schema: default: 1 enum: - 0 - 1 example: 1 type: integer - description: The number of daily backups to retain. in: query name: backup_daily_retention required: false schema: default: 5 example: 5 minimum: 0 type: integer - description: 'Which days of the month to run backups. **Note:** To add multiple days, use a comma-delimited list.' in: query name: backup_monthly_dates required: false schema: default: 1 example: 1 maximum: 31 minimum: 1 type: integer - description: 'Whether to enable monthly backups. * `1` — Enable. * `0` — Disable.' in: query name: backup_monthly_enable required: false schema: default: 0 enum: - 0 - 1 example: 0 type: integer - description: The number of monthly backups to retain. in: query name: backup_monthly_retention required: false schema: default: 1 example: 5 minimum: 0 type: integer - description: 'Which day of the week to run weekly backups. * `0` — Sunday. * `1` — Monday. * `2` — Tuesday. * `3` — Wednesday. * `4` — Thursday. * `5` — Friday. * `6` — Saturday.' in: query name: backup_weekly_day required: false schema: default: 0 example: 1 maximum: 6 minimum: 1 type: integer - description: 'Whether to enable weekly backups. * `1` — Enable. * `0` — Disable.' in: query name: backup_weekly_enable required: false schema: default: 0 enum: - 0 - 1 example: 0 type: integer - description: The number of weekly backups to retain. in: query name: backup_weekly_retention required: false schema: default: 4 example: 4 minimum: 0 type: integer - description: 'Whether to back up cPanel user accounts. * `1` — Back up. * `0` — Do **not** back up. **Note:** This setting affects whether the system enables the *File and Directory Restoration* interfaces in [cPanel](https://docs.cpanel.net/cpanel/files/file-and-directory-restoration-for-cpanel/) and in [WHM](https://docs.cpanel.net/whm/backup/file-and-directory-restoration-for-whm/). For more information, read the [How to Manage Metadata Settings](https://docs.cpanel.net/knowledge-base/backup/how-to-manage-metadata-settings/) documentation.' in: query name: backupaccts required: false schema: default: 1 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to back up bandwidth tracking data. * `1` — Back up. * `0` — Do **not** back up.' in: query name: backupbwdata required: false schema: default: 1 enum: - 0 - 1 example: 1 type: integer - description: 'Which days of the week to run daily backups. * `0` — Sunday. * `1` — Monday. * `2` — Tuesday. * `3` — Wednesday. * `4` — Thursday. * `5` — Friday. * `6` — Saturday. **Note:** For multiple days, use a comma-delimited list.' in: query name: backupdays required: false schema: default: 0,2,4,6 example: 0,1,2,3,4,5,6 maximum: 6 minimum: 0 type: string - description: The primary backup directory. in: query name: backupdir required: false schema: default: /backup example: /backup type: string - description: 'Whether to enable backups. * `1` — Enable. * `0` — Disable. **Note:** This setting affects whether the system enables the *File and Directory Restoration* interfaces in [cPanel](https://docs.cpanel.net/cpanel/files/file-and-directory-restoration-for-cpanel/) and in [WHM](https://docs.cpanel.net/whm/backup/file-and-directory-restoration-for-whm/). For more information, read the [How to Manage Metadata Settings](https://docs.cpanel.net/knowledge-base/backup/how-to-manage-metadata-settings/) documentation.' in: query name: backupenable required: false schema: default: 0 enum: - 0 - 1 example: 0 type: integer - description: 'Whether to back up system files. * `1` — Back up. * `0` — Do **not** back up.' in: query name: backupfiles required: false schema: default: 1 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to back up the error logs. * `1` — Back up. * `0` — Do **not** back up.' in: query name: backuplogs required: false schema: default: 0 enum: - 0 - 1 example: 0 type: integer - description: 'Whether to mount a backup partition. * `1` — Mount. * `0` — Do **not** mount. **Note:** This setting affects whether the system enables the *File and Directory Restoration* interfaces in [cPanel](https://docs.cpanel.net/cpanel/files/file-and-directory-restoration-for-cpanel/) and in [WHM](https://docs.cpanel.net/whm/backup/file-and-directory-restoration-for-whm/). For more information, read the [How to Manage Metadata Settings](https://docs.cpanel.net/knowledge-base/backup/how-to-manage-metadata-settings/) documentation.' in: query name: backupmount required: false schema: default: 0 enum: - 0 - 1 example: 0 type: integer - description: 'Whether to back up suspended accounts. * `1` — Back up. * `0` — Do **not** back up.' in: query name: backupsuspendedaccts required: false schema: default: 0 enum: - 0 - 1 example: 0 type: integer - description: 'The type of backup to create. * `compressed` * `uncompressed` * `incremental`' in: query name: backuptype required: false schema: default: compressed enum: - compressed - uncompressed - incremental example: compressed type: string - description: 'Whether to ensure that the destination server possesses the minimum free disk space available. * `1` — Check the free disk space on the destination server. * `0` — Do **not** check the free disk space on the destination server.' in: query name: check_min_free_space required: false schema: default: 1 enum: - 0 - 1 example: 1 type: integer - description: 'Whether the backup system will create metadata when a backup runs. * `1` — Disable metadata creation. * `0` — Enable metadata creation. **Note:** This setting affects whether the system enables the *File and Directory Restoration* interfaces in [cPanel](https://docs.cpanel.net/cpanel/files/file-and-directory-restoration-for-cpanel/) and in [WHM](https://docs.cpanel.net/whm/backup/file-and-directory-restoration-for-whm/). For more information, read the [How to Manage Metadata Settings](https://docs.cpanel.net/knowledge-base/backup/how-to-manage-metadata-settings/) documentation.' in: query name: disable_metadata required: false schema: default: 0 enum: - 0 - 1 example: 0 type: integer - description: The number of times that the system will try to use the additional backup destination. in: query name: errorthreshhold required: false schema: default: 3 example: 3 minimum: 0 type: integer - description: 'Whether to strictly enforce the value of the `backup_daily_retention` parameter. * `1` — Strictly enforce the `backup_daily_retention` parameter. * `0` — Only enforce the `backup_daily_retention` parameter **after** a successful complete backup.' in: query name: force_prune_daily required: false schema: default: 0 enum: - 0 - 1 example: 0 type: integer - description: 'Whether to strictly enforce the value of the `backup_monthly_retention` parameter. * `1` — Strictly enforce the `backup_monthly_retention` parameter. * `0` — Only enforce the `backup_monthly_retention` parameter **after** a successful complete backup.' in: query name: force_prune_monthly required: false schema: default: 0 enum: - 0 - 1 example: 0 type: integer - description: 'Whether to strictly enforce the value of the `backup_weekly_retention` parameter. * `1` — Strictly enforce the `backup_weekly_retention` parameter. * `0` — Only enforce the `backup_weekly_retention` parameter **after** a successful complete backup.' in: query name: force_prune_weekly required: false schema: default: 0 enum: - 0 - 1 example: 0 type: integer - description: The `gzip` environment variables. in: query name: gziprsyncopts required: false schema: default: '' example: --rysncable type: string - description: 'Whether to delete backups from the local directory. * `1` — Delete. * `0` — Do **not** delete. **Note:** This setting affects whether the system enables the *File and Directory Restoration* interfaces in [cPanel](https://docs.cpanel.net/cpanel/files/file-and-directory-restoration-for-cpanel/) and in [WHM](https://docs.cpanel.net/whm/backup/file-and-directory-restoration-for-whm/). For more information, read the [How to Manage Metadata Settings](https://docs.cpanel.net/knowledge-base/backup/how-to-manage-metadata-settings/) documentation.' in: query name: keeplocal required: false schema: default: 1 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to check the `rsync` function for hardlink support. * `1` — Check. * `0` — Do **not** check.' in: query name: linkdest required: false schema: default: 0 enum: - 0 - 1 example: 0 type: integer - description: 'Whether to use a local zone file from the `/var/named/domain.tld` file or the `dnsadmin` daemon, where `domain.tld` represents the target domain. * `1` — Use the `/var/named/domain.tld` file. * `0` — Use `dnsadmin`.' in: query name: localzonesonly required: false schema: default: 0 enum: - 0 - 1 example: 0 type: integer - description: How long a restoration will attempt to run, in seconds. If the restoration does not succeed in this amount of time, it will stop. in: query name: maximum_restore_timeout required: false schema: default: 21600 example: 21600 minimum: 0 type: integer - description: How long a backup will attempt to run, in seconds. If the backup does not succeed in this amount of time, it will stop. in: query name: maximum_timeout required: false schema: default: 7200 example: 7200 minimum: 0 type: integer - description: 'The minimum amount of free disk to check for on the destination server. **Note:** If the value of the `min_free_space_unit` parameter is `percent`, the maximum value is `100`.' in: query name: min_free_space required: false schema: default: 5 example: 1024 minimum: 0 type: integer - description: 'The units of measurement of disk space for the `min_free_space` return. * `MB` — Megabytes. * `percent` — Percent available.' in: query name: min_free_space_unit required: false schema: default: percent enum: - MB - percent example: MB type: string - description: 'The backup method to use for MySQL® databases. * `accounts` — Back up databases in each account''s archive. * `dir` — Back up the entire MySQL directory. * `both` — Back up databases in each account''s archive and the entire MySQL directory.' in: query name: mysqlbackup required: false schema: default: accounts enum: - accounts - dir - both example: accounts type: string - description: 'Whether to run the `/usr/local/cpanel/scripts/postcpbackup` script after the backup finishes. * `1` — Run. * `0` — Do **not** run.' in: query name: postbackup required: false schema: default: 0 enum: - 0 - 1 example: 0 type: integer - description: 'Whether to run the `/usr/local/cpanel/scripts/precpbackup` script before the system processes backups. * `1` — Run. * `0` — Do **not** run.' in: query name: prebackup required: false schema: default: 1 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to back up PostgreSQL® databases. * `1` — Back up. * `0` — Do **not** back up.' in: query name: psqlbackup required: false schema: default: 0 enum: - 0 - 1 example: 0 type: integer - description: 'The directory that temporarily stores a remote backup''s data during a backup restoration. The data is a compressed (`.tar.gz`) or uncompressed (`.tar`) account tarball. **Important:** The system restores backups one at a time. The backup staging directory **must** be large enough to contain the largest remote backup file that you wish to restore. For example, if you wish to restore three backups, sized 1.5 GB, 528 MB, and 950 MB each, your backup staging directory must be able to hold at **least** 1.5 GB. **Note:** The system empties the directory after the system restores the backup.' in: query name: remote_restore_staging_dir required: false schema: example: /backup type: string responses: '200': content: application/json: schema: properties: metadata: properties: command: description: The method name called. example: backup_config_set type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Update the system's backup configuration tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n backup_config_set\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/backup_config_set?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.38' /backup_date_list: get: description: This function lists the dates where backup file exists, whether stored locally or stored on remote backup destinations when local backups are disabled. operationId: Backup-backup_date_list parameters: [] responses: '200': content: application/json: schema: properties: data: properties: backup_set: description: A list of dates containing the backup files. example: - '2019-02-12T00:00:00.000Z' - '2019-02-12T00:00:00.000Z' - '2019-02-12T00:00:00.000Z' items: format: ISO-8601 Date type: string type: array type: object metadata: properties: command: description: The method name called. example: backup_date_list type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return dates where backup files exist tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n backup_date_list\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/backup_date_list?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.38' /backup_destination_add: get: description: This function adds a backup destination. operationId: Backup-backup_destination_add parameters: - description: 'The application key''s name. **Note:** This parameter is only valid for the `Backblaze` backup type.' in: query name: application_key required: true schema: example: A123b45CD678e9 type: string - description: 'The application key ID that authenticates the Backblaze B2 account. **Note:** This parameter is only valid for the `Backblaze` backup type.' in: query name: application_key_id required: true schema: example: 12a345B678c9 type: string - description: 'The authorization type. * `password` * `key` **Note:** This parameter is only valid for the following backup types: * `SFTP` * `Rsync`' in: query name: authtype required: true schema: enum: - password - key example: password type: string - description: 'The Amazon S3™ Access Key ID. **Note:** This parameter is only valid for the following backup types: * `AmazonS3` * `S3Compatible`' in: query name: aws_access_key_id required: true schema: example: REDACTED_AWS_ACCESS_KEY_ID type: string - description: 'The Amazon S3™ bucket. **Note:** This parameter is only valid for the following backup types: * `AmazonS3` * `S3Compatible`' in: query name: bucket required: true schema: example: ChockFullOfNuts type: string - description: 'The bucket''s ID string. **Note:** This parameter is only valid for the `Backblaze` backup type.' in: query name: bucket_id required: true schema: example: a12b34cd5678e9f type: string - description: 'The bucket''s name. **Note:** This parameter is only valid for the `Backblaze` backup type.' in: query name: bucket_name required: true schema: example: ChockFullOfNuts type: string - description: 'The Google Drive client ID. **Note:** This parameter is only valid for the `GoogleDrive` backup type.' in: query name: client_id required: true schema: example: aBcdeFgHIjK123 type: string - description: 'The Google Drive client secret. **Note:** This parameter is only valid for the `GoogleDrive` backup type.' in: query name: client_secret required: true schema: example: aBcde123FgHIjK456 type: string - description: 'Whether to disable the backup destination. * `1` — Disable the backup destination. * `0` — Enable the backup destination.' in: query name: disabled required: true schema: enum: - 0 - 1 example: 0 type: integer - description: 'The remote server''s hostname. **Note:** This parameter is only valid for the following backup types: * `Custom` * `FTP` * `SFTP` * `Rsync` * `WebDAV` * `S3Compatible`' in: query name: host required: true schema: example: backups.example.com format: hostname type: string - description: The backup destination's name. in: query name: name required: true schema: example: destination_name type: string - description: 'The remote server account''s password or secret access key. **Note:** This parameter is only valid for the following backup types: * `AmazonS3` * `Custom` * `FTP` * `SFTP` * `Rsync` * `WebDAV` * `S3Compatible`' in: query name: password required: true schema: example: 123456luggage type: string - description: 'The absolute file path to the user-supplied transport solution script. **Note:** This parameter is only valid for the `Custom` backup type.' in: query name: script required: true schema: example: /home/backups/beammeupscotty.pl type: string - description: 'The type of backup destination. * `Custom` * `FTP` * `Local` * `SFTP` * `WebDAV` * `AmazonS3` * `Rsync` * `GoogleDrive` * `S3Compatible` * `Backblaze` **Note:** This value determines which parameters you can use with the function. **Warning:** Use any of these encrypted connections to transfer system backup files: * Amazon S3™ * Backblaze * GoogleDrive * Rsync * S3 Compatible * SFTP * WebDAV with SSL enabled' in: query name: type required: true schema: enum: - Custom - FTP - Local - SFTP - WebDAV - AmazonS3 - Rsync - GoogleDrive - S3Compatible - Backblaze example: Local type: string - description: 'The remote server account''s username. **Note:** This parameter is only valid for the following backup types: * `Custom` * `FTP` * `SFTP` * `Rsync` * `WebDAV`' in: query name: username required: true schema: example: username format: username type: string - description: 'The path to the backups directory on the remote server. **Note:** This parameter is only valid for the following backup types: * `AmazonS3` * `GoogleDrive` * `S3Compatible`' in: query name: folder required: false schema: default: '' example: subfolder type: string - description: 'Whether the path is mounted. * `1` — The path is mounted. * `0` — The path is **not** mounted. **Note:** This parameter is only valid for the `Local` backup type.' in: query name: mount required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to fail the backup attempt if the mount fails. * `1` — Fail the backup attempt. * `0` — Do **not** fail the backup attempt. **Note:** This parameter is only valid for the `Local` backup type.' in: query name: no_mount_fail required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to use this transport only for logs. * `1` — This destination will be skipped for regular backups. * `0` — Both log and regular backups will be uploaded. This setting defaults to 0. The only time log files get their own backup is via scripts/remote_log_transfer' in: query name: only_used_for_logs required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to use passive FTP. * `1` — Use passive FTP. * `0` — Use active FTP. **Note:** This parameter is only valid for the `FTP` backup type.' in: query name: passive required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'The private key file''s passphrase, if the `authtype` parameter is the `key` value. **Note:** This parameter is only valid for the following backup types: * `SFTP` * `Rsync`' in: query name: passphrase required: false schema: default: null example: 123456luggage type: string - description: 'The path to the backups directory on the remote server. * This parameter is **required** for the `Local` backup type. * If you do **not** use this parameter, the system will not set a value. **Note:** This parameter is only valid for the following backup types: * `Backblaze` * `Custom` * `Local` * `FTP` * `SFTP` * `Rsync` * `WebDAV`' in: query name: path required: false schema: default: null example: backups type: string - description: "The TCP port to use.\n\n**Note:**\n\n* This parameter defaults to the standard port used by the queried backup `type` parameter.\n* This parameter is only valid for the following backup types:\n * `FTP`\n * `SFTP`\n * `Rsync`\n * `WebDAV`" in: query name: port required: false schema: example: 21 maximum: 65535 minimum: 1 type: integer - description: 'The file path to the private key file, if the `authtype` parameter is the `key` value. **Note:** This parameter is only valid for the following backup types: * `SFTP` * `Rsync`' in: query name: privatekey required: false schema: default: null example: /home/backups/key type: string - description: 'Whether to use SSL. * `1` — Use SSL. * `0` — Do **not** use SSL. **Note:** This parameter is only valid for the `WebDAV` backup type.' in: query name: ssl required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'The session timeout, measured in seconds. **Note:** * This parameter is **not** valid for the `Local` backup `type` parameter. * The default value depends on the `type` parameter''s value.' in: query name: timeout required: false schema: example: 30 type: integer - description: 'Whether to upload system backups. * `1` — Upload system backups. * `0` — Do **not** upload system backups.' in: query name: upload_system_backup required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer responses: '200': content: application/json: schema: properties: data: properties: id: description: The backup destination's ID. example: PhAxIoLSdIkCI40q9vWS4BYy type: string type: object metadata: properties: command: description: The method name called. example: backup_destination_add type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Add a backup destination tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n backup_destination_add \\\n name='destination_name' \\\n type='Local' \\\n disabled='0' \\\n bucket='ChockFullOfNuts' \\\n aws_access_key_id='REDACTED_AWS_ACCESS_KEY_ID' \\\n password='123456luggage' \\\n application_key='A123b45CD678e9' \\\n application_key_id='12a345B678c9' \\\n bucket_id='a12b34cd5678e9f' \\\n bucket_name='ChockFullOfNuts' \\\n script='/home/backups/beammeupscotty.pl' \\\n host='backups.example.com' \\\n username='username' \\\n client_id='aBcdeFgHIjK123' \\\n client_secret='aBcde123FgHIjK456' \\\n authtype='password'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/backup_destination_add?api.version=1&name=destination_name&type=Local&disabled=0&bucket=ChockFullOfNuts&aws_access_key_id=REDACTED_AWS_ACCESS_KEY_ID&password=123456luggage&application_key=A123b45CD678e9&application_key_id=12a345B678c9&bucket_id=a12b34cd5678e9f&bucket_name=ChockFullOfNuts&script=%2fhome%2fbackups%2fbeammeupscotty.pl&host=backups.example.com&username=username&client_id=aBcdeFgHIjK123&client_secret=aBcde123FgHIjK456&authtype=password x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.38' /backup_destination_delete: get: description: This function removes a backup destination from the backup configuration file. operationId: Backup-backup_destination_delete parameters: - description: The destination's ID. in: query name: id required: true schema: example: '11111111' type: string responses: '200': content: application/json: schema: properties: metadata: properties: command: description: The method name called. example: backup_destination_delete type: string reason: description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Delete a backup destination tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n backup_destination_delete \\\n id='11111111'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/backup_destination_delete?api.version=1&id=11111111 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.38' /backup_destination_get: get: description: Use this function to obtain a backup destination's settings. operationId: Backup-backup_destination_get parameters: - description: The backup destination's ID. in: query name: id required: true schema: example: 0W1ei2rd3A4lI5sT6he7Be8st type: string responses: '200': content: application/json: examples: amazons3: summary: type=AmazonS3 value: data: aws_access_key_id: access-key-id bucket: s3-bucket-brigade disabled: 0 folder: '' id: Sr1ThYOnnBIXUupTcSBYQywk name: Amazon S3 timeout: 30 type: AmazonS3 upload_system_backup: 0 metadata: command: backup_destination_get reason: OK result: 1 version: 1 backblaze: summary: type=BackBlaze value: data: application_key: keyS3cret application_key_id: appID bucket_id: backblaze-bucket-id bucket_name: backblaze-bucket-name disabled: 0 id: c85HdhrAkpiqumuXylEzrOcb name: BackBlaze path: '' timeout: 180 type: Backblaze upload_system_backup: 0 metadata: command: backup_destination_get reason: OK result: 1 version: 1 custom: summary: type=Custom value: data: disabled: 0 host: example.com id: Hhd85FsIxbxsLneBMNw1Dmdp name: destination unknown path: '' script: /bin/bacula_start timeout: 30 type: Custom upload_system_backup: 0 username: scott_bacula metadata: command: backup_destination_get reason: OK result: 1 version: 1 ftp: summary: type=FTP value: data: disabled: 0 host: example.com id: YXzdB0ZcPZ8daPvRfobqQh6H name: FTP backups passive: 1 path: '' port: 21 timeout: 30 type: FTP upload_system_backup: 0 username: backup_daemon metadata: command: backup_destination_get reason: OK result: 1 version: 1 google: summary: type=GoogleDrive value: data: client_id: CientID client_secret: backups3crets disabled: 0 folder: '' id: N9jC0iMGNbDwIph7m0MfkDd4 name: Googlyness timeout: 30 type: GoogleDrive upload_system_backup: 0 metadata: command: backup_destination_get reason: OK result: 1 version: 1 local: summary: type=Local value: data: disabled: 0 id: SenJqhJKEEE3rPM4XO7dfBaj mount: 0 name: additional local no_mount_fail: 0 path: /backup type: Local upload_system_backup: 0 metadata: command: backup_destination_get reason: OK result: 1 version: 1 rsync: summary: type=Rsync value: data: authtype: password disabled: 0 host: example.com id: xOL7IT7cwJhGYYra09hrPU1r name: rsync path: '' port: 22 timeout: 30 type: Rsync upload_system_backup: 0 username: scott_bacula metadata: command: backup_destination_get reason: OK result: 1 version: 1 s3compatable: summary: type=S3Compatable value: data: aws_access_key_id: 563DFGHCVD bucket: thepail disabled: 0 folder: '' host: osdc.rcc.example.com id: 68UUM_lypmgTi9_fEaG9MIvY name: s3Compatable timeout: 30 type: S3Compatible upload_system_backup: 0 metadata: command: backup_destination_get reason: OK result: 1 version: 1 sftp: summary: type=SFTP value: data: authtype: key disabled: 0 host: example.com id: OD5CeyEbHMEmDe0dqhtO3KYl name: SFTPBACKUP path: '' port: 22 privatekey: /root/.ssh/the_rsa timeout: 30 type: SFTP upload_system_backup: 0 username: scott_bacula metadata: command: backup_destination_get reason: OK result: 1 version: 1 webdav: summary: type=WebDAV value: data: disabled: 0 host: example.com id: ZlSBGjZEr3HVIqhqsdVgWYOM name: WebDav path: '' port: 8443 ssl: 1 timeout: 30 type: WebDAV upload_system_backup: 0 username: scot_bacula metadata: command: backup_destination_get reason: OK result: 1 version: 1 schema: properties: data: $ref: '#/components/schemas/BackupDestinationGetResponse' metadata: properties: command: description: The method name called. example: backup_destination_get type: string reason: description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success * `0` - Failed: Check the reason field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return a backup destination's settings tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n backup_destination_get \\\n id='0W1ei2rd3A4lI5sT6he7Be8st'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/backup_destination_get?api.version=1&id=0W1ei2rd3A4lI5sT6he7Be8st x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.38' /backup_destination_list: get: description: This function lists backup destinations. operationId: Backup-backup_destination_list parameters: [] responses: '200': content: application/json: schema: properties: data: properties: destination_list: description: An array of objects containing backup destination information. items: $ref: '#/components/schemas/BackupDestinationResponseType' type: array type: object metadata: properties: command: description: The method name called. example: backup_destination_list type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success. * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return a list of backup destinations tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n backup_destination_list\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/backup_destination_list?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.38' /backup_destination_set: post: description: Use this function to edit a backup destination's settings. operationId: Backup-backup_destination_set requestBody: content: application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/BackupDestinationSetParameterType' description: The destination settings. required: true responses: '200': content: application/json: schema: properties: metadata: properties: command: description: The method name called. example: backup_destination_set type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Update backup destination settings tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --input=json --output=jsonpretty \\\n backup_destination_set\n" - label: HTTP Request (Wire Format) lang: HTTP source: 'POST /cpsess##########/json-api/backup_destination_set HTTP/1.1 Host: example.com:2083 Cookie: ################################### Content-Type: application/json Content-Length: 0 ' x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.38' /backup_destination_validate: get: description: This function validates a backup destination. operationId: Backup-backup_destination_validate parameters: - description: 'Whether to disable the backup destination if validation fails. * `1` — Disable. * `0` — Do **not** disable.' in: query name: disableonfail required: true schema: enum: - 0 - 1 example: 1 type: integer - description: The destination's ID. in: query name: id required: true schema: example: 0W1ei2rd3A4lI5sT6he7Be8st type: string responses: '200': content: application/json: schema: properties: data: properties: id: description: The destination's ID. example: 0W1ei2rd3A4lI5sT6he7Be8st type: string type: object metadata: properties: command: description: The method name called. example: backup_destination_validate type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Validate a backup destination tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n backup_destination_validate \\\n id='0W1ei2rd3A4lI5sT6he7Be8st' \\\n disableonfail='1'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/backup_destination_validate?api.version=1&id=0W1ei2rd3A4lI5sT6he7Be8st&disableonfail=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.38' /backup_does_client_id_have_google_credentials: get: description: This function returns whether a Google Drive™ client ID credential file exists. operationId: Backup-backup_does_client_id_have_google_credentials parameters: - description: The user's Google Drive client ID. in: query name: client_id required: true schema: example: aBcdeFgHIjK123 type: string responses: '200': content: application/json: schema: properties: data: properties: exists: description: 'Whether Google credentials exist for the Google Drive client ID. * `1` — Google Drive credentials exist. * `0` — Google Drive credentials do **not** exist.' enum: - 0 - 1 example: 1 type: integer type: object metadata: properties: command: description: The method name called. example: backup_does_client_id_have_google_credentials type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return Google Drive™ client ID credentials tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n backup_does_client_id_have_google_credentials \\\n client_id='aBcdeFgHIjK123'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/backup_does_client_id_have_google_credentials?api.version=1&client_id=aBcdeFgHIjK123 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '68' /backup_generate_google_oauth_uri: get: description: 'This function generates a Google Drive™ OAuth redirect URI.' operationId: Backup-backup_generate_google_oauth_uri parameters: - description: The Google Drive client ID. in: query name: client_id required: true schema: example: aBcdeFgHIjK123 type: string - description: 'The Google Drive [client secret](https://www.oauth.com/oauth2-servers/client-registration/client-id-secret/).' in: query name: client_secret required: true schema: example: aBcde123FgHIjK456 type: string responses: '200': content: application/json: schema: properties: data: properties: uri: description: The generated Google Drive OAuth redirect URI. example: https://accounts.google.com/o/oauth2/auth?client_id=aBcdeFgHIjK123&response_type=code&redirect_uri=https%3A%2F%2Fhost-10-0-0-2.example.tld%3A2087%2Fgoogledriveauth%2Fcallback&scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fdrive.file&access_type=offline&prompt=consent&state=IkdLqOej5CLPW1nHRF6OJYaahE7HPXrRUvpFs6MhmBMbCjvWDQcstyYhbUFge5IJ format: uri type: string type: object metadata: properties: command: description: The method name called. example: backup_generate_google_oauth_uri type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Create Google Drive™ OAuth redirect URI tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n backup_generate_google_oauth_uri \\\n client_id='aBcdeFgHIjK123' \\\n client_secret='aBcde123FgHIjK456'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/backup_generate_google_oauth_uri?api.version=1&client_id=aBcdeFgHIjK123&client_secret=aBcde123FgHIjK456 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '68' /backup_get_transport_status: get: description: This function retrieves the status of any backup transport events on the account. operationId: Backup-backup_get_transport_status parameters: - description: 'That transport''s current state. If you do **not** specify this parameter, the function returns the status of **all** transports on the account. * `completed` * `failed` * `pending` * `running`' in: query name: state required: false schema: enum: - completed - failed - pending - running example: running type: string - description: 'The transport''s identification (ID). If you do **not** specify this parameter, the function returns **all** transports on the account. **Note:** You can use this parameter or the `transport_name` parameter.' in: query name: transport_id required: false schema: example: transportname type: string responses: '200': content: application/json: schema: properties: data: properties: pages: description: 'The number of pages that the backup transports contain. **Note:** This return''s value depends on the [pagination variables](https://go.cpanel.net/paginationvariables) that you pass when you call the function.' example: 3 type: integer transport_status: description: A list of information about each transport event. items: properties: date: description: The backup transport event's date. example: '2019-08-30T00:00:00.000Z' format: ISO-8601 Date type: string end_timestamp: description: The transport event's end time, in `YYYY-MM-DD HH:MM:SS` format. example: '2019-08-30T02:04:06.000Z' type: string start_timestamp: description: The transport event's start time, in `YYYY-MM-DD HH:MM:SS` format. example: '2019-08-30T02:04:08.000Z' type: string status: description: 'The transport event''s status. * `completed` * `failed` * `pending` * `running`' example: running type: string transport: description: 'The transport event''s name. **Note:** If multiple transports use the same name, the system returns the first instance of the transport with that name.' example: transportname type: string user: description: The user for whom the system transported the backup. example: username type: string type: array type: object metadata: properties: command: description: The method name called. example: backup_get_transport_status type: string reason: description: The reason the function failed when the `metadata.result` field is `0`. This field may include a success message when the function succeeds. example: OK type: string result: description: '- `1` — Success. - `0` — Failed. Check the `reason` field for more details.' enum: - 1 - 0 example: 1 type: integer version: description: The API version of the function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return backup transport events' status tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n backup_get_transport_status\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/backup_get_transport_status?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '78' /backup_list_transported: get: description: This function lists backup files that the system sent through a specified additional backup transport. operationId: Backup-backup_list_transported parameters: - description: 'The transport ID. If you do not specify this parameter, the function returns backup information for all transports. **Note:** You may obtain the IDs for all configured transports by calling WHM API 1''s `backup_destination_list` function.' in: query name: transport required: false schema: example: nN04BhzirlJUNSLSBXSMBEYG type: string responses: '200': content: application/json: schema: properties: data: properties: remote_backups: additionalProperties: additionalProperties: description: 'An array containing information on one account''s backups for a given transport. The property name is a cPanel account on the server. Each array element is a date.' items: description: '' example: '2018-07-19T00:00:00.000Z' format: ISO-8601 Date type: string type: array description: 'An object containing details of accounts whose backups the system sent through a transport. The property name is a backup transport ID, an automatically generated random string.' type: object description: An object containing the backup destination information. example: nN04BhzirlJUNSLSBXSMBEYG: janedoe: - '2020-08-28T00:00:00.000Z' - '2020-08-31T00:00:00.000Z' - '2020-09-02T00:00:00.000Z' type: object type: object metadata: properties: command: description: The method name called. example: backup_list_transported type: string reason: description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success * `0` - Failed: Check the reason field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return backup files sent through transport tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n backup_list_transported\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/backup_list_transported?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '76' /backup_set_list: get: description: This function lists backup files for the server's accounts in the local disk. operationId: Backup-backup_set_list parameters: [] responses: '200': content: application/json: schema: properties: data: properties: backup_set: description: hash of a user's backup information. This hash includes the user and backup_date returns. items: properties: backup_date: description: 'The backup file''s date. A date in YYYY-MM-DD format, where:- YYYY represents the year. - MM represents the month. - DD represents the day.' items: example: '2014-01-01T00:00:00.000Z' type: string type: array user: description: The backup file set's owner. A valid username. example: username type: string type: object properties: {} type: object type: object metadata: properties: command: description: The method name called. example: backup_set_list type: string reason: description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success * `0` - Failed: Check the reason field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return backup files in the local disk tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n backup_set_list\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/backup_set_list?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.38' /backup_set_list_combined: get: description: This function lists locally-stored and backup-destination stored backup files for the server's accounts. operationId: Backup-backup_set_list_combined parameters: [] responses: '200': content: application/json: schema: properties: data: properties: backup_set: additionalProperties: description: 'An array of objects containing the cPanel account''s backup file information. **Note:** This return name is the cPanel account''s name.' format: username items: description: An object containing the time and location backup information. properties: when: description: The date the backup was created. example: '2020-09-01T00:00:00.000Z' format: ISO-8601 Date type: string where: description: 'The location of where the backup is located. * `local` - A backup located on the local machine. * `remote` - A backup located on a remote machine.' enum: - local - remote example: local type: string type: object type: array description: An object that contains an object of backup destination information. example: cpusername1: - when: '2020-01-25T00:00:00.000Z' where: local - when: '2020-01-26T00:00:00.000Z' where: local cpusername2: - when: '2020-01-25T00:00:00.000Z' where: local - when: '2020-01-26T00:00:00.000Z' where: local type: object destination_legend: additionalProperties: description: 'An object containing the backup destination''s name and its transport type. **Note:** This return''s name is the destination''s identification string.' properties: name: description: The backup destination's name. example: More Backups type: string type: description: 'The type of backup destination used in the configuration. * `AmazonS3` * `Backblaze` * `Custom` * `FTP` * `GoogleDrive` * `Local` * `Rsync` * `S3Compatible` * `SFTP` * `WebDAV`' enum: - AmazonS3 - Backblaze - Custom - FTP - GoogleDrive - Local - Rsync - S3Compatible - SFTP - WebDAV example: Local type: string type: object description: An object containing objects that contain the backup's destination and type information. example: GLT1vFsVO8cqk2UWWFpJ9kSQ: name: More Backups type: Local type: object type: object metadata: properties: command: description: The method name called. example: backup_set_list_combined type: string reason: description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success. * `0` - Failed. Check the reason field for more details.' enum: - 1 - 0 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return backup files for the server's accounts tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n backup_set_list_combined\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/backup_set_list_combined?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '80' /backup_skip_users_all: get: description: This function enables and disables the backup and legacy backups. operationId: Backup-backup_skip_users_all parameters: - description: "The type of backup.\n * `backup` - Standard backups.\n * `legacy` - Legacy backups." in: query name: backupversion required: true schema: enum: - backup - legacy example: backup type: string - description: "Whether to enable the backup type that the `backupversion` parameter\nspecifies for all users.\n * `1` - Enable.\n * `0` - Disable." in: query name: state required: true schema: enum: - 0 - 1 example: 1 type: integer responses: '200': content: application/json: schema: properties: metadata: properties: command: description: The method name called. example: backup_skip_users_all type: string reason: description: 'The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.' example: Configuration update process started type: string result: description: '* `1` - Success * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Enable or disable backups tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n backup_skip_users_all \\\n state='1' \\\n backupversion='backup'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/backup_skip_users_all?api.version=1&state=1&backupversion=backup x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.38' /backup_skip_users_all_status: get: description: This function checks each user's backup configuration status while the `backup_skip_users_all` function runs. operationId: Backup-backup_skip_users_all_status parameters: [] responses: '200': content: application/json: schema: properties: data: properties: reason: description: An object that contains backup configuration status information. properties: msg: description: The function's status. example: Done type: string perc: description: The percentage of users whose backup status has changed. example: 100 maximum: 100 minimum: 0 type: integer running: description: 'Whether user configuration changes are still in progress. * `1` - In Progress. * `0` - Finished.' enum: - 0 - 1 example: 0 type: integer type: object metadata: properties: command: description: The method name called. example: backup_skip_users_all_status type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK. result: description: '* `1` - Success. * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return backup configuration status tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n backup_skip_users_all_status\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/backup_skip_users_all_status?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.38' /backup_user_list: get: description: This function lists users with a backup file, stored locally or on additional backup destinations, on a specified date. operationId: Backup-backup_user_list parameters: - description: The desired date. in: query name: restore_point required: true schema: example: '2014-10-10T00:00:00.000Z' format: ISO-8601 Date type: string responses: '200': content: application/json: schema: properties: data: properties: user: description: An array of objects containing user backup information. items: properties: status: description: 'The account''s backup status * `active` * `inactive` * `no_backup`' enum: - active - inactive - no_backup example: active type: string username: description: The user's username. example: username format: username type: string type: object type: array type: object metadata: properties: command: description: The method name called. example: backup_user_list type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return users with a backup file tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n backup_user_list \\\n restore_point='2014-10-10T00:00:00.000Z'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/backup_user_list?api.version=1&restore_point=2014-10-10T00%3a00%3a00.000Z x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.38' /convert_and_migrate_from_legacy_config: get: description: This function converts and migrates a server from the Legacy Backup system to the Backup system. operationId: Backup-convert_and_migrate_from_legacy_config parameters: - description: "Whether to convert the server from the Legacy Backup system to\nthe Backup system.\n * `1` — Convert.\n * `0` — Do **not** convert." in: query name: no_convert required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer responses: '200': content: application/json: schema: properties: metadata: properties: command: description: The method name called. example: convert_and_migrate_from_legacy_config type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: Legacy Backup configuration was renamed from /etc/cpbackup.conf to /etc/cpbackup.conf-1485958451 as a backup copy for your records. type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Migrate server to new backup system tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n convert_and_migrate_from_legacy_config\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/convert_and_migrate_from_legacy_config?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '64' /fetch_pkgacct_master_log: get: description: This function returns the contents of a `start_background_pkgacct` session's master log file. operationId: Backup-fetch_pkgacct_master_log parameters: - description: The `start_background_pkgacct` session ID. in: query name: session_id required: true schema: example: username20200323154328kDJ2Kx4xua2KtG type: string responses: '200': content: application/json: schema: properties: data: properties: log: description: The master log file's contents. example: '{"contents":"pkgacct started.\n","partial":0,"timestamp":"2020-03-23 10:43:28 -0500","pid":4073,"indent":0,"type":"out"} {"pid":4073,"timestamp":"2020-03-23 10:43:28 -0500","partial":0,"contents":"pkgacct version 10 - user : username - tarball: 1 - target mysql : 5.7 - split: 1 - incremental: 0 - homedir: 0 - mailman: 1 - backup: 0 - archive version: 4 - running with uid 0\n","indent":0,"type":"out"} {"type":"out","indent":0,"pid":4073,"timestamp":"2020-03-23 10:43:28 -0500","partial":0,"contents":"pkgacct using ''''/usr/bin/pigz -6 --processes 1 --blocksize 4096 --rsyncable'''' to compress archives\n"} {"type":"out","indent":0,"partial":0,"timestamp":"2020-03-23 10:43:28 -0500","contents":"pkgacct -- attempting to use daily backup to create an account package\n","pid":4073} {"indent":0,"contents":"pkgacct -- could not use daily backup because no daily incremental backup for user username can be found ( check if daily incremental backups are enabled )\n","partial":0,"timestamp":"2020-03-23 10:43:28 -0500","pid":4073,"type":"out"} {"type":"out","pid":4073,"partial":0,"timestamp":"2020-03-23 10:43:28 -0500","contents":"pkgacct working dir : /home/cpmove-username","indent":0} {"type":"out","indent":0,"pid":4073,"contents":"Copying Reseller Config...","timestamp":"2020-03-23 10:43:28 -0500","partial":1} {"indent":0,"pid":4073,"timestamp":"2020-03-23 10:43:28 -0500","partial":0,"contents":"Done\n","type":"out"} {"type":"out","indent":0,"pid":4073,"partial":1,"timestamp":"2020-03-23 10:43:28 -0500","contents":"Copying Suspension Info (if needed)..."} {"type":"out","timestamp":"2020-03-23 10:43:28 -0500","partial":0,"contents":"Done\n","pid":4073,"indent":0} {"type":"out","indent":0,"pid":4073,"contents":"Copying installed SSL certificates and keys...","partial":1,"timestamp":"2020-03-23 10:43:28 -0500"} {"type":"out","partial":0,"timestamp":"2020-03-23 10:43:28 -0500","contents":"Performing ApacheTLS component....","pid":4073,"indent":0} {"type":"out","indent":0,"contents":"Completed ApacheTLS component.\n","partial":0,"timestamp":"2020-03-23 10:43:29 -0500","pid":4073} {"type":"out","pid":4073,"contents":"Done\n","partial":0,"timestamp":"2020-03-23 10:43:29 -0500","indent":0} {"indent":0,"contents":"Copying DKIM keys....","partial":1,"timestamp":"2020-03-23 10:43:29 -0500","pid":4073,"type":"out"} {"type":"out","indent":0,"contents":"Done\n","timestamp":"2020-03-23 10:43:29 -0500","partial":0,"pid":4073} {"type":"out","timestamp":"2020-03-23 10:43:29 -0500","partial":1,"contents":"Copying Bandwidth Data....","pid":4073,"indent":0} {"partial":0,"timestamp":"2020-03-23 10:43:29 -0500","contents":"Performing Bandwidth component....","pid":4073,"indent":0,"type":"out"} {"type":"out","contents":"Summary databases ","partial":1,"timestamp":"2020-03-23 10:43:29 -0500","pid":4073,"indent":0} {"type":"out","contents":" done!\n","timestamp":"2020-03-23 10:43:29 -0500","partial":0,"pid":4073,"indent":0} {"indent":0,"pid":4073,"partial":0,"timestamp":"2020-03-23 10:43:29 -0500","contents":"Completed Bandwidth component.\n","type":"out"} {"indent":0,"timestamp":"2020-03-23 10:43:29 -0500","partial":0,"contents":"Done\n","pid":4073,"type":"out"} {"type":"out","timestamp":"2020-03-23 10:43:29 -0500","partial":1,"contents":"Copying Dns Zones....","pid":4073,"indent":0} {"indent":0,"pid":4073,"timestamp":"2020-03-23 10:43:29 -0500","partial":1,"contents":"...username.tld...","type":"out"} {"indent":0,"partial":0,"timestamp":"2020-03-23 10:43:29 -0500","contents":"Done\n","pid":4073,"type":"out"} {"type":"out","indent":0,"pid":4073,"contents":"Copying Mail files....","timestamp":"2020-03-23 10:43:29 -0500","partial":1} {"indent":0,"contents":"Done\n","timestamp":"2020-03-23 10:43:29 -0500","partial":0,"pid":4073,"type":"out"} {"contents":"Copying proftpd file....","partial":1,"timestamp":"2020-03-23 10:43:29 -0500","pid":4073,"indent":0,"type":"out"} {"indent":0,"pid":4073,"contents":"Done\n","timestamp":"2020-03-23 10:43:29 -0500","partial":0,"type":"out"} {"indent":0,"contents":"Performing Logs component....","timestamp":"2020-03-23 10:43:29 -0500","partial":0,"pid":4073,"type":"out"} {"type":"out","indent":0,"pid":4073,"timestamp":"2020-03-23 10:43:29 -0500","partial":1,"contents":"...log file sizes [0 byte(s)]..."} {"type":"out","indent":0,"pid":4073,"contents":"...username.tld-ssl_log...","timestamp":"2020-03-23 10:43:29 -0500","partial":1} {"contents":"...username.tld...","timestamp":"2020-03-23 10:43:29 -0500","partial":1,"pid":4073,"indent":0,"type":"out"} {"indent":0,"pid":4073,"contents":"Completed Logs component.\n","partial":0,"timestamp":"2020-03-23 10:43:29 -0500","type":"out"} {"type":"out","indent":0,"contents":"Copy userdata...","timestamp":"2020-03-23 10:43:29 -0500","partial":1,"pid":4073} {"contents":"Done\n","partial":0,"timestamp":"2020-03-23 10:43:29 -0500","pid":4073,"indent":0,"type":"out"} {"indent":0,"pid":4073,"timestamp":"2020-03-23 10:43:29 -0500","partial":1,"contents":"Copy custom virtualhost templates...","type":"out"} {"type":"out","indent":0,"timestamp":"2020-03-23 10:43:29 -0500","partial":0,"contents":"Done\n","pid":4073} {"type":"out","contents":"Copying mailman lists and archives....","partial":1,"timestamp":"2020-03-23 10:43:29 -0500","pid":4073,"indent":0} {"type":"out","indent":0,"pid":4073,"contents":"Done copying mailman lists and archives.\n","timestamp":"2020-03-23 10:43:29 -0500","partial":1} {"indent":0,"pid":4073,"timestamp":"2020-03-23 10:43:29 -0500","partial":0,"contents":"Performing Postgresql component....","type":"out"} {"indent":0,"pid":4073,"contents":"Completed Postgresql component.\n","partial":0,"timestamp":"2020-03-23 10:43:29 -0500","type":"out"} {"type":"out","pid":4073,"timestamp":"2020-03-23 10:43:29 -0500","partial":0,"contents":"Performing Mysql component....","indent":0} {"contents":"Determining mysql dbs...","timestamp":"2020-03-23 10:43:29 -0500","partial":1,"pid":4073,"indent":0,"type":"out"} {"type":"out","pid":4073,"timestamp":"2020-03-23 10:43:29 -0500","partial":1,"contents":"...mysqldump version: 5.7.27...","indent":0} {"type":"out","contents":"...mysql version: 5.7...","partial":1,"timestamp":"2020-03-23 10:43:29 -0500","pid":4073,"indent":0} {"type":"out","indent":0,"contents":"Saving mysql privs...","timestamp":"2020-03-23 10:43:29 -0500","partial":1,"pid":4073} {"partial":0,"timestamp":"2020-03-23 10:43:29 -0500","contents":"Done\n","pid":4073,"indent":0,"type":"out"} {"indent":0,"contents":"Storing MySQL databases...\n","partial":1,"timestamp":"2020-03-23 10:43:29 -0500","pid":4073,"type":"out"} {"indent":0,"pid":4073,"partial":0,"timestamp":"2020-03-23 10:43:29 -0500","contents":"Done\n","type":"out"} {"type":"out","indent":0,"pid":4073,"partial":0,"timestamp":"2020-03-23 10:43:29 -0500","contents":"...Done\n"} {"pid":4073,"partial":0,"timestamp":"2020-03-23 10:43:29 -0500","contents":"...Done\n","indent":0,"type":"out"} {"type":"out","indent":0,"pid":4073,"partial":0,"timestamp":"2020-03-23 10:43:29 -0500","contents":"Completed Mysql component.\n"} {"indent":0,"contents":"Performing MysqlRemoteNotes component....","partial":0,"timestamp":"2020-03-23 10:43:29 -0500","pid":4073,"type":"out"} {"indent":0,"contents":"Completed MysqlRemoteNotes component.\n","partial":0,"timestamp":"2020-03-23 10:43:29 -0500","pid":4073,"type":"out"} {"pid":4073,"partial":1,"timestamp":"2020-03-23 10:43:29 -0500","contents":"Copying cpuser file.......","indent":0,"type":"out"} {"type":"out","indent":0,"contents":"Done\n","timestamp":"2020-03-23 10:43:29 -0500","partial":0,"pid":4073} {"partial":1,"timestamp":"2020-03-23 10:43:29 -0500","contents":"Copying crontab file.......","pid":4073,"indent":0,"type":"out"} {"indent":0,"pid":4073,"contents":"Done\n","timestamp":"2020-03-23 10:43:29 -0500","partial":0,"type":"out"} {"type":"out","pid":4073,"contents":"Performing Quota component....","partial":0,"timestamp":"2020-03-23 10:43:29 -0500","indent":0} {"pid":4073,"timestamp":"2020-03-23 10:43:29 -0500","partial":0,"contents":"Completed Quota component.\n","indent":0,"type":"out"} {"type":"out","indent":0,"timestamp":"2020-03-23 10:43:29 -0500","partial":0,"contents":"Performing Integration component....","pid":4073} {"pid":4073,"contents":"Completed Integration component.\n","partial":0,"timestamp":"2020-03-23 10:43:29 -0500","indent":0,"type":"out"} {"indent":0,"contents":"Performing AuthnLinks component....","timestamp":"2020-03-23 10:43:29 -0500","partial":0,"pid":4073,"type":"out"} {"type":"out","pid":4073,"contents":"Completed AuthnLinks component.\n","partial":0,"timestamp":"2020-03-23 10:43:29 -0500","indent":0} {"type":"out","indent":0,"pid":4073,"timestamp":"2020-03-23 10:43:29 -0500","partial":0,"contents":"Performing APITokens component...."} {"indent":0,"timestamp":"2020-03-23 10:43:29 -0500","partial":0,"contents":"Completed APITokens component.\n","pid":4073,"type":"out"} {"indent":0,"pid":4073,"partial":0,"timestamp":"2020-03-23 10:43:29 -0500","contents":"Performing DNSSEC component....","type":"out"} {"type":"out","indent":0,"partial":0,"timestamp":"2020-03-23 10:43:29 -0500","contents":"Completed DNSSEC component.\n","pid":4073} {"type":"out","indent":0,"timestamp":"2020-03-23 10:43:29 -0500","partial":0,"contents":"Performing Custom component....","pid":4073} {"pid":4073,"timestamp":"2020-03-23 10:43:29 -0500","partial":0,"contents":"No custom components to perform.\n","indent":0,"type":"out"} {"contents":"Completed Custom component.\n","timestamp":"2020-03-23 10:43:29 -0500","partial":0,"pid":4073,"indent":0,"type":"out"} {"type":"out","indent":0,"pid":4073,"contents":"Performing AutoSSL component....","timestamp":"2020-03-23 10:43:29 -0500","partial":0} {"indent":0,"partial":0,"timestamp":"2020-03-23 10:43:29 -0500","contents":"Completed AutoSSL component.\n","pid":4073,"type":"out"} {"type":"out","pid":4073,"contents":"Storing Subdomains....\n","timestamp":"2020-03-23 10:43:29 -0500","partial":0,"indent":0} {"type":"out","indent":0,"partial":0,"timestamp":"2020-03-23 10:43:29 -0500","contents":"Done\n","pid":4073} {"indent":0,"pid":4073,"partial":0,"timestamp":"2020-03-23 10:43:29 -0500","contents":"Storing Parked Domains....\n","type":"out"} {"type":"out","pid":4073,"contents":"Done\n","partial":0,"timestamp":"2020-03-23 10:43:29 -0500","indent":0} {"indent":0,"contents":"Storing Addon Domains....\n","timestamp":"2020-03-23 10:43:29 -0500","partial":0,"pid":4073,"type":"out"} {"contents":"Performing Password component....","timestamp":"2020-03-23 10:43:29 -0500","partial":0,"pid":4073,"indent":0,"type":"out"} {"type":"out","indent":0,"contents":"Completed Password component.\n","partial":0,"timestamp":"2020-03-23 10:43:29 -0500","pid":4073} {"type":"out","pid":4073,"timestamp":"2020-03-23 10:43:29 -0500","partial":0,"contents":"Performing DigestShadow component....","indent":0} {"type":"out","indent":0,"pid":4073,"partial":0,"timestamp":"2020-03-23 10:43:29 -0500","contents":"Completed DigestShadow component.\n"} {"type":"out","indent":0,"contents":"Copying shell.......","partial":1,"timestamp":"2020-03-23 10:43:29 -0500","pid":4073} {"type":"out","indent":0,"pid":4073,"contents":"Done\n","timestamp":"2020-03-23 10:43:29 -0500","partial":0} {"indent":0,"pid":4073,"contents":"Performing PublicContact component....","partial":0,"timestamp":"2020-03-23 10:43:29 -0500","type":"out"} {"indent":0,"pid":4073,"timestamp":"2020-03-23 10:43:29 -0500","partial":0,"contents":"Completed PublicContact component.\n","type":"out"} {"contents":"Performing MailLimits component....","timestamp":"2020-03-23 10:43:29 -0500","partial":0,"pid":4073,"indent":0,"type":"out"} {"indent":0,"partial":0,"timestamp":"2020-03-23 10:43:29 -0500","contents":"Completed MailLimits component.\n","pid":4073,"type":"out"} {"contents":"Performing LinkedNodes component....","timestamp":"2020-03-23 10:43:29 -0500","partial":0,"pid":4073,"indent":0,"type":"out"} {"timestamp":"2020-03-23 10:43:29 -0500","partial":0,"contents":"Completed LinkedNodes component.\n","pid":4073,"indent":0,"type":"out"} {"pid":4073,"contents":"Creating Archive ....","timestamp":"2020-03-23 10:43:29 -0500","partial":1,"indent":0,"type":"out"} {"indent":0,"pid":4073,"partial":0,"timestamp":"2020-03-23 10:43:29 -0500","contents":"\n","type":"out"} {"contents":"splitpkgacctfile is: /home/cpmove-username-split/cpmove-username.tar.gz.part00001\n","partial":0,"timestamp":"2020-03-23 10:43:29 -0500","pid":4073,"indent":0,"type":"out"} {"pid":4073,"timestamp":"2020-03-23 10:43:29 -0500","partial":0,"contents":"\nsplitmd5sum is: e06a2d1f0cb499cb1d5ff15116f02df4\n","indent":0,"type":"out"} {"type":"out","pid":4073,"timestamp":"2020-03-23 10:43:29 -0500","partial":0,"contents":"\nsplitsize is: 7275\n","indent":0} {"type":"out","timestamp":"2020-03-23 10:43:29 -0500","partial":0,"contents":"Done\n","pid":4073,"indent":0} {"pid":4073,"timestamp":"2020-03-23 10:43:29 -0500","partial":0,"contents":"\nmysqlsize is: 0\n","indent":0,"type":"out"} {"indent":0,"pid":4073,"partial":0,"timestamp":"2020-03-23 10:43:29 -0500","contents":"pkgacct completed\n","type":"out"}' type: string type: object metadata: properties: command: description: The method name called. example: fetch_pkgacct_master_log type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return start_background_pkgacct session log file tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n fetch_pkgacct_master_log \\\n session_id='username20200323154328kDJ2Kx4xua2KtG'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/fetch_pkgacct_master_log?api.version=1&session_id=username20200323154328kDJ2Kx4xua2KtG x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '88' /get_pkgacct_session_state: get: description: This function returns the state of a `start_background_pkgacct` session. operationId: Backup-get_pkgacct_session_state parameters: - description: The `start_background_pkgacct` session ID. in: query name: session_id required: true schema: example: username20200323154328kDJ2Kx4xua2KtG type: string responses: '200': content: application/json: schema: properties: data: properties: state: description: 'The `start_background_pkgacct` session''s state. * `COMPLETED` * `FAILED` * `RUNNING`' enum: - COMPLETED - FAILED - RUNNING example: COMPLETED type: string type: object metadata: properties: command: description: The method name called. example: get_pkgacct_session_state type: string reason: description: 'The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.' example: OK type: string result: description: '* `1` - Success * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return start_background_pkgacct session state tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n get_pkgacct_session_state \\\n session_id='username20200323154328kDJ2Kx4xua2KtG'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/get_pkgacct_session_state?api.version=1&session_id=username20200323154328kDJ2Kx4xua2KtG x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '88' /get_users_and_domains_with_backup_metadata: get: description: This function lists all users and their domains that have backup metadata. operationId: Backup-get_users_and_domains_with_backup_metadata parameters: [] responses: '200': content: application/json: schema: properties: data: additionalProperties: description: The cPanel user account's associated domain. example: example.com format: domain type: string description: Keys are cPanel user accounts that contain backup metadata. example: username: example.com username2: example.net username3: example.org type: object metadata: properties: command: description: The method name called. example: get_users_and_domains_with_backup_metadata type: string reason: description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success. * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return users and domains with backup metadata tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n get_users_and_domains_with_backup_metadata\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/get_users_and_domains_with_backup_metadata?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '74' /get_users_with_backup_metadata: get: description: This function lists users with backup metadata. operationId: Backup-get_users_with_backup_metadata parameters: [] responses: '200': content: application/json: schema: properties: data: properties: accounts: description: The cPanel user accounts on the server that contain backup metadata. items: example: username format: username type: string type: array type: object metadata: properties: command: description: The method name called. example: get_users_with_backup_metadata type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return users with backup metadata tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n get_users_with_backup_metadata\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/get_users_with_backup_metadata?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '70' /list_cparchive_files: get: description: 'This function lists all available cparchive files. **Note:** * `MM.DD.YYYY` represents the file''s date in month, date, and year format. * `HH-MM-SS` represents the file''s timestamp in hour, minute, and second format. The function checks the following filenames, where `USER` represents the cPanel account''s filusername:: * `cpmove-USER` * `cpmove-USER.tar` * `cpmove-USER.tar.gz` * `USER.tar` * `USER.tar.gz` * `backup-{MM.DD.YYYY}{HH-MM-SS}{USER}.tar` * `backup-{MM.DD.YYYY}{HH-MM-SS}{USER}.tar.gz` The function checks for these filenames in the following locations: * `/home` * `/home2` * `/home3` * `/root` * `/usr` * `/usr/home` * `/web`' operationId: Backup-list_cparchive_files parameters: [] responses: '200': content: application/json: schema: properties: data: properties: quickrestore_files: description: An array of objects that contains information about each `cparchive` file. items: properties: file: description: The backup file's name in one of the formats listed above. example: cpmove-username1.tar.gz type: string path: description: The backup file's directory in one of the locations listed above. example: /home type: string user: description: The backup file's account. example: username type: string type: object type: array type: object metadata: properties: command: description: The method name called. example: list_cparchive_files type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` — Success. * `0` — Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Return cparchive files list tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n list_cparchive_files\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/list_cparchive_files?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.42' /start_background_pkgacct: get: description: 'This function backs up an account with the pkgacct script. **Note:** - The `/usr/local/cpanel/scripts/pkgacct` script logs results to the `/var/cpanel/pkgacct_sessions/session_id/` directory, where `session_id` represents the backup session''s ID. - The target system streams the output of this function with the `/usr/local/cpanel/whostmgr/docroot/cgi/live_tail_log.cgi` script on the source system. Users should **not** directly call this script.' operationId: Backup-start_background_pkgacct parameters: - description: The cPanel account to back up. in: query name: user required: true schema: example: username format: username type: string - description: 'Whether to compress the data in .gzip format. * `compress` - Compress the data. * `null` - Do **not** compress the data.' in: query name: compressionsetting required: false schema: default: null enum: - compress example: compress type: - string - 'null' - description: "Whether to update the destination file with any new content since the previous backup.\nThis parameter also removes any content that no longer exists on the account.\nIf the destination file does **not** exist, the function creates a new file in that location.\n* `1` — Create an incremental archive file.\n* `0` — Do **not** create an incremental archive file.\n\n**Note:**\n\n When you use this parameter, the system creates the backup as an uncompressed archive." in: query name: incremental required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to run the background task with a reduced priority. * `1` — Run the backup as a low priority task. * `0` — Run the backup with normal priority.' in: query name: low_priority required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'The minimum version of MySQL® that the system requires to restore the backed up database files. **Note:** - You can view the server''s installed version of MySQL in the `/var/cpanel/cpanel.config` file. - This parameter defaults to the current installed version of MySQL.' in: query name: mysqlver required: false schema: example: '5.5' type: string - description: 'Whether to encode each line of the script''s output in JSON format in order to allow the `live_tail_log.cgi` script to stream it. * `1` — Serialize the output. * `0` — Do **not** serialize the output.' in: query name: serialized_output required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to exclude the account''s databases from the cpmove archive. * `1` — Do **not** back up the account''s databases. * `0` — Back up the account''s databases.' in: query name: skipacctdb required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to exclude the account''s API tokens from the archive. * `1` — Do **not** back up the account''s API tokens. * `0` — Back up the account''s API tokens.' in: query name: skipapitokens required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to exclude the account''s external authentication credentials from the archive. * `1` — Do **not** back up the account''s external authentication credentials. * `0` — Back up the account''s external authentication credentials.' in: query name: skipauthnlinks required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to exclude the account''s bandwidth data from the archive. * `1` — Do **not** back up the account''s bandwidth data. * `0` — Back up the account''s data.' in: query name: skipbwdata required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to exclude the account''s DNSSEC configuration from the archive. * `1` — Do **not** back up the account''s DNSSEC configuration. * `0` — Back up the account''s DNSSEC configuration.' in: query name: skipdnssec required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to exclude the account''s DNS zone file information from the archive. * `1` — Do **not** back up the account''s DNS zone file information. * `0` — Back up the account''s DNS zone file information.' in: query name: skipdnszones required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to exclude the account''s FTP user accounts from the archive. * `1` — Do **not** back up the account''s FTP user accounts. * `0` — Back up the account''s FTP user accounts.' in: query name: skipftpusers required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to skip the home directory''s contents. * `1` — Do **not** back up the account''s home directory. * `0` — Back up the account''s home directory.' in: query name: skiphomedir required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to exclude the account''s cPanel & WHM linked server nodes configuration from the archive. * `1` — Do **not** back up the account''s linked server nodes configuration. * `0` — Back up the account''s linked server nodes configuration.' in: query name: skiplinkednodes required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to exclude the account''s log files from the archive. * `1` — Do **not** back up the account''s log files. * `0` — Back up the account''s log files.' in: query name: skiplogs required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to exclude the account''s reseller privileges from the archive. * `1` — Do **not** back up the account''s reseller privileges. * `0` — Back up the account''s reseller privileges.' in: query name: skipresellerconfig required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to exclude the account''s shell information and privileges from the archive. * `1` — Do **not** back up the account''s shell information and privileges. * `0` — Back up the account''s shell information and privileges.' in: query name: skipshell required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to exclude the account''s virtual host (vhost) templates from the archive. * `1` — Do **not** back up the account''s vhost templates. * `0` — Back up the account''s vhost templates.' in: query name: skipvhosttemplates required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to create the cpmove archive in chunks. * `1` — Create the archive in chunks. * `0` — Create a single archive file.' in: query name: split required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'The path to the directory in which you wish to store the cpmove archive. **Note:** This parameter defaults to `/home/user`, where `user` represents the username of the account.' in: query name: tarroot required: false schema: example: /home/user type: string - description: "Whether to use the account's last known successful backup as a template when the script creates the cpmove archive, if any exist.\n* `1` — Use the account's last known successful backup as a template, if any exist.\n* `0` — Do **not** use the account's last known successful backup.\n\n**Note:**\n\n This parameter may reduce the amount of time that the backup process requires." in: query name: use_backups required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer responses: '200': content: application/json: schema: properties: data: properties: complete_master_error_log: description: "The name of the master error log.\n\n**Note:**\n\n The target system streams the output of this file with the `live_tail_log.cgi` script; however, users should **not** directly call this script." example: master.error_log type: string complete_master_log: description: "The name of the master log.\n\n**Note:**\n\n The target system streams the output of this file with the `live_tail_log.cgi` script; however, users should **not** directly call this script." example: master.log type: string session_id: description: The backup's session ID. example: example20151109162046c4xzDp55q9u4tPj type: string type: object metadata: properties: command: description: The method name called. example: start_background_pkgacct type: string reason: description: The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success. * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Back up an account using the pkgacct script tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n start_background_pkgacct \\\n user='username'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/start_background_pkgacct?api.version=1&user=username x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '54' /start_local_cpmove_restore: get: description: This function performs a full restoration of a single cPanel account from a `cpmove` tarball. operationId: Transfers-start_local_cpmove_restore parameters: - description: "A filepath that contains the account's `cpmove` tarball or the directory path that contains the extracted `cpmove` tarball.\n\n **Note:**\n\nYou can use the [pkgacct script](https://go.cpanel.net/ThepkgacctScript) to create a `cpmove` tarball." in: query name: cpmovepath required: true schema: example: /home/cpmove-newacct.tar.gz type: string - description: "Whether to assign the account a dedicated IP address.\n* `1` - Assign a dedicated IP address.\n* `0` - Do **not** assign a dedicated IP address.\n\n **Note:**\n\nThe system **must** have an available IP address." in: query name: dedicated_ip required: false schema: default: 0 enum: - 0 - 1 example: 0 type: integer - description: 'Whether to delete the `cpmove` tarball or extracted directory, given in the `cpmovepath` parameter, after the system completes the account restoration. * `1` - Delete the `cpmove` tarball or extracted directory. * `0` - Do **not** delete the `cpmove` tarball or extracted directory.' in: query name: delete_archive required: false schema: default: 0 enum: - 0 - 1 example: 0 type: integer - description: 'The server on which the account''s email will reside after the system completes the transfer. * `.local` - Use the local server the account is being restored on. * `.existing` - Use the server location defined in the account''s backup data. The system defaults to the `.local` parameter if this does **not** work. * `ALIAS` - Use a [cPanel & WHM linked node server''s alias](https://go.cpanel.net/whmlinkednodes). For example, the `example-alias` for the `servernode.example.com` domain. The system defaults to the `.local` parameter if this does **not** work.' in: query name: mail_location required: false schema: default: .existing oneOf: - enum: - .local - .existing type: string - description: The remote cPanel & WHM linked server node's alias. example: example-alias type: string - description: 'Whether to overwrite an existing account on the server, if one exists. * `1` - Overwrite an existing account. * `0` - Do **not** overwrite an existing account on the server.' in: query name: overwrite required: false schema: default: 0 enum: - 0 - 1 example: 1 type: integer - description: 'Whether to perform a restricted restore for the account. The system will perform security checks on the backup file. If you do not trust the source of the account backup with `root` access to your server, use this parameter to protect your server. * `1` - Perform a restricted restore. * `0` - Do **not** perform a restricted restore. **Important:** * This parameter is **experimental**. Do **not** consider it as an effective security control. For more information, read our [restricted restore](https://go.cpanel.net/whmdocsTransferorRestoreacPanelAccount#restricted-restore) documentation. * If the account owns PostgreSQL® databases, your server **must** use PostgreSQL version 8.4 or newer. * This parameter **only** allows restored accounts to use the `noshell` or [`jailshell`](https://go.cpanel.net/VirtFSJailedShell) environments. If the account uses a different shell, the system will set the account to use the `noshell` environment. * If there is an issue with the backup file, the system will **not** restore that part of the backup file. It will also adds a warning to the log file.' in: query name: restricted required: false schema: default: 0 enum: - 0 - 1 example: 0 type: integer - description: 'Whether to perform one of the following actions to the account''s A records: * `all` - Replace **all** instances of the original server''s IP address with the new server''s IP address. * `basic` - **Only** replace the cPanel provided A records.' in: query name: update_a_records required: false schema: default: all enum: - all - basic example: all type: string - description: The username to give to the restored cPanel account. This will default to the username provided in the backup files. in: query name: username required: false schema: example: example format: username type: string responses: '200': content: application/json: schema: properties: data: properties: transfer_session_id: description: The background transfer process ID. example: example202003301756425ugO type: string type: object metadata: properties: command: description: The method name called. example: start_local_cpmove_restore type: string reason: description: The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds. example: OK type: string result: description: '* `1` - Success * `0` - Failed: Check the reason field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Restore one cPanel account from a backup tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n start_local_cpmove_restore \\\n cpmovepath='/home/cpmove-newacct.tar.gz'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/start_local_cpmove_restore?api.version=1&cpmovepath=%2fhome%2fcpmove-newacct.tar.gz x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '88' /toggle_user_backup_state: get: description: This function enables or disables legacy backups for a user. operationId: Backup-toggle_user_backup_state parameters: - description: The cPanel account's username. in: query name: user required: true schema: example: username format: username type: string - description: 'Whether the account should use the legacy backup system. * `1` - Use the legacy backup system. * `0` - Use the standard backup system.' in: query name: legacy required: false schema: default: 0 enum: - 0 - 1 example: 0 type: integer responses: '200': content: application/json: schema: properties: data: properties: toggle_status: description: 'Whether backups are active on the account. * `1` - Active. * `0` - Inactive.' enum: - 0 - 1 example: 0 type: integer type: object metadata: properties: command: description: The method name called. example: toggle_user_backup_state type: string reason: description: 'The reason the API function failed when the `metadata.result` field is `0`. This field may display a success message when a function succeeds.' example: Backup state modified type: string result: description: '* `1` - Success * `0` - Failed. Check the `reason` field for more details.' enum: - 0 - 1 example: 1 type: integer version: description: The version of the API function. example: 1 type: integer type: object description: HTTP Request was successful. summary: Enable or disable legacy backups tags: - Backups x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n toggle_user_backup_state \\\n user='username'\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/toggle_user_backup_state?api.version=1&user=username x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '11.38' components: schemas: BackupDestinationGetResponseCustom: allOf: - $ref: '#/components/schemas/BackupDestinationGetResponseBase' - properties: host: description: The remote server's hostname. example: backups.example.com format: domain type: string path: description: The path to the backups directory on the remote server. example: /backups format: path type: string script: description: The absolute file path of the user-supplied transport solution script. example: /home/backups/beammeupscotty.pl format: path type: string timeout: description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer username: description: The remote server account's username. example: username type: string type: object BackupDestinationGetResponseFTP: allOf: - $ref: '#/components/schemas/BackupDestinationGetResponseBase' - properties: host: description: The remote server's hostname. example: backups.example.com format: domain type: string passive: description: 'Whether to use passive FTP. * `1` - Use passive FTP. * `0` - Use active FTP.' example: 1 type: integer path: description: The path to the backups directory on the remote server. example: /backups format: path type: string port: description: The remote server's FTP port. example: 21 maximum: 65535 minimum: 1 type: integer timeout: description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer username: description: The remote server account's username. example: username type: string type: object BackupDestinationGetResponseBackblaze: allOf: - $ref: '#/components/schemas/BackupDestinationGetResponseBase' - properties: application_key: description: The application key's name. example: A123b45CD678e9 type: string application_key_id: description: The application key ID that authenticates the Backblaze B2 account. example: 12a345B678c9 type: string bucket_id: description: The bucket's ID. example: a12b34cd5678e9f type: string bucket_name: description: The bucket's name. example: ChockFullOfNuts type: string path: description: The path to the backups directory on the remote server. example: /backups format: path type: string timeout: description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer type: object BackupDestinationGetResponseWebDAV: allOf: - $ref: '#/components/schemas/BackupDestinationGetResponseBase' - properties: host: description: The remote server's hostname. example: backups.example.com format: domain type: string path: description: The path to the backups directory on the remote server. example: /backups format: path type: string port: description: The remote server's FTP port. example: 21 maximum: 65535 minimum: 1 type: integer ssl: description: 'Whether to use SSL. * `1` - Use SSL. * `0` - Do **not** use SSL.' enum: - 1 - 0 example: 1 type: integer timeout: description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer username: description: The remote server account's username. example: username type: string type: object LocalBackupDestinationResponse: allOf: - $ref: '#/components/schemas/BackupDestinationResponse' - properties: mount: default: 0 description: 'Whether the path is mounted. * `1` - The path is mounted. * `0` - The path is **not** mounted.' enum: - 1 - 0 example: 0 type: integer no_mount_fail: default: 0 description: 'Whether to fail the backup attempt if the mount fails. * `1` - Fail the backup attempt. * `0` - Do **not** fail the backup attempt.' enum: - 1 - 0 example: 0 type: integer path: description: The absolute path to the backups directory. example: /home/backups format: path type: string type: object BackupDestinationSetParameterBackblaze: allOf: - $ref: '#/components/schemas/BackupDestinationSetParameterBase' - properties: application_key: description: The application key's name. example: A123b45CD678e9 type: string application_key_id: description: The application key ID that authenticates the Backblaze B2 account. example: 12a345B678c9 type: string bucket_id: description: The bucket's ID. example: a12b34cd5678e9f type: string bucket_name: description: The bucket's name. example: ChockFullOfNuts type: string path: description: The path to the backups directory on the remote server. example: backups format: path type: string timeout: default: 30 description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer required: - application_key - application_key_id - bucket_id - bucket_name type: object BackupDestinationSetParameterAmazonS3: allOf: - $ref: '#/components/schemas/BackupDestinationSetParameterBase' - properties: aws_access_key_id: description: The Amazon S3 Access Key ID. example: s123456789 type: string bucket: description: The Amazon S3™ bucket. example: ChockFullOfNuts type: string folder: default: '' description: The path to the backups directory, relative to the root directory, on the remote server. example: subfolder format: path type: string password: description: The Amazon S3 Access Key's password. example: 123456luggage type: string timeout: default: 30 description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer required: - bucket - aws_access_key_id - timeout - password type: object SFTPBackupDestinationResponse: allOf: - $ref: '#/components/schemas/BackupDestinationResponse' - properties: authtype: description: 'The authorization type. * `password` * `key`' enum: - password - key example: password host: description: The remote server's hostname. example: backups.example.com format: domain type: string path: description: The path to the backups directory on the remote server. example: /backups format: path type: string port: default: 21 description: The remote server's FTP port. example: 21 maximum: 65535 minimum: 1 type: integer privatekey: description: If the `authtype` return's value is `key`, the absolute path to the private key file. example: /home/backups/key type: string timeout: default: 30 description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer username: description: The remote server account's username. example: username type: string type: object BackupDestinationResponse: properties: disable_reason: description: 'An error message that explains why the backup is disabled. **Note:** You will only see this return when the transport is disabled.' example: 'Could not list files in destination: example' type: string disabled: description: 'Shows whether the backup destination is disabled. * `1` — The destination is disabled. * `0` — The destination is enabled.' enum: - 0 - 1 example: 0 type: integer id: description: The ID of the backup destination to modify. example: 0W1ei2rd3A4lI5sT6he7Be8st type: string name: description: A new name for the backup destination. example: destination_name type: string type: description: The type of backup destination. enum: - Custom - FTP - Local - SFTP - WebDAV - AmazonS3 - Rsync - GoogleDrive - S3Compatible - Backblaze example: Local type: string type: object RsyncBackupDestinationResponse: allOf: - $ref: '#/components/schemas/BackupDestinationResponse' - properties: authtype: description: 'The authorization type. * `password` * `key`' enum: - password - key example: password host: description: The remote server's hostname. example: backups.example.com format: domain type: string path: description: The path to the backups directory on the remote server. example: /backups format: path type: string port: default: 22 description: The remote server's FTP port. example: 22 maximum: 65535 minimum: 1 type: integer privatekey: description: If the `authtype` return's value is `key`, the absolute path to the private key file. example: /home/backups/key type: string timeout: default: 30 description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer username: description: The remote server account's username. example: username type: string type: object BackupDestinationSetParameterGoogleDrive: allOf: - $ref: '#/components/schemas/BackupDestinationSetParameterBase' - properties: client_id: description: The Google Drive client ID. example: aBcdeFgHIjK123 type: string client_secret: description: The Google Drive client secret. example: aBcde123FgHIjK456 type: string folder: default: '' description: The path to the backups directory, relative to the root directory, on the remote server. example: subfolder format: path type: string timeout: default: 30 description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer required: - client_id - client_secret type: object GoogleDriveBackupDestinationResponse: allOf: - $ref: '#/components/schemas/BackupDestinationResponse' - properties: client_id: description: The Google Drive client ID. example: aBcdeFgHIjK123 type: string client_secret: description: The Google Drive client secret. example: aBcde123FgHIjK456 type: string folder: default: '' description: The path to the backups directory, relative to the root directory, on the remote server. example: subfolder type: string timeout: default: 30 description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer type: object BackupDestinationResponseType: anyOf: - $ref: '#/components/schemas/AmazonS3BackupDestinationResponse' - $ref: '#/components/schemas/BackblazeBackupDestinationResponse' - $ref: '#/components/schemas/CustomBackupDestinationResponse' - $ref: '#/components/schemas/FTPBackupDestinationResponse' - $ref: '#/components/schemas/GoogleDriveBackupDestinationResponse' - $ref: '#/components/schemas/LocalBackupDestinationResponse' - $ref: '#/components/schemas/RsyncBackupDestinationResponse' - $ref: '#/components/schemas/S3CompatibleBackupDestinationResponse' - $ref: '#/components/schemas/SFTPBackupDestinationResponse' - $ref: '#/components/schemas/WebDAVBackupDestinationResponse' discriminator: mapping: AmazonS3: '#/components/schemas/AmazonS3BackupDestinationResponse' Backblaze: '#/components/schemas/BackblazeBackupDestinationResponse' Custom: '#/components/schemas/CustomBackupDestinationResponse' FTP: '#/components/schemas/FTPBackupDestinationResponse' GoogleDrive: '#/components/schemas/GoogleDriveBackupDestinationResponse' Local: '#/components/schemas/LocalBackupDestinationResponse' Rsync: '#/components/schemas/RsyncBackupDestinationResponse' S3Compatible: '#/components/schemas/S3CompatibleBackupDestinationResponse' SFTP: '#/components/schemas/SFTPBackupDestinationResponse' WebDAV: '#/components/schemas/WebDAVBackupDestinationResponse' propertyName: type BackblazeBackupDestinationResponse: allOf: - $ref: '#/components/schemas/BackupDestinationResponse' - properties: application_key: description: The application key's name. example: A123b45CD678e9 type: string application_key_id: description: The application key ID that authenticates the Backblaze B2 account. example: 12a345B678c9 type: string bucket_id: description: The bucket's ID. example: a12b34cd5678e9f type: string bucket_name: description: The bucket's name. example: ChockFullOfNuts type: string path: description: The path to the backups directory on the remote server. example: backups format: path type: string timeout: default: 30 description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer type: object FTPBackupDestinationResponse: allOf: - $ref: '#/components/schemas/BackupDestinationResponse' - properties: host: description: The remote server's hostname. example: backups.example.com format: domain type: string passive: default: 1 description: 'Whether to use passive FTP. * `1` - Use passive FTP. * `0` - Use active FTP.' example: 1 type: integer path: description: The path to the backups directory on the remote server. example: /backups format: path type: string port: default: 21 description: The remote server's FTP port. example: 21 maximum: 65535 minimum: 1 type: integer timeout: default: 30 description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer username: description: The remote server account's username. example: username type: string type: object BackupDestinationGetResponseGoogleDrive: allOf: - $ref: '#/components/schemas/BackupDestinationGetResponseBase' - properties: client_id: description: The Google Drive client ID. example: aBcdeFgHIjK123 type: string client_secret: description: The Google Drive client secret. example: aBcde123FgHIjK456 type: string folder: description: The path to the backups directory, relative to the root directory, on the remote server. example: subfolder format: path type: string timeout: description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer type: object BackupDestinationGetResponseRsync: allOf: - $ref: '#/components/schemas/BackupDestinationGetResponseBase' - properties: authtype: description: 'The authorization type. * `password` * `key`' enum: - password - key example: password host: description: The remote server's hostname. example: backups.example.com format: domain type: string path: description: The path to the backups directory on the remote server. example: /backups format: path type: string port: description: The remote server's FTP port. example: 22 maximum: 65535 minimum: 1 type: integer privatekey: description: If the `authtype` return's value is `key`, the absolute path to the private key file. example: /home/backups/key format: path type: string timeout: description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer username: description: The remote server account's username. example: username type: string type: object BackupDestinationSetParameterS3Compatible: allOf: - $ref: '#/components/schemas/BackupDestinationSetParameterBase' - properties: aws_access_key_id: description: The S3-compatible provider key ID. example: s123456789 type: string bucket: description: The S3-compatible bucket. example: ChockFullOfNuts type: string folder: default: '' description: The path to the backups directory, relative to the root directory, on the remote server. example: subfolder format: path type: string host: description: The S3-compatible provider's server. example: www.s3example.com type: string password: description: The S3-compatible provider key's password or secret. example: 123456luggage type: string timeout: default: 30 description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer required: - host - bucket - aws_access_key_id - timeout - password type: object BackupDestinationSetParameterBase: properties: disable_reason: description: An error message that explains why the backup is disabled. example: 'Could not list files in destination: example' type: string disabled: description: 'Whether to disable the backup destination. * `1` — Disable the destination. * `0` — Enable the destination. **Note:** If you do not set this parameter, the system retains the current setting.' enum: - 0 - 1 example: 0 type: integer id: description: The ID of the backup destination to modify. example: 0W1ei2rd3A4lI5sT6he7Be8st type: string name: description: 'A new name for the backup destination. **Note:** If you do not set this parameter, the system retains the current setting.' example: destination_name type: string type: description: 'The type of backup destination. **Note:** If you do not set this parameter, the system retains the current setting. Select a backup destination from the following menu to view its optional parameters:' enum: - Custom - FTP - Local - SFTP - WebDAV - AmazonS3 - Rsync - GoogleDrive - S3Compatible - Backblaze example: Local type: string upload_system_backup: description: 'Whether to upload system backups. * `1` — Upload. * `0` — Do **not** upload. **Note:** If you do not set this parameter, the system retains the current setting.' enum: - 0 - 1 example: 1 type: integer only_used_for_logs: description: 'Whether to use this transport only for logs. * `1` — This destination will be skipped for regular backups. * `0` — Both log and regular backups will be uploaded. This setting defaults to 0. The only time log files get their own backup is via scripts/remote_log_transfer **Note:** If you do not set this parameter, the system retains the current setting.' enum: - 0 - 1 example: 1 type: integer required: - id type: object BackupDestinationSetParameterLocal: allOf: - $ref: '#/components/schemas/BackupDestinationSetParameterBase' - properties: mount: default: 0 description: 'Whether the path is mounted. * `1` - The path is mounted. * `0` - The path is **not** mounted.' enum: - 1 - 0 example: 0 type: integer no_mount_fail: default: 0 description: 'Whether to fail the backup attempt if the mount fails. * `1` - Fail the backup attempt. * `0` - Do **not** fail the backup attempt.' enum: - 1 - 0 example: 0 type: integer path: description: The absolute path to the backups directory. example: /home/backups format: path type: string required: - path type: object AmazonS3BackupDestinationResponse: allOf: - $ref: '#/components/schemas/BackupDestinationResponse' - properties: aws_access_key_id: description: The Amazon S3 Access Key ID. example: s123456789 type: string bucket: description: The Amazon S3™ bucket. example: ChockFullOfNuts type: string folder: default: '' description: The path to the backups directory, relative to the root directory, on the remote server. example: subfolder type: string timeout: default: 30 description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer type: object CustomBackupDestinationResponse: allOf: - $ref: '#/components/schemas/BackupDestinationResponse' - properties: host: description: The remote server's hostname. example: backups.example.com format: domain type: string path: description: The path to the backups directory on the remote server. example: /backups format: path type: string script: description: The absolute file path of the user-supplied transport solution script. example: /home/backups/beammeupscotty.pl type: string timeout: default: 30 description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer username: description: The remote server account's username. example: username type: string type: object BackupDestinationGetResponse: anyOf: - $ref: '#/components/schemas/BackupDestinationGetResponseAmazonS3' - $ref: '#/components/schemas/BackupDestinationGetResponseBackblaze' - $ref: '#/components/schemas/BackupDestinationGetResponseCustom' - $ref: '#/components/schemas/BackupDestinationGetResponseFTP' - $ref: '#/components/schemas/BackupDestinationGetResponseGoogleDrive' - $ref: '#/components/schemas/BackupDestinationGetResponseLocal' - $ref: '#/components/schemas/BackupDestinationGetResponseRsync' - $ref: '#/components/schemas/BackupDestinationGetResponseS3Compatible' - $ref: '#/components/schemas/BackupDestinationGetResponseSFTP' - $ref: '#/components/schemas/BackupDestinationGetResponseWebDAV' discriminator: mapping: AmazonS3: '#/components/schemas/BackupDestinationGetResponseAmazonS3' Backblaze: '#/components/schemas/BackupDestinationGetResponseBackblaze' Custom: '#/components/schemas/BackupDestinationGetResponseCustom' FTP: '#/components/schemas/BackupDestinationGetResponseFTP' GoogleDrive: '#/components/schemas/BackupDestinationGetResponseGoogleDrive' Local: '#/components/schemas/BackupDestinationGetResponseLocal' Rsync: '#/components/schemas/BackupDestinationGetResponseRsync' S3Compatible: '#/components/schemas/BackupDestinationGetResponseS3Compatible' SFTP: '#/components/schemas/BackupDestinationGetResponseSFTP' WebDAV: '#/components/schemas/BackupDestinationGetResponseWebDAV' propertyName: type S3CompatibleBackupDestinationResponse: allOf: - $ref: '#/components/schemas/BackupDestinationResponse' - properties: aws_access_key_id: description: The S3-compatible provider key ID. example: s123456789 type: string bucket: description: The S3-compatible bucket. example: ChockFullOfNuts type: string folder: default: '' description: The path to the backups directory, relative to the root directory, on the remote server. example: subfolder type: string host: description: The S3-compatible provider's server. example: www.s3example.com type: string timeout: default: 30 description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer type: object BackupDestinationSetParameterType: anyOf: - $ref: '#/components/schemas/BackupDestinationSetParameterAmazonS3' - $ref: '#/components/schemas/BackupDestinationSetParameterBackblaze' - $ref: '#/components/schemas/BackupDestinationSetParameterCustom' - $ref: '#/components/schemas/BackupDestinationSetParameterFTP' - $ref: '#/components/schemas/BackupDestinationSetParameterGoogleDrive' - $ref: '#/components/schemas/BackupDestinationSetParameterLocal' - $ref: '#/components/schemas/BackupDestinationSetParameterRsync' - $ref: '#/components/schemas/BackupDestinationSetParameterS3Compatible' - $ref: '#/components/schemas/BackupDestinationSetParameterSFTP' - $ref: '#/components/schemas/BackupDestinationSetParameterWebDAV' discriminator: mapping: AmazonS3: '#/components/schemas/BackupDestinationSetParameterAmazonS3' Backblaze: '#/components/schemas/BackupDestinationSetParameterBackblaze' Custom: '#/components/schemas/BackupDestinationSetParameterCustom' FTP: '#/components/schemas/BackupDestinationSetParameterFTP' GoogleDrive: '#/components/schemas/BackupDestinationSetParameterGoogleDrive' Local: '#/components/schemas/BackupDestinationSetParameterLocal' Rsync: '#/components/schemas/BackupDestinationSetParameterRsync' S3Compatible: '#/components/schemas/BackupDestinationSetParameterS3Compatible' SFTP: '#/components/schemas/BackupDestinationSetParameterSFTP' WebDAV: '#/components/schemas/BackupDestinationSetParameterWebDAV' propertyName: type BackupDestinationGetResponseSFTP: allOf: - $ref: '#/components/schemas/BackupDestinationGetResponseBase' - properties: authtype: description: 'The authorization type. * `password` * `key`' enum: - password - key example: password host: description: The remote server's hostname. example: backups.example.com format: domain type: string path: description: The path to the backups directory on the remote server. example: /backups format: path type: string port: description: The remote server's FTP port. example: 21 maximum: 65535 minimum: 1 type: integer privatekey: description: If the `authtype` return's value is `key`, the absolute path to the private key file. example: /home/backups/key format: path type: string timeout: description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer username: description: The remote server account's username. example: username type: string type: object BackupDestinationGetResponseBase: properties: disable_reason: description: 'An error message that explains why the backup is disabled. **Note:** You will only see this return when the transport is disabled.' example: 'Could not list files in destination: example' type: string disabled: description: 'Shows whether the backup destination is disabled. * `1` — The destination is disabled. * `0` — The destination is enabled.' enum: - 0 - 1 example: 0 type: integer id: description: The backup destination's ID example: sNnLb1req9oJN9lUJFhA99kY type: string name: description: The backup destination's name. example: destination_name type: string type: description: 'The type of backup destination. Select a backup destination from the following menu to view its return values:' enum: - Custom - FTP - Local - SFTP - WebDAV - AmazonS3 - Rsync - GoogleDrive - S3Compatible - Backblaze example: Local type: string type: object BackupDestinationGetResponseAmazonS3: allOf: - $ref: '#/components/schemas/BackupDestinationGetResponseBase' - properties: aws_access_key_id: description: The Amazon S3 Access Key ID. example: s123456789 type: string bucket: description: The Amazon S3™ bucket. example: ChockFullOfNuts type: string folder: description: The path to the backups directory, relative to the root directory, on the remote server. example: subfolder format: path type: string timeout: description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer type: object BackupDestinationSetParameterWebDAV: allOf: - $ref: '#/components/schemas/BackupDestinationSetParameterBase' - properties: host: description: The remote server's hostname. example: backups.example.com format: domain type: string password: description: The remote server account's password. example: 123456luggage type: string path: description: The path to the backups directory on the remote server. example: /backups format: path type: string port: default: 21 description: The remote server's FTP port. example: 21 maximum: 65535 minimum: 1 type: integer ssl: default: 1 description: 'Whether to use SSL. * `1` - Use SSL. * `0` - Do **not** use SSL.' enum: - 1 - 0 example: 1 type: integer timeout: default: 30 description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer username: description: The remote server account's username. example: username type: string required: - host - path - username - password type: object BackupDestinationGetResponseS3Compatible: allOf: - $ref: '#/components/schemas/BackupDestinationGetResponseBase' - properties: aws_access_key_id: description: The S3-compatible provider key ID. example: s123456789 type: string bucket: description: The S3-compatible bucket. example: ChockFullOfNuts type: string folder: description: The path to the backups directory, relative to the root directory, on the remote server. example: subfolder type: string host: description: The S3-compatible provider's server. example: www.s3example.com format: domain type: string timeout: description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer type: object BackupDestinationGetResponseLocal: allOf: - $ref: '#/components/schemas/BackupDestinationGetResponseBase' - properties: mount: description: 'Whether the path is mounted. * `1` - The path is mounted. * `0` - The path is **not** mounted.' enum: - 1 - 0 example: 0 type: integer no_mount_fail: description: 'Whether to fail the backup attempt if the mount fails. * `1` - Fail the backup attempt. * `0` - Do **not** fail the backup attempt.' enum: - 1 - 0 example: 0 type: integer path: description: The absolute path to the backups directory. example: /home/backups format: path type: string type: object BackupDestinationSetParameterFTP: allOf: - $ref: '#/components/schemas/BackupDestinationSetParameterBase' - properties: host: description: The remote server's hostname. example: backups.example.com format: domain type: string passive: default: 1 description: 'Whether to use passive FTP. * `1` - Use passive FTP. * `0` - Use active FTP.' example: 1 type: integer password: description: The remote server account's password. example: 123456luggage type: string path: description: The path to the backups directory on the remote server. example: /backups format: path type: string port: default: 21 description: The remote server's FTP port. example: 21 maximum: 65535 minimum: 1 type: integer timeout: default: 30 description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer username: description: The remote server account's username. example: username type: string required: - host - path - username - password type: object BackupDestinationSetParameterCustom: allOf: - $ref: '#/components/schemas/BackupDestinationSetParameterBase' - properties: host: description: The remote server's hostname. example: backups.example.com format: domain type: string password: description: The remote server account's password. example: 123456luggage type: string path: description: The path to the backups directory on the remote server. example: /backups format: path type: string script: description: The absolute file path of the user-supplied transport solution script. example: /home/backups/beammeupscotty.pl format: path type: string timeout: default: 30 description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer username: description: The remote server account's username. example: username type: string required: - script - host - path - username - password type: object BackupDestinationSetParameterRsync: allOf: - $ref: '#/components/schemas/BackupDestinationSetParameterBase' - properties: authtype: description: 'The authorization type. * `password` * `key`' enum: - password - key example: password host: description: The remote server's hostname. example: backups.example.com format: domain type: string passphrase: description: If the `authtype` parameter's value is `key`, the private key file's passphrase. example: 123456luggage type: string password: description: If the `authtype` parameter's value is `password`, the remote server account's password. example: 123456luggage type: string path: description: The path to the backups directory on the remote server. example: /backups format: path type: string port: default: 22 description: The remote server's FTP port. example: 22 maximum: 65535 minimum: 1 type: integer privatekey: description: If the `authtype` parameter's value is `key`, the absolute path to the private key file. example: /home/backups/key format: path type: string timeout: default: 30 description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer username: description: The remote server account's username. example: username type: string required: - host - path - username - authtype type: object BackupDestinationSetParameterSFTP: allOf: - $ref: '#/components/schemas/BackupDestinationSetParameterBase' - properties: authtype: description: 'The authorization type. * `password` * `key`' enum: - password - key example: password host: description: The remote server's hostname. example: backups.example.com format: domain type: string passphrase: description: If the `authtype` parameter's value is `key`, the private key file's passphrase. example: 123456luggage type: string password: description: If the `authtype` parameter's value is `password`, the remote server account's password. example: 123456luggage type: string path: description: The path to the backups directory on the remote server. example: /backups format: path type: string port: default: 21 description: The remote server's FTP port. example: 21 maximum: 65535 minimum: 1 type: integer privatekey: description: If the `authtype` parameter's value is `key`, the absolute path to the private key file. example: /home/backups/key format: path type: string timeout: default: 30 description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer username: description: The remote server account's username. example: username type: string required: - host - path - username - authtype type: object WebDAVBackupDestinationResponse: allOf: - $ref: '#/components/schemas/BackupDestinationResponse' - properties: host: description: The remote server's hostname. example: backups.example.com format: domain type: string path: description: The path to the backups directory on the remote server. example: /backups format: path type: string port: default: 21 description: The remote server's FTP port. example: 21 maximum: 65535 minimum: 1 type: integer ssl: default: 1 description: 'Whether to use SSL. * `1` - Use SSL. * `0` - Do **not** use SSL.' enum: - 1 - 0 example: 1 type: integer timeout: default: 30 description: The session timeout, in seconds. example: 300 maximum: 300 minimum: 30 type: integer username: description: The remote server account's username. example: username type: string type: object securitySchemes: BasicAuth: scheme: basic type: http externalDocs: url: https://cpanel.net/developers/ x-tagGroups: - name: Account Restoration tags: - Restore Account - Restore Queue Management - Restore Queue Reporting - name: Accounts tags: - Account Creation - Account Enhancements - Account Management - Bandwidth and Disk Quotas - Domain Information - Passwords - Styles - Suspensions - name: API Development Tools tags: - API Execution - API Statistics - API Token Management - Applications - Session - name: Authentication tags: - Authentication Providers - External Authentication - Login URL - SSH Keys and Connections - Two-Factor Authentication - name: Backups tags: - Backup Destination - Backup or Restore - Backup Settings - Legacy Migration - name: Commerce Integration tags: - Market Integration - Sitejet - name: cPanel Market tags: - Product Management - Provider Management - name: cPanel Support Tickets tags: - Support Access - Ticket Management - name: Customizations tags: - Brand - Customizations - name: Databases tags: - Manage MySQL Server - MySQL Databases - PostgreSQL Databases - Remote MySQL Databases - name: DNS tags: - DNS Cluster Settings - DNS Security - DNS Zones - Domain Management - Domain Management - Resolvers - Service Records - name: Hosting Plans tags: - Feature Access - Feature Lists - Hosting Plan Extensions - Hosting Plans - name: InProductSurvey tags: - InProductSurvey - name: Integrations tags: - API Authentication - Links - Scripts Hooks - name: IP Address Management tags: - IPv4 Address Settings - IPv6 Address Settings - Network Address Translation - name: Login Security (cPHulk) tags: - Management - Reporting - Settings - name: Logs tags: - Web Log Retention - name: Mail tags: - cPanel Account Mail Management - Mail DNS Settings - Mail Server Settings - Spam Management - Spam Protection (Greylisting) - name: Monitoring tags: - 360 Monitoring - name: NGINX Manager tags: - NGINX Manager - name: Resellers tags: - Account Enhancement Limit - Account Limits - Account Permissions - Account Settings - Reseller Account Management - name: Security tags: - WHM Access - name: Server Administration tags: - Configuration Clusters - Configurations - Connected Applications - Connections - cPanel Analytics - License Management - Notifications - Plugin-Based Features - Security - Server Nodes - Server Profiles - Services - System Information - Updates - name: SSL Certificates tags: - Auto-Generated Certificates - cPanel Account Settings - SSL Server Settings - name: System Package Management tags: - Install or Uninstall Package - List Package Information - Package Manager Settings - name: Transfers tags: - cPanel Account Transfer - Transfer Configuration - Transfer Monitoring - name: UserData tags: - UserData - name: Web Server Configuration tags: - EasyApache Settings - PHP - PHP-FPM - name: Web Server Security (ModSecurity) tags: - Rule Settings - Rule Vendor Settings - Server Settings