-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy pathNgrokAPI.html
More file actions
157 lines (87 loc) · 11.6 KB
/
NgrokAPI.html
File metadata and controls
157 lines (87 loc) · 11.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: NgrokAPI
— Documentation by YARD 0.9.36
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" />
<link rel="stylesheet" href="css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "NgrokAPI";
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (N)</a> »
<span class="title">NgrokAPI</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: NgrokAPI
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/ngrokapi.rb<span class="defines">,<br />
lib/ngrokapi/error.rb,<br /> lib/ngrokapi/client.rb,<br /> lib/ngrokapi/version.rb,<br /> lib/ngrokapi/models/ref.rb,<br /> lib/ngrokapi/http_client.rb,<br /> lib/ngrokapi/models/vault.rb,<br /> lib/ngrokapi/models/secret.rb,<br /> lib/ngrokapi/models/tunnel.rb,<br /> lib/ngrokapi/models/api_key.rb,<br /> lib/ngrokapi/paged_iterator.rb,<br /> lib/ngrokapi/models/aws_auth.rb,<br /> lib/ngrokapi/models/aws_role.rb,<br /> lib/ngrokapi/models/bot_user.rb,<br /> lib/ngrokapi/models/endpoint.rb,<br /> lib/ngrokapi/models/listable.rb,<br /> lib/ngrokapi/models/location.rb,<br /> lib/ngrokapi/models/tcp_edge.rb,<br /> lib/ngrokapi/models/tls_edge.rb,<br /> lib/ngrokapi/models/ip_policy.rb,<br /> lib/ngrokapi/models/credential.rb,<br /> lib/ngrokapi/models/https_edge.rb,<br /> lib/ngrokapi/models/user_agent.rb,<br /> lib/ngrokapi/models/abuse_report.rb,<br /> lib/ngrokapi/models/event_source.rb,<br /> lib/ngrokapi/models/event_target.rb,<br /> lib/ngrokapi/models/service_user.rb,<br /> lib/ngrokapi/models/agent_ingress.rb,<br /> lib/ngrokapi/models/endpoint_oidc.rb,<br /> lib/ngrokapi/models/endpoint_saml.rb,<br /> lib/ngrokapi/models/reserved_addr.rb,<br /> lib/ngrokapi/models/ip_policy_rule.rb,<br /> lib/ngrokapi/models/ip_restriction.rb,<br /> lib/ngrokapi/models/ssh_credential.rb,<br /> lib/ngrokapi/models/static_backend.rb,<br /> lib/ngrokapi/models/tunnel_session.rb,<br /> lib/ngrokapi/errors/not_found_error.rb,<br /> lib/ngrokapi/models/aws_credentials.rb,<br /> lib/ngrokapi/models/browser_session.rb,<br /> lib/ngrokapi/models/endpoint_o_auth.rb,<br /> lib/ngrokapi/models/reserved_domain.rb,<br /> lib/ngrokapi/models/tls_certificate.rb,<br /> lib/ngrokapi/services/vaults_client.rb,<br /> lib/ngrokapi/models/application_user.rb,<br /> lib/ngrokapi/models/endpoint_backend.rb,<br /> lib/ngrokapi/models/failover_backend.rb,<br /> lib/ngrokapi/models/https_edge_route.rb,<br /> lib/ngrokapi/models/weighted_backend.rb,<br /> lib/ngrokapi/services/secrets_client.rb,<br /> lib/ngrokapi/services/tunnels_client.rb,<br /> lib/ngrokapi/models/event_destination.rb,<br /> lib/ngrokapi/models/event_source_list.rb,<br /> lib/ngrokapi/models/identity_provider.rb,<br /> lib/ngrokapi/services/api_keys_client.rb,<br /> lib/ngrokapi/models/endpoint_ip_policy.rb,<br /> lib/ngrokapi/models/event_subscription.rb,<br /> lib/ngrokapi/models/static_backend_tls.rb,<br /> lib/ngrokapi/services/bot_users_client.rb,<br /> lib/ngrokapi/services/edges_tcp_client.rb,<br /> lib/ngrokapi/services/edges_tls_client.rb,<br /> lib/ngrokapi/services/endpoints_client.rb,<br /> lib/ngrokapi/models/application_session.rb,<br /> lib/ngrokapi/models/endpoint_mutual_tls.rb,<br /> lib/ngrokapi/models/endpoint_compression.rb,<br /> lib/ngrokapi/models/endpoint_saml_mutate.rb,<br /> lib/ngrokapi/models/event_source_replace.rb,<br /> lib/ngrokapi/models/event_target_datadog.rb,<br /> lib/ngrokapi/models/event_target_kinesis.rb,<br /> lib/ngrokapi/models/ssh_host_certificate.rb,<br /> lib/ngrokapi/models/ssh_user_certificate.rb,<br /> lib/ngrokapi/models/tunnel_group_backend.rb,<br /> lib/ngrokapi/services/credentials_client.rb,<br /> lib/ngrokapi/services/edges_https_client.rb,<br /> lib/ngrokapi/services/ip_policies_client.rb,<br /> lib/ngrokapi/models/abuse_report_hostname.rb,<br /> lib/ngrokapi/models/certificate_authority.rb,<br /> lib/ngrokapi/models/event_target_firehose.rb,<br /> lib/ngrokapi/models/http_response_backend.rb,<br /> lib/ngrokapi/models/tls_certificate_sa_ns.rb,<br /> lib/ngrokapi/models/agent_ingress_cert_job.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_amazon.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_google.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_twitch.rb,<br /> lib/ngrokapi/services/abuse_reports_client.rb,<br /> lib/ngrokapi/services/event_sources_client.rb,<br /> lib/ngrokapi/services/service_users_client.rb,<br /> lib/ngrokapi/models/endpoint_backend_mutate.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_git_lab.rb,<br /> lib/ngrokapi/models/endpoint_traffic_policy.rb,<br /> lib/ngrokapi/services/reserved_addrs_client.rb,<br /> lib/ngrokapi/models/endpoint_circuit_breaker.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_facebook.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_provider.rb,<br /> lib/ngrokapi/models/endpoint_request_headers.rb,<br /> lib/ngrokapi/models/endpoint_tls_termination.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_job.rb,<br /> lib/ngrokapi/services/agent_ingresses_client.rb,<br /> lib/ngrokapi/services/ip_policy_rules_client.rb,<br /> lib/ngrokapi/services/ip_restrictions_client.rb,<br /> lib/ngrokapi/services/ssh_credentials_client.rb,<br /> lib/ngrokapi/services/static_backends_client.rb,<br /> lib/ngrokapi/services/tunnel_sessions_client.rb,<br /> lib/ngrokapi/models/agent_ingress_cert_policy.rb,<br /> lib/ngrokapi/models/agent_ingress_cert_status.rb,<br /> lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_linked_in.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,<br /> lib/ngrokapi/models/endpoint_response_headers.rb,<br /> lib/ngrokapi/models/ssh_certificate_authority.rb,<br /> lib/ngrokapi/services/reserved_domains_client.rb,<br /> lib/ngrokapi/services/tls_certificates_client.rb,<br /> lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,<br /> lib/ngrokapi/models/endpoint_user_agent_filter.rb,<br /> lib/ngrokapi/services/application_users_client.rb,<br /> lib/ngrokapi/services/failover_backends_client.rb,<br /> lib/ngrokapi/services/weighted_backends_client.rb,<br /> lib/ngrokapi/models/endpoint_webhook_validation.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_policy.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_status.rb,<br /> lib/ngrokapi/services/edges_https_routes_client.rb,<br /> lib/ngrokapi/services/event_destinations_client.rb,<br /> lib/ngrokapi/models/event_target_cloudwatch_logs.rb,<br /> lib/ngrokapi/services/event_subscriptions_client.rb,<br /> lib/ngrokapi/services/application_sessions_client.rb,<br /> lib/ngrokapi/services/ssh_host_certificates_client.rb,<br /> lib/ngrokapi/services/ssh_user_certificates_client.rb,<br /> lib/ngrokapi/services/tunnel_group_backends_client.rb,<br /> lib/ngrokapi/services/edge_route_oidc_module_client.rb,<br /> lib/ngrokapi/services/edge_route_saml_module_client.rb,<br /> lib/ngrokapi/services/http_response_backends_client.rb,<br /> lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb,<br /> lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb,<br /> lib/ngrokapi/services/certificate_authorities_client.rb,<br /> lib/ngrokapi/services/tcp_edge_backend_module_client.rb,<br /> lib/ngrokapi/services/tls_edge_backend_module_client.rb,<br /> lib/ngrokapi/models/event_target_azure_logs_ingestion.rb,<br /> lib/ngrokapi/services/edge_route_o_auth_module_client.rb,<br /> lib/ngrokapi/services/edge_route_backend_module_client.rb,<br /> lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb,<br /> lib/ngrokapi/services/ssh_certificate_authorities_client.rb,<br /> lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb,<br /> lib/ngrokapi/services/edge_route_compression_module_client.rb,<br /> lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb,<br /> lib/ngrokapi/services/tcp_edge_traffic_policy_module_client.rb,<br /> lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb,<br /> lib/ngrokapi/services/tls_edge_traffic_policy_module_client.rb,<br /> lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb,<br /> lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb,<br /> lib/ngrokapi/services/edge_route_traffic_policy_module_client.rb,<br /> lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb,<br /> lib/ngrokapi/services/edge_route_request_headers_module_client.rb,<br /> lib/ngrokapi/services/https_edge_tls_termination_module_client.rb,<br /> lib/ngrokapi/services/edge_route_response_headers_module_client.rb,<br /> lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb,<br /> lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb,<br /> lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb</span>
</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Code generated for API Clients. DO NOT EDIT.</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <span class='object_link'><a href="NgrokAPI/Errors.html" title="NgrokAPI::Errors (module)">Errors</a></span>, <span class='object_link'><a href="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span>, <span class='object_link'><a href="NgrokAPI/Services.html" title="NgrokAPI::Services (module)">Services</a></span>
<strong class="classes">Classes:</strong> <span class='object_link'><a href="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span>, <span class='object_link'><a href="NgrokAPI/Error.html" title="NgrokAPI::Error (class)">Error</a></span>, <span class='object_link'><a href="NgrokAPI/HttpClient.html" title="NgrokAPI::HttpClient (class)">HttpClient</a></span>, <span class='object_link'><a href="NgrokAPI/PagedIterator.html" title="NgrokAPI::PagedIterator (class)">PagedIterator</a></span>
</p>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="VERSION-constant" class="">VERSION =
<div class="docstring">
<div class="discussion">
<p>The current version of the gem</p>
</div>
</div>
<div class="tags">
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>0.24.0</span><span class='tstring_end'>"</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
</dl>
</div>
<div id="footer">
Generated on Tue Dec 16 17:22:57 2025 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-3.3.10).
</div>
</div>
</body>
</html>