doc/NgrokAPI/Client.html in ngrok-api-0.12.0 vs doc/NgrokAPI/Client.html in ngrok-api-0.14.0
- old
+ new
@@ -141,11 +141,11 @@
<span class="summary_desc"><div class='inline'>
-<p>Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.</p>
+<p>Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.</p>
</div></span>
</li>
@@ -165,11 +165,11 @@
<span class="summary_desc"><div class='inline'>
-<p>API Keys are used to authenticate to the (<a href="https://ngrok.com/docs/api#authentication)ngrok">ngrok.com/docs/api#authentication)ngrok</a> API.</p>
+<p>API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">ngrok API</a>.</p>
</div></span>
</li>
@@ -189,11 +189,11 @@
<span class="summary_desc"><div class='inline'>
-<p>Certificate Authorities are x509 certificates that are used to sign other x509 certificates.</p>
+<p>Certificate Authorities are x509 certificates that are used to sign other x509 certificates.</p>
</div></span>
</li>
@@ -237,11 +237,11 @@
<span class="summary_desc"><div class='inline'>
-<p>Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled.</p>
+<p>Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled.</p>
</div></span>
</li>
@@ -375,11 +375,11 @@
<span class="summary_desc"><div class='inline'>
-<p>IP Policies are reusable groups of CIDR ranges with an allow or deny action.</p>
+<p>IP Policies are reusable groups of CIDR ranges with an <code>allow</code> or <code>deny</code> action.</p>
</div></span>
</li>
@@ -399,11 +399,11 @@
<span class="summary_desc"><div class='inline'>
-<p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.</p>
+<p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.</p>
</div></span>
</li>
@@ -423,11 +423,11 @@
<span class="summary_desc"><div class='inline'>
-<p>An IP restriction is a restriction placed on the CIDRs that are allowed to initate traffic to a specific aspect of your ngrok account.</p>
+<p>An IP restriction is a restriction placed on the CIDRs that are allowed to initate traffic to a specific aspect of your ngrok account.</p>
</div></span>
</li>
@@ -456,10 +456,32 @@
<li class="public ">
<span class="summary_signature">
+ <a href="#pointcfg_module-instance_method" title="#pointcfg_module (instance method)">#<strong>pointcfg_module</strong> ⇒ Object </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
<a href="#reserved_addrs-instance_method" title="#reserved_addrs (instance method)">#<strong>reserved_addrs</strong> ⇒ NgrokAPI::Services::ReservedAddrsClient </a>
</span>
@@ -519,11 +541,11 @@
<span class="summary_desc"><div class='inline'>
-<p>An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.</p>
+<p>An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.</p>
</div></span>
</li>
@@ -543,11 +565,11 @@
<span class="summary_desc"><div class='inline'>
-<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.</p>
+<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.</p>
</div></span>
</li>
@@ -567,11 +589,11 @@
<span class="summary_desc"><div class='inline'>
-<p>SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.</p>
+<p>SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.</p>
</div></span>
</li>
@@ -591,11 +613,11 @@
<span class="summary_desc"><div class='inline'>
-<p>SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection.</p>
+<p>SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection.</p>
</div></span>
</li>
@@ -615,11 +637,11 @@
<span class="summary_desc"><div class='inline'>
-<p>TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic.</p>
+<p>TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic.</p>
</div></span>
</li>
@@ -639,11 +661,11 @@
<span class="summary_desc"><div class='inline'>
-<p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service.</p>
+<p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service.</p>
</div></span>
</li>
@@ -663,11 +685,11 @@
<span class="summary_desc"><div class='inline'>
-<p>Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.</p>
+<p>Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.</p>
</div></span>
</li>
@@ -701,19 +723,19 @@
<tr>
<td>
<pre class="lines">
-8
-9
10
11
12
-13</pre>
+13
+14
+15</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 8</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 10</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span>
<span class='label'>api_key:</span><span class='comma'>,</span>
<span class='label'>base_url:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://api.ngrok.com</span><span class='tstring_end'>'</span></span>
<span class='rparen'>)</span>
@@ -741,16 +763,13 @@
</h3><div class="docstring">
<div class="discussion">
-<p>Abuse Reports allow you to submit take-down requests for URLs hosted by</p>
+<p>Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.</p>
-<pre class="code ruby"><code class="ruby">ngrok that violate ngrok's terms of service.
-</code></pre>
-
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
@@ -771,16 +790,16 @@
<tr>
<td>
<pre class="lines">
-20
-21
-22</pre>
+22
+23
+24</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 20</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 22</span>
<span class='kw'>def</span> <span class='id identifier rubyid_abuse_reports'>abuse_reports</span>
<span class='ivar'>@_abuse_reports</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/AbuseReportsClient.html" title="NgrokAPI::Services::AbuseReportsClient (class)">AbuseReportsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/AbuseReportsClient.html#initialize-instance_method" title="NgrokAPI::Services::AbuseReportsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
@@ -798,19 +817,13 @@
</h3><div class="docstring">
<div class="discussion">
-<p>API Keys are used to authenticate to the (<a href="https://ngrok.com/docs/api#authentication)ngrok">ngrok.com/docs/api#authentication)ngrok</a></p>
+<p>API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">ngrok API</a>. You may use the API itself to provision and manage API Keys but you'll need to provision your first API key from the <a href="https://dashboard.ngrok.com/api/keys">API Keys page</a> on your ngrok.com dashboard.</p>
-<pre class="code ruby"><code class="ruby">API. You may use the API itself
-to provision and manage API Keys but you'll need to provision your first API
-key from the (https://dashboard.ngrok.com/api/keys)API Keys page on your
-ngrok.com dashboard.
-</code></pre>
-
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
@@ -831,16 +844,16 @@
<tr>
<td>
<pre class="lines">
-33
34
-35</pre>
+35
+36</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 33</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 34</span>
<span class='kw'>def</span> <span class='id identifier rubyid_api_keys'>api_keys</span>
<span class='ivar'>@_api_keys</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/APIKeysClient.html" title="NgrokAPI::Services::APIKeysClient (class)">APIKeysClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/APIKeysClient.html#initialize-instance_method" title="NgrokAPI::Services::APIKeysClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
@@ -858,19 +871,13 @@
</h3><div class="docstring">
<div class="discussion">
-<p>Certificate Authorities are x509 certificates that are used to sign other</p>
+<p>Certificate Authorities are x509 certificates that are used to sign other x509 certificates. Attach a Certificate Authority to the Mutual TLS module to verify that the TLS certificate presented by a client has been signed by this CA. Certificate Authorities are used only for mTLS validation only and thus a private key is not included in the resource.</p>
-<pre class="code ruby"><code class="ruby">x509 certificates. Attach a Certificate Authority to the Mutual TLS module
-to verify that the TLS certificate presented by a client has been signed by
-this CA. Certificate Authorities are used only for mTLS validation only and
-thus a private key is not included in the resource.
-</code></pre>
-
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
@@ -891,16 +898,16 @@
<tr>
<td>
<pre class="lines">
-45
46
-47</pre>
+47
+48</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 45</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 46</span>
<span class='kw'>def</span> <span class='id identifier rubyid_certificate_authorities'>certificate_authorities</span>
<span class='ivar'>@_certificate_authorities</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/CertificateAuthoritiesClient.html" title="NgrokAPI::Services::CertificateAuthoritiesClient (class)">CertificateAuthoritiesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/CertificateAuthoritiesClient.html#initialize-instance_method" title="NgrokAPI::Services::CertificateAuthoritiesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
@@ -918,18 +925,13 @@
</h3><div class="docstring">
<div class="discussion">
-<p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok</p>
+<p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok agent to connect the ngrok service as your account. They are installed with the <code>ngrok authtoken</code> command or by specifying it in the <code>ngrok.yml</code> configuration file with the <code>authtoken</code> property.</p>
-<pre class="code ruby"><code class="ruby">agent to connect the ngrok service as your account. They are installed with
-the ngrok authtoken command or by specifying it in the ngrok.yml
-configuration file with the authtoken property.
-</code></pre>
-
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
@@ -950,16 +952,16 @@
<tr>
<td>
<pre class="lines">
-56
57
-58</pre>
+58
+59</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 56</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 57</span>
<span class='kw'>def</span> <span class='id identifier rubyid_credentials'>credentials</span>
<span class='ivar'>@_credentials</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/CredentialsClient.html" title="NgrokAPI::Services::CredentialsClient (class)">CredentialsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/CredentialsClient.html#initialize-instance_method" title="NgrokAPI::Services::CredentialsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
@@ -977,17 +979,13 @@
</h3><div class="docstring">
<div class="discussion">
-<p>Endpoint Configurations are a reusable group of modules that encapsulate how</p>
+<p>Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled. Endpoint configurations are only applied to Domains and TCP Addresses they have been attached to.</p>
-<pre class="code ruby"><code class="ruby">traffic to a domain or address is handled. Endpoint configurations are only
-applied to Domains and TCP Addresses they have been attached to.
-</code></pre>
-
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
@@ -1008,16 +1006,16 @@
<tr>
<td>
<pre class="lines">
-66
67
-68</pre>
+68
+69</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 66</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 67</span>
<span class='kw'>def</span> <span class='id identifier rubyid_endpoint_configurations'>endpoint_configurations</span>
<span class='ivar'>@_endpoint_configurations</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">EndpointConfigurationsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointConfigurationsClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointConfigurationsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
@@ -1038,16 +1036,16 @@
<tr>
<td>
<pre class="lines">
-74
75
-76</pre>
+76
+77</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 74</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 75</span>
<span class='kw'>def</span> <span class='id identifier rubyid_event_destinations'>event_destinations</span>
<span class='ivar'>@_event_destinations</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventDestinationsClient.html" title="NgrokAPI::Services::EventDestinationsClient (class)">EventDestinationsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventDestinationsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventDestinationsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
@@ -1068,16 +1066,16 @@
<tr>
<td>
<pre class="lines">
-82
83
-84</pre>
+84
+85</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 82</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 83</span>
<span class='kw'>def</span> <span class='id identifier rubyid_event_sources'>event_sources</span>
<span class='ivar'>@_event_sources</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventSourcesClient.html" title="NgrokAPI::Services::EventSourcesClient (class)">EventSourcesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventSourcesClient.html#initialize-instance_method" title="NgrokAPI::Services::EventSourcesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
@@ -1098,16 +1096,16 @@
<tr>
<td>
<pre class="lines">
-70
71
-72</pre>
+72
+73</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 70</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 71</span>
<span class='kw'>def</span> <span class='id identifier rubyid_event_streams'>event_streams</span>
<span class='ivar'>@_event_streams</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventStreamsClient.html" title="NgrokAPI::Services::EventStreamsClient (class)">EventStreamsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventStreamsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventStreamsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
@@ -1128,16 +1126,16 @@
<tr>
<td>
<pre class="lines">
-78
79
-80</pre>
+80
+81</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 78</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 79</span>
<span class='kw'>def</span> <span class='id identifier rubyid_event_subscriptions'>event_subscriptions</span>
<span class='ivar'>@_event_subscriptions</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventSubscriptionsClient.html" title="NgrokAPI::Services::EventSubscriptionsClient (class)">EventSubscriptionsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventSubscriptionsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventSubscriptionsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
@@ -1155,18 +1153,13 @@
</h3><div class="docstring">
<div class="discussion">
-<p>IP Policies are reusable groups of CIDR ranges with an allow or deny</p>
+<p>IP Policies are reusable groups of CIDR ranges with an <code>allow</code> or <code>deny</code> action. They can be attached to endpoints via the Endpoint Configuration IP Policy module. They can also be used with IP Restrictions to control source IP ranges that can start tunnel sessions and connect to the API and dashboard.</p>
-<pre class="code ruby"><code class="ruby">action. They can be attached to endpoints via the Endpoint Configuration IP
-Policy module. They can also be used with IP Restrictions to control source
-IP ranges that can start tunnel sessions and connect to the API and dashboard.
-</code></pre>
-
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
@@ -1187,16 +1180,16 @@
<tr>
<td>
<pre class="lines">
-93
94
-95</pre>
+95
+96</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 93</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 94</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ip_policies'>ip_policies</span>
<span class='ivar'>@_ip_policies</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/IPPoliciesClient.html" title="NgrokAPI::Services::IPPoliciesClient (class)">IPPoliciesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/IPPoliciesClient.html#initialize-instance_method" title="NgrokAPI::Services::IPPoliciesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
@@ -1214,16 +1207,13 @@
</h3><div class="docstring">
<div class="discussion">
-<p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that</p>
+<p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.</p>
-<pre class="code ruby"><code class="ruby">make up an IP Policy.
-</code></pre>
-
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
@@ -1244,16 +1234,16 @@
<tr>
<td>
<pre class="lines">
-102
103
-104</pre>
+104
+105</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 102</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 103</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ip_policy_rules'>ip_policy_rules</span>
<span class='ivar'>@_ip_policy_rules</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/IPPolicyRulesClient.html" title="NgrokAPI::Services::IPPolicyRulesClient (class)">IPPolicyRulesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/IPPolicyRulesClient.html#initialize-instance_method" title="NgrokAPI::Services::IPPolicyRulesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
@@ -1271,20 +1261,13 @@
</h3><div class="docstring">
<div class="discussion">
-<p>An IP restriction is a restriction placed on the CIDRs that are allowed to</p>
+<p>An IP restriction is a restriction placed on the CIDRs that are allowed to initate traffic to a specific aspect of your ngrok account. An IP restriction has a type which defines the ingress it applies to. IP restrictions can be used to enforce the source IPs that can make API requests, log in to the dashboard, start ngrok agents, and connect to your public-facing endpoints.</p>
-<pre class="code ruby"><code class="ruby">initate traffic to a specific aspect of your ngrok account. An IP
-restriction has a type which defines the ingress it applies to. IP
-restrictions can be used to enforce the source IPs that can make API
-requests, log in to the dashboard, start ngrok agents, and connect to your
-public-facing endpoints.
-</code></pre>
-
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
@@ -1305,16 +1288,16 @@
<tr>
<td>
<pre class="lines">
-115
116
-117</pre>
+117
+118</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 115</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 116</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ip_restrictions'>ip_restrictions</span>
<span class='ivar'>@_ip_restrictions</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/IPRestrictionsClient.html" title="NgrokAPI::Services::IPRestrictionsClient (class)">IPRestrictionsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/IPRestrictionsClient.html#initialize-instance_method" title="NgrokAPI::Services::IPRestrictionsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
@@ -1332,16 +1315,13 @@
</h3><div class="docstring">
<div class="discussion">
-<p>The IP Whitelist is deprecated and will be removed. Use an IP Restriction</p>
+<p>The IP Whitelist is deprecated and will be removed. Use an IP Restriction with an <code>endpoints</code> type instead.</p>
-<pre class="code ruby"><code class="ruby">with an endpoints type instead.
-</code></pre>
-
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
@@ -1362,26 +1342,84 @@
<tr>
<td>
<pre class="lines">
-124
125
-126</pre>
+126
+127</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 124</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 125</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ip_whitelist'>ip_whitelist</span>
<span class='ivar'>@_ip_whitelist</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/IPWhitelistClient.html" title="NgrokAPI::Services::IPWhitelistClient (class)">IPWhitelistClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/IPWhitelistClient.html#initialize-instance_method" title="NgrokAPI::Services::IPWhitelistClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
+ <h3 class="signature " id="pointcfg_module-instance_method">
+
+ #<strong>pointcfg_module</strong> ⇒ <tt>Object</tt>
+
+
+
+
+
+</h3><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+219
+220
+221
+222
+223
+224
+225
+226
+227
+228
+229
+230
+231
+232
+233
+234
+235</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 219</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_pointcfg_module'>pointcfg_module</span>
+ <span class='id identifier rubyid_ns'>ns</span> <span class='op'>=</span> <span class='const'>OpenStruct</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_logging'>logging</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointLoggingModuleClient.html" title="NgrokAPI::Services::EndpointLoggingModuleClient (class)">EndpointLoggingModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointLoggingModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointLoggingModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointCircuitBreakerModuleClient.html" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient (class)">EndpointCircuitBreakerModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointCircuitBreakerModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_compression'>compression</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointCompressionModuleClient.html" title="NgrokAPI::Services::EndpointCompressionModuleClient (class)">EndpointCompressionModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointCompressionModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointCompressionModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_tls_termination'>tls_termination</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointTLSTerminationModuleClient.html" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient (class)">EndpointTLSTerminationModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointTLSTerminationModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_ip_policy'>ip_policy</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointIPPolicyModuleClient.html" title="NgrokAPI::Services::EndpointIPPolicyModuleClient (class)">EndpointIPPolicyModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointIPPolicyModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointIPPolicyModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_mutual_tls'>mutual_tls</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointMutualTLSModuleClient.html" title="NgrokAPI::Services::EndpointMutualTLSModuleClient (class)">EndpointMutualTLSModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointMutualTLSModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointMutualTLSModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_request_headers'>request_headers</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointRequestHeadersModuleClient.html" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient (class)">EndpointRequestHeadersModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointRequestHeadersModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_response_headers'>response_headers</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointResponseHeadersModuleClient.html" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient (class)">EndpointResponseHeadersModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointResponseHeadersModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_oauth'>oauth</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointOAuthModuleClient.html" title="NgrokAPI::Services::EndpointOAuthModuleClient (class)">EndpointOAuthModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointOAuthModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointOAuthModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_webhook_validation'>webhook_validation</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointWebhookValidationModuleClient.html" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient (class)">EndpointWebhookValidationModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointWebhookValidationModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_saml'>saml</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointSAMLModuleClient.html" title="NgrokAPI::Services::EndpointSAMLModuleClient (class)">EndpointSAMLModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointSAMLModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointSAMLModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_oidc'>oidc</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointOIDCModuleClient.html" title="NgrokAPI::Services::EndpointOIDCModuleClient (class)">EndpointOIDCModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointOIDCModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointOIDCModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
+
+ <span class='id identifier rubyid_ns'>ns</span>
+<span class='kw'>end</span></pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
<h3 class="signature " id="reserved_addrs-instance_method">
#<strong>reserved_addrs</strong> ⇒ <tt><span class='object_link'><a href="Services/ReservedAddrsClient.html" title="NgrokAPI::Services::ReservedAddrsClient (class)">NgrokAPI::Services::ReservedAddrsClient</a></span></tt>
@@ -1389,17 +1427,13 @@
</h3><div class="docstring">
<div class="discussion">
-<p>Reserved Addresses are TCP addresses that can be used to listen for traffic.</p>
+<p>Reserved Addresses are TCP addresses that can be used to listen for traffic. TCP address hostnames and ports are assigned by ngrok, they cannot be chosen.</p>
-<pre class="code ruby"><code class="ruby">TCP address hostnames and ports are assigned by ngrok, they cannot be
-chosen.
-</code></pre>
-
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
@@ -1420,16 +1454,16 @@
<tr>
<td>
<pre class="lines">
-134
135
-136</pre>
+136
+137</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 134</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 135</span>
<span class='kw'>def</span> <span class='id identifier rubyid_reserved_addrs'>reserved_addrs</span>
<span class='ivar'>@_reserved_addrs</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/ReservedAddrsClient.html" title="NgrokAPI::Services::ReservedAddrsClient (class)">ReservedAddrsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/ReservedAddrsClient.html#initialize-instance_method" title="NgrokAPI::Services::ReservedAddrsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
@@ -1447,18 +1481,13 @@
</h3><div class="docstring">
<div class="discussion">
-<p>Reserved Domains are hostnames that you can listen for traffic on. Domains</p>
+<p>Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok's edge servers.</p>
-<pre class="code ruby"><code class="ruby">can be used to listen for http, https or tls traffic. You may use a domain
-that you own by creating a CNAME record specified in the returned resource.
-This CNAME record points traffic for that domain to ngrok's edge servers.
-</code></pre>
-
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
@@ -1479,16 +1508,16 @@
<tr>
<td>
<pre class="lines">
-145
146
-147</pre>
+147
+148</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 145</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 146</span>
<span class='kw'>def</span> <span class='id identifier rubyid_reserved_domains'>reserved_domains</span>
<span class='ivar'>@_reserved_domains</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">ReservedDomainsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/ReservedDomainsClient.html#initialize-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
@@ -1506,16 +1535,13 @@
</h3><div class="docstring">
<div class="discussion">
-<p>An SSH Certificate Authority is a pair of an SSH Certificate and its private</p>
+<p>An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.</p>
-<pre class="code ruby"><code class="ruby">key that can be used to sign other SSH host and user certificates.
-</code></pre>
-
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
@@ -1536,16 +1562,16 @@
<tr>
<td>
<pre class="lines">
-154
155
-156</pre>
+156
+157</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 154</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 155</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ssh_certificate_authorities'>ssh_certificate_authorities</span>
<span class='ivar'>@_ssh_certificate_authorities</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHCertificateAuthoritiesClient.html" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient (class)">SSHCertificateAuthoritiesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHCertificateAuthoritiesClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
@@ -1563,16 +1589,13 @@
</h3><div class="docstring">
<div class="discussion">
-<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels</p>
+<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.</p>
-<pre class="code ruby"><code class="ruby">via the ngrok SSH tunnel gateway.
-</code></pre>
-
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
@@ -1593,16 +1616,16 @@
<tr>
<td>
<pre class="lines">
-163
164
-165</pre>
+165
+166</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 163</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 164</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ssh_credentials'>ssh_credentials</span>
<span class='ivar'>@_ssh_credentials</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHCredentialsClient.html" title="NgrokAPI::Services::SSHCredentialsClient (class)">SSHCredentialsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHCredentialsClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHCredentialsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
@@ -1620,17 +1643,13 @@
</h3><div class="docstring">
<div class="discussion">
-<p>SSH Host Certificates along with the corresponding private key allows an SSH</p>
+<p>SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.</p>
-<pre class="code ruby"><code class="ruby">server to assert its authenticity to connecting SSH clients who trust the
-SSH Certificate Authority that was used to sign the certificate.
-</code></pre>
-
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
@@ -1651,16 +1670,16 @@
<tr>
<td>
<pre class="lines">
-173
174
-175</pre>
+175
+176</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 173</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 174</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ssh_host_certificates'>ssh_host_certificates</span>
<span class='ivar'>@_ssh_host_certificates</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHHostCertificatesClient.html" title="NgrokAPI::Services::SSHHostCertificatesClient (class)">SSHHostCertificatesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHHostCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHHostCertificatesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
@@ -1678,17 +1697,13 @@
</h3><div class="docstring">
<div class="discussion">
-<p>SSH User Certificates are presented by SSH clients when connecting to an SSH</p>
+<p>SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection. The SSH server must trust the SSH Certificate Authority used to sign the certificate.</p>
-<pre class="code ruby"><code class="ruby">server to authenticate their connection. The SSH server must trust the SSH
-Certificate Authority used to sign the certificate.
-</code></pre>
-
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
@@ -1709,16 +1724,16 @@
<tr>
<td>
<pre class="lines">
-183
184
-185</pre>
+185
+186</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 183</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 184</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ssh_user_certificates'>ssh_user_certificates</span>
<span class='ivar'>@_ssh_user_certificates</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHUserCertificatesClient.html" title="NgrokAPI::Services::SSHUserCertificatesClient (class)">SSHUserCertificatesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHUserCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHUserCertificatesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
@@ -1736,19 +1751,13 @@
</h3><div class="docstring">
<div class="discussion">
-<p>TLS Certificates are pairs of x509 certificates and their matching private</p>
+<p>TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic. TLS certificates are unused until they are attached to a Domain. TLS Certificates may also be provisioned by ngrok automatically for domains on which you have enabled automated certificate provisioning.</p>
-<pre class="code ruby"><code class="ruby">key that can be used to terminate TLS traffic. TLS certificates are unused
-until they are attached to a Domain. TLS Certificates may also be
-provisioned by ngrok automatically for domains on which you have enabled
-automated certificate provisioning.
-</code></pre>
-
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
@@ -1769,16 +1778,16 @@
<tr>
<td>
<pre class="lines">
-195
196
-197</pre>
+197
+198</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 195</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 196</span>
<span class='kw'>def</span> <span class='id identifier rubyid_tls_certificates'>tls_certificates</span>
<span class='ivar'>@_tls_certificates</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TLSCertificatesClient.html" title="NgrokAPI::Services::TLSCertificatesClient (class)">TLSCertificatesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TLSCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::TLSCertificatesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
@@ -1796,17 +1805,13 @@
</h3><div class="docstring">
<div class="discussion">
-<p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel</p>
+<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>
-<pre class="code ruby"><code class="ruby">sessions that are running and connected to the ngrok service. Each tunnel
-session can include one or more Tunnels.
-</code></pre>
-
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
@@ -1827,16 +1832,16 @@
<tr>
<td>
<pre class="lines">
-205
206
-207</pre>
+207
+208</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 205</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 206</span>
<span class='kw'>def</span> <span class='id identifier rubyid_tunnel_sessions'>tunnel_sessions</span>
<span class='ivar'>@_tunnel_sessions</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TunnelSessionsClient.html" title="NgrokAPI::Services::TunnelSessionsClient (class)">TunnelSessionsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TunnelSessionsClient.html#initialize-instance_method" title="NgrokAPI::Services::TunnelSessionsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
@@ -1854,16 +1859,13 @@
</h3><div class="docstring">
<div class="discussion">
-<p>Tunnels provide endpoints to access services exposed by a running ngrok</p>
+<p>Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.</p>
-<pre class="code ruby"><code class="ruby">agent tunnel session or an SSH reverse tunnel session.
-</code></pre>
-
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
@@ -1884,16 +1886,16 @@
<tr>
<td>
<pre class="lines">
-214
215
-216</pre>
+216
+217</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 214</span>
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 215</span>
<span class='kw'>def</span> <span class='id identifier rubyid_tunnels'>tunnels</span>
<span class='ivar'>@_tunnels</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TunnelsClient.html" title="NgrokAPI::Services::TunnelsClient (class)">TunnelsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TunnelsClient.html#initialize-instance_method" title="NgrokAPI::Services::TunnelsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
@@ -1904,10 +1906,10 @@
</div>
</div>
<div id="footer">
- Generated on Mon Oct 4 23:24:15 2021 by
+ Generated on Tue Oct 19 15:48:18 2021 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.26 (ruby-3.0.1).
</div>
</div>
\ No newline at end of file