# cPanel Box Trapper API

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

cPanel Box Trapper 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 BoxTrapper. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

The BoxTrapper module for UAPI.

## Operations (25)

| Method | Path | Summary |
|---|---|---|
| GET | `/BoxTrapper/blacklist_messages` | Add email address to BoxTrapper blocked senders |
| GET | `/BoxTrapper/delete_messages` | Delete messages in the BoxTrapper queue |
| GET | `/BoxTrapper/deliver_messages` | Send messages in the BoxTrapper queue |
| GET | `/BoxTrapper/get_allowlist` | Return account BoxTrapper allowlist rules |
| GET | `/BoxTrapper/get_blocklist` | Return account BoxTrapper blocklist rules |
| GET | `/BoxTrapper/get_configuration` | Return email account's BoxTrapper configuration |
| GET | `/BoxTrapper/get_email_template` | Return specified BoxTrapper email template |
| GET | `/BoxTrapper/get_forwarders` | Return all BoxTrapper forwarders |
| GET | `/BoxTrapper/get_ignorelist` | Return account BoxTrapper ignorelist rules |
| GET | `/BoxTrapper/get_log` | Return BoxTrapper log file and contents |
| GET | `/BoxTrapper/get_message` | Return message's top 200 lines in BoxTrapper queue |
| GET | `/BoxTrapper/get_status` | Return whether email account uses BoxTrapper |
| GET | `/BoxTrapper/ignore_messages` | Add email account to Exim ignore list |
| GET | `/BoxTrapper/list_email_templates` | Return BoxTrapper email templates |
| GET | `/BoxTrapper/list_queued_messages` | Return email account's BoxTrapper queued messages |
| GET | `/BoxTrapper/process_messages` | Run a specific BoxTrapper action for a message |
| GET | `/BoxTrapper/reset_email_template` | Restore default BoxTrapper email message template |
| GET | `/BoxTrapper/save_configuration` | Update email account's BoxTrapper configuration |
| GET | `/BoxTrapper/save_email_template` | Save BoxTrapper message template contents |
| GET | `/BoxTrapper/set_allowlist` | Update account BoxTrapper allowlist |
| GET | `/BoxTrapper/set_blocklist` | Update account BoxTrapper blocklist |
| GET | `/BoxTrapper/set_forwarders` | Add email address to BoxTrapper forwarders |
| GET | `/BoxTrapper/set_ignorelist` | Update account BoxTrapper ignorelist |
| GET | `/BoxTrapper/set_status` | Enable or disable BoxTrapper for email account |
| GET | `/BoxTrapper/whitelist_messages` | Add email address to BoxTrapper allowed senders |

## Machine-readable artifacts (7)

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

BoxTrapper

---

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