mirror of
https://github.com/ngrok/ngrok-api-ruby.git
synced 2026-06-16 16:54:38 +00:00
2725 lines
102 KiB
HTML
2725 lines
102 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>
|
|
Class: NgrokAPI::Services::EdgesHTTPSRoutesClient
|
|
|
|
— Documentation by YARD 0.9.36
|
|
|
|
</title>
|
|
|
|
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
|
|
|
|
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
|
|
|
<script type="text/javascript">
|
|
pathId = "NgrokAPI::Services::EdgesHTTPSRoutesClient";
|
|
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 (E)</a> »
|
|
<span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> » <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span>
|
|
»
|
|
<span class="title">EdgesHTTPSRoutesClient</span>
|
|
|
|
</div>
|
|
|
|
<div id="search">
|
|
|
|
<a class="full_list_link" id="class_list_link"
|
|
href="../../class_list.html">
|
|
|
|
<svg width="24" height="24">
|
|
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
</svg>
|
|
</a>
|
|
|
|
</div>
|
|
<div class="clear"></div>
|
|
</div>
|
|
|
|
<div id="content"><h1>Class: NgrokAPI::Services::EdgesHTTPSRoutesClient
|
|
|
|
|
|
|
|
</h1>
|
|
<div class="box_info">
|
|
|
|
<dl>
|
|
<dt>Inherits:</dt>
|
|
<dd>
|
|
<span class="inheritName">Object</span>
|
|
|
|
<ul class="fullTree">
|
|
<li>Object</li>
|
|
|
|
<li class="next">NgrokAPI::Services::EdgesHTTPSRoutesClient</li>
|
|
|
|
</ul>
|
|
<a href="#" class="inheritanceTree">show all</a>
|
|
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dl>
|
|
<dt>Defined in:</dt>
|
|
<dd>lib/ngrokapi/services/edges_https_routes_client.rb</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
<h2>Overview</h2><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p><a href="https://ngrok.com/docs/api#api-edges-https-routes">ngrok.com/docs/api#api-edges-https-routes</a></p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
|
|
</div>
|
|
|
|
<h2>
|
|
Constant Summary
|
|
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
</h2>
|
|
|
|
<dl class="constants">
|
|
|
|
<dt id="PATH-constant" class="">PATH =
|
|
<div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>The API path for the requests</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
|
|
</div>
|
|
</dt>
|
|
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
|
|
</dl>
|
|
|
|
|
|
|
|
|
|
|
|
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
<ul class="summary">
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> ⇒ Object </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
<span class="note title readonly">readonly</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Returns the value of attribute client.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<h2>
|
|
Instance Method Summary
|
|
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
</h2>
|
|
|
|
<ul class="summary">
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil, traffic_policy: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Create an HTTPS Edge Route.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil, traffic_policy: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Create an HTTPS Edge Route Throws an exception if API error.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(edge_id: "", id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Delete an HTTPS Edge Route by ID.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(edge_id: "", id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Delete an HTTPS Edge Route by ID Throws an exception if API error.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(edge_id: "", id: "") ⇒ NgrokAPI::Models::HTTPSEdgeRoute </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Get an HTTPS Edge Route by ID.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(edge_id: "", id: "") ⇒ NgrokAPI::Models::HTTPSEdgeRoute </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Get an HTTPS Edge Route by ID Throws an exception if API error.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒ EdgesHTTPSRoutesClient </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
<span class="note title constructor">constructor</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>A new instance of EdgesHTTPSRoutesClient.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil, traffic_policy: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Updates an HTTPS Edge Route by ID.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
<li class="public ">
|
|
<span class="summary_signature">
|
|
|
|
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil, traffic_policy: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute </a>
|
|
|
|
|
|
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<span class="summary_desc"><div class='inline'>
|
|
<p>Updates an HTTPS Edge Route by ID.</p>
|
|
</div></span>
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
<div id="constructor_details" class="method_details_list">
|
|
<h2>Constructor Details</h2>
|
|
|
|
<div class="method_details first">
|
|
<h3 class="signature first" id="initialize-instance_method">
|
|
|
|
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::EdgesHTTPSRoutesClient (class)">EdgesHTTPSRoutesClient</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Returns a new instance of EdgesHTTPSRoutesClient.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
15
|
|
16
|
|
17</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 15</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
|
|
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div id="instance_attr_details" class="attr_details">
|
|
<h2>Instance Attribute Details</h2>
|
|
|
|
|
|
<span id=""></span>
|
|
<div class="method_details first">
|
|
<h3 class="signature first" id="client-instance_method">
|
|
|
|
#<strong>client</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Returns the value of attribute client.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
13
|
|
14
|
|
15</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 13</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
<span class='ivar'>@client</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<div id="instance_method_details" class="method_details_list">
|
|
<h2>Instance Method Details</h2>
|
|
|
|
|
|
<div class="method_details first">
|
|
<h3 class="signature first" id="create-instance_method">
|
|
|
|
#<strong>create</strong>(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil, traffic_policy: nil) ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Create an HTTPS Edge Route</p>
|
|
|
|
<p><a href="https://ngrok.com/docs/api#api-edges-https-routes-create">ngrok.com/docs/api#api-edges-https-routes-create</a></p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
<p class="tag_title">Parameters:</p>
|
|
<ul class="param">
|
|
|
|
<li>
|
|
|
|
<span class='name'>edge_id</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>unique identifier of this edge</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>match_type</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>Type of match to use for this route. Valid values are “exact_path” and “path_prefix”.</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>match</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>Route selector: “/blog” or “example.com” or “example.com/blog”</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>description</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>metadata</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>backend</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointBackendMutate</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>backend module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>ip_restriction</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>ip restriction module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>circuit_breaker</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointCircuitBreaker</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>circuit breaker module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>compression</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointCompression</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>compression module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>request_headers</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointRequestHeaders</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>request headers module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>response_headers</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointResponseHeaders</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>response headers module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>webhook_verification</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointWebhookValidation</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>webhook verification module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>oauth</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointOAuth</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>oauth module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>saml</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointSAMLMutate</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>saml module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>oidc</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointOIDC</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>oidc module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>websocket_tcp_converter</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointWebsocketTCPConverter</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>websocket to tcp adapter configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>user_agent_filter</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointUserAgentFilter</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>traffic_policy</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointTrafficPolicy</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>the traffic policy associated with this edge or null</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>result from the API request</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
43
|
|
44
|
|
45
|
|
46
|
|
47
|
|
48
|
|
49
|
|
50
|
|
51
|
|
52
|
|
53
|
|
54
|
|
55
|
|
56
|
|
57
|
|
58
|
|
59
|
|
60
|
|
61
|
|
62
|
|
63
|
|
64
|
|
65
|
|
66
|
|
67
|
|
68</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 43</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match_type:</span><span class='comma'>,</span> <span class='label'>match:</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>webhook_verification:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>websocket_tcp_converter:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>user_agent_filter:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>policy:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>traffic_policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes</span><span class='tstring_end'>'</span></span>
|
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
<span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
|
|
<span class='rbrace'>}</span>
|
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:match_type</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_match_type'>match_type</span> <span class='kw'>if</span> <span class='id identifier rubyid_match_type'>match_type</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:match</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_match'>match</span> <span class='kw'>if</span> <span class='id identifier rubyid_match'>match</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:backend</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_backend'>backend</span> <span class='kw'>if</span> <span class='id identifier rubyid_backend'>backend</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_restriction</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:circuit_breaker</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span> <span class='kw'>if</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:compression</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_compression'>compression</span> <span class='kw'>if</span> <span class='id identifier rubyid_compression'>compression</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:request_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_request_headers'>request_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_request_headers'>request_headers</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:response_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_response_headers'>response_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_response_headers'>response_headers</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:webhook_verification</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_webhook_verification'>webhook_verification</span> <span class='kw'>if</span> <span class='id identifier rubyid_webhook_verification'>webhook_verification</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oauth</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth'>oauth</span> <span class='kw'>if</span> <span class='id identifier rubyid_oauth'>oauth</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:saml</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_saml'>saml</span> <span class='kw'>if</span> <span class='id identifier rubyid_saml'>saml</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oidc</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oidc'>oidc</span> <span class='kw'>if</span> <span class='id identifier rubyid_oidc'>oidc</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:websocket_tcp_converter</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_websocket_tcp_converter'>websocket_tcp_converter</span> <span class='kw'>if</span> <span class='id identifier rubyid_websocket_tcp_converter'>websocket_tcp_converter</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:user_agent_filter</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_user_agent_filter'>user_agent_filter</span> <span class='kw'>if</span> <span class='id identifier rubyid_user_agent_filter'>user_agent_filter</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:traffic_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_traffic_policy'>traffic_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_traffic_policy'>traffic_policy</span>
|
|
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">HTTPSEdgeRoute</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html#initialize-instance_method" title="NgrokAPI::Models::HTTPSEdgeRoute#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="create!-instance_method">
|
|
|
|
#<strong>create!</strong>(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil, traffic_policy: nil) ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Create an HTTPS Edge Route Throws an exception if API error.</p>
|
|
|
|
<p><a href="https://ngrok.com/docs/api#api-edges-https-routes-create">ngrok.com/docs/api#api-edges-https-routes-create</a></p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
<p class="tag_title">Parameters:</p>
|
|
<ul class="param">
|
|
|
|
<li>
|
|
|
|
<span class='name'>edge_id</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>unique identifier of this edge</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>match_type</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>Type of match to use for this route. Valid values are “exact_path” and “path_prefix”.</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>match</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>Route selector: “/blog” or “example.com” or “example.com/blog”</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>description</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>metadata</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>backend</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointBackendMutate</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>backend module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>ip_restriction</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>ip restriction module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>circuit_breaker</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointCircuitBreaker</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>circuit breaker module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>compression</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointCompression</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>compression module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>request_headers</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointRequestHeaders</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>request headers module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>response_headers</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointResponseHeaders</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>response headers module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>webhook_verification</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointWebhookValidation</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>webhook verification module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>oauth</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointOAuth</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>oauth module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>saml</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointSAMLMutate</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>saml module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>oidc</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointOIDC</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>oidc module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>websocket_tcp_converter</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointWebsocketTCPConverter</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>websocket to tcp adapter configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>user_agent_filter</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointUserAgentFilter</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>traffic_policy</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointTrafficPolicy</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>the traffic policy associated with this edge or null</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>result from the API request</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
95
|
|
96
|
|
97
|
|
98
|
|
99
|
|
100
|
|
101
|
|
102
|
|
103
|
|
104
|
|
105
|
|
106
|
|
107
|
|
108
|
|
109
|
|
110
|
|
111
|
|
112
|
|
113
|
|
114
|
|
115
|
|
116
|
|
117
|
|
118
|
|
119
|
|
120</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 95</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match_type:</span><span class='comma'>,</span> <span class='label'>match:</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>webhook_verification:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>websocket_tcp_converter:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>user_agent_filter:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>policy:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>traffic_policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes</span><span class='tstring_end'>'</span></span>
|
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
<span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
|
|
<span class='rbrace'>}</span>
|
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:match_type</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_match_type'>match_type</span> <span class='kw'>if</span> <span class='id identifier rubyid_match_type'>match_type</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:match</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_match'>match</span> <span class='kw'>if</span> <span class='id identifier rubyid_match'>match</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:backend</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_backend'>backend</span> <span class='kw'>if</span> <span class='id identifier rubyid_backend'>backend</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_restriction</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:circuit_breaker</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span> <span class='kw'>if</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:compression</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_compression'>compression</span> <span class='kw'>if</span> <span class='id identifier rubyid_compression'>compression</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:request_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_request_headers'>request_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_request_headers'>request_headers</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:response_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_response_headers'>response_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_response_headers'>response_headers</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:webhook_verification</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_webhook_verification'>webhook_verification</span> <span class='kw'>if</span> <span class='id identifier rubyid_webhook_verification'>webhook_verification</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oauth</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth'>oauth</span> <span class='kw'>if</span> <span class='id identifier rubyid_oauth'>oauth</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:saml</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_saml'>saml</span> <span class='kw'>if</span> <span class='id identifier rubyid_saml'>saml</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oidc</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oidc'>oidc</span> <span class='kw'>if</span> <span class='id identifier rubyid_oidc'>oidc</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:websocket_tcp_converter</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_websocket_tcp_converter'>websocket_tcp_converter</span> <span class='kw'>if</span> <span class='id identifier rubyid_websocket_tcp_converter'>websocket_tcp_converter</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:user_agent_filter</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_user_agent_filter'>user_agent_filter</span> <span class='kw'>if</span> <span class='id identifier rubyid_user_agent_filter'>user_agent_filter</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:traffic_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_traffic_policy'>traffic_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_traffic_policy'>traffic_policy</span>
|
|
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">HTTPSEdgeRoute</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html#initialize-instance_method" title="NgrokAPI::Models::HTTPSEdgeRoute#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="delete-instance_method">
|
|
|
|
#<strong>delete</strong>(edge_id: "", id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Delete an HTTPS Edge Route by ID</p>
|
|
|
|
<p><a href="https://ngrok.com/docs/api#api-edges-https-routes-delete">ngrok.com/docs/api#api-edges-https-routes-delete</a></p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
<p class="tag_title">Parameters:</p>
|
|
<ul class="param">
|
|
|
|
<li>
|
|
|
|
<span class='name'>edge_id</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>unique identifier of this edge</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>id</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>unique identifier of this edge route</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>result from the API request</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
282
|
|
283
|
|
284
|
|
285
|
|
286
|
|
287
|
|
288
|
|
289</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 282</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes/%{id}</span><span class='tstring_end'>'</span></span>
|
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
<span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
|
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
<span class='rbrace'>}</span>
|
|
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='rparen'>)</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="delete!-instance_method">
|
|
|
|
#<strong>delete!</strong>(edge_id: "", id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Delete an HTTPS Edge Route by ID Throws an exception if API error.</p>
|
|
|
|
<p><a href="https://ngrok.com/docs/api#api-edges-https-routes-delete">ngrok.com/docs/api#api-edges-https-routes-delete</a></p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
<p class="tag_title">Parameters:</p>
|
|
<ul class="param">
|
|
|
|
<li>
|
|
|
|
<span class='name'>edge_id</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>unique identifier of this edge</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>id</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>unique identifier of this edge route</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>result from the API request</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
300
|
|
301
|
|
302
|
|
303
|
|
304
|
|
305
|
|
306
|
|
307</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 300</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes/%{id}</span><span class='tstring_end'>'</span></span>
|
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
<span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
|
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
<span class='rbrace'>}</span>
|
|
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="get-instance_method">
|
|
|
|
#<strong>get</strong>(edge_id: "", id: "") ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Get an HTTPS Edge Route by ID</p>
|
|
|
|
<p><a href="https://ngrok.com/docs/api#api-edges-https-routes-get">ngrok.com/docs/api#api-edges-https-routes-get</a></p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
<p class="tag_title">Parameters:</p>
|
|
<ul class="param">
|
|
|
|
<li>
|
|
|
|
<span class='name'>edge_id</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>unique identifier of this edge</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>id</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>unique identifier of this edge route</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>result from the API request</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
130
|
|
131
|
|
132
|
|
133
|
|
134
|
|
135
|
|
136
|
|
137
|
|
138
|
|
139</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 130</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes/%{id}</span><span class='tstring_end'>'</span></span>
|
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
<span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
|
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
<span class='rbrace'>}</span>
|
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">HTTPSEdgeRoute</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html#initialize-instance_method" title="NgrokAPI::Models::HTTPSEdgeRoute#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="get!-instance_method">
|
|
|
|
#<strong>get!</strong>(edge_id: "", id: "") ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Get an HTTPS Edge Route by ID Throws an exception if API error.</p>
|
|
|
|
<p><a href="https://ngrok.com/docs/api#api-edges-https-routes-get">ngrok.com/docs/api#api-edges-https-routes-get</a></p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
<p class="tag_title">Parameters:</p>
|
|
<ul class="param">
|
|
|
|
<li>
|
|
|
|
<span class='name'>edge_id</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>unique identifier of this edge</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>id</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>unique identifier of this edge route</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>result from the API request</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
150
|
|
151
|
|
152
|
|
153
|
|
154
|
|
155
|
|
156
|
|
157
|
|
158
|
|
159</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 150</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes/%{id}</span><span class='tstring_end'>'</span></span>
|
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
<span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
|
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
<span class='rbrace'>}</span>
|
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">HTTPSEdgeRoute</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html#initialize-instance_method" title="NgrokAPI::Models::HTTPSEdgeRoute#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="update-instance_method">
|
|
|
|
#<strong>update</strong>(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil, traffic_policy: nil) ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Updates an HTTPS Edge Route by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.</p>
|
|
|
|
<p><a href="https://ngrok.com/docs/api#api-edges-https-routes-update">ngrok.com/docs/api#api-edges-https-routes-update</a></p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
<p class="tag_title">Parameters:</p>
|
|
<ul class="param">
|
|
|
|
<li>
|
|
|
|
<span class='name'>edge_id</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>unique identifier of this edge</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>id</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>unique identifier of this edge route</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>match_type</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>Type of match to use for this route. Valid values are “exact_path” and “path_prefix”.</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>match</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>Route selector: “/blog” or “example.com” or “example.com/blog”</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>description</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>metadata</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>backend</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointBackendMutate</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>backend module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>ip_restriction</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>ip restriction module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>circuit_breaker</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointCircuitBreaker</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>circuit breaker module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>compression</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointCompression</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>compression module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>request_headers</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointRequestHeaders</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>request headers module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>response_headers</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointResponseHeaders</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>response headers module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>webhook_verification</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointWebhookValidation</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>webhook verification module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>oauth</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointOAuth</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>oauth module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>saml</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointSAMLMutate</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>saml module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>oidc</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointOIDC</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>oidc module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>websocket_tcp_converter</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointWebsocketTCPConverter</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>websocket to tcp adapter configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>user_agent_filter</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointUserAgentFilter</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>traffic_policy</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointTrafficPolicy</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>the traffic policy associated with this edge or null</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>result from the API request</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
189
|
|
190
|
|
191
|
|
192
|
|
193
|
|
194
|
|
195
|
|
196
|
|
197
|
|
198
|
|
199
|
|
200
|
|
201
|
|
202
|
|
203
|
|
204
|
|
205
|
|
206
|
|
207
|
|
208
|
|
209
|
|
210
|
|
211
|
|
212
|
|
213
|
|
214
|
|
215</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 189</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match_type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>webhook_verification:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>websocket_tcp_converter:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>user_agent_filter:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>policy:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>traffic_policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes/%{id}</span><span class='tstring_end'>'</span></span>
|
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
<span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
|
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
<span class='rbrace'>}</span>
|
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:match_type</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_match_type'>match_type</span> <span class='kw'>if</span> <span class='id identifier rubyid_match_type'>match_type</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:match</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_match'>match</span> <span class='kw'>if</span> <span class='id identifier rubyid_match'>match</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:backend</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_backend'>backend</span> <span class='kw'>if</span> <span class='id identifier rubyid_backend'>backend</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_restriction</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:circuit_breaker</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span> <span class='kw'>if</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:compression</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_compression'>compression</span> <span class='kw'>if</span> <span class='id identifier rubyid_compression'>compression</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:request_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_request_headers'>request_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_request_headers'>request_headers</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:response_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_response_headers'>response_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_response_headers'>response_headers</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:webhook_verification</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_webhook_verification'>webhook_verification</span> <span class='kw'>if</span> <span class='id identifier rubyid_webhook_verification'>webhook_verification</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oauth</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth'>oauth</span> <span class='kw'>if</span> <span class='id identifier rubyid_oauth'>oauth</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:saml</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_saml'>saml</span> <span class='kw'>if</span> <span class='id identifier rubyid_saml'>saml</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oidc</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oidc'>oidc</span> <span class='kw'>if</span> <span class='id identifier rubyid_oidc'>oidc</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:websocket_tcp_converter</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_websocket_tcp_converter'>websocket_tcp_converter</span> <span class='kw'>if</span> <span class='id identifier rubyid_websocket_tcp_converter'>websocket_tcp_converter</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:user_agent_filter</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_user_agent_filter'>user_agent_filter</span> <span class='kw'>if</span> <span class='id identifier rubyid_user_agent_filter'>user_agent_filter</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:traffic_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_traffic_policy'>traffic_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_traffic_policy'>traffic_policy</span>
|
|
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">HTTPSEdgeRoute</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html#initialize-instance_method" title="NgrokAPI::Models::HTTPSEdgeRoute#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="method_details ">
|
|
<h3 class="signature " id="update!-instance_method">
|
|
|
|
#<strong>update!</strong>(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil, traffic_policy: nil) ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>
|
|
|
|
|
|
|
|
|
|
|
|
</h3><div class="docstring">
|
|
<div class="discussion">
|
|
|
|
<p>Updates an HTTPS Edge Route by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API. Throws an exception if API error.</p>
|
|
|
|
<p><a href="https://ngrok.com/docs/api#api-edges-https-routes-update">ngrok.com/docs/api#api-edges-https-routes-update</a></p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<div class="tags">
|
|
<p class="tag_title">Parameters:</p>
|
|
<ul class="param">
|
|
|
|
<li>
|
|
|
|
<span class='name'>edge_id</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>unique identifier of this edge</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>id</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>unique identifier of this edge route</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>match_type</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>Type of match to use for this route. Valid values are “exact_path” and “path_prefix”.</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>match</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>Route selector: “/blog” or “example.com” or “example.com/blog”</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>description</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>metadata</span>
|
|
|
|
|
|
<span class='type'>(<tt>string</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>backend</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointBackendMutate</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>backend module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>ip_restriction</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>ip restriction module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>circuit_breaker</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointCircuitBreaker</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>circuit breaker module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>compression</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointCompression</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>compression module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>request_headers</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointRequestHeaders</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>request headers module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>response_headers</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointResponseHeaders</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>response headers module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>webhook_verification</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointWebhookValidation</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>webhook verification module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>oauth</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointOAuth</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>oauth module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>saml</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointSAMLMutate</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>saml module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>oidc</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointOIDC</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>oidc module configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>websocket_tcp_converter</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointWebsocketTCPConverter</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>websocket to tcp adapter configuration or <code>null</code></p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>user_agent_filter</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointUserAgentFilter</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
</li>
|
|
|
|
<li>
|
|
|
|
<span class='name'>traffic_policy</span>
|
|
|
|
|
|
<span class='type'>(<tt>EndpointTrafficPolicy</tt>)</span>
|
|
|
|
|
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>the traffic policy associated with this edge or null</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
<p class="tag_title">Returns:</p>
|
|
<ul class="return">
|
|
|
|
<li>
|
|
|
|
|
|
<span class='type'>(<tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>)</span>
|
|
|
|
|
|
|
|
—
|
|
<div class='inline'>
|
|
<p>result from the API request</p>
|
|
</div>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</div><table class="source_code">
|
|
<tr>
|
|
<td>
|
|
<pre class="lines">
|
|
|
|
|
|
246
|
|
247
|
|
248
|
|
249
|
|
250
|
|
251
|
|
252
|
|
253
|
|
254
|
|
255
|
|
256
|
|
257
|
|
258
|
|
259
|
|
260
|
|
261
|
|
262
|
|
263
|
|
264
|
|
265
|
|
266
|
|
267
|
|
268
|
|
269
|
|
270
|
|
271
|
|
272</pre>
|
|
</td>
|
|
<td>
|
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 246</span>
|
|
|
|
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match_type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>webhook_verification:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>websocket_tcp_converter:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>user_agent_filter:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>policy:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>traffic_policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes/%{id}</span><span class='tstring_end'>'</span></span>
|
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
<span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
|
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
<span class='rbrace'>}</span>
|
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:match_type</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_match_type'>match_type</span> <span class='kw'>if</span> <span class='id identifier rubyid_match_type'>match_type</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:match</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_match'>match</span> <span class='kw'>if</span> <span class='id identifier rubyid_match'>match</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:backend</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_backend'>backend</span> <span class='kw'>if</span> <span class='id identifier rubyid_backend'>backend</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_restriction</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:circuit_breaker</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span> <span class='kw'>if</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:compression</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_compression'>compression</span> <span class='kw'>if</span> <span class='id identifier rubyid_compression'>compression</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:request_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_request_headers'>request_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_request_headers'>request_headers</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:response_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_response_headers'>response_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_response_headers'>response_headers</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:webhook_verification</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_webhook_verification'>webhook_verification</span> <span class='kw'>if</span> <span class='id identifier rubyid_webhook_verification'>webhook_verification</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oauth</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth'>oauth</span> <span class='kw'>if</span> <span class='id identifier rubyid_oauth'>oauth</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:saml</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_saml'>saml</span> <span class='kw'>if</span> <span class='id identifier rubyid_saml'>saml</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oidc</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oidc'>oidc</span> <span class='kw'>if</span> <span class='id identifier rubyid_oidc'>oidc</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:websocket_tcp_converter</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_websocket_tcp_converter'>websocket_tcp_converter</span> <span class='kw'>if</span> <span class='id identifier rubyid_websocket_tcp_converter'>websocket_tcp_converter</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:user_agent_filter</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_user_agent_filter'>user_agent_filter</span> <span class='kw'>if</span> <span class='id identifier rubyid_user_agent_filter'>user_agent_filter</span>
|
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:traffic_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_traffic_policy'>traffic_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_traffic_policy'>traffic_policy</span>
|
|
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">HTTPSEdgeRoute</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html#initialize-instance_method" title="NgrokAPI::Models::HTTPSEdgeRoute#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
<span class='kw'>end</span></pre>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div id="footer">
|
|
Generated on Fri Jan 23 21:38:08 2026 by
|
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
0.9.36 (ruby-3.3.10).
|
|
</div>
|
|
|
|
</div>
|
|
</body>
|
|
</html> |