Skip to main content

List all WireGuard Interfaces

GET 
/wireguard_interfaces

List all WireGuard Interfaces.

Request​

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

    filter[network_id] string

    The associated network id to filter on.

Responses​

200: Successful response

Schema

    data object[]

    meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

    • code intrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object

  • ]

Request samples

curl -L 'https://api.telnyx.com/v2/wireguard_interfaces' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": true,
      "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": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}