Skip to content

Latest commit

 

History

History
102 lines (69 loc) · 2.55 KB

WireguardAPI.md

File metadata and controls

102 lines (69 loc) · 2.55 KB

WireguardAPI

All URIs are relative to https://api.forestvpn.com/v2

Method HTTP request Description
getWireGuardPeerInfo GET /wireguard/peers/{pubKey}/ Wireguard peer info
listWireGuardPeers GET /wireguard/peers/ Wireguard peers list

getWireGuardPeerInfo

    open class func getWireGuardPeerInfo(pubKey: String, completion: @escaping (_ data: WireGuardPeerInfo?, _ error: Error?) -> Void)

Wireguard peer info

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ForestVPNAPI

let pubKey = "pubKey_example" // String | 

// Wireguard peer info
WireguardAPI.getWireGuardPeerInfo(pubKey: pubKey) { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

Name Type Description Notes
pubKey String

Return type

WireGuardPeerInfo

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listWireGuardPeers

    open class func listWireGuardPeers(completion: @escaping (_ data: [WireGuardPeerInfo]?, _ error: Error?) -> Void)

Wireguard peers list

Example

// The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new
import ForestVPNAPI


// Wireguard peers list
WireguardAPI.listWireGuardPeers() { (response, error) in
    guard error == nil else {
        print(error)
        return
    }

    if (response) {
        dump(response)
    }
}

Parameters

This endpoint does not need any parameter.

Return type

[WireGuardPeerInfo]

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]