Skip to main content
GET
/
networks
/
{id}
/
network_interfaces
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const response = await client.networks.listInterfaces('6a09cdc3-8948-47f0-aa62-74ac943d6c58');

console.log(response.data);
{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "network_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",
      "region_code": "ashburn-va",
      "region": {
        "code": "ashburn-va",
        "name": "Ashburn",
        "record_type": "region"
      },
      "type": "wireguard_interface"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Identifies the resource.

Example:

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

Query Parameters

filter
object

Consolidated filter parameter (deepObject style). Originally: filter[name], filter[type], filter[status]

page
object

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

Response

Successful response

data
NetworkInterface · object[]
meta
object