Le API di cPanel consentono di automatizzare la gestione degli account, dei domini, dei database e di numerose altre funzionalità di hosting. Offrono diversi livelli di accesso e formati di interazione, rendendole utili sia per sviluppatori che per amministratori di sistema.
Tipologie di API
UAPI
UAPI è l'API moderna progettata per gli utenti finali. Permette di gestire aspetti come email, domini aggiuntivi, database e metriche.
uapi --user=username Email list_pops
API 2
API 2 è una versione precedente ma tuttora utilizzata per alcune funzionalità non ancora migrate a UAPI.
cpapi2 --user=username Email listpopswithdisk
WHM API 1
WHM API 1 è destinata agli amministratori di server e consente la gestione degli account, dei pacchetti, degli IP e di risorse avanzate.
whmapi1 list_accounts
Autenticazione
L'accesso può avvenire tramite password dell'account, token di accesso o autenticazione HTTP Basic.
curl -H "Authorization: cpanel username:token" \
"https://example.com:2083/execute/Email/list_pops"
Struttura delle risposte
Le API restituiscono generalmente risposte in formato JSON per facilitare l'integrazione con applicazioni esterne.
{
"status": 1,
"data": {
"email": "info@example.com",
"disk_used": 1024
}
}
Esempio pratico
Ecco un esempio di script in Python per interrogare UAPI:
import requests
url = "https://example.com:2083/execute/Email/list_pops"
headers = {
"Authorization": "cpanel username:token"
}
response = requests.get(url, headers=headers, verify=False)
print(response.json())