Sign in

v52

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
WireGuard Interfaces

Create a WireGuard Interface

Create a new WireGuard Interface. Current limitation of 10 interfaces per user can be created.

post/wireguard_interfaces

Request body

created_atstring

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

idstring uuid

Identifies the resource.

record_typestring

Identifies the type of the resource.

updated_atstring

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

namestring

A user specified name for the interface.

network_idstring uuid required

The id of the network associated with the interface.

status'created' | 'provisioning' | 'provisioned' | 'deleting'

The current status of the interface deployment.

enable_sip_trunkingboolean

Enable SIP traffic forwarding over VPN interface.

endpointstring

The Telnyx WireGuard peers Peer.endpoint value.

public_keystring

The Telnyx WireGuard peers Peer.PublicKey.

region_codestring required

The region the interface should be deployed to.

Example request

{
  "created_at": "2018-02-02T22:25:27.521Z",
  "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "record_type": "wireguard_interface",
  "updated_at": "2018-02-02T22:25:27.521Z",
  "name": "test interface",
  "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "status": "provisioned",
  "endpoint": "203.0.113.0:51871",
  "public_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=",
  "region_code": "ashburn-va"
}

Response

Successful response

Example response

{
  "data": {
    "created_at": "2018-02-02T22:25:27.521Z",
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "wireguard_interface",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "name": "test interface",
    "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "status": "provisioned",
    "endpoint": "203.0.113.0:51871",
    "public_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=",
    "region": {
      "code": "ashburn-va",
      "name": "Ashburn",
      "record_type": "region"
    },
    "region_code": "ashburn-va"
  }
}