WireGuard Interfaces

Create a WireGuard Interface

Changed on

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

post/wireguard_interfaces

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/wireguard_interfaces
  • 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.

network_idstring uuid required

The id of the network associated with the interface.

namestring

A user specified name for the interface.

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

The current status of the interface deployment.

endpointstring

The Telnyx WireGuard peers Peer.endpoint value.

public_keystring

The Telnyx WireGuard peers Peer.PublicKey.

enable_sip_trunkingboolean

Enable SIP traffic forwarding over VPN interface.

region_codestring required

The region the interface should be deployed to.

Example request

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

Response

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

Example response

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

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