This endpoint enables retrieving all Wireguard Peers using pagination and optional filters.
To retrieve all the Wireguard Peers, perform a GET
request.
Use the following endpoint to retrieve all wireguard peers: https://vpn.de-fra.ionos.com/wireguardgateways/{gatewayId}/peers
.
Below is the list of optional Path Parameters:
To make authenticated requests to the API, the following fields are mandatory in the request header:
200 Successful operation
Result: All existing Wireguard Peers and their details are successfully obtained.
Query Parameters | Type | Description | Example |
---|---|---|---|
Header Parameters | Required | Type | Description |
---|---|---|---|
offset
integer
The first element (of the total list of elements) to include in the response. Use together with limit for pagination. Default: 0
0
limit
integer
The maximum number of elements to return. Use together with offset for pagination. Default: 100
100
Authorization
yes
string
The Bearer token enables requests to authenticate using a JSON Web Token (JWT).
Content-Type
no
string
Set this to application/json
.