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 Access 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: Security / WHM Access name: WHM Access paths: /allow_all_whm_root_access: get: description: This function removes all restrictions to root login to cPanel & WHM login based on IP. operationId: RootIPAccess-allow_all_whm_root_access responses: '200': content: application/json: schema: properties: metadata: properties: command: description: The method name called. example: allow_all_whm_root_access 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: Clear all CIDR restrictions to login to cPanel & WHM with the root password tags: - WHM Access x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n allow_all_whm_root_access\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/allow_all_whm_root_access?api.version=1 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '108' /restrict_whm_root_access: get: description: 'This function restricts root login to cPanel & WHM based on a list of CIDR addresses. **Note:** This API manipulates `/var/cpanel/authorized_whm_root_ips`. We HIGHLY recommend you not modify this file directly. Improper formatting of the file can lead to loss of all access to cPanel & WHM using the root password. Use of this API replaces any previous restrictions so be sure to include previous CIDR patterns when adding new ones. As this API only restricts logins, please be aware that existing root logins are not terminated when these restrictions are asserted. This API DOES NOT restrict root resellers.' operationId: RootIPAccess-restrict_whm_root_access parameters: - description: 'The IPs you wish to restrict in CIDR format. **Note:** You can pass this parameter multiple times.' examples: multiple: summary: Multiple CIDR Addresses. value: - 10.2.0.0/16 - 10.6.5.0/24 - 10.1.6.7 single: summary: A single CIDR Address value: 10.2.0.0/16 explode: true in: query name: cidr required: true schema: format: cidr type: string style: form responses: '200': content: application/json: schema: properties: data: properties: cidr: type: array example: - 10.2.0.0/16 - 10.6.5.0/24 - 10.1.6.7 items: type: string format: cidr description: A reduced list of what CIDR addresses root access will be restricted to. type: object metadata: properties: command: description: The method name called. example: restrict_whm_root_access 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: Restrict Access to WHM by CIDR list tags: - WHM Access x-codeSamples: - label: CLI lang: Shell source: "whmapi1 --output=jsonpretty \\\n restrict_whm_root_access \\\n cidr=10.2.0.0/16 \\\n cidr=10.6.5.0/24 \\\n cidr=10.1.6.7\n" - label: URL lang: HTTP source: https://hostname.example.com:2087/cpsess##########/json-api/restrict_whm_root_access?api.version=1&cidr=10.2.0.0/16&cidr=10.6.5.0/24&cidr=10.1.6.7 x-cpanel-api-version: WHM API 1 x-cpanel-available-version: '108' components: 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