v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 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"
}

numberinteger

The page number to load

sizeinteger

The size of the page

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

Response

Successful response

Example response

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