C
CIFP

Proxies API

Create, manage, and monitor proxy instances.

Manage proxy lifecycle: create, list, pause, resume, and delete.

List Proxies

GET/api/proxies

Returns all proxies belonging to the authenticated tenant.

bash
curl https://cifp.vril.dev/api/proxies \
  -H "Authorization: Bearer cifp_your_api_key"
Response
{
  "proxies": [
    {
      "id": "proxy-abc123def456",
      "name": "my-proxy",
      "status": "running",
      "mode": "auto-auth",
      "proxyUrl": "https://proxy-abc123def456.proxy.cifp.vril.dev:3128",
      "flyRegion": "sjc",
      "secretCount": 3,
      "createdAt": "2026-06-01T12:00:00Z"
    }
  ],
  "count": 1
}

Create Proxy

POST/api/proxies
bash
curl -X POST https://cifp.vril.dev/api/proxies \
  -H "Authorization: Bearer cifp_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name":     "my-proxy",
    "mode":     "auto-auth",
    "region":   "sjc",
    "cpuCores": 1,
    "memoryMb": 512
  }'
FieldRequiredDescription
nameYesDisplay name (1–100 chars)
modeNoauto-auth (default) or firewall
regionNoDatacenter region code. Default: sjc (San Jose)
cpuCoresNovCPU count. Default: 1
memoryMbNoMemory in MB. Default: 512

Get Proxy

GET/api/proxies/:id
bash
curl https://cifp.vril.dev/api/proxies/proxy-abc123def456 \
  -H "Authorization: Bearer cifp_your_api_key"

Pause / Resume Proxy

PATCH/api/proxies/:id
bash
# Pause
curl -X PATCH https://cifp.vril.dev/api/proxies/proxy-abc123def456 \
  -H "Authorization: Bearer cifp_your_api_key" \
  -d '{"action": "pause"}'

# Resume
curl -X PATCH https://cifp.vril.dev/api/proxies/proxy-abc123def456 \
  -d '{"action": "resume"}'

Delete Proxy

DELETE/api/proxies/:id

Permanently destroys the proxy's dedicated virtual machine and all associated secrets. This cannot be undone.

bash
curl -X DELETE https://cifp.vril.dev/api/proxies/proxy-abc123def456 \
  -H "Authorization: Bearer cifp_your_api_key"

# Returns 204 No Content on success

Proxy Events (SSE)

GET/api/proxies/:id/events

Server-Sent Events stream for real-time proxy state. Emits proxy.updateevery 5 seconds and on state changes.

bash
curl -N https://cifp.vril.dev/api/proxies/proxy-id/events \
  -H "Authorization: Bearer cifp_your_api_key"