ngrok/ngrok-api-ruby
1
0
Fork 0
mirror of https://github.com/ngrok/ngrok-api-ruby.git synced 2026-05-17 16:50:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
426eb34aab37b2cb4e4c885febff2a90f4ceae5a
ngrok-api-ruby/doc/NgrokAPI/Models.html
T
ngrok release bot fecdfa013c Update generated files
2024-07-25 21:32:21 +00:00

117 lines
19 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: NgrokAPI::Models
&mdash; 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::Models";
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 (M)</a> &raquo;
<span class='title'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span>
&raquo;
<span class="title">Models</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::Models
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/ngrokapi/models/ref.rb<span class="defines">,<br />
lib/ngrokapi/models/tunnel.rb,<br /> lib/ngrokapi/models/api_key.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/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/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/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/models/event_destination.rb,<br /> lib/ngrokapi/models/event_source_list.rb,<br /> lib/ngrokapi/models/identity_provider.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/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/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/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/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/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/models/endpoint_mutual_tls_mutate.rb,<br /> lib/ngrokapi/models/endpoint_user_agent_filter.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/models/event_target_cloudwatch_logs.rb,<br /> lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb,<br /> lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb,<br /> lib/ngrokapi/models/event_target_azure_logs_ingestion.rb</span>
</dd>
</dl>
</div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span>, <span class='object_link'><a href="Models/AWSAuth.html" title="NgrokAPI::Models::AWSAuth (class)">AWSAuth</a></span>, <span class='object_link'><a href="Models/AWSCredentials.html" title="NgrokAPI::Models::AWSCredentials (class)">AWSCredentials</a></span>, <span class='object_link'><a href="Models/AWSRole.html" title="NgrokAPI::Models::AWSRole (class)">AWSRole</a></span>, <span class='object_link'><a href="Models/AbuseReport.html" title="NgrokAPI::Models::AbuseReport (class)">AbuseReport</a></span>, <span class='object_link'><a href="Models/AbuseReportHostname.html" title="NgrokAPI::Models::AbuseReportHostname (class)">AbuseReportHostname</a></span>, <span class='object_link'><a href="Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span>, <span class='object_link'><a href="Models/AgentIngressCertJob.html" title="NgrokAPI::Models::AgentIngressCertJob (class)">AgentIngressCertJob</a></span>, <span class='object_link'><a href="Models/AgentIngressCertPolicy.html" title="NgrokAPI::Models::AgentIngressCertPolicy (class)">AgentIngressCertPolicy</a></span>, <span class='object_link'><a href="Models/AgentIngressCertStatus.html" title="NgrokAPI::Models::AgentIngressCertStatus (class)">AgentIngressCertStatus</a></span>, <span class='object_link'><a href="Models/ApplicationSession.html" title="NgrokAPI::Models::ApplicationSession (class)">ApplicationSession</a></span>, <span class='object_link'><a href="Models/ApplicationUser.html" title="NgrokAPI::Models::ApplicationUser (class)">ApplicationUser</a></span>, <span class='object_link'><a href="Models/BotUser.html" title="NgrokAPI::Models::BotUser (class)">BotUser</a></span>, <span class='object_link'><a href="Models/BrowserSession.html" title="NgrokAPI::Models::BrowserSession (class)">BrowserSession</a></span>, <span class='object_link'><a href="Models/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">CertificateAuthority</a></span>, <span class='object_link'><a href="Models/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span>, <span class='object_link'><a href="Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">Endpoint</a></span>, <span class='object_link'><a href="Models/EndpointBackend.html" title="NgrokAPI::Models::EndpointBackend (class)">EndpointBackend</a></span>, <span class='object_link'><a href="Models/EndpointBackendMutate.html" title="NgrokAPI::Models::EndpointBackendMutate (class)">EndpointBackendMutate</a></span>, <span class='object_link'><a href="Models/EndpointCircuitBreaker.html" title="NgrokAPI::Models::EndpointCircuitBreaker (class)">EndpointCircuitBreaker</a></span>, <span class='object_link'><a href="Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span>, <span class='object_link'><a href="Models/EndpointIPPolicy.html" title="NgrokAPI::Models::EndpointIPPolicy (class)">EndpointIPPolicy</a></span>, <span class='object_link'><a href="Models/EndpointIPPolicyMutate.html" title="NgrokAPI::Models::EndpointIPPolicyMutate (class)">EndpointIPPolicyMutate</a></span>, <span class='object_link'><a href="Models/EndpointMutualTLS.html" title="NgrokAPI::Models::EndpointMutualTLS (class)">EndpointMutualTLS</a></span>, <span class='object_link'><a href="Models/EndpointMutualTLSMutate.html" title="NgrokAPI::Models::EndpointMutualTLSMutate (class)">EndpointMutualTLSMutate</a></span>, <span class='object_link'><a href="Models/EndpointOAuth.html" title="NgrokAPI::Models::EndpointOAuth (class)">EndpointOAuth</a></span>, <span class='object_link'><a href="Models/EndpointOAuthAmazon.html" title="NgrokAPI::Models::EndpointOAuthAmazon (class)">EndpointOAuthAmazon</a></span>, <span class='object_link'><a href="Models/EndpointOAuthFacebook.html" title="NgrokAPI::Models::EndpointOAuthFacebook (class)">EndpointOAuthFacebook</a></span>, <span class='object_link'><a href="Models/EndpointOAuthGitHub.html" title="NgrokAPI::Models::EndpointOAuthGitHub (class)">EndpointOAuthGitHub</a></span>, <span class='object_link'><a href="Models/EndpointOAuthGitLab.html" title="NgrokAPI::Models::EndpointOAuthGitLab (class)">EndpointOAuthGitLab</a></span>, <span class='object_link'><a href="Models/EndpointOAuthGoogle.html" title="NgrokAPI::Models::EndpointOAuthGoogle (class)">EndpointOAuthGoogle</a></span>, <span class='object_link'><a href="Models/EndpointOAuthLinkedIn.html" title="NgrokAPI::Models::EndpointOAuthLinkedIn (class)">EndpointOAuthLinkedIn</a></span>, <span class='object_link'><a href="Models/EndpointOAuthMicrosoft.html" title="NgrokAPI::Models::EndpointOAuthMicrosoft (class)">EndpointOAuthMicrosoft</a></span>, <span class='object_link'><a href="Models/EndpointOAuthProvider.html" title="NgrokAPI::Models::EndpointOAuthProvider (class)">EndpointOAuthProvider</a></span>, <span class='object_link'><a href="Models/EndpointOAuthTwitch.html" title="NgrokAPI::Models::EndpointOAuthTwitch (class)">EndpointOAuthTwitch</a></span>, <span class='object_link'><a href="Models/EndpointOIDC.html" title="NgrokAPI::Models::EndpointOIDC (class)">EndpointOIDC</a></span>, <span class='object_link'><a href="Models/EndpointRequestHeaders.html" title="NgrokAPI::Models::EndpointRequestHeaders (class)">EndpointRequestHeaders</a></span>, <span class='object_link'><a href="Models/EndpointResponseHeaders.html" title="NgrokAPI::Models::EndpointResponseHeaders (class)">EndpointResponseHeaders</a></span>, <span class='object_link'><a href="Models/EndpointSAML.html" title="NgrokAPI::Models::EndpointSAML (class)">EndpointSAML</a></span>, <span class='object_link'><a href="Models/EndpointSAMLMutate.html" title="NgrokAPI::Models::EndpointSAMLMutate (class)">EndpointSAMLMutate</a></span>, <span class='object_link'><a href="Models/EndpointTLSTermination.html" title="NgrokAPI::Models::EndpointTLSTermination (class)">EndpointTLSTermination</a></span>, <span class='object_link'><a href="Models/EndpointTLSTerminationAtEdge.html" title="NgrokAPI::Models::EndpointTLSTerminationAtEdge (class)">EndpointTLSTerminationAtEdge</a></span>, <span class='object_link'><a href="Models/EndpointTrafficPolicy.html" title="NgrokAPI::Models::EndpointTrafficPolicy (class)">EndpointTrafficPolicy</a></span>, <span class='object_link'><a href="Models/EndpointUserAgentFilter.html" title="NgrokAPI::Models::EndpointUserAgentFilter (class)">EndpointUserAgentFilter</a></span>, <span class='object_link'><a href="Models/EndpointWebhookValidation.html" title="NgrokAPI::Models::EndpointWebhookValidation (class)">EndpointWebhookValidation</a></span>, <span class='object_link'><a href="Models/EndpointWebsocketTCPConverter.html" title="NgrokAPI::Models::EndpointWebsocketTCPConverter (class)">EndpointWebsocketTCPConverter</a></span>, <span class='object_link'><a href="Models/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">EventDestination</a></span>, <span class='object_link'><a href="Models/EventSource.html" title="NgrokAPI::Models::EventSource (class)">EventSource</a></span>, <span class='object_link'><a href="Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">EventSourceList</a></span>, <span class='object_link'><a href="Models/EventSourceReplace.html" title="NgrokAPI::Models::EventSourceReplace (class)">EventSourceReplace</a></span>, <span class='object_link'><a href="Models/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">EventSubscription</a></span>, <span class='object_link'><a href="Models/EventTarget.html" title="NgrokAPI::Models::EventTarget (class)">EventTarget</a></span>, <span class='object_link'><a href="Models/EventTargetAzureLogsIngestion.html" title="NgrokAPI::Models::EventTargetAzureLogsIngestion (class)">EventTargetAzureLogsIngestion</a></span>, <span class='object_link'><a href="Models/EventTargetCloudwatchLogs.html" title="NgrokAPI::Models::EventTargetCloudwatchLogs (class)">EventTargetCloudwatchLogs</a></span>, <span class='object_link'><a href="Models/EventTargetDatadog.html" title="NgrokAPI::Models::EventTargetDatadog (class)">EventTargetDatadog</a></span>, <span class='object_link'><a href="Models/EventTargetFirehose.html" title="NgrokAPI::Models::EventTargetFirehose (class)">EventTargetFirehose</a></span>, <span class='object_link'><a href="Models/EventTargetKinesis.html" title="NgrokAPI::Models::EventTargetKinesis (class)">EventTargetKinesis</a></span>, <span class='object_link'><a href="Models/FailoverBackend.html" title="NgrokAPI::Models::FailoverBackend (class)">FailoverBackend</a></span>, <span class='object_link'><a href="Models/HTTPResponseBackend.html" title="NgrokAPI::Models::HTTPResponseBackend (class)">HTTPResponseBackend</a></span>, <span class='object_link'><a href="Models/HTTPSEdge.html" title="NgrokAPI::Models::HTTPSEdge (class)">HTTPSEdge</a></span>, <span class='object_link'><a href="Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">HTTPSEdgeRoute</a></span>, <span class='object_link'><a href="Models/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">IPPolicy</a></span>, <span class='object_link'><a href="Models/IPPolicyRule.html" title="NgrokAPI::Models::IPPolicyRule (class)">IPPolicyRule</a></span>, <span class='object_link'><a href="Models/IPRestriction.html" title="NgrokAPI::Models::IPRestriction (class)">IPRestriction</a></span>, <span class='object_link'><a href="Models/IdentityProvider.html" title="NgrokAPI::Models::IdentityProvider (class)">IdentityProvider</a></span>, <span class='object_link'><a href="Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span>, <span class='object_link'><a href="Models/Location.html" title="NgrokAPI::Models::Location (class)">Location</a></span>, <span class='object_link'><a href="Models/Ref.html" title="NgrokAPI::Models::Ref (class)">Ref</a></span>, <span class='object_link'><a href="Models/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">ReservedAddr</a></span>, <span class='object_link'><a href="Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span>, <span class='object_link'><a href="Models/ReservedDomainCertJob.html" title="NgrokAPI::Models::ReservedDomainCertJob (class)">ReservedDomainCertJob</a></span>, <span class='object_link'><a href="Models/ReservedDomainCertPolicy.html" title="NgrokAPI::Models::ReservedDomainCertPolicy (class)">ReservedDomainCertPolicy</a></span>, <span class='object_link'><a href="Models/ReservedDomainCertStatus.html" title="NgrokAPI::Models::ReservedDomainCertStatus (class)">ReservedDomainCertStatus</a></span>, <span class='object_link'><a href="Models/SSHCertificateAuthority.html" title="NgrokAPI::Models::SSHCertificateAuthority (class)">SSHCertificateAuthority</a></span>, <span class='object_link'><a href="Models/SSHCredential.html" title="NgrokAPI::Models::SSHCredential (class)">SSHCredential</a></span>, <span class='object_link'><a href="Models/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">SSHHostCertificate</a></span>, <span class='object_link'><a href="Models/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">SSHUserCertificate</a></span>, <span class='object_link'><a href="Models/StaticBackend.html" title="NgrokAPI::Models::StaticBackend (class)">StaticBackend</a></span>, <span class='object_link'><a href="Models/StaticBackendTLS.html" title="NgrokAPI::Models::StaticBackendTLS (class)">StaticBackendTLS</a></span>, <span class='object_link'><a href="Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">TCPEdge</a></span>, <span class='object_link'><a href="Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span>, <span class='object_link'><a href="Models/TLSCertificateSANs.html" title="NgrokAPI::Models::TLSCertificateSANs (class)">TLSCertificateSANs</a></span>, <span class='object_link'><a href="Models/TLSEdge.html" title="NgrokAPI::Models::TLSEdge (class)">TLSEdge</a></span>, <span class='object_link'><a href="Models/Tunnel.html" title="NgrokAPI::Models::Tunnel (class)">Tunnel</a></span>, <span class='object_link'><a href="Models/TunnelGroupBackend.html" title="NgrokAPI::Models::TunnelGroupBackend (class)">TunnelGroupBackend</a></span>, <span class='object_link'><a href="Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">TunnelSession</a></span>, <span class='object_link'><a href="Models/UserAgent.html" title="NgrokAPI::Models::UserAgent (class)">UserAgent</a></span>, <span class='object_link'><a href="Models/WeightedBackend.html" title="NgrokAPI::Models::WeightedBackend (class)">WeightedBackend</a></span>
</p>
</div>
<div id="footer">
Generated on Thu Jul 25 21:32:04 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-3.3.1).
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink