Create A New VPN User

Create a new VPN user for this environments VPN service.

Requires the environments-vpn-manage permission.

Parameters: token hubIdenvironment IDvalues

Values
  • username
    string

    The username of the new VPN account

  • password
    string

    The password for the new VPN account

Returns

Returns a VPN user if sucessful, otherwise returns an Error.

POST /v1/environments/5b9c2a77b6393d0001eb45fd/services/vpn/users

Example Request
$ curl https://api.cycle.io/v1/environments/5b9c2a77b6393d0001eb45fd/services/vpn/users \
  -H 
"Authorization: Bearer API_KEY"
 \
  -H 
"X-Hub-Id: HUB_ID"
 \
  -H 'Content-Type: application/json'
  -d '{"username":"test","password":"examplepassword"}'
  -X POST
Example Response
{
  "data": {
    "id": "5b9c2a77b6393d0001eb45fd",
    "username": "Demo User",
    "creator": {
      "id": "5b9c2a77b6393d0001eb45fd",
      "type": "account"
    },
    "last_login": "0001-01-01T00:00:00Z",
    "hub_id": "5b9c2a77b6393d0001eb45fd",
    "environment_id": "5b9c2a77b6393d0001eb45fd",
    "events": {
      "created": "2022-09-14T21:39:03.096Z",
      "updated": "0001-01-01T00:00:00Z",
      "deleted": "0001-01-01T00:00:00Z"
    }
  }
}