List VPN Logins

A collection of VPN Login attempts for an environment's VPN. Useful to keep track of failed/malicious attempts to access your VPN.

Requires the environments-vpn-manage permission.

Parameters: token hubIdenvironment IDquery

query
  • sort

    Sorts can be performed on any field - see sorting

  • filter

    Collections of resources can be filtered based on certain criteria - see filtering 

Returns

Returns a collection of VPN login attempts, otherwise returns an Error.

VPN Login Attempt
  • id
    string

    The ID of the login attempt.

  • username
    string

    The username of the account attempting to log in. If a Cycle account, will be the person's email address.

  • environment_id
    string

    The ID of the environment this login event is associated with.

  • hub_id
    string

    The ID of the hub this login event is associated with.

  • ip
    string

    The source IP address of the attempted login.

  • time
    timestamp

    The time of the attempted login.

  • success
    bool

    If true, the VPN login attempt was successfully authorized.

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

Example Request
$ curl https://api.cycle.io/v1/environments/5b9c2a77b6393d0001eb45fd/services/vpn/logins \
  -H 
"Authorization: Bearer API_KEY"
 \
  -H 
"X-Hub-Id: HUB_ID"
Example Response
{
  "data": [
    {
      "id": "5b9c2a77b6393d0001eb45fd",
      "username": "Demo Name",
      "environment_id": "5b9c2a77b6393d0001eb45fd",
      "hub_id": "5b9c2a77b6393d0001eb45fd",
      "ip": "",
      "time": "2022-09-14T21:39:03.096Z",
      "success": true
    }
  ]
}