cPanel

cPanel Backups API

The Backups module for WHM API 1.

GitHub OpenAPI

Operations 27

GET /backup_config_get Return backup configuration file data #
GET /backup_config_set Update the system's backup configuration #
GET /backup_date_list Return dates where backup files exist #
GET /backup_destination_add Add a backup destination #
GET /backup_destination_delete Delete a backup destination #
GET /backup_destination_get Return a backup destination's settings #
GET /backup_destination_list Return a list of backup destinations #
POST /backup_destination_set Update backup destination settings #
GET /backup_destination_validate Validate a backup destination #
GET /backup_does_client_id_have_google_credentials Return Google Drive™ client ID credentials #
GET /backup_generate_google_oauth_uri Create Google Drive™ OAuth redirect URI #
GET /backup_get_transport_status Return backup transport events' status #
GET /backup_list_transported Return backup files sent through transport #
GET /backup_set_list Return backup files in the local disk #
GET /backup_set_list_combined Return backup files for the server's accounts #
GET /backup_skip_users_all Enable or disable backups #
GET /backup_skip_users_all_status Return backup configuration status #
GET /backup_user_list Return users with a backup file #
GET /convert_and_migrate_from_legacy_config Migrate server to new backup system #
GET /fetch_pkgacct_master_log Return start_background_pkgacct session log file #
GET /get_pkgacct_session_state Return start_background_pkgacct session state #
GET /get_users_and_domains_with_backup_metadata Return users and domains with backup metadata #
GET /get_users_with_backup_metadata Return users with backup metadata #
GET /list_cparchive_files Return cparchive files list #
GET /start_background_pkgacct Back up an account using the pkgacct script #
GET /start_local_cpmove_restore Restore one cPanel account from a backup #
GET /toggle_user_backup_state Enable or disable legacy backups #

Documentation

📖
Documentation
https://api.docs.cpanel.net/cpanel/introduction/
📖
APIReference
https://api.docs.cpanel.net/specifications/cpanel.openapi
📖
Authentication
https://api.docs.cpanel.net/cpanel/tokens/
📖
Documentation
https://api.docs.cpanel.net/whm/introduction/
📖
APIReference
https://api.docs.cpanel.net/specifications/whm.openapi
📖
Authentication
https://api.docs.cpanel.net/whm/tokens/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cpanel/refs/heads/main/openapi/cpanel-backups-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cpanel-backups-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cpanel-backups-api-openapi.yml Raw ↑ 
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:


# --- truncated at 32 KB (207 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cpanel/refs/heads/main/openapi/cpanel-backups-api-openapi.yml