v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-181,0851,7264.5 MB

WireGuard Interfaces

List all WireGuard Peers

List all WireGuard peers.

get/wireguard_peers

Query parameters

wireguard_interface_idstring uuid

The id of the associated WireGuard interface to filter on.

Consolidated filter parameter (deepObject style). Originally: filter[wireguard_interface_id]

{
  "wireguard_interface_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58"
}

page[number]integer

page[size]integer

Response

Successful response

Example response

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "sample_record_type",
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z",
      "last_seen": "2018-02-02T22:25:27.521Z",
      "wireguard_interface_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "private_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU="
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}