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

    The URL of the VPN.

  • service

    An object containing details about the VPN service.

    Show child fields


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 \
"Authorization: Bearer API_KEY"
"X-Hub-Id: HUB_ID"
Example Response
"data": {
"url": "",
"service": {
"enable": true,
"container_id": "5b9c2a77b6393d0001eb45fd",
"high_availability": false,
"config": {
"auth": {
"webhook": null,
"cycle_accounts": true,
"vpn_accounts": false
"allow_internet": false