ngrok-api 0.21.0 → 0.23.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/Gemfile +1 -1
- data/doc/NgrokAPI/Client.html +166 -110
- data/doc/NgrokAPI/Error.html +3 -3
- data/doc/NgrokAPI/Errors/NotFoundError.html +3 -3
- data/doc/NgrokAPI/Errors.html +3 -3
- data/doc/NgrokAPI/HttpClient.html +4 -4
- data/doc/NgrokAPI/Models/APIKey.html +3 -3
- data/doc/NgrokAPI/Models/AWSAuth.html +3 -3
- data/doc/NgrokAPI/Models/AWSCredentials.html +3 -3
- data/doc/NgrokAPI/Models/AWSRole.html +3 -3
- data/doc/NgrokAPI/Models/AbuseReport.html +3 -3
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +3 -3
- data/doc/NgrokAPI/Models/AgentIngress.html +3 -3
- data/doc/NgrokAPI/Models/AgentIngressCertJob.html +3 -3
- data/doc/NgrokAPI/Models/AgentIngressCertPolicy.html +3 -3
- data/doc/NgrokAPI/Models/AgentIngressCertStatus.html +3 -3
- data/doc/NgrokAPI/Models/ApplicationSession.html +3 -3
- data/doc/NgrokAPI/Models/ApplicationUser.html +3 -3
- data/doc/NgrokAPI/Models/BotUser.html +1051 -0
- data/doc/NgrokAPI/Models/BrowserSession.html +3 -3
- data/doc/NgrokAPI/Models/CertificateAuthority.html +3 -3
- data/doc/NgrokAPI/Models/Credential.html +3 -3
- data/doc/NgrokAPI/Models/Endpoint.html +3 -3
- data/doc/NgrokAPI/Models/EndpointAction.html +669 -0
- data/doc/NgrokAPI/Models/EndpointBackend.html +3 -3
- data/doc/NgrokAPI/Models/EndpointBackendMutate.html +3 -3
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +3 -3
- data/doc/NgrokAPI/Models/EndpointCompression.html +3 -3
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +3 -3
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +3 -3
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +3 -3
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuth.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthAmazon.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthGitLab.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthTwitch.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOIDC.html +3 -3
- data/doc/NgrokAPI/Models/EndpointPolicy.html +743 -0
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +3 -3
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +3 -3
- data/doc/NgrokAPI/Models/EndpointRule.html +743 -0
- data/doc/NgrokAPI/Models/EndpointSAML.html +18 -96
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +18 -96
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +3 -3
- data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +3 -3
- data/doc/NgrokAPI/Models/EndpointTrafficPolicy.html +669 -0
- data/doc/NgrokAPI/Models/EndpointUserAgentFilter.html +743 -0
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +3 -3
- data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +3 -3
- data/doc/NgrokAPI/Models/EventDestination.html +3 -3
- data/doc/NgrokAPI/Models/EventSource.html +19 -167
- data/doc/NgrokAPI/Models/EventSourceList.html +3 -3
- data/doc/NgrokAPI/Models/EventSourceReplace.html +19 -167
- data/doc/NgrokAPI/Models/EventSubscription.html +3 -3
- data/doc/NgrokAPI/Models/EventTarget.html +32 -32
- data/doc/NgrokAPI/Models/EventTargetAzureLogsIngestion.html +965 -0
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +3 -3
- data/doc/NgrokAPI/Models/EventTargetDatadog.html +3 -3
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +3 -3
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +3 -3
- data/doc/NgrokAPI/Models/FailoverBackend.html +3 -3
- data/doc/NgrokAPI/Models/HTTPResponseBackend.html +3 -3
- data/doc/NgrokAPI/Models/HTTPSEdge.html +3 -3
- data/doc/NgrokAPI/Models/HTTPSEdgeRoute.html +197 -37
- data/doc/NgrokAPI/Models/IPPolicy.html +27 -101
- data/doc/NgrokAPI/Models/IPPolicyRule.html +3 -3
- data/doc/NgrokAPI/Models/IPRestriction.html +3 -3
- data/doc/NgrokAPI/Models/IdentityProvider.html +3 -3
- data/doc/NgrokAPI/Models/Listable.html +3 -3
- data/doc/NgrokAPI/Models/Location.html +3 -3
- data/doc/NgrokAPI/Models/Ref.html +3 -3
- data/doc/NgrokAPI/Models/ReservedAddr.html +22 -96
- data/doc/NgrokAPI/Models/ReservedDomain.html +25 -173
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +3 -3
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +3 -3
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +3 -3
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +3 -3
- data/doc/NgrokAPI/Models/SSHCredential.html +3 -3
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +3 -3
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +3 -3
- data/doc/NgrokAPI/Models/StaticBackend.html +1211 -0
- data/doc/NgrokAPI/Models/StaticBackendTLS.html +595 -0
- data/doc/NgrokAPI/Models/TCPEdge.html +112 -32
- data/doc/NgrokAPI/Models/TLSCertificate.html +3 -3
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +3 -3
- data/doc/NgrokAPI/Models/TLSEdge.html +112 -32
- data/doc/NgrokAPI/Models/Tunnel.html +3 -3
- data/doc/NgrokAPI/Models/TunnelGroupBackend.html +3 -3
- data/doc/NgrokAPI/Models/TunnelSession.html +3 -3
- data/doc/NgrokAPI/Models/UserAgent.html +3 -3
- data/doc/NgrokAPI/Models/WeightedBackend.html +3 -3
- data/doc/NgrokAPI/Models.html +5 -5
- data/doc/NgrokAPI/PagedIterator.html +3 -3
- data/doc/NgrokAPI/Services/APIKeysClient.html +4 -4
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +4 -4
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +3 -3
- data/doc/NgrokAPI/Services/ApplicationSessionsClient.html +3 -3
- data/doc/NgrokAPI/Services/ApplicationUsersClient.html +3 -3
- data/doc/NgrokAPI/Services/BotUsersClient.html +1717 -0
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +4 -4
- data/doc/NgrokAPI/Services/CredentialsClient.html +10 -10
- data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgeRoutePolicyModuleClient.html +1149 -0
- data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgeRouteTrafficPolicyModuleClient.html +1149 -0
- data/doc/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html +1149 -0
- data/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgesHTTPSClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +233 -93
- data/doc/NgrokAPI/Services/EdgesTCPClient.html +159 -79
- data/doc/NgrokAPI/Services/EdgesTLSClient.html +159 -79
- data/doc/NgrokAPI/Services/EndpointsClient.html +4 -4
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +3 -3
- data/doc/NgrokAPI/Services/EventSourcesClient.html +3 -3
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +7 -7
- data/doc/NgrokAPI/Services/FailoverBackendsClient.html +4 -4
- data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +3 -3
- data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +4 -4
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +4 -4
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +4 -4
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +4 -4
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +18 -18
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +4 -4
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +6 -6
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +4 -4
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +8 -8
- data/doc/NgrokAPI/Services/StaticBackendsClient.html +1879 -0
- data/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/TCPEdgePolicyModuleClient.html +1039 -0
- data/doc/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html +1039 -0
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +8 -8
- data/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/TLSEdgePolicyModuleClient.html +1039 -0
- data/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html +1039 -0
- data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +4 -4
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +6 -6
- data/doc/NgrokAPI/Services/TunnelsClient.html +4 -4
- data/doc/NgrokAPI/Services/WeightedBackendsClient.html +4 -4
- data/doc/NgrokAPI/Services.html +5 -5
- data/doc/NgrokAPI.html +4 -4
- data/doc/_index.html +88 -4
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +3 -3
- data/doc/frames.html +10 -5
- data/doc/index.html +3 -3
- data/doc/method_list.html +1752 -832
- data/doc/top-level-namespace.html +3 -3
- data/docs/NgrokAPI/Client.html +166 -110
- data/docs/NgrokAPI/Error.html +3 -3
- data/docs/NgrokAPI/Errors/NotFoundError.html +3 -3
- data/docs/NgrokAPI/Errors.html +3 -3
- data/docs/NgrokAPI/HttpClient.html +4 -4
- data/docs/NgrokAPI/Models/APIKey.html +3 -3
- data/docs/NgrokAPI/Models/AWSAuth.html +3 -3
- data/docs/NgrokAPI/Models/AWSCredentials.html +3 -3
- data/docs/NgrokAPI/Models/AWSRole.html +3 -3
- data/docs/NgrokAPI/Models/AbuseReport.html +3 -3
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +3 -3
- data/docs/NgrokAPI/Models/AgentIngress.html +3 -3
- data/docs/NgrokAPI/Models/AgentIngressCertJob.html +3 -3
- data/docs/NgrokAPI/Models/AgentIngressCertPolicy.html +3 -3
- data/docs/NgrokAPI/Models/AgentIngressCertStatus.html +3 -3
- data/docs/NgrokAPI/Models/ApplicationSession.html +3 -3
- data/docs/NgrokAPI/Models/ApplicationUser.html +3 -3
- data/docs/NgrokAPI/Models/BotUser.html +1051 -0
- data/docs/NgrokAPI/Models/BrowserSession.html +3 -3
- data/docs/NgrokAPI/Models/CertificateAuthority.html +3 -3
- data/docs/NgrokAPI/Models/Credential.html +3 -3
- data/docs/NgrokAPI/Models/Endpoint.html +3 -3
- data/docs/NgrokAPI/Models/EndpointAction.html +669 -0
- data/docs/NgrokAPI/Models/EndpointBackend.html +3 -3
- data/docs/NgrokAPI/Models/EndpointBackendMutate.html +3 -3
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +3 -3
- data/docs/NgrokAPI/Models/EndpointCompression.html +3 -3
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +3 -3
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +3 -3
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +3 -3
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuth.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthAmazon.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthGitLab.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthTwitch.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOIDC.html +3 -3
- data/docs/NgrokAPI/Models/EndpointPolicy.html +743 -0
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +3 -3
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +3 -3
- data/docs/NgrokAPI/Models/EndpointRule.html +743 -0
- data/docs/NgrokAPI/Models/EndpointSAML.html +18 -96
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +18 -96
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +3 -3
- data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +3 -3
- data/docs/NgrokAPI/Models/EndpointTrafficPolicy.html +669 -0
- data/docs/NgrokAPI/Models/EndpointUserAgentFilter.html +743 -0
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +3 -3
- data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +3 -3
- data/docs/NgrokAPI/Models/EventDestination.html +3 -3
- data/docs/NgrokAPI/Models/EventSource.html +19 -167
- data/docs/NgrokAPI/Models/EventSourceList.html +3 -3
- data/docs/NgrokAPI/Models/EventSourceReplace.html +19 -167
- data/docs/NgrokAPI/Models/EventSubscription.html +3 -3
- data/docs/NgrokAPI/Models/EventTarget.html +32 -32
- data/docs/NgrokAPI/Models/EventTargetAzureLogsIngestion.html +965 -0
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +3 -3
- data/docs/NgrokAPI/Models/EventTargetDatadog.html +3 -3
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +3 -3
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +3 -3
- data/docs/NgrokAPI/Models/FailoverBackend.html +3 -3
- data/docs/NgrokAPI/Models/HTTPResponseBackend.html +3 -3
- data/docs/NgrokAPI/Models/HTTPSEdge.html +3 -3
- data/docs/NgrokAPI/Models/HTTPSEdgeRoute.html +197 -37
- data/docs/NgrokAPI/Models/IPPolicy.html +27 -101
- data/docs/NgrokAPI/Models/IPPolicyRule.html +3 -3
- data/docs/NgrokAPI/Models/IPRestriction.html +3 -3
- data/docs/NgrokAPI/Models/IdentityProvider.html +3 -3
- data/docs/NgrokAPI/Models/Listable.html +3 -3
- data/docs/NgrokAPI/Models/Location.html +3 -3
- data/docs/NgrokAPI/Models/Ref.html +3 -3
- data/docs/NgrokAPI/Models/ReservedAddr.html +22 -96
- data/docs/NgrokAPI/Models/ReservedDomain.html +25 -173
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +3 -3
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +3 -3
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +3 -3
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +3 -3
- data/docs/NgrokAPI/Models/SSHCredential.html +3 -3
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +3 -3
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +3 -3
- data/docs/NgrokAPI/Models/StaticBackend.html +1211 -0
- data/docs/NgrokAPI/Models/StaticBackendTLS.html +595 -0
- data/docs/NgrokAPI/Models/TCPEdge.html +112 -32
- data/docs/NgrokAPI/Models/TLSCertificate.html +3 -3
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +3 -3
- data/docs/NgrokAPI/Models/TLSEdge.html +112 -32
- data/docs/NgrokAPI/Models/Tunnel.html +3 -3
- data/docs/NgrokAPI/Models/TunnelGroupBackend.html +3 -3
- data/docs/NgrokAPI/Models/TunnelSession.html +3 -3
- data/docs/NgrokAPI/Models/UserAgent.html +3 -3
- data/docs/NgrokAPI/Models/WeightedBackend.html +3 -3
- data/docs/NgrokAPI/Models.html +5 -5
- data/docs/NgrokAPI/PagedIterator.html +3 -3
- data/docs/NgrokAPI/Services/APIKeysClient.html +4 -4
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +4 -4
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +3 -3
- data/docs/NgrokAPI/Services/ApplicationSessionsClient.html +3 -3
- data/docs/NgrokAPI/Services/ApplicationUsersClient.html +3 -3
- data/docs/NgrokAPI/Services/BotUsersClient.html +1717 -0
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +4 -4
- data/docs/NgrokAPI/Services/CredentialsClient.html +10 -10
- data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgeRoutePolicyModuleClient.html +1149 -0
- data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgeRouteTrafficPolicyModuleClient.html +1149 -0
- data/docs/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html +1149 -0
- data/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgesHTTPSClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +233 -93
- data/docs/NgrokAPI/Services/EdgesTCPClient.html +159 -79
- data/docs/NgrokAPI/Services/EdgesTLSClient.html +159 -79
- data/docs/NgrokAPI/Services/EndpointsClient.html +4 -4
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +3 -3
- data/docs/NgrokAPI/Services/EventSourcesClient.html +3 -3
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +7 -7
- data/docs/NgrokAPI/Services/FailoverBackendsClient.html +4 -4
- data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +3 -3
- data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +4 -4
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +4 -4
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +4 -4
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +4 -4
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +18 -18
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +4 -4
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +6 -6
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +4 -4
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +8 -8
- data/docs/NgrokAPI/Services/StaticBackendsClient.html +1879 -0
- data/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/TCPEdgePolicyModuleClient.html +1039 -0
- data/docs/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html +1039 -0
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +8 -8
- data/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/TLSEdgePolicyModuleClient.html +1039 -0
- data/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html +1039 -0
- data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +4 -4
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +6 -6
- data/docs/NgrokAPI/Services/TunnelsClient.html +4 -4
- data/docs/NgrokAPI/Services/WeightedBackendsClient.html +4 -4
- data/docs/NgrokAPI/Services.html +5 -5
- data/docs/NgrokAPI.html +4 -4
- data/docs/_index.html +88 -4
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +3 -3
- data/docs/frames.html +10 -5
- data/docs/index.html +3 -3
- data/docs/method_list.html +1752 -832
- data/docs/top-level-namespace.html +3 -3
- data/lib/ngrokapi/client.rb +6 -0
- data/lib/ngrokapi/models/bot_user.rb +70 -0
- data/lib/ngrokapi/models/endpoint_saml.rb +0 -4
- data/lib/ngrokapi/models/endpoint_saml_mutate.rb +0 -4
- data/lib/ngrokapi/models/endpoint_traffic_policy.rb +33 -0
- data/lib/ngrokapi/models/endpoint_user_agent_filter.rb +35 -0
- data/lib/ngrokapi/models/event_source.rb +0 -4
- data/lib/ngrokapi/models/event_source_replace.rb +1 -5
- data/lib/ngrokapi/models/event_target.rb +3 -3
- data/lib/ngrokapi/models/event_target_azure_logs_ingestion.rb +41 -0
- data/lib/ngrokapi/models/https_edge_route.rb +13 -3
- data/lib/ngrokapi/models/ip_policy.rb +1 -3
- data/lib/ngrokapi/models/reserved_addr.rb +1 -3
- data/lib/ngrokapi/models/reserved_domain.rb +0 -4
- data/lib/ngrokapi/models/static_backend.rb +80 -0
- data/lib/ngrokapi/models/static_backend_tls.rb +31 -0
- data/lib/ngrokapi/models/tcp_edge.rb +8 -3
- data/lib/ngrokapi/models/tls_edge.rb +8 -3
- data/lib/ngrokapi/services/bot_users_client.rb +223 -0
- data/lib/ngrokapi/services/credentials_client.rb +2 -2
- data/lib/ngrokapi/services/edge_route_traffic_policy_module_client.rb +120 -0
- data/lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb +120 -0
- data/lib/ngrokapi/services/edges_https_routes_client.rb +20 -4
- data/lib/ngrokapi/services/edges_tcp_client.rb +12 -4
- data/lib/ngrokapi/services/edges_tls_client.rb +12 -4
- data/lib/ngrokapi/services/reserved_domains_client.rb +6 -6
- data/lib/ngrokapi/services/static_backends_client.rb +242 -0
- data/lib/ngrokapi/services/tcp_edge_traffic_policy_module_client.rb +108 -0
- data/lib/ngrokapi/services/tls_edge_traffic_policy_module_client.rb +108 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/spec/ngrokapi/client_spec.rb +8 -0
- data/spec/ngrokapi/models/bot_user_spec.rb +44 -0
- data/spec/ngrokapi/models/endpoint_traffic_policy_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_user_agent_filter_spec.rb +23 -0
- data/spec/ngrokapi/models/event_target_azure_logs_ingestion_spec.rb +23 -0
- data/spec/ngrokapi/models/https_edge_route_spec.rb +7 -1
- data/spec/ngrokapi/models/static_backend_spec.rb +50 -0
- data/spec/ngrokapi/models/static_backend_tls_spec.rb +23 -0
- data/spec/ngrokapi/models/tcp_edge_spec.rb +4 -1
- data/spec/ngrokapi/models/tls_edge_spec.rb +4 -1
- data/spec/ngrokapi/services/bot_users_client_spec.rb +178 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +4 -2
- data/spec/ngrokapi/services/edge_route_traffic_policy_module_client_spec.rb +139 -0
- data/spec/ngrokapi/services/edge_route_user_agent_filter_module_client_spec.rb +139 -0
- data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +24 -4
- data/spec/ngrokapi/services/edges_tcp_client_spec.rb +16 -4
- data/spec/ngrokapi/services/edges_tls_client_spec.rb +16 -4
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +8 -4
- data/spec/ngrokapi/services/static_backends_client_spec.rb +194 -0
- data/spec/ngrokapi/services/tcp_edge_traffic_policy_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/tls_edge_traffic_policy_module_client_spec.rb +125 -0
- data/spec/spec_helper.rb +59 -0
- metadata +62 -2
data/docs/NgrokAPI/Client.html
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Class: NgrokAPI::Client
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.36
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -102,7 +102,7 @@
|
|
102
102
|
<h2>Overview</h2><div class="docstring">
|
103
103
|
<div class="discussion">
|
104
104
|
|
105
|
-
<p>Low-level api client for communicating with Ngrok
|
105
|
+
<p>Low-level api client for communicating with Ngrok’s HTTP API. Use this object to instantiate your clients.</p>
|
106
106
|
|
107
107
|
|
108
108
|
</div>
|
@@ -143,7 +143,7 @@
|
|
143
143
|
|
144
144
|
|
145
145
|
<span class="summary_desc"><div class='inline'>
|
146
|
-
<p>Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok
|
146
|
+
<p>Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok’s terms of service.</p>
|
147
147
|
</div></span>
|
148
148
|
|
149
149
|
</li>
|
@@ -256,6 +256,28 @@
|
|
256
256
|
|
257
257
|
|
258
258
|
|
259
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
260
|
+
|
261
|
+
</li>
|
262
|
+
|
263
|
+
|
264
|
+
<li class="public ">
|
265
|
+
<span class="summary_signature">
|
266
|
+
|
267
|
+
<a href="#bot_users-instance_method" title="#bot_users (instance method)">#<strong>bot_users</strong> ⇒ Object </a>
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
</span>
|
272
|
+
|
273
|
+
|
274
|
+
|
275
|
+
|
276
|
+
|
277
|
+
|
278
|
+
|
279
|
+
|
280
|
+
|
259
281
|
<span class="summary_desc"><div class='inline'></div></span>
|
260
282
|
|
261
283
|
</li>
|
@@ -823,7 +845,7 @@
|
|
823
845
|
</h3><div class="docstring">
|
824
846
|
<div class="discussion">
|
825
847
|
|
826
|
-
<p>Abuse Reports allow you to submit take-down requests for URLs hosted by
|
848
|
+
<p>Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok’s terms of service.</p>
|
827
849
|
|
828
850
|
|
829
851
|
</div>
|
@@ -907,7 +929,7 @@
|
|
907
929
|
</h3><div class="docstring">
|
908
930
|
<div class="discussion">
|
909
931
|
|
910
|
-
<p>API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">ngrok API</a>. You may use the API itself
|
932
|
+
<p>API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">ngrok API</a>. You may use the API itself to provision and manage API Keys but you’ll need to provision your first API key from the <a href="https://dashboard.ngrok.com/api/keys">API Keys page</a> on your ngrok.com dashboard.</p>
|
911
933
|
|
912
934
|
|
913
935
|
</div>
|
@@ -1024,23 +1046,25 @@
|
|
1024
1046
|
<pre class="lines">
|
1025
1047
|
|
1026
1048
|
|
1027
|
-
217
|
1028
|
-
218
|
1029
|
-
219
|
1030
|
-
220
|
1031
1049
|
221
|
1032
1050
|
222
|
1033
1051
|
223
|
1034
1052
|
224
|
1035
|
-
225
|
1053
|
+
225
|
1054
|
+
226
|
1055
|
+
227
|
1056
|
+
228
|
1057
|
+
229
|
1058
|
+
230</pre>
|
1036
1059
|
</td>
|
1037
1060
|
<td>
|
1038
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1061
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 221</span>
|
1039
1062
|
|
1040
1063
|
<span class='kw'>def</span> <span class='id identifier rubyid_backends'>backends</span>
|
1041
1064
|
<span class='id identifier rubyid_ns'>ns</span> <span class='op'>=</span> <span class='const'>OpenStruct</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
1042
1065
|
<span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_failover'>failover</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/FailoverBackendsClient.html" title="NgrokAPI::Services::FailoverBackendsClient (class)">FailoverBackendsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/FailoverBackendsClient.html#initialize-instance_method" title="NgrokAPI::Services::FailoverBackendsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1043
1066
|
<span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_http_response'>http_response</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/HTTPResponseBackendsClient.html" title="NgrokAPI::Services::HTTPResponseBackendsClient (class)">HTTPResponseBackendsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/HTTPResponseBackendsClient.html#initialize-instance_method" title="NgrokAPI::Services::HTTPResponseBackendsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1067
|
+
<span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_static_address'>static_address</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/StaticBackendsClient.html" title="NgrokAPI::Services::StaticBackendsClient (class)">StaticBackendsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/StaticBackendsClient.html#initialize-instance_method" title="NgrokAPI::Services::StaticBackendsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1044
1068
|
<span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_tunnel_group'>tunnel_group</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TunnelGroupBackendsClient.html" title="NgrokAPI::Services::TunnelGroupBackendsClient (class)">TunnelGroupBackendsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TunnelGroupBackendsClient.html#initialize-instance_method" title="NgrokAPI::Services::TunnelGroupBackendsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1045
1069
|
<span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_weighted'>weighted</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/WeightedBackendsClient.html" title="NgrokAPI::Services::WeightedBackendsClient (class)">WeightedBackendsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/WeightedBackendsClient.html#initialize-instance_method" title="NgrokAPI::Services::WeightedBackendsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1046
1070
|
|
@@ -1049,6 +1073,36 @@
|
|
1049
1073
|
</td>
|
1050
1074
|
</tr>
|
1051
1075
|
</table>
|
1076
|
+
</div>
|
1077
|
+
|
1078
|
+
<div class="method_details ">
|
1079
|
+
<h3 class="signature " id="bot_users-instance_method">
|
1080
|
+
|
1081
|
+
#<strong>bot_users</strong> ⇒ <tt>Object</tt>
|
1082
|
+
|
1083
|
+
|
1084
|
+
|
1085
|
+
|
1086
|
+
|
1087
|
+
</h3><table class="source_code">
|
1088
|
+
<tr>
|
1089
|
+
<td>
|
1090
|
+
<pre class="lines">
|
1091
|
+
|
1092
|
+
|
1093
|
+
59
|
1094
|
+
60
|
1095
|
+
61</pre>
|
1096
|
+
</td>
|
1097
|
+
<td>
|
1098
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 59</span>
|
1099
|
+
|
1100
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_bot_users'>bot_users</span>
|
1101
|
+
<span class='ivar'>@_bot_users</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/BotUsersClient.html" title="NgrokAPI::Services::BotUsersClient (class)">BotUsersClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/BotUsersClient.html#initialize-instance_method" title="NgrokAPI::Services::BotUsersClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1102
|
+
<span class='kw'>end</span></pre>
|
1103
|
+
</td>
|
1104
|
+
</tr>
|
1105
|
+
</table>
|
1052
1106
|
</div>
|
1053
1107
|
|
1054
1108
|
<div class="method_details ">
|
@@ -1063,7 +1117,7 @@
|
|
1063
1117
|
</h3><div class="docstring">
|
1064
1118
|
<div class="discussion">
|
1065
1119
|
|
1066
|
-
<p>Certificate Authorities are x509 certificates that are used to sign other
|
1120
|
+
<p>Certificate Authorities are x509 certificates that are used to sign other x509 certificates. Attach a Certificate Authority to the Mutual TLS module to verify that the TLS certificate presented by a client has been signed by this CA. Certificate Authorities are used only for mTLS validation only and thus a private key is not included in the resource.</p>
|
1067
1121
|
|
1068
1122
|
|
1069
1123
|
</div>
|
@@ -1090,12 +1144,12 @@
|
|
1090
1144
|
<pre class="lines">
|
1091
1145
|
|
1092
1146
|
|
1093
|
-
|
1094
|
-
|
1095
|
-
|
1147
|
+
71
|
1148
|
+
72
|
1149
|
+
73</pre>
|
1096
1150
|
</td>
|
1097
1151
|
<td>
|
1098
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1152
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 71</span>
|
1099
1153
|
|
1100
1154
|
<span class='kw'>def</span> <span class='id identifier rubyid_certificate_authorities'>certificate_authorities</span>
|
1101
1155
|
<span class='ivar'>@_certificate_authorities</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/CertificateAuthoritiesClient.html" title="NgrokAPI::Services::CertificateAuthoritiesClient (class)">CertificateAuthoritiesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/CertificateAuthoritiesClient.html#initialize-instance_method" title="NgrokAPI::Services::CertificateAuthoritiesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
@@ -1117,7 +1171,7 @@
|
|
1117
1171
|
</h3><div class="docstring">
|
1118
1172
|
<div class="discussion">
|
1119
1173
|
|
1120
|
-
<p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
|
1174
|
+
<p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok agent to connect the ngrok service as your account. They are installed with the <code>ngrok config add-authtoken</code> command or by specifying it in the <code>ngrok.yml</code> configuration file with the <code>authtoken</code> property.</p>
|
1121
1175
|
|
1122
1176
|
|
1123
1177
|
</div>
|
@@ -1144,12 +1198,12 @@
|
|
1144
1198
|
<pre class="lines">
|
1145
1199
|
|
1146
1200
|
|
1147
|
-
|
1148
|
-
|
1149
|
-
|
1201
|
+
82
|
1202
|
+
83
|
1203
|
+
84</pre>
|
1150
1204
|
</td>
|
1151
1205
|
<td>
|
1152
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1206
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 82</span>
|
1153
1207
|
|
1154
1208
|
<span class='kw'>def</span> <span class='id identifier rubyid_credentials'>credentials</span>
|
1155
1209
|
<span class='ivar'>@_credentials</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/CredentialsClient.html" title="NgrokAPI::Services::CredentialsClient (class)">CredentialsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/CredentialsClient.html#initialize-instance_method" title="NgrokAPI::Services::CredentialsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
@@ -1174,11 +1228,6 @@
|
|
1174
1228
|
<pre class="lines">
|
1175
1229
|
|
1176
1230
|
|
1177
|
-
237
|
1178
|
-
238
|
1179
|
-
239
|
1180
|
-
240
|
1181
|
-
241
|
1182
1231
|
242
|
1183
1232
|
243
|
1184
1233
|
244
|
@@ -1197,10 +1246,16 @@
|
|
1197
1246
|
257
|
1198
1247
|
258
|
1199
1248
|
259
|
1200
|
-
260
|
1249
|
+
260
|
1250
|
+
261
|
1251
|
+
262
|
1252
|
+
263
|
1253
|
+
264
|
1254
|
+
265
|
1255
|
+
266</pre>
|
1201
1256
|
</td>
|
1202
1257
|
<td>
|
1203
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1258
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 242</span>
|
1204
1259
|
|
1205
1260
|
<span class='kw'>def</span> <span class='id identifier rubyid_edge_modules'>edge_modules</span>
|
1206
1261
|
<span class='id identifier rubyid_ns'>ns</span> <span class='op'>=</span> <span class='const'>OpenStruct</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
@@ -1217,6 +1272,7 @@
|
|
1217
1272
|
<span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_https_edge_route_saml'>https_edge_route_saml</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EdgeRouteSAMLModuleClient.html" title="NgrokAPI::Services::EdgeRouteSAMLModuleClient (class)">EdgeRouteSAMLModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgeRouteSAMLModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgeRouteSAMLModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1218
1273
|
<span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_https_edge_route_oidc'>https_edge_route_oidc</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EdgeRouteOIDCModuleClient.html" title="NgrokAPI::Services::EdgeRouteOIDCModuleClient (class)">EdgeRouteOIDCModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgeRouteOIDCModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgeRouteOIDCModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1219
1274
|
<span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_https_edge_route_websocket_tcp_converter'>https_edge_route_websocket_tcp_converter</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EdgeRouteWebsocketTCPConverterModuleClient.html" title="NgrokAPI::Services::EdgeRouteWebsocketTCPConverterModuleClient (class)">EdgeRouteWebsocketTCPConverterModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgeRouteWebsocketTCPConverterModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgeRouteWebsocketTCPConverterModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1275
|
+
<span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_https_edge_route_user_agent_filter'>https_edge_route_user_agent_filter</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EdgeRouteUserAgentFilterModuleClient.html" title="NgrokAPI::Services::EdgeRouteUserAgentFilterModuleClient (class)">EdgeRouteUserAgentFilterModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EdgeRouteUserAgentFilterModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EdgeRouteUserAgentFilterModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1220
1276
|
<span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_tcp_edge_backend'>tcp_edge_backend</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TCPEdgeBackendModuleClient.html" title="NgrokAPI::Services::TCPEdgeBackendModuleClient (class)">TCPEdgeBackendModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TCPEdgeBackendModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::TCPEdgeBackendModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1221
1277
|
<span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_tcp_edge_ip_restriction'>tcp_edge_ip_restriction</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TCPEdgeIPRestrictionModuleClient.html" title="NgrokAPI::Services::TCPEdgeIPRestrictionModuleClient (class)">TCPEdgeIPRestrictionModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TCPEdgeIPRestrictionModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::TCPEdgeIPRestrictionModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1222
1278
|
<span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_tls_edge_backend'>tls_edge_backend</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TLSEdgeBackendModuleClient.html" title="NgrokAPI::Services::TLSEdgeBackendModuleClient (class)">TLSEdgeBackendModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TLSEdgeBackendModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::TLSEdgeBackendModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
@@ -1246,18 +1302,18 @@
|
|
1246
1302
|
<pre class="lines">
|
1247
1303
|
|
1248
1304
|
|
1249
|
-
227
|
1250
|
-
228
|
1251
|
-
229
|
1252
|
-
230
|
1253
|
-
231
|
1254
1305
|
232
|
1255
1306
|
233
|
1256
1307
|
234
|
1257
|
-
235
|
1308
|
+
235
|
1309
|
+
236
|
1310
|
+
237
|
1311
|
+
238
|
1312
|
+
239
|
1313
|
+
240</pre>
|
1258
1314
|
</td>
|
1259
1315
|
<td>
|
1260
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1316
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 232</span>
|
1261
1317
|
|
1262
1318
|
<span class='kw'>def</span> <span class='id identifier rubyid_edges'>edges</span>
|
1263
1319
|
<span class='id identifier rubyid_ns'>ns</span> <span class='op'>=</span> <span class='const'>OpenStruct</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
@@ -1285,7 +1341,7 @@
|
|
1285
1341
|
</h3><div class="docstring">
|
1286
1342
|
<div class="discussion">
|
1287
1343
|
|
1288
|
-
<p>Endpoints provides an API for querying the endpoint objects
|
1344
|
+
<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>
|
1289
1345
|
|
1290
1346
|
|
1291
1347
|
</div>
|
@@ -1312,12 +1368,12 @@
|
|
1312
1368
|
<pre class="lines">
|
1313
1369
|
|
1314
1370
|
|
1315
|
-
|
1316
|
-
|
1317
|
-
|
1371
|
+
92
|
1372
|
+
93
|
1373
|
+
94</pre>
|
1318
1374
|
</td>
|
1319
1375
|
<td>
|
1320
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1376
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 92</span>
|
1321
1377
|
|
1322
1378
|
<span class='kw'>def</span> <span class='id identifier rubyid_endpoints'>endpoints</span>
|
1323
1379
|
<span class='ivar'>@_endpoints</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointsClient.html" title="NgrokAPI::Services::EndpointsClient (class)">EndpointsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointsClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
@@ -1342,12 +1398,12 @@
|
|
1342
1398
|
<pre class="lines">
|
1343
1399
|
|
1344
1400
|
|
1345
|
-
|
1346
|
-
|
1347
|
-
|
1401
|
+
96
|
1402
|
+
97
|
1403
|
+
98</pre>
|
1348
1404
|
</td>
|
1349
1405
|
<td>
|
1350
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1406
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 96</span>
|
1351
1407
|
|
1352
1408
|
<span class='kw'>def</span> <span class='id identifier rubyid_event_destinations'>event_destinations</span>
|
1353
1409
|
<span class='ivar'>@_event_destinations</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventDestinationsClient.html" title="NgrokAPI::Services::EventDestinationsClient (class)">EventDestinationsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventDestinationsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventDestinationsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
@@ -1372,12 +1428,12 @@
|
|
1372
1428
|
<pre class="lines">
|
1373
1429
|
|
1374
1430
|
|
1375
|
-
|
1376
|
-
|
1377
|
-
|
1431
|
+
104
|
1432
|
+
105
|
1433
|
+
106</pre>
|
1378
1434
|
</td>
|
1379
1435
|
<td>
|
1380
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1436
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 104</span>
|
1381
1437
|
|
1382
1438
|
<span class='kw'>def</span> <span class='id identifier rubyid_event_sources'>event_sources</span>
|
1383
1439
|
<span class='ivar'>@_event_sources</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventSourcesClient.html" title="NgrokAPI::Services::EventSourcesClient (class)">EventSourcesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventSourcesClient.html#initialize-instance_method" title="NgrokAPI::Services::EventSourcesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
@@ -1402,12 +1458,12 @@
|
|
1402
1458
|
<pre class="lines">
|
1403
1459
|
|
1404
1460
|
|
1405
|
-
|
1406
|
-
|
1407
|
-
|
1461
|
+
100
|
1462
|
+
101
|
1463
|
+
102</pre>
|
1408
1464
|
</td>
|
1409
1465
|
<td>
|
1410
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1466
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 100</span>
|
1411
1467
|
|
1412
1468
|
<span class='kw'>def</span> <span class='id identifier rubyid_event_subscriptions'>event_subscriptions</span>
|
1413
1469
|
<span class='ivar'>@_event_subscriptions</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventSubscriptionsClient.html" title="NgrokAPI::Services::EventSubscriptionsClient (class)">EventSubscriptionsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventSubscriptionsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventSubscriptionsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
@@ -1429,7 +1485,7 @@
|
|
1429
1485
|
</h3><div class="docstring">
|
1430
1486
|
<div class="discussion">
|
1431
1487
|
|
1432
|
-
<p>IP Policies are reusable groups of CIDR ranges with an <code>allow</code> or <code>deny</code>
|
1488
|
+
<p>IP Policies are reusable groups of CIDR ranges with an <code>allow</code> or <code>deny</code> action. They can be attached to endpoints via the Endpoint Configuration IP Policy module. They can also be used with IP Restrictions to control source IP ranges that can start tunnel sessions and connect to the API and dashboard.</p>
|
1433
1489
|
|
1434
1490
|
|
1435
1491
|
</div>
|
@@ -1456,12 +1512,12 @@
|
|
1456
1512
|
<pre class="lines">
|
1457
1513
|
|
1458
1514
|
|
1459
|
-
|
1460
|
-
|
1461
|
-
|
1515
|
+
115
|
1516
|
+
116
|
1517
|
+
117</pre>
|
1462
1518
|
</td>
|
1463
1519
|
<td>
|
1464
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1520
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 115</span>
|
1465
1521
|
|
1466
1522
|
<span class='kw'>def</span> <span class='id identifier rubyid_ip_policies'>ip_policies</span>
|
1467
1523
|
<span class='ivar'>@_ip_policies</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/IPPoliciesClient.html" title="NgrokAPI::Services::IPPoliciesClient (class)">IPPoliciesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/IPPoliciesClient.html#initialize-instance_method" title="NgrokAPI::Services::IPPoliciesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
@@ -1483,7 +1539,7 @@
|
|
1483
1539
|
</h3><div class="docstring">
|
1484
1540
|
<div class="discussion">
|
1485
1541
|
|
1486
|
-
<p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that
|
1542
|
+
<p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.</p>
|
1487
1543
|
|
1488
1544
|
|
1489
1545
|
</div>
|
@@ -1510,12 +1566,12 @@
|
|
1510
1566
|
<pre class="lines">
|
1511
1567
|
|
1512
1568
|
|
1513
|
-
|
1514
|
-
|
1515
|
-
|
1569
|
+
124
|
1570
|
+
125
|
1571
|
+
126</pre>
|
1516
1572
|
</td>
|
1517
1573
|
<td>
|
1518
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1574
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 124</span>
|
1519
1575
|
|
1520
1576
|
<span class='kw'>def</span> <span class='id identifier rubyid_ip_policy_rules'>ip_policy_rules</span>
|
1521
1577
|
<span class='ivar'>@_ip_policy_rules</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/IPPolicyRulesClient.html" title="NgrokAPI::Services::IPPolicyRulesClient (class)">IPPolicyRulesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/IPPolicyRulesClient.html#initialize-instance_method" title="NgrokAPI::Services::IPPolicyRulesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
@@ -1537,7 +1593,7 @@
|
|
1537
1593
|
</h3><div class="docstring">
|
1538
1594
|
<div class="discussion">
|
1539
1595
|
|
1540
|
-
<p>An IP restriction is a restriction placed on the CIDRs that are allowed to
|
1596
|
+
<p>An IP restriction is a restriction placed on the CIDRs that are allowed to initiate traffic to a specific aspect of your ngrok account. An IP restriction has a type which defines the ingress it applies to. IP restrictions can be used to enforce the source IPs that can make API requests, log in to the dashboard, start ngrok agents, and connect to your public-facing endpoints.</p>
|
1541
1597
|
|
1542
1598
|
|
1543
1599
|
</div>
|
@@ -1564,12 +1620,12 @@
|
|
1564
1620
|
<pre class="lines">
|
1565
1621
|
|
1566
1622
|
|
1567
|
-
|
1568
|
-
|
1569
|
-
|
1623
|
+
137
|
1624
|
+
138
|
1625
|
+
139</pre>
|
1570
1626
|
</td>
|
1571
1627
|
<td>
|
1572
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1628
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 137</span>
|
1573
1629
|
|
1574
1630
|
<span class='kw'>def</span> <span class='id identifier rubyid_ip_restrictions'>ip_restrictions</span>
|
1575
1631
|
<span class='ivar'>@_ip_restrictions</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/IPRestrictionsClient.html" title="NgrokAPI::Services::IPRestrictionsClient (class)">IPRestrictionsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/IPRestrictionsClient.html#initialize-instance_method" title="NgrokAPI::Services::IPRestrictionsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
@@ -1591,7 +1647,7 @@
|
|
1591
1647
|
</h3><div class="docstring">
|
1592
1648
|
<div class="discussion">
|
1593
1649
|
|
1594
|
-
<p>Reserved Addresses are TCP addresses that can be used to listen for traffic.
|
1650
|
+
<p>Reserved Addresses are TCP addresses that can be used to listen for traffic. TCP address hostnames and ports are assigned by ngrok, they cannot be chosen.</p>
|
1595
1651
|
|
1596
1652
|
|
1597
1653
|
</div>
|
@@ -1618,12 +1674,12 @@
|
|
1618
1674
|
<pre class="lines">
|
1619
1675
|
|
1620
1676
|
|
1621
|
-
|
1622
|
-
|
1623
|
-
|
1677
|
+
147
|
1678
|
+
148
|
1679
|
+
149</pre>
|
1624
1680
|
</td>
|
1625
1681
|
<td>
|
1626
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1682
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 147</span>
|
1627
1683
|
|
1628
1684
|
<span class='kw'>def</span> <span class='id identifier rubyid_reserved_addrs'>reserved_addrs</span>
|
1629
1685
|
<span class='ivar'>@_reserved_addrs</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/ReservedAddrsClient.html" title="NgrokAPI::Services::ReservedAddrsClient (class)">ReservedAddrsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/ReservedAddrsClient.html#initialize-instance_method" title="NgrokAPI::Services::ReservedAddrsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
@@ -1645,7 +1701,7 @@
|
|
1645
1701
|
</h3><div class="docstring">
|
1646
1702
|
<div class="discussion">
|
1647
1703
|
|
1648
|
-
<p>Reserved Domains are hostnames that you can listen for traffic on. Domains
|
1704
|
+
<p>Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok’s edge servers.</p>
|
1649
1705
|
|
1650
1706
|
|
1651
1707
|
</div>
|
@@ -1672,12 +1728,12 @@
|
|
1672
1728
|
<pre class="lines">
|
1673
1729
|
|
1674
1730
|
|
1675
|
-
|
1676
|
-
|
1677
|
-
|
1731
|
+
158
|
1732
|
+
159
|
1733
|
+
160</pre>
|
1678
1734
|
</td>
|
1679
1735
|
<td>
|
1680
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1736
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 158</span>
|
1681
1737
|
|
1682
1738
|
<span class='kw'>def</span> <span class='id identifier rubyid_reserved_domains'>reserved_domains</span>
|
1683
1739
|
<span class='ivar'>@_reserved_domains</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">ReservedDomainsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/ReservedDomainsClient.html#initialize-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
@@ -1699,7 +1755,7 @@
|
|
1699
1755
|
</h3><div class="docstring">
|
1700
1756
|
<div class="discussion">
|
1701
1757
|
|
1702
|
-
<p>An SSH Certificate Authority is a pair of an SSH Certificate and its private
|
1758
|
+
<p>An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.</p>
|
1703
1759
|
|
1704
1760
|
|
1705
1761
|
</div>
|
@@ -1726,12 +1782,12 @@
|
|
1726
1782
|
<pre class="lines">
|
1727
1783
|
|
1728
1784
|
|
1729
|
-
|
1730
|
-
|
1731
|
-
|
1785
|
+
167
|
1786
|
+
168
|
1787
|
+
169</pre>
|
1732
1788
|
</td>
|
1733
1789
|
<td>
|
1734
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1790
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 167</span>
|
1735
1791
|
|
1736
1792
|
<span class='kw'>def</span> <span class='id identifier rubyid_ssh_certificate_authorities'>ssh_certificate_authorities</span>
|
1737
1793
|
<span class='ivar'>@_ssh_certificate_authorities</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHCertificateAuthoritiesClient.html" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient (class)">SSHCertificateAuthoritiesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHCertificateAuthoritiesClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
@@ -1753,7 +1809,7 @@
|
|
1753
1809
|
</h3><div class="docstring">
|
1754
1810
|
<div class="discussion">
|
1755
1811
|
|
1756
|
-
<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels
|
1812
|
+
<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.</p>
|
1757
1813
|
|
1758
1814
|
|
1759
1815
|
</div>
|
@@ -1780,12 +1836,12 @@
|
|
1780
1836
|
<pre class="lines">
|
1781
1837
|
|
1782
1838
|
|
1783
|
-
|
1784
|
-
|
1785
|
-
|
1839
|
+
176
|
1840
|
+
177
|
1841
|
+
178</pre>
|
1786
1842
|
</td>
|
1787
1843
|
<td>
|
1788
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1844
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 176</span>
|
1789
1845
|
|
1790
1846
|
<span class='kw'>def</span> <span class='id identifier rubyid_ssh_credentials'>ssh_credentials</span>
|
1791
1847
|
<span class='ivar'>@_ssh_credentials</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHCredentialsClient.html" title="NgrokAPI::Services::SSHCredentialsClient (class)">SSHCredentialsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHCredentialsClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHCredentialsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
@@ -1807,7 +1863,7 @@
|
|
1807
1863
|
</h3><div class="docstring">
|
1808
1864
|
<div class="discussion">
|
1809
1865
|
|
1810
|
-
<p>SSH Host Certificates along with the corresponding private key allows an SSH
|
1866
|
+
<p>SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.</p>
|
1811
1867
|
|
1812
1868
|
|
1813
1869
|
</div>
|
@@ -1834,12 +1890,12 @@
|
|
1834
1890
|
<pre class="lines">
|
1835
1891
|
|
1836
1892
|
|
1837
|
-
|
1838
|
-
|
1839
|
-
|
1893
|
+
186
|
1894
|
+
187
|
1895
|
+
188</pre>
|
1840
1896
|
</td>
|
1841
1897
|
<td>
|
1842
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1898
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 186</span>
|
1843
1899
|
|
1844
1900
|
<span class='kw'>def</span> <span class='id identifier rubyid_ssh_host_certificates'>ssh_host_certificates</span>
|
1845
1901
|
<span class='ivar'>@_ssh_host_certificates</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHHostCertificatesClient.html" title="NgrokAPI::Services::SSHHostCertificatesClient (class)">SSHHostCertificatesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHHostCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHHostCertificatesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
@@ -1861,7 +1917,7 @@
|
|
1861
1917
|
</h3><div class="docstring">
|
1862
1918
|
<div class="discussion">
|
1863
1919
|
|
1864
|
-
<p>SSH User Certificates are presented by SSH clients when connecting to an SSH
|
1920
|
+
<p>SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection. The SSH server must trust the SSH Certificate Authority used to sign the certificate.</p>
|
1865
1921
|
|
1866
1922
|
|
1867
1923
|
</div>
|
@@ -1888,12 +1944,12 @@
|
|
1888
1944
|
<pre class="lines">
|
1889
1945
|
|
1890
1946
|
|
1891
|
-
|
1892
|
-
|
1893
|
-
|
1947
|
+
196
|
1948
|
+
197
|
1949
|
+
198</pre>
|
1894
1950
|
</td>
|
1895
1951
|
<td>
|
1896
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1952
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 196</span>
|
1897
1953
|
|
1898
1954
|
<span class='kw'>def</span> <span class='id identifier rubyid_ssh_user_certificates'>ssh_user_certificates</span>
|
1899
1955
|
<span class='ivar'>@_ssh_user_certificates</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHUserCertificatesClient.html" title="NgrokAPI::Services::SSHUserCertificatesClient (class)">SSHUserCertificatesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHUserCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHUserCertificatesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
@@ -1915,7 +1971,7 @@
|
|
1915
1971
|
</h3><div class="docstring">
|
1916
1972
|
<div class="discussion">
|
1917
1973
|
|
1918
|
-
<p>TLS Certificates are pairs of x509 certificates and their matching private
|
1974
|
+
<p>TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic. TLS certificates are unused until they are attached to a Domain. TLS Certificates may also be provisioned by ngrok automatically for domains on which you have enabled automated certificate provisioning.</p>
|
1919
1975
|
|
1920
1976
|
|
1921
1977
|
</div>
|
@@ -1942,12 +1998,12 @@
|
|
1942
1998
|
<pre class="lines">
|
1943
1999
|
|
1944
2000
|
|
1945
|
-
|
1946
|
-
|
1947
|
-
|
2001
|
+
208
|
2002
|
+
209
|
2003
|
+
210</pre>
|
1948
2004
|
</td>
|
1949
2005
|
<td>
|
1950
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
2006
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 208</span>
|
1951
2007
|
|
1952
2008
|
<span class='kw'>def</span> <span class='id identifier rubyid_tls_certificates'>tls_certificates</span>
|
1953
2009
|
<span class='ivar'>@_tls_certificates</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TLSCertificatesClient.html" title="NgrokAPI::Services::TLSCertificatesClient (class)">TLSCertificatesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TLSCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::TLSCertificatesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
@@ -1969,7 +2025,7 @@
|
|
1969
2025
|
</h3><div class="docstring">
|
1970
2026
|
<div class="discussion">
|
1971
2027
|
|
1972
|
-
<p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
|
2028
|
+
<p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service. Each tunnel session can include one or more Tunnels.</p>
|
1973
2029
|
|
1974
2030
|
|
1975
2031
|
</div>
|
@@ -2023,7 +2079,7 @@
|
|
2023
2079
|
</h3><div class="docstring">
|
2024
2080
|
<div class="discussion">
|
2025
2081
|
|
2026
|
-
<p>Tunnels provide endpoints to access services exposed by a running ngrok
|
2082
|
+
<p>Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.</p>
|
2027
2083
|
|
2028
2084
|
|
2029
2085
|
</div>
|
@@ -2050,12 +2106,12 @@
|
|
2050
2106
|
<pre class="lines">
|
2051
2107
|
|
2052
2108
|
|
2053
|
-
|
2054
|
-
|
2055
|
-
|
2109
|
+
217
|
2110
|
+
218
|
2111
|
+
219</pre>
|
2056
2112
|
</td>
|
2057
2113
|
<td>
|
2058
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
2114
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 217</span>
|
2059
2115
|
|
2060
2116
|
<span class='kw'>def</span> <span class='id identifier rubyid_tunnels'>tunnels</span>
|
2061
2117
|
<span class='ivar'>@_tunnels</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TunnelsClient.html" title="NgrokAPI::Services::TunnelsClient (class)">TunnelsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TunnelsClient.html#initialize-instance_method" title="NgrokAPI::Services::TunnelsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
@@ -2070,9 +2126,9 @@
|
|
2070
2126
|
</div>
|
2071
2127
|
|
2072
2128
|
<div id="footer">
|
2073
|
-
Generated on Thu
|
2129
|
+
Generated on Thu Jul 25 21:32:05 2024 by
|
2074
2130
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
2075
|
-
0.9.
|
2131
|
+
0.9.36 (ruby-3.3.1).
|
2076
2132
|
</div>
|
2077
2133
|
|
2078
2134
|
</div>
|