List pickable servers

This endpoint requires authentication. Include your API key in the X-API-KEY header with every request.

GET/hoster/v1/servers

The proxy servers a new self-rent tunnel can be placed on: only servers with at least one free slot appear, and capacity counts stay internal. Pass a server's id as serverId when enabling self-rent to pin the tunnel to it; omit serverId to let the proxy service pick. Slots fill and free as tunnels come and go, so read the list shortly before enabling and be ready for a 409 SETUP_TUNNEL_NO_CAPACITY on enable.

Example Request

curl -X GET "https://api.proxied.com/hoster/v1/servers" \
  -H "X-API-KEY: <api-key>"

Response Body

success
boolean
Always true on a successful response.
data
object
The proxy servers a new self-rent tunnel can be placed on.
- servers
  object[]
  The pickable servers, sorted by hostname; servers with no free slots are left out, so the list can be empty. A proxy server a new self-rent tunnel can be placed on; only servers with free capacity are listed.
  - id
    string
    The server's id, a 24-character hexadecimal string; pass it as serverId when enabling self-rent to place the tunnel on this server.
  - host
    string
    The server's hostname; a tunnel placed on it serves its proxy ports on this host.
  - hostIpv4
    string
    The server's public IPv4 address.
  - countryIso
    string
    ISO 3166-1 alpha-2 code of the country the server is in, uppercase.
  - cityLocode
    string
    UN/LOCODE place code of the city the server is in, uppercase; read it together with countryIso (DE + FRA is Frankfurt).

200 Response

{
  "success": true,
  "data": {
    "servers": [
      {
        "id": "665f1c2e8b3f4a5d6e7f8091",
        "host": "proxy-prod-1a.proxied.com",
        "hostIpv4": "203.0.113.10",
        "countryIso": "DE",
        "cityLocode": "FRA"
      }
    ]
  }
}

Error Responses

Error shape

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "readable message"
  }
}

Status	Code	Description
401	MISSING_API_KEY	Missing API key.
403	INVALID_API_KEY	Invalid key or suspended account.
403	HOSTER_BANNED	Invalid key or suspended account.
500	INTERNAL_ERROR	Internal error.
503	SERVER_LIST_UNAVAILABLE	The proxy service could not supply the server list; retry later.