Skip to main content

Retrieve a WireGuard Interfaces

GET 

/wireguard_interfaces/:id

Retrieve a WireGuard Interfaces.

Request

Path Parameters

    id uuidrequired

    Identifies the resource.

Responses

200: Successful response

Schema

    data

    object

    id uuid

    Identifies the resource.

    record_type string

    Identifies the type of the resource.

    created_at string

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

    updated_at string

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

    network_id uuid

    The id of the network associated with the interface.

    name string

    A user specified name for the interface.

    status InterfaceStatus

    Possible values: [created, provisioning, provisioned, deleting]

    The current status of the interface deployment.

    endpoint string

    The Telnyx WireGuard peers Peer.endpoint value.

    public_key string

    The Telnyx WireGuard peers Peer.PublicKey.

    enable_sip_trunking boolean

    Enable SIP traffic forwarding over VPN interface.

    region_code string

    The region interface is deployed to.

    region

    object

    code string

    Region code of the interface.

    name string

    Region name of the interface.

    record_type string

    Identifies the type of the resource.

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
  • ]

Loading...