Skip to main content
GET
/
api
/
proxy_accounts
Retrieves the collection of ProxyAccount resources.
curl --request GET \
  --url https://dashboard.anyip.io/api/proxy_accounts \
  --header 'api-key: <api-key>'
{
  "hydra:member": [
    {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "description": "<string>",
      "enabled_by_admin": true,
      "status": "ACCOUNT_BLOCKED",
      "is_active": true,
      "enabled": true,
      "id": "<string>",
      "ip_whitelist": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "ips": [
          "<string>"
        ],
        "ports": [
          {
            "@context": "<string>",
            "@id": "<string>",
            "@type": "<string>",
            "port": 10001499,
            "type": "residential",
            "country": "<string>",
            "city": "<string>",
            "session": "<string>",
            "sess_time": 30,
            "sess_replace": true,
            "sess_ip_collision": "strict"
          }
        ],
        "is_enabled": true
      },
      "plain_password": "<string>",
      "quota": 123,
      "username": "<string>",
      "hash": "<string>",
      "quota_str": "<string>",
      "bytes_recv": 123,
      "bytes_sent": 123,
      "consumption": 123,
      "consumption_str": "<string>"
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "string",
    "type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://anyip.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
api-key
string
header
required

Value for the api-key header parameter.

Query Parameters

​
page
integer
default:1

The collection page number

​
itemsPerPage
integer
default:30

The number of items per page

Required range: x >= 0
​
username
string
​
description
string

Response

ProxyAccount collection

​
hydra:member
object[]
required
​
hydra:totalItems
integer
Required range: x >= 0
​
hydra:view
object
Example:
{
  "@id": "string",
  "type": "string",
  "hydra:first": "string",
  "hydra:last": "string",
  "hydra:previous": "string",
  "hydra:next": "string"
}
​
hydra:search
object