Networks

List all Interfaces for a Network.

Changed on

Returns a paginated list of the interfaces attached to the specified network, with support for filtering.

get/networks/{id}/network_interfaces

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/networks/{id}/network_interfaces
  • Auth: HTTP bearer

Path parameters

idstring uuid required
Example:6a09cdc3-8948-47f0-aa62-74ac943d6c58

Identifies the resource.

Query parameters

namestring

The interface name to filter on.

typestring

The interface type to filter on.

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

The current status of the interface deployment.

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

{
  "name": "test interface",
  "type": "wireguard_interface",
  "status": "provisioned"
}
numberinteger

The page number to load

sizeinteger

The size of the page

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

Response

Successful response

Example response

{
  "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": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

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