mirror of
https://github.com/ngrok/ngrok-api-ruby.git
synced 2026-05-17 16:50:40 +00:00
ngrok-release-bot
1976 lines
93 KiB
HTML
1976 lines
93 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>
|
|
Class: NgrokAPI::Client
|
|
|
|
— Documentation by YARD 0.9.28
|
|
|
|
</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::Client";
|
|
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 (C)</a> »
|
|
<span class='title'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span>
|
|
»
|
|
<span class="title">Client</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::Client
|
|
|
|
|
|
|
|
</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::Client</li>
|
|
|
|
</ul>
|
|
<a href="#" class="inheritanceTree">show all</a>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl>
|
|
<dt>Defined in:</dt>
|
|
<dd>lib/ngrokapi/client.rb</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
<h2>Overview</h2><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Low-level api client for communicating with Ngrok's HTTP API. Use this object to instantiate your clients.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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="#abuse_reports-instance_method" title="#abuse_reports (instance method)">#<strong>abuse_reports</strong> ⇒ NgrokAPI::Services::AbuseReportsClient </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#agent_ingresses-instance_method" title="#agent_ingresses (instance method)">#<strong>agent_ingresses</strong> ⇒ Object </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'></div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#api_keys-instance_method" title="#api_keys (instance method)">#<strong>api_keys</strong> ⇒ NgrokAPI::Services::APIKeysClient </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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 API</a>.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#backends-instance_method" title="#backends (instance method)">#<strong>backends</strong> ⇒ Object </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'></div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#certificate_authorities-instance_method" title="#certificate_authorities (instance method)">#<strong>certificate_authorities</strong> ⇒ NgrokAPI::Services::CertificateAuthoritiesClient </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Certificate Authorities are x509 certificates that are used to sign other x509 certificates.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#credentials-instance_method" title="#credentials (instance method)">#<strong>credentials</strong> ⇒ NgrokAPI::Services::CredentialsClient </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Tunnel Credentials are ngrok agent authtokens.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#edge_modules-instance_method" title="#edge_modules (instance method)">#<strong>edge_modules</strong> ⇒ Object </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'></div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#edges-instance_method" title="#edges (instance method)">#<strong>edges</strong> ⇒ Object </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'></div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#endpoints-instance_method" title="#endpoints (instance method)">#<strong>endpoints</strong> ⇒ NgrokAPI::Services::EndpointsClient </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Endpoints provides an API for querying the endpoint objects which define what tunnel or edge is used to serve a hostport.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#event_destinations-instance_method" title="#event_destinations (instance method)">#<strong>event_destinations</strong> ⇒ Object </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'></div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#event_sources-instance_method" title="#event_sources (instance method)">#<strong>event_sources</strong> ⇒ Object </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'></div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#event_subscriptions-instance_method" title="#event_subscriptions (instance method)">#<strong>event_subscriptions</strong> ⇒ Object </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'></div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(api_key:, base_url: 'https://api.ngrok.com') ⇒ Client </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
<span class="note title constructor">constructor</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>A new instance of Client.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#ip_policies-instance_method" title="#ip_policies (instance method)">#<strong>ip_policies</strong> ⇒ NgrokAPI::Services::IPPoliciesClient </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>IP Policies are reusable groups of CIDR ranges with an <code>allow</code> or <code>deny</code> action.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#ip_policy_rules-instance_method" title="#ip_policy_rules (instance method)">#<strong>ip_policy_rules</strong> ⇒ NgrokAPI::Services::IPPolicyRulesClient </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#ip_restrictions-instance_method" title="#ip_restrictions (instance method)">#<strong>ip_restrictions</strong> ⇒ NgrokAPI::Services::IPRestrictionsClient </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>An IP restriction is a restriction placed on the CIDRs that are allowed to initiate traffic to a specific aspect of your ngrok account.</p>
|
|
</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>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Reserved Addresses are TCP addresses that can be used to listen for traffic.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#reserved_domains-instance_method" title="#reserved_domains (instance method)">#<strong>reserved_domains</strong> ⇒ NgrokAPI::Services::ReservedDomainsClient </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Reserved Domains are hostnames that you can listen for traffic on.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#ssh_certificate_authorities-instance_method" title="#ssh_certificate_authorities (instance method)">#<strong>ssh_certificate_authorities</strong> ⇒ NgrokAPI::Services::SSHCertificateAuthoritiesClient </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#ssh_credentials-instance_method" title="#ssh_credentials (instance method)">#<strong>ssh_credentials</strong> ⇒ NgrokAPI::Services::SSHCredentialsClient </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#ssh_host_certificates-instance_method" title="#ssh_host_certificates (instance method)">#<strong>ssh_host_certificates</strong> ⇒ NgrokAPI::Services::SSHHostCertificatesClient </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#ssh_user_certificates-instance_method" title="#ssh_user_certificates (instance method)">#<strong>ssh_user_certificates</strong> ⇒ NgrokAPI::Services::SSHUserCertificatesClient </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#tls_certificates-instance_method" title="#tls_certificates (instance method)">#<strong>tls_certificates</strong> ⇒ NgrokAPI::Services::TLSCertificatesClient </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#tunnel_sessions-instance_method" title="#tunnel_sessions (instance method)">#<strong>tunnel_sessions</strong> ⇒ NgrokAPI::Services::TunnelSessionsClient </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#tunnels-instance_method" title="#tunnels (instance method)">#<strong>tunnels</strong> ⇒ NgrokAPI::Services::TunnelsClient </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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>
|
|
</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>(api_key:, base_url: 'https://api.ngrok.com') ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Client (class)">Client</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Returns a new instance of Client.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
10
|
|
11
|
|
12</pre>
|
|
</td>
|
|
<td>
|
|
<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>
|
|
<span class='ivar'>@client</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="HttpClient.html" title="NgrokAPI::HttpClient (class)">HttpClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="HttpClient.html#initialize-instance_method" title="NgrokAPI::HttpClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='id identifier rubyid_api_key'>api_key</span><span class='comma'>,</span> <span class='label'>base_url:</span> <span class='id identifier rubyid_base_url'>base_url</span><span class='rparen'>)</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="abuse_reports-instance_method">
|
|
|
|
#<strong>abuse_reports</strong> ⇒ <tt><span class='object_link'><a href="Services/AbuseReportsClient.html" title="NgrokAPI::Services::AbuseReportsClient (class)">NgrokAPI::Services::AbuseReportsClient</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="Services/AbuseReportsClient.html" title="NgrokAPI::Services::AbuseReportsClient (class)">NgrokAPI::Services::AbuseReportsClient</a></span></tt>)</span>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</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/client.rb', line 19</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>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="agent_ingresses-instance_method">
|
|
|
|
#<strong>agent_ingresses</strong> ⇒ <tt>Object</tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
23
|
|
24
|
|
25</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 23</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_agent_ingresses'>agent_ingresses</span>
|
|
<span class='ivar'>@_agent_ingresses</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/AgentIngressesClient.html" title="NgrokAPI::Services::AgentIngressesClient (class)">AgentIngressesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/AgentIngressesClient.html#initialize-instance_method" title="NgrokAPI::Services::AgentIngressesClient#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="api_keys-instance_method">
|
|
|
|
#<strong>api_keys</strong> ⇒ <tt><span class='object_link'><a href="Services/APIKeysClient.html" title="NgrokAPI::Services::APIKeysClient (class)">NgrokAPI::Services::APIKeysClient</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</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 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>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="Services/APIKeysClient.html" title="NgrokAPI::Services::APIKeysClient (class)">NgrokAPI::Services::APIKeysClient</a></span></tt>)</span>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
35
|
|
36
|
|
37</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 35</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>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="backends-instance_method">
|
|
|
|
#<strong>backends</strong> ⇒ <tt>Object</tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
207
|
|
208
|
|
209
|
|
210
|
|
211
|
|
212
|
|
213
|
|
214
|
|
215</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 207</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_backends'>backends</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_failover'>failover</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/FailoverBackendsClient.html" title="NgrokAPI::Services::FailoverBackendsClient (class)">FailoverBackendsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/FailoverBackendsClient.html#initialize-instance_method" title="NgrokAPI::Services::FailoverBackendsClient#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_http_response'>http_response</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/HTTPResponseBackendsClient.html" title="NgrokAPI::Services::HTTPResponseBackendsClient (class)">HTTPResponseBackendsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/HTTPResponseBackendsClient.html#initialize-instance_method" title="NgrokAPI::Services::HTTPResponseBackendsClient#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_tunnel_group'>tunnel_group</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/TunnelGroupBackendsClient.html" title="NgrokAPI::Services::TunnelGroupBackendsClient (class)">TunnelGroupBackendsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TunnelGroupBackendsClient.html#initialize-instance_method" title="NgrokAPI::Services::TunnelGroupBackendsClient#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_weighted'>weighted</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/WeightedBackendsClient.html" title="NgrokAPI::Services::WeightedBackendsClient (class)">WeightedBackendsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/WeightedBackendsClient.html#initialize-instance_method" title="NgrokAPI::Services::WeightedBackendsClient#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="certificate_authorities-instance_method">
|
|
|
|
#<strong>certificate_authorities</strong> ⇒ <tt><span class='object_link'><a href="Services/CertificateAuthoritiesClient.html" title="NgrokAPI::Services::CertificateAuthoritiesClient (class)">NgrokAPI::Services::CertificateAuthoritiesClient</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<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>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="Services/CertificateAuthoritiesClient.html" title="NgrokAPI::Services::CertificateAuthoritiesClient (class)">NgrokAPI::Services::CertificateAuthoritiesClient</a></span></tt>)</span>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
47
|
|
48
|
|
49</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 47</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>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="credentials-instance_method">
|
|
|
|
#<strong>credentials</strong> ⇒ <tt><span class='object_link'><a href="Services/CredentialsClient.html" title="NgrokAPI::Services::CredentialsClient (class)">NgrokAPI::Services::CredentialsClient</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<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 config add-authtoken</code> command or by specifying it in the <code>ngrok.yml</code> configuration file with the <code>authtoken</code> property.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="Services/CredentialsClient.html" title="NgrokAPI::Services::CredentialsClient (class)">NgrokAPI::Services::CredentialsClient</a></span></tt>)</span>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
58
|
|
59
|
|
60</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 58</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>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="edge_modules-instance_method">
|
|
|
|
#<strong>edge_modules</strong> ⇒ <tt>Object</tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
227
|
|
228
|
|
229
|
|
230
|
|
231
|
|
232
|
|
233
|
|
234
|
|
235
|
|
236
|
|
237
|
|
238
|
|
239
|
|
240
|
|
241
|
|
242
|
|
243
|
|
244
|
|
245
|
|
246
|
|
247
|
|
248
|
|
249
|
|
250</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 227</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_edge_modules'>edge_modules</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_https_edge_mutual_tls'>https_edge_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/HTTPSEdgeMutualTLSModuleClient.html" title="NgrokAPI::Services::HTTPSEdgeMutualTLSModuleClient (class)">HTTPSEdgeMutualTLSModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/HTTPSEdgeMutualTLSModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::HTTPSEdgeMutualTLSModuleClient#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_https_edge_tls_termination'>https_edge_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/HTTPSEdgeTLSTerminationModuleClient.html" title="NgrokAPI::Services::HTTPSEdgeTLSTerminationModuleClient (class)">HTTPSEdgeTLSTerminationModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/HTTPSEdgeTLSTerminationModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::HTTPSEdgeTLSTerminationModuleClient#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_https_edge_route_backend'>https_edge_route_backend</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/EdgeRouteBackendModuleClient.html" title="NgrokAPI::Services::EdgeRouteBackendModuleClient (class)">EdgeRouteBackendModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgeRouteBackendModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgeRouteBackendModuleClient#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_https_edge_route_ip_restriction'>https_edge_route_ip_restriction</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/EdgeRouteIPRestrictionModuleClient.html" title="NgrokAPI::Services::EdgeRouteIPRestrictionModuleClient (class)">EdgeRouteIPRestrictionModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgeRouteIPRestrictionModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgeRouteIPRestrictionModuleClient#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_https_edge_route_request_headers'>https_edge_route_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/EdgeRouteRequestHeadersModuleClient.html" title="NgrokAPI::Services::EdgeRouteRequestHeadersModuleClient (class)">EdgeRouteRequestHeadersModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgeRouteRequestHeadersModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgeRouteRequestHeadersModuleClient#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_https_edge_route_response_headers'>https_edge_route_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/EdgeRouteResponseHeadersModuleClient.html" title="NgrokAPI::Services::EdgeRouteResponseHeadersModuleClient (class)">EdgeRouteResponseHeadersModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgeRouteResponseHeadersModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgeRouteResponseHeadersModuleClient#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_https_edge_route_compression'>https_edge_route_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/EdgeRouteCompressionModuleClient.html" title="NgrokAPI::Services::EdgeRouteCompressionModuleClient (class)">EdgeRouteCompressionModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgeRouteCompressionModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgeRouteCompressionModuleClient#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_https_edge_route_circuit_breaker'>https_edge_route_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/EdgeRouteCircuitBreakerModuleClient.html" title="NgrokAPI::Services::EdgeRouteCircuitBreakerModuleClient (class)">EdgeRouteCircuitBreakerModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgeRouteCircuitBreakerModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgeRouteCircuitBreakerModuleClient#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_https_edge_route_webhook_verification'>https_edge_route_webhook_verification</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/EdgeRouteWebhookVerificationModuleClient.html" title="NgrokAPI::Services::EdgeRouteWebhookVerificationModuleClient (class)">EdgeRouteWebhookVerificationModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgeRouteWebhookVerificationModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgeRouteWebhookVerificationModuleClient#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_https_edge_route_oauth'>https_edge_route_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/EdgeRouteOAuthModuleClient.html" title="NgrokAPI::Services::EdgeRouteOAuthModuleClient (class)">EdgeRouteOAuthModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgeRouteOAuthModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgeRouteOAuthModuleClient#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_https_edge_route_saml'>https_edge_route_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/EdgeRouteSAMLModuleClient.html" title="NgrokAPI::Services::EdgeRouteSAMLModuleClient (class)">EdgeRouteSAMLModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgeRouteSAMLModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgeRouteSAMLModuleClient#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_https_edge_route_oidc'>https_edge_route_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/EdgeRouteOIDCModuleClient.html" title="NgrokAPI::Services::EdgeRouteOIDCModuleClient (class)">EdgeRouteOIDCModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgeRouteOIDCModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgeRouteOIDCModuleClient#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_https_edge_route_websocket_tcp_converter'>https_edge_route_websocket_tcp_converter</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/EdgeRouteWebsocketTCPConverterModuleClient.html" title="NgrokAPI::Services::EdgeRouteWebsocketTCPConverterModuleClient (class)">EdgeRouteWebsocketTCPConverterModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgeRouteWebsocketTCPConverterModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgeRouteWebsocketTCPConverterModuleClient#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_tcp_edge_backend'>tcp_edge_backend</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/TCPEdgeBackendModuleClient.html" title="NgrokAPI::Services::TCPEdgeBackendModuleClient (class)">TCPEdgeBackendModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TCPEdgeBackendModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::TCPEdgeBackendModuleClient#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_tcp_edge_ip_restriction'>tcp_edge_ip_restriction</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/TCPEdgeIPRestrictionModuleClient.html" title="NgrokAPI::Services::TCPEdgeIPRestrictionModuleClient (class)">TCPEdgeIPRestrictionModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TCPEdgeIPRestrictionModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::TCPEdgeIPRestrictionModuleClient#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_edge_backend'>tls_edge_backend</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/TLSEdgeBackendModuleClient.html" title="NgrokAPI::Services::TLSEdgeBackendModuleClient (class)">TLSEdgeBackendModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TLSEdgeBackendModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::TLSEdgeBackendModuleClient#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_edge_ip_restriction'>tls_edge_ip_restriction</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/TLSEdgeIPRestrictionModuleClient.html" title="NgrokAPI::Services::TLSEdgeIPRestrictionModuleClient (class)">TLSEdgeIPRestrictionModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TLSEdgeIPRestrictionModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::TLSEdgeIPRestrictionModuleClient#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_edge_mutual_tls'>tls_edge_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/TLSEdgeMutualTLSModuleClient.html" title="NgrokAPI::Services::TLSEdgeMutualTLSModuleClient (class)">TLSEdgeMutualTLSModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TLSEdgeMutualTLSModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::TLSEdgeMutualTLSModuleClient#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_edge_tls_termination'>tls_edge_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/TLSEdgeTLSTerminationModuleClient.html" title="NgrokAPI::Services::TLSEdgeTLSTerminationModuleClient (class)">TLSEdgeTLSTerminationModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TLSEdgeTLSTerminationModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::TLSEdgeTLSTerminationModuleClient#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="edges-instance_method">
|
|
|
|
#<strong>edges</strong> ⇒ <tt>Object</tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
217
|
|
218
|
|
219
|
|
220
|
|
221
|
|
222
|
|
223
|
|
224
|
|
225</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 217</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_edges'>edges</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_https_routes'>https_routes</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/EdgesHTTPSRoutesClient.html" title="NgrokAPI::Services::EdgesHTTPSRoutesClient (class)">EdgesHTTPSRoutesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgesHTTPSRoutesClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgesHTTPSRoutesClient#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_https'>https</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/EdgesHTTPSClient.html" title="NgrokAPI::Services::EdgesHTTPSClient (class)">EdgesHTTPSClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgesHTTPSClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgesHTTPSClient#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_tcp'>tcp</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/EdgesTCPClient.html" title="NgrokAPI::Services::EdgesTCPClient (class)">EdgesTCPClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgesTCPClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgesTCPClient#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'>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/EdgesTLSClient.html" title="NgrokAPI::Services::EdgesTLSClient (class)">EdgesTLSClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgesTLSClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgesTLSClient#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="endpoints-instance_method">
|
|
|
|
#<strong>endpoints</strong> ⇒ <tt><span class='object_link'><a href="Services/EndpointsClient.html" title="NgrokAPI::Services::EndpointsClient (class)">NgrokAPI::Services::EndpointsClient</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Endpoints provides an API for querying the endpoint objects which define what tunnel or edge is used to serve a hostport. Only active endpoints associated with a tunnel or backend are returned.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="Services/EndpointsClient.html" title="NgrokAPI::Services::EndpointsClient (class)">NgrokAPI::Services::EndpointsClient</a></span></tt>)</span>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
68
|
|
69
|
|
70</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 68</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_endpoints'>endpoints</span>
|
|
<span class='ivar'>@_endpoints</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/EndpointsClient.html" title="NgrokAPI::Services::EndpointsClient (class)">EndpointsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointsClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointsClient#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="event_destinations-instance_method">
|
|
|
|
#<strong>event_destinations</strong> ⇒ <tt>Object</tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
72
|
|
73
|
|
74</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 72</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>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="event_sources-instance_method">
|
|
|
|
#<strong>event_sources</strong> ⇒ <tt>Object</tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
80
|
|
81
|
|
82</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 80</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>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="event_subscriptions-instance_method">
|
|
|
|
#<strong>event_subscriptions</strong> ⇒ <tt>Object</tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
76
|
|
77
|
|
78</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 76</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>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="ip_policies-instance_method">
|
|
|
|
#<strong>ip_policies</strong> ⇒ <tt><span class='object_link'><a href="Services/IPPoliciesClient.html" title="NgrokAPI::Services::IPPoliciesClient (class)">NgrokAPI::Services::IPPoliciesClient</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<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>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="Services/IPPoliciesClient.html" title="NgrokAPI::Services::IPPoliciesClient (class)">NgrokAPI::Services::IPPoliciesClient</a></span></tt>)</span>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
91
|
|
92
|
|
93</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 91</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>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="ip_policy_rules-instance_method">
|
|
|
|
#<strong>ip_policy_rules</strong> ⇒ <tt><span class='object_link'><a href="Services/IPPolicyRulesClient.html" title="NgrokAPI::Services::IPPolicyRulesClient (class)">NgrokAPI::Services::IPPolicyRulesClient</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="Services/IPPolicyRulesClient.html" title="NgrokAPI::Services::IPPolicyRulesClient (class)">NgrokAPI::Services::IPPolicyRulesClient</a></span></tt>)</span>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
100
|
|
101
|
|
102</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 100</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>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="ip_restrictions-instance_method">
|
|
|
|
#<strong>ip_restrictions</strong> ⇒ <tt><span class='object_link'><a href="Services/IPRestrictionsClient.html" title="NgrokAPI::Services::IPRestrictionsClient (class)">NgrokAPI::Services::IPRestrictionsClient</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>An IP restriction is a restriction placed on the CIDRs that are allowed to initiate 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>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="Services/IPRestrictionsClient.html" title="NgrokAPI::Services::IPRestrictionsClient (class)">NgrokAPI::Services::IPRestrictionsClient</a></span></tt>)</span>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
113
|
|
114
|
|
115</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 113</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>
|
|
</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>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<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>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="Services/ReservedAddrsClient.html" title="NgrokAPI::Services::ReservedAddrsClient (class)">NgrokAPI::Services::ReservedAddrsClient</a></span></tt>)</span>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
123
|
|
124
|
|
125</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 123</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>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="reserved_domains-instance_method">
|
|
|
|
#<strong>reserved_domains</strong> ⇒ <tt><span class='object_link'><a href="Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">NgrokAPI::Services::ReservedDomainsClient</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<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>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">NgrokAPI::Services::ReservedDomainsClient</a></span></tt>)</span>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
134
|
|
135
|
|
136</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 134</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>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="ssh_certificate_authorities-instance_method">
|
|
|
|
#<strong>ssh_certificate_authorities</strong> ⇒ <tt><span class='object_link'><a href="Services/SSHCertificateAuthoritiesClient.html" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient (class)">NgrokAPI::Services::SSHCertificateAuthoritiesClient</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<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>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="Services/SSHCertificateAuthoritiesClient.html" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient (class)">NgrokAPI::Services::SSHCertificateAuthoritiesClient</a></span></tt>)</span>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
143
|
|
144
|
|
145</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 143</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>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="ssh_credentials-instance_method">
|
|
|
|
#<strong>ssh_credentials</strong> ⇒ <tt><span class='object_link'><a href="Services/SSHCredentialsClient.html" title="NgrokAPI::Services::SSHCredentialsClient (class)">NgrokAPI::Services::SSHCredentialsClient</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="Services/SSHCredentialsClient.html" title="NgrokAPI::Services::SSHCredentialsClient (class)">NgrokAPI::Services::SSHCredentialsClient</a></span></tt>)</span>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
152
|
|
153
|
|
154</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 152</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>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="ssh_host_certificates-instance_method">
|
|
|
|
#<strong>ssh_host_certificates</strong> ⇒ <tt><span class='object_link'><a href="Services/SSHHostCertificatesClient.html" title="NgrokAPI::Services::SSHHostCertificatesClient (class)">NgrokAPI::Services::SSHHostCertificatesClient</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<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>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="Services/SSHHostCertificatesClient.html" title="NgrokAPI::Services::SSHHostCertificatesClient (class)">NgrokAPI::Services::SSHHostCertificatesClient</a></span></tt>)</span>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
162
|
|
163
|
|
164</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 162</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>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="ssh_user_certificates-instance_method">
|
|
|
|
#<strong>ssh_user_certificates</strong> ⇒ <tt><span class='object_link'><a href="Services/SSHUserCertificatesClient.html" title="NgrokAPI::Services::SSHUserCertificatesClient (class)">NgrokAPI::Services::SSHUserCertificatesClient</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<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>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="Services/SSHUserCertificatesClient.html" title="NgrokAPI::Services::SSHUserCertificatesClient (class)">NgrokAPI::Services::SSHUserCertificatesClient</a></span></tt>)</span>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
172
|
|
173
|
|
174</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 172</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>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="tls_certificates-instance_method">
|
|
|
|
#<strong>tls_certificates</strong> ⇒ <tt><span class='object_link'><a href="Services/TLSCertificatesClient.html" title="NgrokAPI::Services::TLSCertificatesClient (class)">NgrokAPI::Services::TLSCertificatesClient</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<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>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="Services/TLSCertificatesClient.html" title="NgrokAPI::Services::TLSCertificatesClient (class)">NgrokAPI::Services::TLSCertificatesClient</a></span></tt>)</span>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
184
|
|
185
|
|
186</pre>
|
|
</td>
|
|
<td>
|
|
<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_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>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="tunnel_sessions-instance_method">
|
|
|
|
#<strong>tunnel_sessions</strong> ⇒ <tt><span class='object_link'><a href="Services/TunnelSessionsClient.html" title="NgrokAPI::Services::TunnelSessionsClient (class)">NgrokAPI::Services::TunnelSessionsClient</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><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>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="Services/TunnelSessionsClient.html" title="NgrokAPI::Services::TunnelSessionsClient (class)">NgrokAPI::Services::TunnelSessionsClient</a></span></tt>)</span>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
194
|
|
195
|
|
196</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 194</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>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="tunnels-instance_method">
|
|
|
|
#<strong>tunnels</strong> ⇒ <tt><span class='object_link'><a href="Services/TunnelsClient.html" title="NgrokAPI::Services::TunnelsClient (class)">NgrokAPI::Services::TunnelsClient</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="Services/TunnelsClient.html" title="NgrokAPI::Services::TunnelsClient (class)">NgrokAPI::Services::TunnelsClient</a></span></tt>)</span>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
203
|
|
204
|
|
205</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 203</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>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div id="footer">
|
|
Generated on Tue Jun 14 17:35:29 2022 by
|
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
0.9.28 (ruby-2.7.5).
|
|
</div>
|
|
|
|
</div>
|
|
</body>
|
|
</html> |