Getting a list of proxies

API Reference

Request

List the team's proxy configurations, page by page.

Effect: none. Read-only. Safe to retry with bounded backoff.
Note: passwords are withheld from ordinary members and for cloud and dynamic proxies. Dynamic proxies appear here but are managed elsewhere and cannot be edited through the proxy endpoints.

Security

Authorization

Bodyapplication/jsonrequired

idstring^\d+$

Optional proxy ID for an exact match. Send the 64-bit ID as a decimal string to avoid precision loss. Omit it to query without an ID filter. Other filters and pagination still apply.

Example:"1800000000000101"

pageNointeger

Current page number (starts from 1)

Example:1

pageSizeinteger

Number of items per page

Example:10

isCloudPhoneProxyboolean

Whether the proxy is for cloud phone usage.

true: Exclude local/private IPs (e.g., 127.0.0.1, 360, pia, private ranges)
false: Return all proxies

Example:false

proxyCategoryTypeinteger

Proxy category type:

1 = Cloud platform
2 = Self-owned IP

Example:2

proxyIpstring

Filter by proxy IP address (partial match)

Example:""

proxyNamestring

Filter by proxy name (partial match)

Example:""

proxyProvidersArray of integers

List of Proxy type IDs. Supported values:

0 = None
4 = Oxylabs
5 = Proxys.io
6 = GeoSurf
7 = Luminati
8 = Lumauto
9 = Oxylabsauto
10 = Trojan
11 = Shadowsocks
12 = vmess
13 = ABCPROXY
14 = LunaProxy
15 = IPHTML
16 = PiaProxy
17 = 922S5

Example:

[]

proxyStatusinteger

Proxy assignment status:

0 = Normal
1 = Unassigned
2 = Upgrading
3 = Expired
4 = Expiring soon

Note: Self-owned proxies always use status 1.

Example:1

proxyCheckStatusinteger

Proxy health check status:

0 = Pending
1 = Success
2 = Failed
3 = Unknown error

Example:1

proxyTypesArray of integers

Proxy protocol types:

0 = HTTP
1 = HTTPS
2 = SOCKS5
3 = SSH

Example:

[]

curl -i -X POST \
  https://api.morelogin.com/proxyInfo/page \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "1800000000000101",
    "pageNo": 1,
    "pageSize": 10,
    "isCloudPhoneProxy": false,
    "proxyCategoryType": 2,
    "proxyIp": "",
    "proxyName": "",
    "proxyProviders": [],
    "proxyStatus": 1,
    "proxyCheckStatus": 1,
    "proxyTypes": []
  }'

Responses

Success. data.dataList holds the records for the requested page and is an empty array when there are no matches; data.total, data.current and data.pages describe the paging.

Headers

any

Bodyapplication/json

codeintegerrequired

Return result code 0:Normal Other codes are exceptions.

msgstring or nullrequired

Error message

dataobjectrequired

requestIdstringrequired

Operation Request ID

Response

{
  "code": 0,
  "msg": null,
  "data": {
    "current": "1",
    "dataList": [ … ],
    "pages": "1",
    "total": "1"
  },
  "requestId": "0d8b6f1c-9f4e-4d02-9d1a-7c3f5a1b2c3d"
}