get Return proxy list (active or all).
/api/client/v1/proxies
Retrieve detailed information for all proxies associated with the current account. This request can be used to obtain relevant metadata for all purchased proxies. By specifying the expired parameter, you can include expired proxies in the response.
Parameters
expired
Defines whether to include expired proxies in the response. This parameter allows you to filter proxies based on their expiration status, making it easier to manage active and expired proxies separately.
In:
query
Example:
1
Schema:
- integerExample:
0
Enum:0
1
Responses
200
OK. A successful server response returns detailed information about all associated proxies (with or without expired ones based on parameter you've used).
Content Type:
application/json
- Schema
- Example
- arrayExample:
[{"id":1,"login":"string","password":"string","protocol":"http","host":"string","port":8080,"geo_country":"RU","geo_city":"Moscow","geo_operator":"mts","private":true,"comment":"string","rotate_ip_url":"string","rotate_ip_freq":5,"start_at":"2019-08-24T14:15:22Z","stop_at":"2019-08-24T14:15:22Z"}]
Items:- objectProxyResourceExample:
{"id":1,"login":"string","password":"string","protocol":"http","host":"string","port":8080,"geo_country":"RU","geo_city":"Moscow","geo_operator":"mts","private":true,"comment":"string","rotate_ip_url":"string","rotate_ip_freq":5,"start_at":"2019-08-24T14:15:22Z","stop_at":"2019-08-24T14:15:22Z"}
401
Unauthorized. Missing or invalid authentication token, please check the Authorization header.
Content Type:
application/json
- Schema
- Example
- objectErrorResponseExample:
{"message":"string","errors":{}}
Properties:message
stringRequiredError messageExample:"string"
errors
object or nullInput validation errorsExample:{}