Sign in

v1

latestOpenAPI 3.0.12026-07-265331168.0 KB
Proxy

Generate Proxy List By ID

This endpoint retrieves a list of proxies assigned to the current user (or a specified customer) based on the proxy IDs.

This endpoint is intentionally a POST even though it only retrieves data since it needs to larger lists of UUIDs.

post/public/user/proxy/list_by_id

Headers

Content-Typestring required

Content type for the request body as application/json.

Request body

list_authentication'username_and_password' | 'ip_address' | 'proxy_specific'

Authentication type for the proxies in the returned list.

list_format'standard' | 'http' | 'socks5' | 'socks5h'

Desired format for displaying the proxies in the returned list.

list_protocol'http' | 'socks5'

Desired protocol for the proxies in the returned list.

list_version'ipv4' | 'ipv6'

IP version preference.

proxy_idsstring[]

List of proxy UUIDs to retrieve.

proxy_user_idstring

ID of the proxy_user used for authentication with the proxies.

Example request

{
  "list_authentication": "username_and_password",
  "list_format": "standard",
  "list_protocol": "http",
  "list_version": "ipv4",
  "proxy_ids": [
    "19efadd4-5814-4986-90be-4460e7d05c29",
    "1847e66a-a56e-4bc9-94e2-88a8cf3d0ad3"
  ],
  "proxy_user_id": "some_proxy_user_id"
}

Response

Successfully generated proxy list.

datastring[]

The resulting list of proxies in the requested format.

messagestring

Success message.

Example response

{
  "data": [
    "socks5://user:password@17.253.94.0:8080"
  ],
  "message": "Proxy list successfully generated."
}