Kelvin SDK Client Library Reference

Hierarchy

Index

Methods

Methods

Static createWireguardPeer

Static createWireguardTunnel

Static deleteWireguardPeer

  • Delete Wireguard Peer Delete Wireguard Peer Permission Required: `kelvin.permission.acp.delete`

    Parameters

    • __namedParameters: { peerName: string }
      • peerName: string

        Peer name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<IKvHttpResponse>

Static deleteWireguardTunnel

  • Delete Wireguard Tunnel Delete Wireguard Tunnel Permission Required: `kelvin.permission.acp.delete`

    Parameters

    • __namedParameters: { peerName: string }
      • peerName: string

        Source peer

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<WireguardTunnel>

Static getPaginator

Static getWireguardGraph

  • Get Wireguard Graph Get Wireguard Graph returns a visual representation of all the tunnels in the system Permission Required: `kelvin.permission.acp.read`

    Parameters

    • Default value __namedParameters: { format: string } = {}
      • format: string

        Desired return format (svg or dot)

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<WireguardTunnel>

Static getWireguardPeer

  • Get Wireguard Peer Get Wireguard Peer Permission Required: `kelvin.permission.acp.read`

    Parameters

    • __namedParameters: { peerName: string }
      • peerName: string

        Peer name

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<WireguardPeer>

Static listWireguardPeer

  • List Wireguard Peer List Wireguard Peer Pagination Sortable Columns: `wireguard_peer.name` Permission Required: `kelvin.permission.acp.read`

    Parameters

    • Default value __namedParameters: { endingBefore: string; pageSize: number; search: string[]; sortAsc: boolean; sortBy: string; startingAfter: string } = {}
      • endingBefore: string

        Upper bound cursor for use in pagination

      • pageSize: number

        Number of objects to be returned, between 1 and 1000. Default: 20

      • search: string[]

        Search Peers by name, title or public key

      • sortAsc: boolean

        Order of sorting is Ascending. Possible Values: true/false. Default: true

      • sortBy: string

        Parameter to sort by. Must be one of the sortable columns

      • startingAfter: string

        Lower bound cursor for use in pagination

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<WireguardPeerListPaginated>

Static listWireguardTunnel

  • List Wireguard Tunnel List Wireguard Tunnel Pagination Sortable Columns: `wireguard_tunnel.wg_src`, `wireguard_tunnel.wg_peer` Permission Required: `kelvin.permission.acp.read`

    Parameters

    • __namedParameters: { endingBefore: string; pageSize: number; peerName: string; sortAsc: boolean; sortBy: string; startingAfter: string }
      • endingBefore: string

        Upper bound cursor for use in pagination

      • pageSize: number

        Number of objects to be returned, between 1 and 1000. Default: 20

      • peerName: string

        Source peer

      • sortAsc: boolean

        Order of sorting is Ascending. Possible Values: true/false. Default: true

      • sortBy: string

        Parameter to sort by. Must be one of the sortable columns

      • startingAfter: string

        Lower bound cursor for use in pagination

    • Optional options: IKvHttpRequestOptions

      Request optional parameters

    Returns Observable<WireguardPeerListPaginated>

Static onError

Static request

Static requestUrl

  • requestUrl<T>(request: IKvHttpRequest, modelClass?: IModel, autenticated?: boolean): Observable<T>

Static updateWireguardPeer