List Servers

List OpenBlu Servers

This method allows you to retrieve OpenVPN servers that are available on OpenBlu, this method allows you to filter and order the results in different ways. These results do not return the actual details about each server, you need to use the Get Server method to accomplish that.
Parameter NameDefault ValueRequiredDescription
filterNULLFalseFilters the results by "country" or "country_short"
byNULLFalseThe value to filter by, eg; japan, thailand, etc. This is required if "filter" is used
order_bylast_updatedFalseOrders the results by "score", "ping", "sessions", "total_sessions", "last_updated" and "created"
sort_bydescendingFalseSorts the ordered results by "descending" or "ascending"

Example Success Response

This response gives an array of servers that was found in OpenBlu
{
  "success": true,
  "response_code": 200,
  "servers": [
    {
      "id": "8cd76121cb412234",
      "host_name": "vpn449395045",
      "country": "Thailand",
      "country_short": "TH",
      "score": 577616,
      "ping": 30,
      "sessions": 61,
      "total_sessions": 34133,
      "last_updated": 1580340394,
      "created": 1580340394
    },
    {
      "id": "563eb9182ba28749",
      "host_name": "vpn336227155",
      "country": "Thailand",
      "country_short": "TH",
      "score": 520198,
      "ping": 38,
      "sessions": 13,
      "total_sessions": 2302,
      "last_updated": 1580340394,
      "created": 1580340394
    },
    {
      "id": "58c61a8d1f8ec36b",
      "host_name": "vpn589223849",
      "country": "Thailand",
      "country_short": "TH",
      "score": 615902,
      "ping": 27,
      "sessions": 50,
      "total_sessions": 27778,
      "last_updated": 1580070319,
      "created": 1580070319
    },
    {
      "id": "f3eba00c4efe51a9",
      "host_name": "vpn543929979",
      "country": "Thailand",
      "country_short": "TH",
      "score": 571883,
      "ping": 25,
      "sessions": 0,
      "total_sessions": 3226,
      "last_updated": 1580070319,
      "created": 1580070319
    }
  ]
}

Server Listing Structure

NameTypeDescription
idstringThe ID of the server
host_namestringThe name of the host of the server
countrystringThe full name of the country that this server is based in
country_shortstringThe short version of the country that this server is based in
scoreintThe score of the server
pingintThe ping of the server
sessionsintThe amount of sessions that are currently established to this server
total_sessionsintThe total amount of sessions that has been established
last_updatedintThe Unix Timestamp of when this server was last updated
createdintThe Unix Timestamp of when this server was created

No Results

No errors will be shown if no results are returned
{
  "success": true,
  "response_code": 200,
  "servers": []
}