# cPanel Server Administration API

**Canonical:** https://apis.io/apis/cpanel/cpanel-server-administration-api/  
**Provider:** cPanel — https://apis.io/providers/cpanel/  
**Base URL:** https://{host}:2083/execute  
**Documentation:** https://api.docs.cpanel.net/cpanel/introduction/

cPanel Server Administration API is one of 144 APIs that [cPanel](https://apis.io/providers/cpanel/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Server Administration. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

The Server Administration module for WHM API 1.

## Operations (60 of 66)

| Method | Path | Summary |
|---|---|---|
| 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 | `/link_server_node_with_api_token` | Add linked server node |
| 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 | `/unlink_server_node` | Remove linked server node |
| GET | `/update_configclusterserver` | Update configuration cluster server credentials |
| GET | `/update_contact_email` | Update WHM contact email address |

…and 6 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/cpanel/refs/heads/main/openapi/cpanel-server-administration-api-openapi.yml
- **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/

## Other cPanel APIs (12)

- [cPanel API 2 (Legacy)](https://apis.io/apis/cpanel/cpanel-api-2/)
- [Manage2 API](https://apis.io/apis/cpanel/manage2/)
- [cPanel 360 Monitoring API](https://apis.io/apis/cpanel/cpanel-360-monitoring-api/)
- [cPanel Account Creation API](https://apis.io/apis/cpanel/cpanel-account-creation-api/)
- [cPanel Account Enhancements API](https://apis.io/apis/cpanel/cpanel-account-enhancements-api/)
- [cPanel Account Management API](https://apis.io/apis/cpanel/cpanel-account-management-api/)
- [cPanel Account Restoration API](https://apis.io/apis/cpanel/cpanel-account-restoration-api/)
- [cPanel Accounts API](https://apis.io/apis/cpanel/cpanel-accounts-api/)
- [cPanel Addon Domain API](https://apis.io/apis/cpanel/cpanel-addondomain-api/)
- [cPanel API Execution API](https://apis.io/apis/cpanel/cpanel-api-execution-api/)
- [cPanel Applications API](https://apis.io/apis/cpanel/cpanel-applications-api/)
- [cPanel Authentication API](https://apis.io/apis/cpanel/cpanel-authentication-api/)

## Tags

Server Administration

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/cpanel/cpanel-server-administration-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/cpanel/.