cPanel

cPanel Box Trapper API

The BoxTrapper module for UAPI.

GitHub OpenAPI

Operations 25

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 #

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-boxtrapper-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-boxtrapper-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-boxtrapper-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: cs@cpanel.net
    name: WebPros International, LLC
    url: https://cpanel.net/support/
  description: UAPI accesses the cPanel interface's features. Use this API to access and modify cPanel account data and settings.
  license:
    name: cPanel License
    url: https://cpanel.net/legal-notices/
  termsOfService: https://cpanel.net/legal-notices/
  title: cPanel U Box Trapper 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 cPanel.
  url: https://{host}:{port}/execute
  variables:
    host:
      default: cpanel-server.tld
      description: The hostname of a server running cPanel.
    port:
      default: '2083'
      description: The cPanel port.
security:
- BasicAuth: []
tags:


# --- truncated at 32 KB (232 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cpanel/refs/heads/main/openapi/cpanel-boxtrapper-api-openapi.yml