WireGuard Interfaces

Update the WireGuard Peer

Changed on

Updates the specified WireGuard peer and returns the updated peer.

patch/wireguard_peers/{id}

Request

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

Path parameters

idstring uuid required
Example:6a09cdc3-8948-47f0-aa62-74ac943d6c58

Identifies the resource.

Request body

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.

Example request

{
  "public_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU="
}

Response

Successful response

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