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:
| Query Parameters | Type | Description | Example |
|---|---|---|---|
To make authenticated requests to the API, the following fields are mandatory in the request header:
| Header Parameters | Required | Type | Description |
|---|---|---|---|
200 Successful operation
Result: All existing WireGuard Peers and their details are successfully obtained.
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.