Documentation
Home

Nodes API

Manage proxy nodes, monitor status, and perform maintenance operations

Overview

The Nodes API allows you to monitor and manage the proxy nodes in your network. Track node status, perform maintenance operations, and retrieve detailed metrics.

Base URL

https://api.enterpriseproxynetwork.com/v1/nodes

Endpoints

GET /nodes

List all nodes with pagination

GET /v1/nodes?page=1&limit=50

Response:

{
  "data": [
    {
      "id": "node_1234567890abcdef",
      "name": "US-East-Node-01",
      "status": "online",
      "country": "US",
      "region": "east",
      "ip_address": "192.168.1.100",
      "version": "2.1.0",
      "last_seen": "2024-01-15T10:30:00Z",
      "uptime_hours": 720,
      "active_sessions": 45,
      "bandwidth_gb": 1250.5
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 125
  }
}

GET /nodes/{id}

Retrieve detailed information about a specific node

GET /v1/nodes/node_1234567890abcdef

Response:

{
  "id": "node_1234567890abcdef",
  "name": "US-East-Node-01",
  "status": "online",
  "country": "US",
  "region": "east",
  "ip_address": "192.168.1.100",
  "version": "2.1.0",
  "last_seen": "2024-01-15T10:30:00Z",
  "uptime_hours": 720,
  "active_sessions": 45,
  "bandwidth_gb": 1250.5,
  "cpu_usage": 45.2,
  "memory_usage": 68.5,
  "disk_usage": 32.1,
  "created_at": "2023-12-01T08:00:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

POST /nodes/{id}/quarantine

Quarantine a node for maintenance or security reasons

POST /v1/nodes/node_1234567890abcdef/quarantine

Request Body:

{
  "reason": "Suspicious activity detected",
  "duration_minutes": 60
}

Response:

{
  "success": true,
  "message": "Node node_1234567890abcdef quarantined",
  "reason": "Suspicious activity detected",
  "duration_minutes": 60,
  "disconnected_sessions": 45
}

POST /nodes/{id}/reboot

Reboot a node (graceful or forced)

POST /v1/nodes/node_1234567890abcdef/reboot

Request Body:

{
  "force": false
}

POST /nodes/{id}/disconnect

Disconnect all active sessions on a node

POST /v1/nodes/node_1234567890abcdef/disconnect

Node Status Codes

online - Node is operational and accepting connections
offline - Node is not responding to health checks
quarantined - Node is temporarily disabled for maintenance or security
rebooting - Node is currently restarting
maintenance - Node is undergoing scheduled maintenance

Authentication

All node endpoints require authentication with an API key with appropriate permissions.

Authorization: Bearer sk_live_1234567890abcdef

Required scopes: nodes:read (for GET), nodes:write (for POST operations)

Was this helpful?

Help us improve our documentation