Establishing Secure Automation Uplinks

The API Manager is the gateway for external platforms to communicate with your BoostonCP node. Follow this manual to establish a secure API access key.

Step 1: Open the Configuration Portal

Navigate to API Manager in the Admin Panel sidebar and click the "Create New API Key" button.

Step 2: Define Identity & Security Scope

  1. Key Identifier (Name): Provide a descriptive name (e.g., WHMCS Primary Node).
  2. Allowed IP Addresses: (Crucial Security) Enter the IPv4 address of the server that will call the API. For example, enter your WHMCS server IP. Note: Leave blank only for debugging; always restrict in production.
[IMAGE_PLACE_HOLDER: API Modal Step - Screenshot of the API configuration modal with permissions.]

Step 3: Managing Permissions (Scope)

BoostonCP supports Granular ACL (Access Control List). Toggle the switches to define what this specific key can do:

  • Create Users: Authorization to establish new system accounts and websites.
  • Suspend/Unsuspend: Authorization to pause user services for billing or abuse reasons.
  • Terminate Users: Authorization to permanently erase user data.
  • View Statistics: Read-only access to server telemetry and usage reports.

Step 4: Activation & Retrieval

Click "Save API Configuration". Your new key will appear in the API Ledger. Use the "Copy Icon" to transmit the long-string key to your automation software.

SECURITY HARDENING: Treat your API Key as a root password. If a key is compromised, use the Status Selector to set it to "Disabled" instantly to sever the neural uplink.