cPanel

cPanel Server Administration API

The Server Administration module for WHM API 1.

GitHub OpenAPI

Operations 66

POST /add_configclusterserver Add configuration cluster server #
GET /configurebackgroundprocesskiller Update background process stopper #
GET /configureservice Enable or disable a service and its monitoring #
GET /create_user_session Create a temporary user session #
GET /delete_configclusterserver Delete server from configuration cluster #
GET /enable_monitor_all_enabled_services Enable monitoring for all services #
POST /fetch_connected_application Fetch application connection information #
GET /force_dedistribution_from_node Repair distributed accounts with data loss #
GET /get_all_contact_importances Return Contact Manager event importance settings #
GET /get_api_calls Return deprecated cPanel API 1 functions by date #
GET /get_api_pages Return deprecated cPanel API 1 functions #
GET /get_appconfig_application_list Return registered applications #
GET /get_application_contact_event_importance Return app's event contact importance setting #
GET /get_application_contact_importance Return app contact importance setting #
GET /get_available_profiles Return available server profiles #
GET /get_current_profile Return server's node profile #
GET /get_linked_server_node Return linked remote server node settings #
GET /get_remote_access_hash Return remote access file's hash #
GET /get_server_node_status Return linked server node status #
GET /get_service_config Return service configuration settings #
GET /get_service_config_key Return service configuration key #
GET /get_tcp4_sockets Return TCP IPv4 sockets data #
GET /get_tcp6_sockets Return TCP IPv6 sockets data #
GET /get_udp4_sockets Return UDP IPv4 sockets data #
GET /get_udp6_sockets Return UDP IPv6 sockets data #
GET /get_update_availability Return if server uses the default update version #
GET /getdiskusage Return server's drive partition information #
GET /gethostname Return server's hostname #
GET /is_role_enabled Return whether server role is enabled #
GET /list_configclusterservers Return all configuration cluster servers #
POST /list_connected_applications List application connection information #
GET /list_linked_server_nodes Return all linked server nodes #
GET /list_user_child_nodes Return cPanel accounts with server name and type #
POST /personalization_get Return data from NVData file #
POST /personalization_set Save data to NVData file #
GET /purchase_a_license Return cPanel Store or Market checkout URL #
GET /reboot Restart server #
POST /remove_connected_application Remove application connection information #
GET /remove_in_progress_exim_config_edit Remove Exim configuration files after failed update #
GET /restartservice Restart service #
GET /restore_config_from_file Update configuration file from backup #
POST /restore_config_from_upload Update configuration file from backup via POST #
GET /run_cpkeyclt Return server's cPanel license status #
POST /save_connected_application Save application connection information #
GET /send_test_posturl Send notification URL via POST #
GET /send_test_pushbullet_note Send Pushbullet™ test with access token #
GET /servicestatus Return service status #
GET /set_application_contact_event_importance Update app's event contact importance setting #
GET /set_application_contact_importance Update app contact importance setting #
GET /set_primary_servername Update server's primary virtual host #
GET /set_service_config_key Update service configuration key #
GET /sethostname Update server's hostname #
GET /start_cpanel_update Start cPanel & WHM update #
GET /start_profile_activation Update server node profile #
GET /system_needs_reboot Return whether system needs reboot #
GET /systemloadavg Return system load average #
GET /update_configclusterserver Update configuration cluster server credentials #
GET /update_contact_email Update WHM contact email address #
GET /update_linked_server_node Update linked server node settings #
GET /verify_posturl_access Send notification URL via POST verification #
GET /verify_pushbullet_access Send Pushbullet™ access verification #
GET /verify_slack_access Verify Slack® Webhook connection #
GET /wp_dashboard_get_hostname Return server's hostname #

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-server-administration-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-server-administration-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-server-administration-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 Server Administration 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 (308 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cpanel/refs/heads/main/openapi/cpanel-server-administration-api-openapi.yml