Everything you can do in the ProxyPass dashboard, you can do through the Management API. And everything you can automate in your infrastructure, you can connect to ProxyPass through the same API.
API Overview
The API is REST-based, authenticated with your API key via the X-ProxyPass-ApiKey header. Documentation in the customer portal includes examples in cURL, .NET, Python, and Node.js for every endpoint.
The core operations cover the full node lifecycle:
- GET / — group overview with node counts and request statistics
- GET /nodes — paginated list of all nodes with details
- PUT /nodes//alias — set or clear a node alias
- POST /nodes//block — block a node (immediate disconnect, 6-hour reconnect)
- POST /nodes//unblock — restore a blocked node
- POST /nodes//restart — restart container or host OS
- POST /nodes//remove — permanently remove a node
Scenario: Automated Health Recovery
Your monitoring system tracks node uptime. It detects that a node at a warehouse has not sent traffic in 24 hours — unusual for a node that normally handles hundreds of requests per day. Something is stuck.
Your automation script kicks in:
- Calls the restart endpoint with
type: "container" - Waits 60 seconds for the node to come back online
- Polls the node list to check the node's status
- If still no traffic after 5 minutes, calls restart with
type: "os" - If still unresponsive after another 5 minutes, sends an alert to the on-call engineer
This entire sequence runs without human intervention. The on-call engineer only gets paged if two levels of automated recovery have already failed. Most of the time, a container restart fixes it, and nobody is woken up at 3 AM.
Integration Power
What makes this powerful is integration. Your provisioning pipeline deploys a new batch of devices — it polls the node list to confirm they registered. Your security team flags a compromised site — it blocks the node in the same script that locks the other credentials. Your billing system needs node counts — it queries the group overview.
The API returns structured JSON responses, making it straightforward to parse results and chain operations. For businesses that run ProxyPass alongside other infrastructure, the API is how ProxyPass becomes part of your operational workflow rather than a separate tool you check manually.