List all WireGuard Peers

GET

/wireguard_peers

WireGuard Interfaces

List all WireGuard peers.

Response Example

200 - Example 1

{
    "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
    }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

page[number]

integer

optional

The page number to load

>= 1

Default:

page[size]

integer

optional

The size of the page

>= 1<= 250

Default:

filter[wireguard_interface_id]

string <uuid>

optional

The id of the associated WireGuard interface to filter on.

Example:

6a09cdc3-8948-47f0-aa62-74ac943d6c58

Responses

🟢200OK

application/json

Successful response

Body

data

array[object (WireguardPeer) {8}]

optional

created_at

string

read-onlyoptional

ISO 8601 formatted date-time indicating when the resource was created.

Example:

2018-02-02T22:25:27.521Z

string <uuid>

read-onlyoptional

Identifies the resource.

Example:

6a09cdc3-8948-47f0-aa62-74ac943d6c58

record_type

string

read-onlyoptional

Identifies the type of the resource.

Examples:

sample_record_typewireguard_peer

updated_at

string

read-onlyoptional

ISO 8601 formatted date-time indicating when the resource was updated.

Example:

2018-02-02T22:25:27.521Z

public_key

string

optional

The WireGuard PublicKey.

If you do not provide a Public Key, a new Public and Private key pair will be generated for you.

Example:

qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=

last_seen

string

read-onlyoptional

ISO 8601 formatted date-time indicating when peer sent traffic last time.

Example:

2018-02-02T22:25:27.521Z

private_key

string

read-onlyoptional

Your WireGuard Interface.PrivateKey.

This attribute is only ever utlised if, on POST, you do NOT provide your own public_key. In which case, a new Public and Private key pair will be generated for you. When your private_key is returned, you must save this immediately as we do not save it within Telnyx. If you lose your Private Key, it can not be recovered.

Example:

qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=

wireguard_interface_id

string <uuid>

optional

The id of the wireguard interface associated with the peer.

Example:

6a09cdc3-8948-47f0-aa62-74ac943d6c58