Contents x
    Get a Wireguard tunnel
    • 22 Nov 2023
    • 1 Minute to read
    • Contributors
      Contents

      Get a Wireguard tunnel

      • Updated on 22 Nov 2023
      • 1 Minute to read
      • Contributors
        Article summary

        Get
        /v2/networks/{networkId}/tunnels/wireguard/{tunnelId}

        Required permissions: ["network:read"]

        Security
        Http
        Type bearer
        Path parameters
        networkId
        stringRequired
        tunnelId
        stringRequired
        Responses
        200

        Success

        object
        remoteEndpoint
        string (ipv4)
        remoteSubnets
        Array of string
        string
        regionID
        string

        Region ID

        gatewayID
        string

        Gateway ID

        tunnelName
        string

        The name of the tunnel

        Max length15
        Min length3
        Pattern^[a-zA-Z0-9]*$
        createdAt
        string (date-time)

        The date when this record was created.

        updatedAt
        string (date-time)

        The date of last update of the record.

        tunnelID
        string
        type
        string
        Default"wireguard"
        401

        Unauthorized

        object
        id
        string
        message
        string
        403

        Forbidden

        object
        id
        string
        message
        string
        404

        Resource not found

        object
        id
        string
        message
        string
        Was this article helpful?
        What's Next