Skip to main content
MainWP Dashboard 6.4 registers 32 abilities in the mainwp-backups category. Use them to manage MainWP Built-In Backups through the WordPress Abilities API or the MainWP MCP Server.

Prerequisites

  • MainWP Dashboard 6.4 or later and the matching MainWP Child release
  • WordPress 6.9 or later on the Dashboard
  • An authenticated Dashboard user with access to the requested sites and the required backup permissions
  • Built-in backups enabled for backup creation and restores
Authenticate direct API requests with a WordPress Application Password. MainWP REST API keys do not authenticate Abilities API requests.

Discover the Available Schemas

List the category to retrieve each ability’s input schema, output schema, and execution instructions:
Fetch one ability’s definition before calling it:
Use the returned schema for the installed Dashboard version. Inputs reject unknown fields. Storage credentials, encryption keys, and recovery passphrases are not exposed by these abilities.

Read Backup Status

Read abilities use GET. Pass input as a JSON-encoded input query parameter when needed:
In MainWP Dashboard 6.4.2 and later, a task run’s upload counts include active uploads and uploads awaiting another attempt under pending. The failed count includes permanent upload failures and invalid storage credentials. Check these counts separately from the site’s backup result when you need to verify a remote copy.

Preview and Confirm Changes

Write abilities use POST and require either dry_run: true to preview or confirm: true to execute. Preview the action, review its affected sites, destinations, retention deletions, and warnings, then confirm the same selection. Do not set both flags to true. For example, preview an on-demand full backup:
After reviewing the preview, execute it:
The backup continues in the background. Follow the returned polling instructions until it completes or fails. A start response does not mean the backup has finished. If the result is not_started, no work was queued; retry later. An already_running result attaches to an existing run, so poll it rather than starting another. Edit destination credentials, hosts, buckets, and paths in Backups > Storage (/wp-admin/admin.php?page=ManageBackupsStorage). Configure encryption and the recovery passphrase in Backup Settings.

Read API Backups Data

MainWP Dashboard 6.4.1 adds two read-only abilities for API Backups. They appear in the mainwp-backups category when the API Backups module is enabled. Use them to check which hosting providers are configured and when backups were last requested for each site. These abilities read only data stored on the Dashboard. They do not contact providers or Child Sites, and they never read or decrypt credentials. A listed provider does not mean its credentials are valid. Filter the site list by provider and page through results. per_page accepts 1 to 100 and defaults to 20:
Example response:
last_backup is the date a backup was last requested, or null if none is stored. It is not a confirmed completion time. last_status is unknown because API Backups does not consistently store backup outcomes. hidden_site_count is the number of sites excluded because your account can’t access them. Provider values are cloudways, gridpane, vultr, linode, digitalocean, cpanel, plesk, and kinsta. Both abilities require a Dashboard administrator with the API Backups management permission. The providers ability also requires access to all sites and tags. Accounts restricted to some sites receive 403 with mainwp_restricted_account.

Permissions and Restore Results

Abilities enforce the user’s site access, task ownership, and operation permissions. Storage changes require an account with access to all sites. Reading or changing global backup settings requires the corresponding Dashboard settings permissions. Before confirming a restore, review the preview’s replacement and WooCommerce warnings. After starting it, poll mainwp/get-restore-job-v1 and inspect outcome, partial_state_risk, and verification. A cancellation request may still be pending; keep polling until the site confirms it stopped. Rollback requires an available safety backup from the original restore. For restore precautions and recovery options, see Restore a Snapshot.