Skip to main content
POST
/
wireguard_peers
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const wireguardPeer = await client.wireguardPeers.create({
  wireguard_interface_id: '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
});

console.log(wireguardPeer.data);
{
  "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",
    "public_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=",
    "last_seen": "2018-02-02T22:25:27.521Z",
    "wireguard_interface_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "private_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU="
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
wireguard_interface_id
string<uuid>
required

The id of the wireguard interface associated with the peer.

Example:

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

​
public_key
string

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="

Response

Successful response

​
data
WireguardPeer · object