Telnyx

JavaScript

import Telnyx from 'telnyx';

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

const wireguardInterface = await client.wireguardInterfaces.create({ region_code: 'ashburn-va' });

console.log(wireguardInterface.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",
    "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "name": "test interface",
    "status": "provisioned",
    "endpoint": "203.0.113.0:51871",
    "public_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=",
    "enable_sip_trunking": false,
    "region_code": "ashburn-va",
    "region": {
      "code": "ashburn-va",
      "name": "Ashburn",
      "record_type": "region"
    }
  }
}

POST

wireguard_interfaces

JavaScript

import Telnyx from 'telnyx';

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

const wireguardInterface = await client.wireguardInterfaces.create({ region_code: 'ashburn-va' });

console.log(wireguardInterface.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",
    "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "name": "test interface",
    "status": "provisioned",
    "endpoint": "203.0.113.0:51871",
    "public_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=",
    "enable_sip_trunking": false,
    "region_code": "ashburn-va",
    "region": {
      "code": "ashburn-va",
      "name": "Ashburn",
      "record_type": "region"
    }
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

network_id

string<uuid>

required

The id of the network associated with the interface.

Example:

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

region_code

string

required

The region the interface should be deployed to.

Example:

"ashburn-va"

name

string

A user specified name for the interface.

Example:

"test interface"

enable_sip_trunking

boolean

Enable SIP traffic forwarding over VPN interface.

Example:

false

Response

Successful response

data

WireguardInterface · object

Show child attributes

data.id

string<uuid>

Identifies the resource.

Example:

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

data.record_type

string

Identifies the type of the resource.

Example:

"sample_record_type"

data.created_at

string

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

Example:

"2018-02-02T22:25:27.521Z"

data.updated_at

string

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

Example:

"2018-02-02T22:25:27.521Z"

data.network_id

string<uuid>

The id of the network associated with the interface.

Example:

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

data.name

string

A user specified name for the interface.

Example:

"test interface"

data.status

enum<string>

The current status of the interface deployment.

Available options:

created,

provisioning,

provisioned,

deleting

Example:

"provisioned"

data.endpoint

string

The Telnyx WireGuard peers Peer.endpoint value.

Example:

"203.0.113.0:51871"

data.public_key

string

The Telnyx WireGuard peers Peer.PublicKey.

Example:

"qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU="

data.enable_sip_trunking

boolean

Enable SIP traffic forwarding over VPN interface.

Example:

false

data.region_code

string

The region interface is deployed to.

Example:

"ashburn-va"

data.region

object

Show child attributes

data.region.code

string

Region code of the interface.

Example:

"ashburn-va"

data.region.name

string

Region name of the interface.

Example:

"Ashburn"

data.region.record_type

string

Identifies the type of the resource.

Example:

"region"

List all WireGuard Interfaces Retrieve a WireGuard Interfaces

⌘I

IoT

Networking

Create a WireGuard Interface

Authorizations

Body

Response