VPN Gateways API Documentation

Overview

This document outlines the usage of APIs for interacting with VPN Gateway services, including retrieving a list of VPN servers and obtaining connection credentials for a selected VPN server.

1. List VPN Servers API

Endpoint: GET /list
Description: Fetches the list of VPN gateways available.
Response Format:
- Type: Array of Objects
- Content Example:

json

[
  {
    "flag": "https://country-flags.1timetech.com/png100px/jp.png",
    "country": "Japan",
    "countryCode": "JP",
    "port": 1195,
    "type": "udp",
    "sid": 1713272401715,
    "hid": "15134944",
    "ip": "219.100.37.211",
    "ping": 16,
    "bandwidth": 299.85,
    "sessions": 28,
    "fid": "219-100-37-211-udp",
    "createdAt": 1713272402352,
    "updatedAt": 1713272402352
  }
  // Additional server objects may follow
]

Fields:
- flag - URL to the server's country flag image.
- country - The country where the server is located.
- countryCode - The ISO country code.
- port - The port number for the VPN connection.
- type - The connection protocol type (udp or tcp).
- sid - The server ID.
- hid - A unique hardware ID for the server.
- ip - The IP address of the server.
- ping - The ping time to the server in milliseconds.
- bandwidth - Server's bandwidth in Mbps.
- sessions - Number of active sessions on the server.
- fid - A unique identifier for the server.
- createdAt - The timestamp when the server was added.
- updatedAt - The timestamp when the server information was last updated.

2. Get VPN Connection Information API

Endpoint: GET /openvpn
Description: Provides the necessary credentials to establish a VPN connection.
Query Parameters:
- type - The desired connection protocol (udp or tcp).
- ip - The IP address of the target VPN server.
- sid - The server ID for authentication.
Response Format:
- Type: JSON Object
- Content Example:

json

{
  "vpnAuthCode": "XYZ123ABC789",
  "username": "user12345",
  "password": "passSecure987"
}

Fields:
- vpnAuthCode - The authorization code required for establishing a VPN connection.
- username - The username allocated for the VPN connection.
- password - The password for the provided username.

Please utilize these APIs in accordance with the service terms and ensure secure storage of the obtained credentials.