ProxyWhirl Docs
OpenapiPool Management

Export all proxies as streaming JSON

GET
/api/proxies/export

Stream all proxies as newline-delimited JSON (NDJSON).

This endpoint is functionally equivalent to /api/proxies/stream and is provided for discoverability under the /export path.

Args: status_filter: Filter by health status (optional) rotator: ProxyWhirl dependency api_key: API key verification

Returns: StreamingResponse with NDJSON content

Authorization

APIKeyHeader
X-API-Key<token>

In: header

Query Parameters

status_filter?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/api/proxies/export"
null
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}