Fetch an Environments VPN Info

An API call that returns information about the configuration of the VPN service container.

Requires the environments-vpn permission.

Parameters: token hubId ID

VPN Info Object
  • url
    string

    The URL of the VPN.

  • service
    object

    An object containing details about the VPN service.

    Show child fields

Returns

Returns a VPN Info object (see above), otherwise returns an Error.

GET /v1/environments/5b9c2a77b6393d0001eb45fd/services/vpn

Example Request
$ curl https://api.cycle.io/v1/environments/5b9c2a77b6393d0001eb45fd/services/vpn \
  -H 
"Authorization: Bearer API_KEY"
 \
  -H 
"X-Hub-Id: HUB_ID"
 \
Example Response
{
  "data": {
    "url": "http://123.75.73.111:8812/v1/config?token=DJjhedwwwwwwvWmEyaG83SjEzWnlKenk5ckpxdnVjTkFIaHBrRkF2Y1RVRW1wb3hnSEJqMllxZkZBWC55&aid=5b9c2a77b6393d0001eb45fd",
    "service": {
      "enable": true,
      "container_id": "5b9c2a77b6393d0001eb45fd",
      "high_availability": false,
      "config": {
        "auth": {
          "webhook": null,
          "cycle_accounts": true,
          "vpn_accounts": false
        },
        "allow_internet": false
      }
    }
  }
}