ngrok/ngrok-api-ruby
1
0
Fork 0
mirror of https://github.com/ngrok/ngrok-api-ruby.git synced 2026-06-16 16:54:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
ngrok-api-ruby/docs/NgrokAPI/Services/TunnelSessionsClient.html
T

1663 lines
51 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: NgrokAPI::Services::TunnelSessionsClient
&mdash; Documentation by YARD 0.9.36
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "NgrokAPI::Services::TunnelSessionsClient";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (T)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span>
&raquo;
<span class="title">TunnelSessionsClient</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: NgrokAPI::Services::TunnelSessionsClient
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">NgrokAPI::Services::TunnelSessionsClient</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/ngrokapi/services/tunnel_sessions_client.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service. Each tunnel session can include one or more Tunnels.</p>
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions">ngrok.com/docs/api#api-tunnel-sessions</a></p>
</div>
</div>
<div class="tags">
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
<div class="docstring">
<div class="discussion">
<p>The List Property from the resulting API for list calls</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>tunnel_sessions</span><span class='tstring_end'>&#39;</span></span></pre></dd>
<dt id="PATH-constant" class="">PATH =
<div class="docstring">
<div class="discussion">
<p>The API path for the requests</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/tunnel_sessions</span><span class='tstring_end'>&#39;</span></span></pre></dd>
</dl>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute client.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::TunnelSession </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Get the detailed status of a tunnel session by ID.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::TunnelSession </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Get the detailed status of a tunnel session by ID Throws an exception if API error.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) &#x21d2; TunnelSessionsClient </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of TunnelSessionsClient.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, filter: nil, url: nil) &#x21d2; NgrokAPI::Models::Listable </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>List all online tunnel sessions running on this account.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, filter: nil, url: nil) &#x21d2; NgrokAPI::Models::Listable </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>List all online tunnel sessions running on this account.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#restart-instance_method" title="#restart (instance method)">#<strong>restart</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::Empty </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Issues a command instructing the ngrok agent to restart.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#restart!-instance_method" title="#restart! (instance method)">#<strong>restart!</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::Empty </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Issues a command instructing the ngrok agent to restart.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#stop-instance_method" title="#stop (instance method)">#<strong>stop</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::Empty </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Issues a command instructing the ngrok agent that started this tunnel session to exit.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#stop!-instance_method" title="#stop! (instance method)">#<strong>stop!</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::Empty </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Issues a command instructing the ngrok agent that started this tunnel session to exit.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: &quot;&quot;, version: &quot;&quot;) &#x21d2; NgrokAPI::Models::Empty </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Issues a command instructing the ngrok agent to update itself to the latest version.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: &quot;&quot;, version: &quot;&quot;) &#x21d2; NgrokAPI::Models::Empty </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Issues a command instructing the ngrok agent to update itself to the latest version.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(client:) &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Services::TunnelSessionsClient (class)">TunnelSessionsClient</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of TunnelSessionsClient.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
21
22
23</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 21</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="client-instance_method">
#<strong>client</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute client.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
<span class='ivar'>@client</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="get-instance_method">
#<strong>get</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">NgrokAPI::Models::TunnelSession</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Get the detailed status of a tunnel session by ID</p>
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-get">ngrok.com/docs/api#api-tunnel-sessions-get</a></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
&mdash;
<div class='inline'>
<p>a resource identifier</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">NgrokAPI::Models::TunnelSession</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>result from the API request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
99
100
101
102
103
104
105
106
107</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 99</span>
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/tunnel_sessions/%{id}</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">TunnelSession</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TunnelSession.html#initialize-instance_method" title="NgrokAPI::Models::TunnelSession#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="get!-instance_method">
#<strong>get!</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">NgrokAPI::Models::TunnelSession</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Get the detailed status of a tunnel session by ID Throws an exception if API error.</p>
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-get">ngrok.com/docs/api#api-tunnel-sessions-get</a></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
&mdash;
<div class='inline'>
<p>a resource identifier</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">NgrokAPI::Models::TunnelSession</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>result from the API request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
117
118
119
120
121
122
123
124
125</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 117</span>
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/tunnel_sessions/%{id}</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">TunnelSession</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TunnelSession.html#initialize-instance_method" title="NgrokAPI::Models::TunnelSession#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="list-instance_method">
#<strong>list</strong>(before_id: nil, limit: nil, filter: nil, url: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>List all online tunnel sessions running on this account.</p>
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-list">ngrok.com/docs/api#api-tunnel-sessions-list</a></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>before_id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.</p>
</div>
</li>
<li>
<span class='name'>limit</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>Constrains the number of results in the dataset. See the <code>API Overview &lt;https://ngrok.com/docs/api/index#pagination&gt;</code>_ for details.</p>
</div>
</li>
<li>
<span class='name'>filter</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as <code>id</code>, <code>metadata</code>, <code>created_at</code>, and more. See ngrok API Filtering for syntax and field details: <code>https://ngrok.com/docs/api/api-filtering &lt;https://ngrok.com/docs/api/api-filtering&gt;</code>_.</p>
</div>
</li>
<li>
<span class='name'>url</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>optional and mutually exclusive from before_id and limit</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>result from the API request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 35</span>
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>url:</span> <span class='kw'>nil</span>
<span class='rparen'>)</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
<span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span>
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TunnelSessionsClient::PATH (constant)">PATH</a></span></span>
<span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
<span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::TunnelSessionsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
<span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">TunnelSession</a></span></span>
<span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="list!-instance_method">
#<strong>list!</strong>(before_id: nil, limit: nil, filter: nil, url: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>List all online tunnel sessions running on this account. Throws an exception if API error.</p>
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-list">ngrok.com/docs/api#api-tunnel-sessions-list</a></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>before_id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.</p>
</div>
</li>
<li>
<span class='name'>limit</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>Constrains the number of results in the dataset. See the <code>API Overview &lt;https://ngrok.com/docs/api/index#pagination&gt;</code>_ for details.</p>
</div>
</li>
<li>
<span class='name'>filter</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as <code>id</code>, <code>metadata</code>, <code>created_at</code>, and more. See ngrok API Filtering for syntax and field details: <code>https://ngrok.com/docs/api/api-filtering &lt;https://ngrok.com/docs/api/api-filtering&gt;</code>_.</p>
</div>
</li>
<li>
<span class='name'>url</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>optional and mutually exclusive from before_id and limit</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>result from the API request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 68</span>
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span>
<span class='label'>url:</span> <span class='kw'>nil</span>
<span class='rparen'>)</span>
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
<span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span>
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TunnelSessionsClient::PATH (constant)">PATH</a></span></span>
<span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
<span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::TunnelSessionsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
<span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">TunnelSession</a></span></span><span class='comma'>,</span>
<span class='label'>danger:</span> <span class='kw'>true</span>
<span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="restart-instance_method">
#<strong>restart</strong>(id: &quot;&quot;) &#x21d2; <tt>NgrokAPI::Models::Empty</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Issues a command instructing the ngrok agent to restart. The agent restarts itself by calling exec() on platforms that support it. This operation is notably not supported on Windows. When an agent restarts, it reconnects with a new tunnel session ID.</p>
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-restart">ngrok.com/docs/api#api-tunnel-sessions-restart</a></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
&mdash;
<div class='inline'>
<p>a resource identifier</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
&mdash;
<div class='inline'>
<p>result from the API request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
137
138
139
140
141
142
143</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 137</span>
<span class='kw'>def</span> <span class='id identifier rubyid_restart'>restart</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/tunnel_sessions/%{id}/restart</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="restart!-instance_method">
#<strong>restart!</strong>(id: &quot;&quot;) &#x21d2; <tt>NgrokAPI::Models::Empty</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Issues a command instructing the ngrok agent to restart. The agent restarts itself by calling exec() on platforms that support it. This operation is notably not supported on Windows. When an agent restarts, it reconnects with a new tunnel session ID. Throws an exception if API error.</p>
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-restart">ngrok.com/docs/api#api-tunnel-sessions-restart</a></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
&mdash;
<div class='inline'>
<p>a resource identifier</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
&mdash;
<div class='inline'>
<p>result from the API request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
156
157
158
159
160
161
162</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 156</span>
<span class='kw'>def</span> <span class='id identifier rubyid_restart!'>restart!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/tunnel_sessions/%{id}/restart</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="stop-instance_method">
#<strong>stop</strong>(id: &quot;&quot;) &#x21d2; <tt>NgrokAPI::Models::Empty</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Issues a command instructing the ngrok agent that started this tunnel session to exit.</p>
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-stop">ngrok.com/docs/api#api-tunnel-sessions-stop</a></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
&mdash;
<div class='inline'>
<p>a resource identifier</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
&mdash;
<div class='inline'>
<p>result from the API request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
172
173
174
175
176
177
178</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 172</span>
<span class='kw'>def</span> <span class='id identifier rubyid_stop'>stop</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/tunnel_sessions/%{id}/stop</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="stop!-instance_method">
#<strong>stop!</strong>(id: &quot;&quot;) &#x21d2; <tt>NgrokAPI::Models::Empty</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Issues a command instructing the ngrok agent that started this tunnel session to exit. Throws an exception if API error.</p>
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-stop">ngrok.com/docs/api#api-tunnel-sessions-stop</a></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
&mdash;
<div class='inline'>
<p>a resource identifier</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
&mdash;
<div class='inline'>
<p>result from the API request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
189
190
191
192
193
194
195</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 189</span>
<span class='kw'>def</span> <span class='id identifier rubyid_stop!'>stop!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/tunnel_sessions/%{id}/stop</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="update-instance_method">
#<strong>update</strong>(id: &quot;&quot;, version: &quot;&quot;) &#x21d2; <tt>NgrokAPI::Models::Empty</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent’s configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted</p>
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-update">ngrok.com/docs/api#api-tunnel-sessions-update</a></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
&mdash;
<div class='inline'>
<p>result from the API request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
215
216
217
218
219
220
221</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 215</span>
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>version:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/tunnel_sessions/%{id}/update</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="update!-instance_method">
#<strong>update!</strong>(id: &quot;&quot;, version: &quot;&quot;) &#x21d2; <tt>NgrokAPI::Models::Empty</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent’s configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted Throws an exception if API error.</p>
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-update">ngrok.com/docs/api#api-tunnel-sessions-update</a></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>id</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
&mdash;
<div class='inline'>
<p>result from the API request</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
242
243
244
245
246
247
248</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 242</span>
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>version:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/tunnel_sessions/%{id}/update</span><span class='tstring_end'>&#39;</span></span>
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri Jan 23 21:38:07 2026 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-3.3.10).
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink