ngrok/ngrok-api-python
1
0
Fork 0
mirror of https://github.com/ngrok/ngrok-api-python.git synced 2026-05-17 16:50:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #38 from ngrok/pr/generated-ef4a538441

Browse Source 
Update generated files
This commit is contained in:
Joshua Hertlein
2024-10-25 10:04:53 -05:00
committed by GitHub
parent 7d5c96fbb4 c87422f2da
commit 974605f590
17 changed files with 770 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.tox/dist/ngrok-api-0.0.0.zip
Vendored
BIN
View File
Binary file not shown.
.tox/dist/ngrok_api-0.0.0.zip
Vendored
BIN
View File
Binary file not shown.
.tox/log/GLOB-0.log
+53 -52
View File
@@ -1,6 +1,6 @@
action: GLOB, msg: packaging
cwd: /var/lib/buildkite-agent-0/builds/repo-ngrok-private-ngrok-buildkite-agent-0/.cache/ngrok-api-python
cmd: /var/lib/buildkite-agent-0/builds/repo-ngrok-private-ngrok-buildkite-agent-0/.cache/ngrok-api-python/venv/bin/python setup.py sdist --formats=zip --dist-dir .tox/dist
cwd: /var/lib/buildkite-agent-1/builds/repo-ngrok-private-ngrok-buildkite-agent-1/.cache/ngrok-api-python
cmd: /var/lib/buildkite-agent-1/builds/repo-ngrok-private-ngrok-buildkite-agent-1/.cache/ngrok-api-python/venv/bin/python setup.py sdist --formats=zip --dist-dir .tox/dist
running sdist
running egg_info
writing ngrok_api.egg-info/PKG-INFO
@@ -11,53 +11,54 @@ reading manifest file 'ngrok_api.egg-info/SOURCES.txt'
adding license file 'LICENSE'
writing manifest file 'ngrok_api.egg-info/SOURCES.txt'
running check
creating ngrok-api-0.0.0
creating ngrok-api-0.0.0/ngrok
creating ngrok-api-0.0.0/ngrok_api.egg-info
creating ngrok-api-0.0.0/tests
copying files to ngrok-api-0.0.0...
copying LICENSE -> ngrok-api-0.0.0
copying README.md -> ngrok-api-0.0.0
copying pyproject.toml -> ngrok-api-0.0.0
copying setup.py -> ngrok-api-0.0.0
copying ngrok/__init__.py -> ngrok-api-0.0.0/ngrok
copying ngrok/client.py -> ngrok-api-0.0.0/ngrok
copying ngrok/datatypes.py -> ngrok-api-0.0.0/ngrok
copying ngrok/error.py -> ngrok-api-0.0.0/ngrok
copying ngrok/http_client.py -> ngrok-api-0.0.0/ngrok
copying ngrok/iterator.py -> ngrok-api-0.0.0/ngrok
copying ngrok/services.py -> ngrok-api-0.0.0/ngrok
copying ngrok/utils.py -> ngrok-api-0.0.0/ngrok
copying ngrok_api.egg-info/PKG-INFO -> ngrok-api-0.0.0/ngrok_api.egg-info
copying ngrok_api.egg-info/SOURCES.txt -> ngrok-api-0.0.0/ngrok_api.egg-info
copying ngrok_api.egg-info/dependency_links.txt -> ngrok-api-0.0.0/ngrok_api.egg-info
copying ngrok_api.egg-info/requires.txt -> ngrok-api-0.0.0/ngrok_api.egg-info
copying ngrok_api.egg-info/top_level.txt -> ngrok-api-0.0.0/ngrok_api.egg-info
copying tests/test_ngrok.py -> ngrok-api-0.0.0/tests
Writing ngrok-api-0.0.0/setup.cfg
creating '.tox/dist/ngrok-api-0.0.0.zip' and adding 'ngrok-api-0.0.0' to it
adding 'ngrok-api-0.0.0'
adding 'ngrok-api-0.0.0/ngrok_api.egg-info'
adding 'ngrok-api-0.0.0/ngrok'
adding 'ngrok-api-0.0.0/tests'
adding 'ngrok-api-0.0.0/LICENSE'
adding 'ngrok-api-0.0.0/setup.cfg'
adding 'ngrok-api-0.0.0/pyproject.toml'
adding 'ngrok-api-0.0.0/PKG-INFO'
adding 'ngrok-api-0.0.0/setup.py'
adding 'ngrok-api-0.0.0/README.md'
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/SOURCES.txt'
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/PKG-INFO'
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/dependency_links.txt'
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/top_level.txt'
adding 'ngrok-api-0.0.0/ngrok_api.egg-info/requires.txt'
adding 'ngrok-api-0.0.0/ngrok/error.py'
adding 'ngrok-api-0.0.0/ngrok/datatypes.py'
adding 'ngrok-api-0.0.0/ngrok/http_client.py'
adding 'ngrok-api-0.0.0/ngrok/iterator.py'
adding 'ngrok-api-0.0.0/ngrok/services.py'
adding 'ngrok-api-0.0.0/ngrok/__init__.py'
adding 'ngrok-api-0.0.0/ngrok/utils.py'
adding 'ngrok-api-0.0.0/ngrok/client.py'
adding 'ngrok-api-0.0.0/tests/test_ngrok.py'
removing 'ngrok-api-0.0.0' (and everything under it)
creating ngrok_api-0.0.0
creating ngrok_api-0.0.0/ngrok
creating ngrok_api-0.0.0/ngrok_api.egg-info
creating ngrok_api-0.0.0/tests
copying files to ngrok_api-0.0.0...
copying LICENSE -> ngrok_api-0.0.0
copying README.md -> ngrok_api-0.0.0
copying pyproject.toml -> ngrok_api-0.0.0
copying setup.py -> ngrok_api-0.0.0
copying ngrok/__init__.py -> ngrok_api-0.0.0/ngrok
copying ngrok/client.py -> ngrok_api-0.0.0/ngrok
copying ngrok/datatypes.py -> ngrok_api-0.0.0/ngrok
copying ngrok/error.py -> ngrok_api-0.0.0/ngrok
copying ngrok/http_client.py -> ngrok_api-0.0.0/ngrok
copying ngrok/iterator.py -> ngrok_api-0.0.0/ngrok
copying ngrok/services.py -> ngrok_api-0.0.0/ngrok
copying ngrok/utils.py -> ngrok_api-0.0.0/ngrok
copying ngrok_api.egg-info/PKG-INFO -> ngrok_api-0.0.0/ngrok_api.egg-info
copying ngrok_api.egg-info/SOURCES.txt -> ngrok_api-0.0.0/ngrok_api.egg-info
copying ngrok_api.egg-info/dependency_links.txt -> ngrok_api-0.0.0/ngrok_api.egg-info
copying ngrok_api.egg-info/requires.txt -> ngrok_api-0.0.0/ngrok_api.egg-info
copying ngrok_api.egg-info/top_level.txt -> ngrok_api-0.0.0/ngrok_api.egg-info
copying tests/test_ngrok.py -> ngrok_api-0.0.0/tests
copying ngrok_api.egg-info/SOURCES.txt -> ngrok_api-0.0.0/ngrok_api.egg-info
Writing ngrok_api-0.0.0/setup.cfg
creating '.tox/dist/ngrok_api-0.0.0.zip' and adding 'ngrok_api-0.0.0' to it
adding 'ngrok_api-0.0.0'
adding 'ngrok_api-0.0.0/ngrok_api.egg-info'
adding 'ngrok_api-0.0.0/tests'
adding 'ngrok_api-0.0.0/ngrok'
adding 'ngrok_api-0.0.0/pyproject.toml'
adding 'ngrok_api-0.0.0/PKG-INFO'
adding 'ngrok_api-0.0.0/setup.py'
adding 'ngrok_api-0.0.0/setup.cfg'
adding 'ngrok_api-0.0.0/README.md'
adding 'ngrok_api-0.0.0/LICENSE'
adding 'ngrok_api-0.0.0/ngrok_api.egg-info/SOURCES.txt'
adding 'ngrok_api-0.0.0/ngrok_api.egg-info/PKG-INFO'
adding 'ngrok_api-0.0.0/ngrok_api.egg-info/top_level.txt'
adding 'ngrok_api-0.0.0/ngrok_api.egg-info/requires.txt'
adding 'ngrok_api-0.0.0/ngrok_api.egg-info/dependency_links.txt'
adding 'ngrok_api-0.0.0/tests/test_ngrok.py'
adding 'ngrok_api-0.0.0/ngrok/utils.py'
adding 'ngrok_api-0.0.0/ngrok/datatypes.py'
adding 'ngrok_api-0.0.0/ngrok/__init__.py'
adding 'ngrok_api-0.0.0/ngrok/http_client.py'
adding 'ngrok_api-0.0.0/ngrok/iterator.py'
adding 'ngrok_api-0.0.0/ngrok/error.py'
adding 'ngrok_api-0.0.0/ngrok/services.py'
adding 'ngrok_api-0.0.0/ngrok/client.py'
removing 'ngrok_api-0.0.0' (and everything under it)
CHANGELOG.md
+3
View File
@@ -1,5 +1,8 @@
<!-- Code generated for API Clients. DO NOT EDIT. -->
## 0.13.0
* Added support for Cloud Endpoints (currently in private beta).
## 0.12.0
* Renamed the Policy Module to the Traffic Policy Module on HTTP Edge Routes, TCP Edges, and TLS Edges, which allows you to configure rules that can be used to influence and control traffic to and from your upstream service. The Traffic Policy itself is now specified as either a JSON or YAML string.
docs/_modules/ngrok/client.html
+6
View File
@@ -475,12 +475,15 @@
<span class="s2">&quot;https_edge_route_oidc&quot;</span><span class="p">,</span>
<span class="s2">&quot;https_edge_route_websocket_tcp_converter&quot;</span><span class="p">,</span>
<span class="s2">&quot;https_edge_route_user_agent_filter&quot;</span><span class="p">,</span>
<span class="s2">&quot;https_edge_route_traffic_policy&quot;</span><span class="p">,</span>
<span class="s2">&quot;tcp_edge_backend&quot;</span><span class="p">,</span>
<span class="s2">&quot;tcp_edge_ip_restriction&quot;</span><span class="p">,</span>
<span class="s2">&quot;tcp_edge_traffic_policy&quot;</span><span class="p">,</span>
<span class="s2">&quot;tls_edge_backend&quot;</span><span class="p">,</span>
<span class="s2">&quot;tls_edge_ip_restriction&quot;</span><span class="p">,</span>
<span class="s2">&quot;tls_edge_mutual_tls&quot;</span><span class="p">,</span>
<span class="s2">&quot;tls_edge_tls_termination&quot;</span><span class="p">,</span>
<span class="s2">&quot;tls_edge_traffic_policy&quot;</span><span class="p">,</span>
<span class="p">],</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">ns</span><span class="p">(</span>
@@ -506,12 +509,15 @@
<span class="n">https_edge_route_user_agent_filter</span><span class="o">=</span><span class="n">EdgeRouteUserAgentFilterModuleClient</span><span class="p">(</span>
<span class="bp">self</span>
<span class="p">),</span>
<span class="n">https_edge_route_traffic_policy</span><span class="o">=</span><span class="n">EdgeRouteTrafficPolicyModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">tcp_edge_backend</span><span class="o">=</span><span class="n">TCPEdgeBackendModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">tcp_edge_ip_restriction</span><span class="o">=</span><span class="n">TCPEdgeIPRestrictionModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">tcp_edge_traffic_policy</span><span class="o">=</span><span class="n">TCPEdgeTrafficPolicyModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">tls_edge_backend</span><span class="o">=</span><span class="n">TLSEdgeBackendModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">tls_edge_ip_restriction</span><span class="o">=</span><span class="n">TLSEdgeIPRestrictionModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">tls_edge_mutual_tls</span><span class="o">=</span><span class="n">TLSEdgeMutualTLSModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">tls_edge_tls_termination</span><span class="o">=</span><span class="n">TLSEdgeTLSTerminationModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="n">tls_edge_traffic_policy</span><span class="o">=</span><span class="n">TLSEdgeTrafficPolicyModuleClient</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
<span class="p">)</span></div>
</pre></div>
</article>
docs/_modules/ngrok/datatypes.html
+111 -5
View File
@@ -3912,6 +3912,21 @@
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;edge&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">Ref</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">[</span><span class="s2">&quot;edge&quot;</span><span class="p">])</span> <span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;edge&quot;</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="k">else</span> <span class="kc">None</span>
<span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;principal&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">Ref</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">[</span><span class="s2">&quot;principal&quot;</span><span class="p">])</span>
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;principal&quot;</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="k">else</span> <span class="kc">None</span>
<span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;principal_id&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">Ref</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">[</span><span class="s2">&quot;principal_id&quot;</span><span class="p">])</span>
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;principal_id&quot;</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="k">else</span> <span class="kc">None</span>
<span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;tunnel_session&quot;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">Ref</span><span class="p">(</span><span class="n">client</span><span class="p">,</span> <span class="n">props</span><span class="p">[</span><span class="s2">&quot;tunnel_session&quot;</span><span class="p">])</span>
<span class="k">if</span> <span class="n">props</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;tunnel_session&quot;</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="k">else</span> <span class="kc">None</span>
<span class="p">)</span>
<span class="k">def</span> <span class="fm">__eq__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">other</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span> <span class="o">==</span> <span class="n">other</span><span class="o">.</span><span class="n">_props</span>
@@ -3922,6 +3937,30 @@
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="s2">&quot;&lt;Endpoint </span><span class="si">{}</span><span class="s2">&gt;&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">))</span>
<div class="viewcode-block" id="Endpoint.update"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.Endpoint.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">traffic_policy</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">bindings</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">endpoints</span><span class="o">.</span><span class="n">update</span><span class="p">(</span>
<span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
<span class="n">url</span><span class="o">=</span><span class="n">url</span><span class="p">,</span>
<span class="n">traffic_policy</span><span class="o">=</span><span class="n">traffic_policy</span><span class="p">,</span>
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
<span class="n">bindings</span><span class="o">=</span><span class="n">bindings</span><span class="p">,</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="Endpoint.delete"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.Endpoint.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">endpoints</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span>
<span class="nb">id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
<span class="p">)</span></div>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">id</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;unique endpoint resource identifier&quot;&quot;&quot;</span>
@@ -3952,14 +3991,26 @@
<span class="w"> </span><span class="sd">&quot;&quot;&quot;protocol served by this endpoint. one of ``http``, ``https``, ``tcp``, or ``tls``&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;proto&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">scheme</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;scheme&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">hostport</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;hostport served by this endpoint (hostname:port)&quot;&quot;&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;hostport served by this endpoint (hostname:port) -&gt; soon to be deprecated&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;hostport&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">host</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;host&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">port</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;port&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;whether the endpoint is ``ephemeral`` (served directly by an agent-initiated tunnel) or ``edge`` (served by an edge)&quot;&quot;&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;whether the endpoint is ``ephemeral`` (served directly by an agent-initiated tunnel) or ``edge`` (served by an edge) or ``cloud (represents a cloud endpoint)``&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;type&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
@@ -3967,6 +4018,11 @@
<span class="w"> </span><span class="sd">&quot;&quot;&quot;user-supplied metadata of the associated tunnel or edge object&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;metadata&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">description</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;user-supplied description of the associated tunnel&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;description&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">domain</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Ref</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;the domain reserved for this endpoint&quot;&quot;&quot;</span>
@@ -3985,7 +4041,57 @@
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">edge</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Ref</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;the edge serving requests to this endpoint, if this is an edge endpoint&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;edge&quot;</span><span class="p">]</span></div>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;edge&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">upstream_url</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;the local address the tunnel forwards to&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;upstream_url&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">upstream_proto</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;the protocol the agent uses to forward with&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;upstream_proto&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">url</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;the url of the endpoint&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">principal</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Ref</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;The ID of the owner (bot or user) that owns this endpoint&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;principal&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">principal_id</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Ref</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;TODO: deprecate me!&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;principal_id&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">traffic_policy</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;The traffic policy attached to this endpoint&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;traffic_policy&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">bindings</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;the bindings associated with this endpoint&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;bindings&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">tunnel_session</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Ref</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;The tunnel session of the agent for this endpoint&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;tunnel_session&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">uri</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;URI of the clep API resource&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;uri&quot;</span><span class="p">]</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">name</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;user supplied name for the endpoint&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;name&quot;</span><span class="p">]</span></div>
<div class="viewcode-block" id="EndpointList"><a class="viewcode-back" href="../../datatypes.html#ngrok.datatypes.EndpointList">[docs]</a><span class="k">class</span> <span class="nc">EndpointList</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
@@ -4354,7 +4460,7 @@
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">data_collection_stream_name</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Data collection stream name to use as destination, located instide the DCR&quot;&quot;&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Data collection stream name to use as destination, located inside the DCR&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;data_collection_stream_name&quot;</span><span class="p">]</span></div>
@@ -5186,7 +5292,7 @@
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">private_key_type</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.&quot;&quot;&quot;</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;type of private key to use when requesting certificates. Defaults to ecdsa, can be either rsa or ecdsa.&quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_props</span><span class="p">[</span><span class="s2">&quot;private_key_type&quot;</span><span class="p">]</span></div>
docs/_modules/ngrok/services.html
+84 -1
View File
@@ -3770,6 +3770,38 @@
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span> <span class="o">=</span> <span class="n">client</span>
<div class="viewcode-block" id="EndpointsClient.create"><a class="viewcode-back" href="../../endpoints.html#ngrok.services.EndpointsClient.create">[docs]</a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="nb">type</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="n">traffic_policy</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span><span class="p">,</span>
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">bindings</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Endpoint</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Create an endpoint, currently available only for cloud endpoints</span>
<span class="sd"> :param url: the url of the endpoint</span>
<span class="sd"> :param type: whether the endpoint is ``ephemeral`` (served directly by an agent-initiated tunnel) or ``edge`` (served by an edge) or ``cloud (represents a cloud endpoint)``</span>
<span class="sd"> :param traffic_policy: The traffic policy attached to this endpoint</span>
<span class="sd"> :param description: user-supplied description of the associated tunnel</span>
<span class="sd"> :param metadata: user-supplied metadata of the associated tunnel or edge object</span>
<span class="sd"> :param bindings: the bindings associated with this endpoint</span>
<span class="sd"> https://ngrok.com/docs/api#api-endpoints-create</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="s2">&quot;/endpoints&quot;</span>
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
<span class="n">url</span><span class="o">=</span><span class="n">url</span><span class="p">,</span>
<span class="nb">type</span><span class="o">=</span><span class="nb">type</span><span class="p">,</span>
<span class="n">traffic_policy</span><span class="o">=</span><span class="n">traffic_policy</span><span class="p">,</span>
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
<span class="n">bindings</span><span class="o">=</span><span class="n">bindings</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Endpoint</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
<div class="viewcode-block" id="EndpointsClient.list"><a class="viewcode-back" href="../../endpoints.html#ngrok.services.EndpointsClient.list">[docs]</a> <span class="k">def</span> <span class="nf">list</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="n">before_id</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
@@ -3806,7 +3838,58 @@
<span class="p">)</span>
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Endpoint</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div></div>
<span class="k">return</span> <span class="n">Endpoint</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
<div class="viewcode-block" id="EndpointsClient.update"><a class="viewcode-back" href="../../endpoints.html#ngrok.services.EndpointsClient.update">[docs]</a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="n">url</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">traffic_policy</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">description</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">metadata</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="n">bindings</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Endpoint</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Update an Endpoint by ID, currently available only for cloud endpoints</span>
<span class="sd"> :param id: unique endpoint resource identifier</span>
<span class="sd"> :param url: the url of the endpoint</span>
<span class="sd"> :param traffic_policy: The traffic policy attached to this endpoint</span>
<span class="sd"> :param description: user-supplied description of the associated tunnel</span>
<span class="sd"> :param metadata: user-supplied metadata of the associated tunnel or edge object</span>
<span class="sd"> :param bindings: the bindings associated with this endpoint</span>
<span class="sd"> https://ngrok.com/docs/api#api-endpoints-update</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="s2">&quot;/endpoints/</span><span class="si">{id}</span><span class="s2">&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">body_arg</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span>
<span class="n">url</span><span class="o">=</span><span class="n">url</span><span class="p">,</span>
<span class="n">traffic_policy</span><span class="o">=</span><span class="n">traffic_policy</span><span class="p">,</span>
<span class="n">description</span><span class="o">=</span><span class="n">description</span><span class="p">,</span>
<span class="n">metadata</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
<span class="n">bindings</span><span class="o">=</span><span class="n">bindings</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span>
<span class="k">return</span> <span class="n">Endpoint</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span></div>
<div class="viewcode-block" id="EndpointsClient.delete"><a class="viewcode-back" href="../../endpoints.html#ngrok.services.EndpointsClient.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span>
<span class="bp">self</span><span class="p">,</span>
<span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Delete an Endpoint by ID, currently available only for cloud endpoints</span>
<span class="sd"> :param id: a resource identifier</span>
<span class="sd"> https://ngrok.com/docs/api#api-endpoints-delete</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="s2">&quot;/endpoints/</span><span class="si">{id}</span><span class="s2">&quot;</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">path</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="nb">id</span><span class="o">=</span><span class="nb">id</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">body_arg</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_client</span><span class="o">.</span><span class="n">http_client</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">body_arg</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="EventDestinationsClient"><a class="viewcode-back" href="../../event_destinations.html#ngrok.services.EventDestinationsClient">[docs]</a><span class="k">class</span> <span class="nc">EventDestinationsClient</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
docs/datatypes.html
+181 -4
View File
@@ -1622,6 +1622,17 @@
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">ngrok.datatypes.</span></span><span class="sig-name descname"><span class="pre">Endpoint</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">props</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#Endpoint"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.Endpoint" title="Permalink to this definition">#</a></dt>
<dd><dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.bindings">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">bindings</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Sequence</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.bindings" title="Permalink to this definition">#</a></dt>
<dd><p>the bindings associated with this endpoint</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]</p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.created_at">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.created_at" title="Permalink to this definition">#</a></dt>
<dd><p>timestamp when the endpoint was created in RFC 3339 format</p>
@@ -1632,6 +1643,22 @@
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.delete">
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#Endpoint.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.Endpoint.delete" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.description">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.description" title="Permalink to this definition">#</a></dt>
<dd><p>user-supplied description of the associated tunnel</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.domain">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">domain</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><span class="pre">Ref</span></a></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.domain" title="Permalink to this definition">#</a></dt>
@@ -1654,10 +1681,20 @@
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.host">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.host" title="Permalink to this definition">#</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.hostport">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hostport</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.hostport" title="Permalink to this definition">#</a></dt>
<dd><p>hostport served by this endpoint (hostname:port)</p>
<dd><p>hostport served by this endpoint (hostname:port) -&gt; soon to be deprecated</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
@@ -1687,6 +1724,49 @@
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.name">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.name" title="Permalink to this definition">#</a></dt>
<dd><p>user supplied name for the endpoint</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.port">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">port</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.port" title="Permalink to this definition">#</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.principal">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">principal</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><span class="pre">Ref</span></a></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.principal" title="Permalink to this definition">#</a></dt>
<dd><p>The ID of the owner (bot or user) that owns this endpoint</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ref</span></code></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.principal_id">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">principal_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><span class="pre">Ref</span></a></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.principal_id" title="Permalink to this definition">#</a></dt>
<dd><p>TODO: deprecate me!</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ref</span></code></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.proto">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">proto</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.proto" title="Permalink to this definition">#</a></dt>
@@ -1720,6 +1800,16 @@
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.scheme">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">scheme</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.scheme" title="Permalink to this definition">#</a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.tcp_addr">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tcp_addr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><span class="pre">Ref</span></a></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.tcp_addr" title="Permalink to this definition">#</a></dt>
@@ -1731,6 +1821,17 @@
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.traffic_policy">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">traffic_policy</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.traffic_policy" title="Permalink to this definition">#</a></dt>
<dd><p>The traffic policy attached to this endpoint</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.tunnel">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tunnel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><span class="pre">Ref</span></a></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.tunnel" title="Permalink to this definition">#</a></dt>
@@ -1742,10 +1843,21 @@
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.tunnel_session">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tunnel_session</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><span class="pre">Ref</span></a></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.tunnel_session" title="Permalink to this definition">#</a></dt>
<dd><p>The tunnel session of the agent for this endpoint</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#ngrok.datatypes.Ref" title="ngrok.datatypes.Ref"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ref</span></code></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.type">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.type" title="Permalink to this definition">#</a></dt>
<dd><p>whether the endpoint is <code class="docutils literal notranslate"><span class="pre">ephemeral</span></code> (served directly by an agent-initiated tunnel) or <code class="docutils literal notranslate"><span class="pre">edge</span></code> (served by an edge)</p>
<dd><p>whether the endpoint is <code class="docutils literal notranslate"><span class="pre">ephemeral</span></code> (served directly by an agent-initiated tunnel) or <code class="docutils literal notranslate"><span class="pre">edge</span></code> (served by an edge) or <code class="docutils literal notranslate"><span class="pre">cloud</span> <span class="pre">(represents</span> <span class="pre">a</span> <span class="pre">cloud</span> <span class="pre">endpoint)</span></code></p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
@@ -1753,6 +1865,11 @@
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.update">
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">traffic_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bindings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/datatypes.html#Endpoint.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.datatypes.Endpoint.update" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.updated_at">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">updated_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.updated_at" title="Permalink to this definition">#</a></dt>
@@ -1764,6 +1881,50 @@
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.upstream_proto">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">upstream_proto</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.upstream_proto" title="Permalink to this definition">#</a></dt>
<dd><p>the protocol the agent uses to forward with</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.upstream_url">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">upstream_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.upstream_url" title="Permalink to this definition">#</a></dt>
<dd><p>the local address the tunnel forwards to</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.uri">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uri</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.uri" title="Permalink to this definition">#</a></dt>
<dd><p>URI of the clep API resource</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.Endpoint.url">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.Endpoint.url" title="Permalink to this definition">#</a></dt>
<dd><p>the url of the endpoint</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py class">
@@ -3774,7 +3935,7 @@
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.EventTargetAzureLogsIngestion.data_collection_stream_name">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">data_collection_stream_name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.EventTargetAzureLogsIngestion.data_collection_stream_name" title="Permalink to this definition">#</a></dt>
<dd><p>Data collection stream name to use as destination, located instide the DCR</p>
<dd><p>Data collection stream name to use as destination, located inside the DCR</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
@@ -5408,7 +5569,7 @@
<dl class="py property">
<dt class="sig sig-object py" id="ngrok.datatypes.ReservedDomainCertPolicy.private_key_type">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">private_key_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#ngrok.datatypes.ReservedDomainCertPolicy.private_key_type" title="Permalink to this definition">#</a></dt>
<dd><p>type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.</p>
<dd><p>type of private key to use when requesting certificates. Defaults to ecdsa, can be either rsa or ecdsa.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></p>
@@ -7810,19 +7971,35 @@
</ul>
</li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint"><code class="docutils literal notranslate"><span class="pre">Endpoint</span></code></a><ul>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.bindings"><code class="docutils literal notranslate"><span class="pre">Endpoint.bindings</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.created_at"><code class="docutils literal notranslate"><span class="pre">Endpoint.created_at</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.delete"><code class="docutils literal notranslate"><span class="pre">Endpoint.delete()</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.description"><code class="docutils literal notranslate"><span class="pre">Endpoint.description</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.domain"><code class="docutils literal notranslate"><span class="pre">Endpoint.domain</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.edge"><code class="docutils literal notranslate"><span class="pre">Endpoint.edge</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.host"><code class="docutils literal notranslate"><span class="pre">Endpoint.host</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.hostport"><code class="docutils literal notranslate"><span class="pre">Endpoint.hostport</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.id"><code class="docutils literal notranslate"><span class="pre">Endpoint.id</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.metadata"><code class="docutils literal notranslate"><span class="pre">Endpoint.metadata</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.name"><code class="docutils literal notranslate"><span class="pre">Endpoint.name</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.port"><code class="docutils literal notranslate"><span class="pre">Endpoint.port</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.principal"><code class="docutils literal notranslate"><span class="pre">Endpoint.principal</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.principal_id"><code class="docutils literal notranslate"><span class="pre">Endpoint.principal_id</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.proto"><code class="docutils literal notranslate"><span class="pre">Endpoint.proto</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.public_url"><code class="docutils literal notranslate"><span class="pre">Endpoint.public_url</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.region"><code class="docutils literal notranslate"><span class="pre">Endpoint.region</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.scheme"><code class="docutils literal notranslate"><span class="pre">Endpoint.scheme</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.tcp_addr"><code class="docutils literal notranslate"><span class="pre">Endpoint.tcp_addr</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.traffic_policy"><code class="docutils literal notranslate"><span class="pre">Endpoint.traffic_policy</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.tunnel"><code class="docutils literal notranslate"><span class="pre">Endpoint.tunnel</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.tunnel_session"><code class="docutils literal notranslate"><span class="pre">Endpoint.tunnel_session</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.type"><code class="docutils literal notranslate"><span class="pre">Endpoint.type</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.update"><code class="docutils literal notranslate"><span class="pre">Endpoint.update()</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.updated_at"><code class="docutils literal notranslate"><span class="pre">Endpoint.updated_at</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.upstream_proto"><code class="docutils literal notranslate"><span class="pre">Endpoint.upstream_proto</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.upstream_url"><code class="docutils literal notranslate"><span class="pre">Endpoint.upstream_url</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.uri"><code class="docutils literal notranslate"><span class="pre">Endpoint.uri</span></code></a></li>
<li><a class="reference internal" href="#ngrok.datatypes.Endpoint.url"><code class="docutils literal notranslate"><span class="pre">Endpoint.url</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#ngrok.datatypes.EndpointBackend"><code class="docutils literal notranslate"><span class="pre">EndpointBackend</span></code></a><ul>
docs/endpoints.html
+63
View File
@@ -262,6 +262,42 @@
<dd><p>Endpoints provides an API for querying the endpoint objects
which define what tunnel or edge is used to serve a hostport.
Only active endpoints associated with a tunnel or backend are returned.</p>
<dl class="py method">
<dt class="sig sig-object py" id="ngrok.services.EndpointsClient.create">
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">traffic_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bindings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EndpointsClient.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EndpointsClient.create" title="Permalink to this definition">#</a></dt>
<dd><p>Create an endpoint, currently available only for cloud endpoints</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the url of the endpoint</p></li>
<li><p><strong>type</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – whether the endpoint is <code class="docutils literal notranslate"><span class="pre">ephemeral</span></code> (served directly by an agent-initiated tunnel) or <code class="docutils literal notranslate"><span class="pre">edge</span></code> (served by an edge) or <code class="docutils literal notranslate"><span class="pre">cloud</span> <span class="pre">(represents</span> <span class="pre">a</span> <span class="pre">cloud</span> <span class="pre">endpoint)</span></code></p></li>
<li><p><strong>traffic_policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The traffic policy attached to this endpoint</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – user-supplied description of the associated tunnel</p></li>
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – user-supplied metadata of the associated tunnel or edge object</p></li>
<li><p><strong>bindings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – the bindings associated with this endpoint</p></li>
</ul>
</dd>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoints-create">https://ngrok.com/docs/api#api-endpoints-create</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint" title="ngrok.datatypes.Endpoint"><code class="xref py py-class docutils literal notranslate"><span class="pre">Endpoint</span></code></a></p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="ngrok.services.EndpointsClient.delete">
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EndpointsClient.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EndpointsClient.delete" title="Permalink to this definition">#</a></dt>
<dd><p>Delete an Endpoint by ID, currently available only for cloud endpoints</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – a resource identifier</p>
</dd>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoints-delete">https://ngrok.com/docs/api#api-endpoints-delete</a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="ngrok.services.EndpointsClient.get">
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EndpointsClient.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EndpointsClient.get" title="Permalink to this definition">#</a></dt>
@@ -299,6 +335,30 @@ Only active endpoints associated with a tunnel or backend are returned.</p>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="ngrok.services.EndpointsClient.update">
<span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">id</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">traffic_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bindings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/ngrok/services.html#EndpointsClient.update"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#ngrok.services.EndpointsClient.update" title="Permalink to this definition">#</a></dt>
<dd><p>Update an Endpoint by ID, currently available only for cloud endpoints</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>id</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – unique endpoint resource identifier</p></li>
<li><p><strong>url</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – the url of the endpoint</p></li>
<li><p><strong>traffic_policy</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – The traffic policy attached to this endpoint</p></li>
<li><p><strong>description</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – user-supplied description of the associated tunnel</p></li>
<li><p><strong>metadata</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – user-supplied metadata of the associated tunnel or edge object</p></li>
<li><p><strong>bindings</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – the bindings associated with this endpoint</p></li>
</ul>
</dd>
</dl>
<p><a class="reference external" href="https://ngrok.com/docs/api#api-endpoints-update">https://ngrok.com/docs/api#api-endpoints-update</a></p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint" title="ngrok.datatypes.Endpoint"><code class="xref py py-class docutils literal notranslate"><span class="pre">Endpoint</span></code></a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
@@ -360,8 +420,11 @@ Only active endpoints associated with a tunnel or backend are returned.</p>
<ul>
<li><a class="reference internal" href="#">Endpoints</a><ul>
<li><a class="reference internal" href="#ngrok.services.EndpointsClient"><code class="docutils literal notranslate"><span class="pre">EndpointsClient</span></code></a><ul>
<li><a class="reference internal" href="#ngrok.services.EndpointsClient.create"><code class="docutils literal notranslate"><span class="pre">EndpointsClient.create()</span></code></a></li>
<li><a class="reference internal" href="#ngrok.services.EndpointsClient.delete"><code class="docutils literal notranslate"><span class="pre">EndpointsClient.delete()</span></code></a></li>
<li><a class="reference internal" href="#ngrok.services.EndpointsClient.get"><code class="docutils literal notranslate"><span class="pre">EndpointsClient.get()</span></code></a></li>
<li><a class="reference internal" href="#ngrok.services.EndpointsClient.list"><code class="docutils literal notranslate"><span class="pre">EndpointsClient.list()</span></code></a></li>
<li><a class="reference internal" href="#ngrok.services.EndpointsClient.update"><code class="docutils literal notranslate"><span class="pre">EndpointsClient.update()</span></code></a></li>
</ul>
</li>
</ul>
docs/genindex.html
+49 -7
View File
@@ -430,6 +430,8 @@
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.bindings">bindings (ngrok.datatypes.Endpoint property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.HTTPResponseBackend.body">body (ngrok.datatypes.HTTPResponseBackend property)</a>
</li>
<li><a href="client.html#ngrok.Client.bot_users">bot_users (ngrok.Client property)</a>
@@ -588,6 +590,8 @@
<li><a href="edges_tcp.html#ngrok.services.EdgesTCPClient.create">(ngrok.services.EdgesTCPClient method)</a>
</li>
<li><a href="edges_tls.html#ngrok.services.EdgesTLSClient.create">(ngrok.services.EdgesTLSClient method)</a>
</li>
<li><a href="endpoints.html#ngrok.services.EndpointsClient.create">(ngrok.services.EndpointsClient method)</a>
</li>
<li><a href="event_destinations.html#ngrok.services.EventDestinationsClient.create">(ngrok.services.EventDestinationsClient method)</a>
</li>
@@ -740,6 +744,8 @@
<li><a href="datatypes.html#ngrok.datatypes.CertificateAuthority.delete">(ngrok.datatypes.CertificateAuthority method)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.Credential.delete">(ngrok.datatypes.Credential method)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.delete">(ngrok.datatypes.Endpoint method)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.EventDestination.delete">(ngrok.datatypes.EventDestination method)</a>
</li>
@@ -830,6 +836,8 @@
<li><a href="edges_tcp.html#ngrok.services.EdgesTCPClient.delete">(ngrok.services.EdgesTCPClient method)</a>
</li>
<li><a href="edges_tls.html#ngrok.services.EdgesTLSClient.delete">(ngrok.services.EdgesTLSClient method)</a>
</li>
<li><a href="endpoints.html#ngrok.services.EndpointsClient.delete">(ngrok.services.EndpointsClient method)</a>
</li>
<li><a href="event_destinations.html#ngrok.services.EventDestinationsClient.delete">(ngrok.services.EventDestinationsClient method)</a>
</li>
@@ -906,6 +914,8 @@
<li><a href="datatypes.html#ngrok.datatypes.CertificateAuthority.description">(ngrok.datatypes.CertificateAuthority property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.Credential.description">(ngrok.datatypes.Credential property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.description">(ngrok.datatypes.Endpoint property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.EventDestination.description">(ngrok.datatypes.EventDestination property)</a>
</li>
@@ -1417,6 +1427,8 @@
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="datatypes.html#ngrok.datatypes.HTTPResponseBackend.headers">headers (ngrok.datatypes.HTTPResponseBackend property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.host">host (ngrok.datatypes.Endpoint property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.AbuseReportHostname.hostname">hostname (ngrok.datatypes.AbuseReportHostname property)</a>
</li>
@@ -1432,10 +1444,10 @@
<li><a href="datatypes.html#ngrok.datatypes.TLSEdge.hostports">(ngrok.datatypes.TLSEdge property)</a>
</li>
</ul></li>
<li><a href="datatypes.html#ngrok.datatypes.HTTPResponseBackend">HTTPResponseBackend (class in ngrok.datatypes)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="datatypes.html#ngrok.datatypes.HTTPResponseBackend">HTTPResponseBackend (class in ngrok.datatypes)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.HTTPResponseBackendList">HTTPResponseBackendList (class in ngrok.datatypes)</a>
</li>
<li><a href="http_response_backends.html#ngrok.services.HTTPResponseBackendsClient">HTTPResponseBackendsClient (class in ngrok.services)</a>
@@ -1877,6 +1889,8 @@
<ul>
<li><a href="datatypes.html#ngrok.datatypes.BotUser.name">(ngrok.datatypes.BotUser property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.name">(ngrok.datatypes.Endpoint property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.IdentityProvider.name">(ngrok.datatypes.IdentityProvider property)</a>
</li>
@@ -2040,6 +2054,12 @@
<h2>P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.port">port (ngrok.datatypes.Endpoint property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.principal">principal (ngrok.datatypes.Endpoint property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.principal_id">principal_id (ngrok.datatypes.Endpoint property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.SSHHostCertificate.principals">principals (ngrok.datatypes.SSHHostCertificate property)</a>
<ul>
@@ -2245,6 +2265,8 @@
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="datatypes.html#ngrok.datatypes.HTTPSEdgeRoute.saml">saml (ngrok.datatypes.HTTPSEdgeRoute property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.scheme">scheme (ngrok.datatypes.Endpoint property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.EndpointOAuthAmazon.scopes">scopes (ngrok.datatypes.EndpointOAuthAmazon property)</a>
@@ -2452,17 +2474,19 @@
</li>
<li><a href="tls_edge_traffic_policy_module.html#ngrok.services.TLSEdgeTrafficPolicyModuleClient">TLSEdgeTrafficPolicyModuleClient (class in ngrok.services)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="datatypes.html#ngrok.datatypes.APIKey.token">token (ngrok.datatypes.APIKey property)</a>
<ul>
<li><a href="datatypes.html#ngrok.datatypes.Credential.token">(ngrok.datatypes.Credential property)</a>
</li>
</ul></li>
<li><a href="datatypes.html#ngrok.datatypes.HTTPSEdgeRoute.traffic_policy">traffic_policy (ngrok.datatypes.HTTPSEdgeRoute property)</a>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.traffic_policy">traffic_policy (ngrok.datatypes.Endpoint property)</a>
<ul>
<li><a href="datatypes.html#ngrok.datatypes.HTTPSEdgeRoute.traffic_policy">(ngrok.datatypes.HTTPSEdgeRoute property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.TCPEdge.traffic_policy">(ngrok.datatypes.TCPEdge property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.TLSEdge.traffic_policy">(ngrok.datatypes.TLSEdge property)</a>
@@ -2476,8 +2500,12 @@
</li>
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.tunnel">tunnel (ngrok.datatypes.Endpoint property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.Tunnel.tunnel_session">tunnel_session (ngrok.datatypes.Tunnel property)</a>
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.tunnel_session">tunnel_session (ngrok.datatypes.Endpoint property)</a>
<ul>
<li><a href="datatypes.html#ngrok.datatypes.Tunnel.tunnel_session">(ngrok.datatypes.Tunnel property)</a>
</li>
</ul></li>
<li><a href="client.html#ngrok.Client.tunnel_sessions">tunnel_sessions (ngrok.Client property)</a>
<ul>
@@ -2538,6 +2566,8 @@
<li><a href="datatypes.html#ngrok.datatypes.CertificateAuthority.update">(ngrok.datatypes.CertificateAuthority method)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.Credential.update">(ngrok.datatypes.Credential method)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.update">(ngrok.datatypes.Endpoint method)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.FailoverBackend.update">(ngrok.datatypes.FailoverBackend method)</a>
</li>
@@ -2588,6 +2618,8 @@
<li><a href="edges_tcp.html#ngrok.services.EdgesTCPClient.update">(ngrok.services.EdgesTCPClient method)</a>
</li>
<li><a href="edges_tls.html#ngrok.services.EdgesTLSClient.update">(ngrok.services.EdgesTLSClient method)</a>
</li>
<li><a href="endpoints.html#ngrok.services.EndpointsClient.update">(ngrok.services.EndpointsClient method)</a>
</li>
<li><a href="event_destinations.html#ngrok.services.EventDestinationsClient.update">(ngrok.services.EventDestinationsClient method)</a>
</li>
@@ -2629,6 +2661,10 @@
</li>
</ul></li>
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.updated_at">updated_at (ngrok.datatypes.Endpoint property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.upstream_proto">upstream_proto (ngrok.datatypes.Endpoint property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.upstream_url">upstream_url (ngrok.datatypes.Endpoint property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.AbuseReport.uri">uri (ngrok.datatypes.AbuseReport property)</a>
@@ -2660,6 +2696,8 @@
<li><a href="datatypes.html#ngrok.datatypes.Credential.uri">(ngrok.datatypes.Credential property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.CredentialList.uri">(ngrok.datatypes.CredentialList property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.uri">(ngrok.datatypes.Endpoint property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.EndpointList.uri">(ngrok.datatypes.EndpointList property)</a>
</li>
@@ -2760,8 +2798,12 @@
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="datatypes.html#ngrok.datatypes.IdentityProvider.url">url (ngrok.datatypes.IdentityProvider property)</a>
<li><a href="datatypes.html#ngrok.datatypes.Endpoint.url">url (ngrok.datatypes.Endpoint property)</a>
<ul>
<li><a href="datatypes.html#ngrok.datatypes.IdentityProvider.url">(ngrok.datatypes.IdentityProvider property)</a>
</li>
</ul></li>
<li><a href="datatypes.html#ngrok.datatypes.AbuseReport.urls">urls (ngrok.datatypes.AbuseReport property)</a>
</li>
<li><a href="datatypes.html#ngrok.datatypes.BrowserSession.user_agent">user_agent (ngrok.datatypes.BrowserSession property)</a>
docs/index.html
+19
View File
@@ -576,19 +576,35 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint"><code class="docutils literal notranslate"><span class="pre">Endpoint</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.bindings"><code class="docutils literal notranslate"><span class="pre">Endpoint.bindings</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.created_at"><code class="docutils literal notranslate"><span class="pre">Endpoint.created_at</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.delete"><code class="docutils literal notranslate"><span class="pre">Endpoint.delete()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.description"><code class="docutils literal notranslate"><span class="pre">Endpoint.description</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.domain"><code class="docutils literal notranslate"><span class="pre">Endpoint.domain</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.edge"><code class="docutils literal notranslate"><span class="pre">Endpoint.edge</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.host"><code class="docutils literal notranslate"><span class="pre">Endpoint.host</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.hostport"><code class="docutils literal notranslate"><span class="pre">Endpoint.hostport</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.id"><code class="docutils literal notranslate"><span class="pre">Endpoint.id</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.metadata"><code class="docutils literal notranslate"><span class="pre">Endpoint.metadata</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.name"><code class="docutils literal notranslate"><span class="pre">Endpoint.name</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.port"><code class="docutils literal notranslate"><span class="pre">Endpoint.port</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.principal"><code class="docutils literal notranslate"><span class="pre">Endpoint.principal</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.principal_id"><code class="docutils literal notranslate"><span class="pre">Endpoint.principal_id</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.proto"><code class="docutils literal notranslate"><span class="pre">Endpoint.proto</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.public_url"><code class="docutils literal notranslate"><span class="pre">Endpoint.public_url</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.region"><code class="docutils literal notranslate"><span class="pre">Endpoint.region</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.scheme"><code class="docutils literal notranslate"><span class="pre">Endpoint.scheme</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.tcp_addr"><code class="docutils literal notranslate"><span class="pre">Endpoint.tcp_addr</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.traffic_policy"><code class="docutils literal notranslate"><span class="pre">Endpoint.traffic_policy</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.tunnel"><code class="docutils literal notranslate"><span class="pre">Endpoint.tunnel</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.tunnel_session"><code class="docutils literal notranslate"><span class="pre">Endpoint.tunnel_session</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.type"><code class="docutils literal notranslate"><span class="pre">Endpoint.type</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.update"><code class="docutils literal notranslate"><span class="pre">Endpoint.update()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.updated_at"><code class="docutils literal notranslate"><span class="pre">Endpoint.updated_at</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.upstream_proto"><code class="docutils literal notranslate"><span class="pre">Endpoint.upstream_proto</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.upstream_url"><code class="docutils literal notranslate"><span class="pre">Endpoint.upstream_url</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.uri"><code class="docutils literal notranslate"><span class="pre">Endpoint.uri</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="datatypes.html#ngrok.datatypes.Endpoint.url"><code class="docutils literal notranslate"><span class="pre">Endpoint.url</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="datatypes.html#ngrok.datatypes.EndpointBackend"><code class="docutils literal notranslate"><span class="pre">EndpointBackend</span></code></a><ul>
@@ -1796,8 +1812,11 @@ section on <a class="reference internal" href="errors.html#errors"><span class="
</li>
<li class="toctree-l1"><a class="reference internal" href="endpoints.html">Endpoints</a><ul>
<li class="toctree-l2"><a class="reference internal" href="endpoints.html#ngrok.services.EndpointsClient"><code class="docutils literal notranslate"><span class="pre">EndpointsClient</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="endpoints.html#ngrok.services.EndpointsClient.create"><code class="docutils literal notranslate"><span class="pre">EndpointsClient.create()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="endpoints.html#ngrok.services.EndpointsClient.delete"><code class="docutils literal notranslate"><span class="pre">EndpointsClient.delete()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="endpoints.html#ngrok.services.EndpointsClient.get"><code class="docutils literal notranslate"><span class="pre">EndpointsClient.get()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="endpoints.html#ngrok.services.EndpointsClient.list"><code class="docutils literal notranslate"><span class="pre">EndpointsClient.list()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="endpoints.html#ngrok.services.EndpointsClient.update"><code class="docutils literal notranslate"><span class="pre">EndpointsClient.update()</span></code></a></li>
</ul>
</li>
</ul>
docs/objects.inv
BIN
View File
Binary file not shown.
docs/searchindex.js
+1 -1
View File
File diff suppressed because one or more lines are too long
ngrok/client.py
+6
View File
@@ -222,12 +222,15 @@ class Client(object):
"https_edge_route_oidc",
"https_edge_route_websocket_tcp_converter",
"https_edge_route_user_agent_filter",
"https_edge_route_traffic_policy",
"tcp_edge_backend",
"tcp_edge_ip_restriction",
"tcp_edge_traffic_policy",
"tls_edge_backend",
"tls_edge_ip_restriction",
"tls_edge_mutual_tls",
"tls_edge_tls_termination",
"tls_edge_traffic_policy",
],
)
return ns(
@@ -253,10 +256,13 @@ class Client(object):
https_edge_route_user_agent_filter=EdgeRouteUserAgentFilterModuleClient(
self
),
https_edge_route_traffic_policy=EdgeRouteTrafficPolicyModuleClient(self),
tcp_edge_backend=TCPEdgeBackendModuleClient(self),
tcp_edge_ip_restriction=TCPEdgeIPRestrictionModuleClient(self),
tcp_edge_traffic_policy=TCPEdgeTrafficPolicyModuleClient(self),
tls_edge_backend=TLSEdgeBackendModuleClient(self),
tls_edge_ip_restriction=TLSEdgeIPRestrictionModuleClient(self),
tls_edge_mutual_tls=TLSEdgeMutualTLSModuleClient(self),
tls_edge_tls_termination=TLSEdgeTLSTerminationModuleClient(self),
tls_edge_traffic_policy=TLSEdgeTrafficPolicyModuleClient(self),
)
ngrok/datatypes.py
+110 -4
View File
@@ -3659,6 +3659,21 @@ class Endpoint(object):
self._props["edge"] = (
Ref(client, props["edge"]) if props.get("edge") is not None else None
)
self._props["principal"] = (
Ref(client, props["principal"])
if props.get("principal") is not None
else None
)
self._props["principal_id"] = (
Ref(client, props["principal_id"])
if props.get("principal_id") is not None
else None
)
self._props["tunnel_session"] = (
Ref(client, props["tunnel_session"])
if props.get("tunnel_session") is not None
else None
)
def __eq__(self, other):
return self._props == other._props
@@ -3669,6 +3684,30 @@ class Endpoint(object):
else:
return "<Endpoint {}>".format(repr(self._props))
def update(
self,
url: str = None,
traffic_policy: str = None,
description: str = None,
metadata: str = None,
bindings: Sequence[str] = None,
):
self._client.endpoints.update(
id=self.id,
url=url,
traffic_policy=traffic_policy,
description=description,
metadata=metadata,
bindings=bindings,
)
def delete(
self,
):
self._client.endpoints.delete(
id=self.id,
)
@property
def id(self) -> str:
"""unique endpoint resource identifier"""
@@ -3699,14 +3738,26 @@ class Endpoint(object):
"""protocol served by this endpoint. one of ``http``, ``https``, ``tcp``, or ``tls``"""
return self._props["proto"]
@property
def scheme(self) -> str:
return self._props["scheme"]
@property
def hostport(self) -> str:
"""hostport served by this endpoint (hostname:port)"""
"""hostport served by this endpoint (hostname:port) -> soon to be deprecated"""
return self._props["hostport"]
@property
def host(self) -> str:
return self._props["host"]
@property
def port(self) -> int:
return self._props["port"]
@property
def type(self) -> str:
"""whether the endpoint is ``ephemeral`` (served directly by an agent-initiated tunnel) or ``edge`` (served by an edge)"""
"""whether the endpoint is ``ephemeral`` (served directly by an agent-initiated tunnel) or ``edge`` (served by an edge) or ``cloud (represents a cloud endpoint)``"""
return self._props["type"]
@property
@@ -3714,6 +3765,11 @@ class Endpoint(object):
"""user-supplied metadata of the associated tunnel or edge object"""
return self._props["metadata"]
@property
def description(self) -> str:
"""user-supplied description of the associated tunnel"""
return self._props["description"]
@property
def domain(self) -> Ref:
"""the domain reserved for this endpoint"""
@@ -3734,6 +3790,56 @@ class Endpoint(object):
"""the edge serving requests to this endpoint, if this is an edge endpoint"""
return self._props["edge"]
@property
def upstream_url(self) -> str:
"""the local address the tunnel forwards to"""
return self._props["upstream_url"]
@property
def upstream_proto(self) -> str:
"""the protocol the agent uses to forward with"""
return self._props["upstream_proto"]
@property
def url(self) -> str:
"""the url of the endpoint"""
return self._props["url"]
@property
def principal(self) -> Ref:
"""The ID of the owner (bot or user) that owns this endpoint"""
return self._props["principal"]
@property
def principal_id(self) -> Ref:
"""TODO: deprecate me!"""
return self._props["principal_id"]
@property
def traffic_policy(self) -> str:
"""The traffic policy attached to this endpoint"""
return self._props["traffic_policy"]
@property
def bindings(self) -> Sequence[str]:
"""the bindings associated with this endpoint"""
return self._props["bindings"]
@property
def tunnel_session(self) -> Ref:
"""The tunnel session of the agent for this endpoint"""
return self._props["tunnel_session"]
@property
def uri(self) -> str:
"""URI of the clep API resource"""
return self._props["uri"]
@property
def name(self) -> str:
"""user supplied name for the endpoint"""
return self._props["name"]
class EndpointList(object):
def __init__(self, client, props):
@@ -4101,7 +4207,7 @@ class EventTargetAzureLogsIngestion(object):
@property
def data_collection_stream_name(self) -> str:
"""Data collection stream name to use as destination, located instide the DCR"""
"""Data collection stream name to use as destination, located inside the DCR"""
return self._props["data_collection_stream_name"]
@@ -4933,7 +5039,7 @@ class ReservedDomainCertPolicy(object):
@property
def private_key_type(self) -> str:
"""type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa."""
"""type of private key to use when requesting certificates. Defaults to ecdsa, can be either rsa or ecdsa."""
return self._props["private_key_type"]
ngrok/services.py
+83
View File
@@ -3517,6 +3517,38 @@ class EndpointsClient(object):
def __init__(self, client):
self._client = client
def create(
self,
url: str = "",
type: str = "",
traffic_policy: str = "",
description: str = None,
metadata: str = None,
bindings: Sequence[str] = None,
) -> Endpoint:
"""Create an endpoint, currently available only for cloud endpoints
:param url: the url of the endpoint
:param type: whether the endpoint is ``ephemeral`` (served directly by an agent-initiated tunnel) or ``edge`` (served by an edge) or ``cloud (represents a cloud endpoint)``
:param traffic_policy: The traffic policy attached to this endpoint
:param description: user-supplied description of the associated tunnel
:param metadata: user-supplied metadata of the associated tunnel or edge object
:param bindings: the bindings associated with this endpoint
https://ngrok.com/docs/api#api-endpoints-create
"""
path = "/endpoints"
body_arg = dict(
url=url,
type=type,
traffic_policy=traffic_policy,
description=description,
metadata=metadata,
bindings=bindings,
)
result = self._client.http_client.post(path, body_arg)
return Endpoint(self._client, result)
def list(
self,
before_id: str = None,
@@ -3555,6 +3587,57 @@ class EndpointsClient(object):
result = self._client.http_client.get(path, body_arg)
return Endpoint(self._client, result)
def update(
self,
id: str,
url: str = None,
traffic_policy: str = None,
description: str = None,
metadata: str = None,
bindings: Sequence[str] = None,
) -> Endpoint:
"""Update an Endpoint by ID, currently available only for cloud endpoints
:param id: unique endpoint resource identifier
:param url: the url of the endpoint
:param traffic_policy: The traffic policy attached to this endpoint
:param description: user-supplied description of the associated tunnel
:param metadata: user-supplied metadata of the associated tunnel or edge object
:param bindings: the bindings associated with this endpoint
https://ngrok.com/docs/api#api-endpoints-update
"""
path = "/endpoints/{id}"
path = path.format(
id=id,
)
body_arg = dict(
url=url,
traffic_policy=traffic_policy,
description=description,
metadata=metadata,
bindings=bindings,
)
result = self._client.http_client.patch(path, body_arg)
return Endpoint(self._client, result)
def delete(
self,
id: str,
):
"""Delete an Endpoint by ID, currently available only for cloud endpoints
:param id: a resource identifier
https://ngrok.com/docs/api#api-endpoints-delete
"""
path = "/endpoints/{id}"
path = path.format(
id=id,
)
body_arg = None
self._client.http_client.delete(path, body_arg)
class EventDestinationsClient(object):
def __init__(self, client):
setup.py
+1 -1
View File
@@ -13,7 +13,7 @@ def read_file(filename):
setup(
name="ngrok-api",
version="0.12.0",
version="0.13.0",
description="ngrok HTTP API client library",
long_description=read_file("README.md"),
long_description_content_type="text/markdown",