import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const wireguardInterfaces = await client.wireguardInterfaces.list();
console.log(wireguardInterfaces.data);{
"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=",
"enable_sip_trunking": false,
"region_code": "ashburn-va",
"region": {
"code": "ashburn-va",
"name": "Ashburn",
"record_type": "region"
}
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}List all WireGuard Interfaces.
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const wireguardInterfaces = await client.wireguardInterfaces.list();
console.log(wireguardInterfaces.data);{
"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=",
"enable_sip_trunking": false,
"region_code": "ashburn-va",
"region": {
"code": "ashburn-va",
"name": "Ashburn",
"record_type": "region"
}
}
],
"meta": {
"page_number": 2,
"page_size": 25,
"total_pages": 3,
"total_results": 55
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Successful response
Show child attributes
Identifies the resource.
"6a09cdc3-8948-47f0-aa62-74ac943d6c58"
Identifies the type of the resource. Identifies the type of the resource.
"wireguard_interface"
ISO 8601 formatted date-time indicating when the resource was created.
"2018-02-02T22:25:27.521Z"
ISO 8601 formatted date-time indicating when the resource was updated.
"2018-02-02T22:25:27.521Z"
The id of the network associated with the interface.
"6a09cdc3-8948-47f0-aa62-74ac943d6c58"
A user specified name for the interface.
"test interface"
The current status of the interface deployment.
created, provisioning, provisioned, deleting "provisioned"
The Telnyx WireGuard peers Peer.endpoint value.
"203.0.113.0:51871"
The Telnyx WireGuard peers Peer.PublicKey.
"qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU="
Enable SIP traffic forwarding over VPN interface.
false
The region interface is deployed to.
"ashburn-va"
Was this page helpful?