Reconfigure an Environments VPN

Submit configuration changes for an environments VPN - creating a task and starting the reconfiguration process..

Requires the environments-vpn-manage permission.

Parameters: token hubIdenvironment IDvalue

Parameter
  • action
    string

    Create a task resulting in the following action: reconfigure.

  • contents
    object

    An object holding information about the reconfiguration of the VPN service.

    Show child fields

Returns

Returns an task resource, 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"
\
-H 'Content-Type: application/json'
-d '{"action":"reconfigure","contents":{"enable":true,"config":{"auth":{"webhook":null,"cycle_accounts":true,"vpn_accounts":false},"allow_internet":false}}}'
-X POST
Example Response
{
"data": {
"action": "reconfigure",
"job_id": "5b9c2a77b6393d0001eb45fd"
}
}