Ngrok.AgentAPI 0.2.0

dotnet add package Ngrok.AgentAPI --version 0.2.0
NuGet\Install-Package Ngrok.AgentAPI -Version 0.2.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Ngrok.AgentAPI" Version="0.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Ngrok.AgentAPI --version 0.2.0
#r "nuget: Ngrok.AgentAPI, 0.2.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Ngrok.AgentAPI as a Cake Addin
#addin nuget:?package=Ngrok.AgentAPI&version=0.2.0

// Install Ngrok.AgentAPI as a Cake Tool
#tool nuget:?package=Ngrok.AgentAPI&version=0.2.0

Ngrok.AgentAPI

NuGet version ngrok Agent version

Simple library to use the ngrok Agent API. Start and stop tunnels programmatically.

How to use

Step 1: Run ngrok via external console or background service

Before you start using ngrok in your NET project, you need to make sure that ngrok is running. If not, run ngrok using the console, a script, or a background service.

ngrok start --none;

Step 2: Start a new instance of the NgrokAgentClient

In your NET project, create a new instance of NgrokAgentClient as follows.

using Ngrok.AgentAPI

api = new NgrokAgentClient();

Step 3: Call any method

Example:

// List all tunnels and do something
var resource = api.ListTunnels();
if(resource.Tunnels != null){
    foreach (var tunnel in list.Tunnels)
    {
        var tunnelName = tunnel.Name;
        // ...
    }
}

Example:

// Start a new HTTP tunnel on port 5000 using http and https schemes
var configuration = new HttpTunnelConfiguration("MyLocalWebsite", "https://localhost:5000")
{
    Schemes = new string[] { "http", "https" },
    HostHeader = "localhost:5000"
};
var myTunnel = api.StartTunnel(configuration);

See also

To see the list with all the methods, see the official webpage of the ngrok agent API documentation.

License

MIT

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.2.0 1,529 5/4/2022