Skip to main content

Retrieve the WireGuard Peer

GET 
/wireguard_peers/:id

Retrieve the WireGuard peer.

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.

    public_key string

    The WireGuard PublicKey.

    If you do not provide a Public Key, a new Public and Private key pair will be generated for you.

    last_seen string

    ISO 8601 formatted date-time indicating when peer sent traffic last time.

    wireguard_interface_id uuid

    The id of the wireguard interface associated with the peer.

    private_key string

    Your WireGuard Interface.PrivateKey.

    This attribute is only ever utlised if, on POST, you do NOT provide your own public_key. In which case, a new Public and Private key pair will be generated for you. When your private_key is returned, you must save this immediately as we do not save it within Telnyx. If you lose your Private Key, it can not be recovered.

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...