WireGuard Interfaces

Create a WireGuard Peer

Changed on

Create a new WireGuard Peer. Current limitation of 5 peers per interface can be created.

post/wireguard_peers

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/wireguard_peers
  • Auth: HTTP bearer

Request body

idstring uuid

Identifies the resource.

record_typestring

Identifies the type of the resource.

created_atstring

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

updated_atstring

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

public_keystring

The WireGuard PublicKey.<br /><br />If you do not provide a Public Key, a new Public and Private key pair will be generated for you.

last_seenstring

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

wireguard_interface_idstring uuid required

The id of the wireguard interface associated with the peer.

private_keystring

Your WireGuard Interface.PrivateKey.<br /><br />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 request

{
  "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "record_type": "wireguard_peer",
  "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="
}

Response

Creation request accepted. Provisioning is asynchronous; poll GET /wireguard_peers/{id} with the returned id to check status.

Example response

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "wireguard_peer",
    "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="
  }
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status