ngrok-api 0.16.0 → 0.17.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/doc/NgrokAPI/Client.html +270 -180
- data/doc/NgrokAPI/Error.html +2 -2
- data/doc/NgrokAPI/Errors/NotFoundError.html +2 -2
- data/doc/NgrokAPI/Errors.html +2 -2
- data/doc/NgrokAPI/HttpClient.html +2 -2
- data/doc/NgrokAPI/Models/APIKey.html +2 -2
- data/doc/NgrokAPI/Models/AWSAuth.html +2 -2
- data/doc/NgrokAPI/Models/AWSCredentials.html +2 -2
- data/doc/NgrokAPI/Models/AWSRole.html +2 -2
- data/doc/NgrokAPI/Models/AbuseReport.html +2 -2
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +2 -2
- data/doc/NgrokAPI/Models/AgentIngress.html +2 -2
- data/doc/NgrokAPI/Models/CertificateAuthority.html +2 -2
- data/doc/NgrokAPI/Models/Credential.html +2 -2
- data/doc/NgrokAPI/Models/Endpoint.html +1431 -0
- data/{docs/NgrokAPI/Models/EndpointLogging.html → doc/NgrokAPI/Models/EndpointBackend.html} +41 -41
- data/doc/NgrokAPI/Models/{EndpointLoggingMutate.html → EndpointBackendMutate.html} +41 -41
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +2 -2
- data/doc/NgrokAPI/Models/EndpointCompression.html +2 -2
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +2 -2
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +2 -2
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +2 -2
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuth.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOIDC.html +2 -2
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +2 -2
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +2 -2
- data/doc/NgrokAPI/Models/EndpointSAML.html +2 -2
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +2 -2
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +2 -2
- data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +617 -0
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +2 -2
- data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +543 -0
- data/doc/NgrokAPI/Models/EventDestination.html +6 -6
- data/doc/NgrokAPI/Models/EventSource.html +2 -2
- data/doc/NgrokAPI/Models/EventSourceList.html +2 -2
- data/doc/NgrokAPI/Models/EventSourceReplace.html +2 -2
- data/doc/NgrokAPI/Models/EventSubscription.html +2 -2
- data/doc/NgrokAPI/Models/EventTarget.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +2 -2
- data/doc/NgrokAPI/Models/FailoverBackend.html +1075 -0
- data/doc/NgrokAPI/Models/HTTPResponseBackend.html +1231 -0
- data/{docs/NgrokAPI/Models/EventStream.html → doc/NgrokAPI/Models/HTTPSEdge.html} +118 -118
- data/doc/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +202 -264
- data/doc/NgrokAPI/Models/IPPolicy.html +2 -2
- data/doc/NgrokAPI/Models/IPPolicyRule.html +96 -22
- data/doc/NgrokAPI/Models/IPRestriction.html +2 -2
- data/doc/NgrokAPI/Models/Listable.html +2 -2
- data/doc/NgrokAPI/Models/Ref.html +2 -2
- data/doc/NgrokAPI/Models/ReservedAddr.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomain.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +2 -2
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +2 -2
- data/doc/NgrokAPI/Models/SSHCredential.html +2 -2
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +2 -2
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +2 -2
- data/doc/NgrokAPI/Models/TCPEdge.html +1235 -0
- data/doc/NgrokAPI/Models/TLSCertificate.html +2 -2
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
- data/doc/NgrokAPI/Models/TLSEdge.html +1395 -0
- data/doc/NgrokAPI/Models/Tunnel.html +313 -17
- data/doc/NgrokAPI/Models/TunnelGroupBackend.html +1149 -0
- data/doc/NgrokAPI/Models/TunnelSession.html +2 -2
- data/doc/NgrokAPI/Models/WeightedBackend.html +1075 -0
- data/doc/NgrokAPI/Models.html +4 -4
- data/doc/NgrokAPI/PagedIterator.html +2 -2
- data/doc/NgrokAPI/Services/APIKeysClient.html +2 -2
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +2 -2
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +2 -2
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +2 -2
- data/doc/NgrokAPI/Services/CredentialsClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1153 -0
- data/doc/NgrokAPI/Services/{EndpointCircuitBreakerModuleClient.html → EdgeRouteCircuitBreakerModuleClient.html} +206 -96
- data/{docs/NgrokAPI/Services/EndpointCompressionModuleClient.html → doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html} +206 -96
- data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1153 -0
- data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +1153 -0
- data/{docs/NgrokAPI/Services/EndpointOIDCModuleClient.html → doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html} +206 -96
- data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1153 -0
- data/{docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html → doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html} +206 -96
- data/{docs/NgrokAPI/Services/EndpointSAMLModuleClient.html → doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html} +206 -96
- data/doc/NgrokAPI/Services/{EndpointWebhookValidationModuleClient.html → EdgeRouteWebhookVerificationModuleClient.html} +206 -96
- data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1153 -0
- data/doc/NgrokAPI/Services/{EventStreamsClient.html → EdgesHTTPSClient.html} +236 -271
- data/{docs/NgrokAPI/Services/EndpointConfigurationsClient.html → doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html} +456 -620
- data/doc/NgrokAPI/Services/EdgesTCPClient.html +1757 -0
- data/doc/NgrokAPI/Services/EdgesTLSClient.html +1847 -0
- data/doc/NgrokAPI/Services/EndpointsClient.html +907 -0
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +35 -35
- data/doc/NgrokAPI/Services/EventSourcesClient.html +2 -2
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +5 -5
- data/doc/NgrokAPI/Services/FailoverBackendsClient.html +1644 -0
- data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +1744 -0
- data/doc/NgrokAPI/Services/{EndpointOIDCModuleClient.html → HTTPSEdgeMutualTLSModuleClient.html} +59 -59
- data/doc/NgrokAPI/Services/{EndpointRequestHeadersModuleClient.html → HTTPSEdgeTLSTerminationModuleClient.html} +59 -59
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +40 -58
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +60 -40
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +3 -3
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +41 -331
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +94 -674
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +2 -2
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +2 -2
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +2 -2
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +2 -2
- data/{docs/NgrokAPI/Services/EndpointLoggingModuleClient.html → doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html} +59 -59
- data/doc/NgrokAPI/Services/{EndpointIPPolicyModuleClient.html → TCPEdgeIPRestrictionModuleClient.html} +41 -41
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +2 -2
- data/doc/NgrokAPI/Services/{EndpointLoggingModuleClient.html → TLSEdgeBackendModuleClient.html} +59 -59
- data/{docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html → doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html} +41 -41
- data/doc/NgrokAPI/Services/{EndpointMutualTLSModuleClient.html → TLSEdgeMutualTLSModuleClient.html} +41 -41
- data/{docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html → doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html} +41 -41
- data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +1644 -0
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +2 -2
- data/doc/NgrokAPI/Services/TunnelsClient.html +241 -3
- data/doc/NgrokAPI/Services/WeightedBackendsClient.html +1644 -0
- data/doc/NgrokAPI/Services.html +4 -4
- data/doc/NgrokAPI.html +3 -3
- data/doc/_index.html +237 -60
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +2 -2
- data/doc/index.html +2 -2
- data/doc/method_list.html +3393 -1433
- data/doc/top-level-namespace.html +2 -2
- data/docs/NgrokAPI/Client.html +270 -180
- data/docs/NgrokAPI/Error.html +2 -2
- data/docs/NgrokAPI/Errors/NotFoundError.html +2 -2
- data/docs/NgrokAPI/Errors.html +2 -2
- data/docs/NgrokAPI/HttpClient.html +2 -2
- data/docs/NgrokAPI/Models/APIKey.html +2 -2
- data/docs/NgrokAPI/Models/AWSAuth.html +2 -2
- data/docs/NgrokAPI/Models/AWSCredentials.html +2 -2
- data/docs/NgrokAPI/Models/AWSRole.html +2 -2
- data/docs/NgrokAPI/Models/AbuseReport.html +2 -2
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +2 -2
- data/docs/NgrokAPI/Models/AgentIngress.html +2 -2
- data/docs/NgrokAPI/Models/CertificateAuthority.html +2 -2
- data/docs/NgrokAPI/Models/Credential.html +2 -2
- data/docs/NgrokAPI/Models/Endpoint.html +1431 -0
- data/{doc/NgrokAPI/Models/EndpointLogging.html → docs/NgrokAPI/Models/EndpointBackend.html} +41 -41
- data/docs/NgrokAPI/Models/{EndpointLoggingMutate.html → EndpointBackendMutate.html} +41 -41
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +2 -2
- data/docs/NgrokAPI/Models/EndpointCompression.html +2 -2
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +2 -2
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +2 -2
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +2 -2
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuth.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOIDC.html +2 -2
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +2 -2
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +2 -2
- data/docs/NgrokAPI/Models/EndpointSAML.html +2 -2
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +2 -2
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +2 -2
- data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +617 -0
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +2 -2
- data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +543 -0
- data/docs/NgrokAPI/Models/EventDestination.html +6 -6
- data/docs/NgrokAPI/Models/EventSource.html +2 -2
- data/docs/NgrokAPI/Models/EventSourceList.html +2 -2
- data/docs/NgrokAPI/Models/EventSourceReplace.html +2 -2
- data/docs/NgrokAPI/Models/EventSubscription.html +2 -2
- data/docs/NgrokAPI/Models/EventTarget.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +2 -2
- data/docs/NgrokAPI/Models/FailoverBackend.html +1075 -0
- data/docs/NgrokAPI/Models/HTTPResponseBackend.html +1231 -0
- data/{doc/NgrokAPI/Models/EventStream.html → docs/NgrokAPI/Models/HTTPSEdge.html} +118 -118
- data/docs/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +202 -264
- data/docs/NgrokAPI/Models/IPPolicy.html +2 -2
- data/docs/NgrokAPI/Models/IPPolicyRule.html +96 -22
- data/docs/NgrokAPI/Models/IPRestriction.html +2 -2
- data/docs/NgrokAPI/Models/Listable.html +2 -2
- data/docs/NgrokAPI/Models/Ref.html +2 -2
- data/docs/NgrokAPI/Models/ReservedAddr.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomain.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +2 -2
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +2 -2
- data/docs/NgrokAPI/Models/SSHCredential.html +2 -2
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +2 -2
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +2 -2
- data/docs/NgrokAPI/Models/TCPEdge.html +1235 -0
- data/docs/NgrokAPI/Models/TLSCertificate.html +2 -2
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
- data/docs/NgrokAPI/Models/TLSEdge.html +1395 -0
- data/docs/NgrokAPI/Models/Tunnel.html +313 -17
- data/docs/NgrokAPI/Models/TunnelGroupBackend.html +1149 -0
- data/docs/NgrokAPI/Models/TunnelSession.html +2 -2
- data/docs/NgrokAPI/Models/WeightedBackend.html +1075 -0
- data/docs/NgrokAPI/Models.html +4 -4
- data/docs/NgrokAPI/PagedIterator.html +2 -2
- data/docs/NgrokAPI/Services/APIKeysClient.html +2 -2
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +2 -2
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +2 -2
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +2 -2
- data/docs/NgrokAPI/Services/CredentialsClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1153 -0
- data/docs/NgrokAPI/Services/{EndpointCircuitBreakerModuleClient.html → EdgeRouteCircuitBreakerModuleClient.html} +206 -96
- data/{doc/NgrokAPI/Services/EndpointCompressionModuleClient.html → docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html} +206 -96
- data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1153 -0
- data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +1153 -0
- data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +1153 -0
- data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1153 -0
- data/{doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html → docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html} +206 -96
- data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +1153 -0
- data/docs/NgrokAPI/Services/{EndpointWebhookValidationModuleClient.html → EdgeRouteWebhookVerificationModuleClient.html} +206 -96
- data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1153 -0
- data/docs/NgrokAPI/Services/{EventStreamsClient.html → EdgesHTTPSClient.html} +236 -271
- data/{doc/NgrokAPI/Services/EndpointConfigurationsClient.html → docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html} +456 -620
- data/docs/NgrokAPI/Services/EdgesTCPClient.html +1757 -0
- data/docs/NgrokAPI/Services/EdgesTLSClient.html +1847 -0
- data/docs/NgrokAPI/Services/EndpointsClient.html +907 -0
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +35 -35
- data/docs/NgrokAPI/Services/EventSourcesClient.html +2 -2
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +5 -5
- data/docs/NgrokAPI/Services/FailoverBackendsClient.html +1644 -0
- data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +1744 -0
- data/{doc/NgrokAPI/Services/EndpointSAMLModuleClient.html → docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html} +59 -59
- data/docs/NgrokAPI/Services/{EndpointRequestHeadersModuleClient.html → HTTPSEdgeTLSTerminationModuleClient.html} +59 -59
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +40 -58
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +60 -40
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +3 -3
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +41 -331
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +94 -674
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +2 -2
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +2 -2
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +2 -2
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +2 -2
- data/docs/NgrokAPI/Services/{EndpointOAuthModuleClient.html → TCPEdgeBackendModuleClient.html} +59 -59
- data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +2 -2
- data/{doc/NgrokAPI/Services/EndpointOAuthModuleClient.html → docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html} +59 -59
- data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/{EndpointMutualTLSModuleClient.html → TLSEdgeMutualTLSModuleClient.html} +41 -41
- data/{doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html → docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html} +41 -41
- data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +1644 -0
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +2 -2
- data/docs/NgrokAPI/Services/TunnelsClient.html +241 -3
- data/docs/NgrokAPI/Services/WeightedBackendsClient.html +1644 -0
- data/docs/NgrokAPI/Services.html +4 -4
- data/docs/NgrokAPI.html +3 -3
- data/docs/_index.html +237 -60
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +2 -2
- data/docs/index.html +2 -2
- data/docs/method_list.html +3393 -1433
- data/docs/top-level-namespace.html +2 -2
- data/lib/ngrokapi/client.rb +47 -24
- data/lib/ngrokapi/models/endpoint.rb +49 -0
- data/lib/ngrokapi/models/{endpoint_logging.rb → endpoint_backend.rb} +3 -3
- data/lib/ngrokapi/models/{endpoint_logging_mutate.rb → endpoint_backend_mutate.rb} +3 -3
- data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb +27 -0
- data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb +25 -0
- data/lib/ngrokapi/models/event_destination.rb +1 -2
- data/lib/ngrokapi/models/{event_stream.rb → failover_backend.rb} +15 -27
- data/lib/ngrokapi/models/http_response_backend.rb +71 -0
- data/lib/ngrokapi/models/https_edge.rb +80 -0
- data/lib/ngrokapi/models/{endpoint_configuration.rb → https_edge_route.rb} +56 -53
- data/lib/ngrokapi/models/ip_policy_rule.rb +3 -1
- data/lib/ngrokapi/models/tcp_edge.rb +78 -0
- data/lib/ngrokapi/models/tls_edge.rb +88 -0
- data/lib/ngrokapi/models/tunnel.rb +9 -1
- data/lib/ngrokapi/models/tunnel_group_backend.rb +67 -0
- data/lib/ngrokapi/models/weighted_backend.rb +65 -0
- data/lib/ngrokapi/services/edge_route_backend_module_client.rb +120 -0
- data/lib/ngrokapi/services/{endpoint_circuit_breaker_module_client.rb → edge_route_circuit_breaker_module_client.rb} +37 -25
- data/lib/ngrokapi/services/{endpoint_compression_module_client.rb → edge_route_compression_module_client.rb} +37 -25
- data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +120 -0
- data/lib/ngrokapi/services/edge_route_o_auth_module_client.rb +120 -0
- data/lib/ngrokapi/services/edge_route_oidc_module_client.rb +120 -0
- data/lib/ngrokapi/services/edge_route_request_headers_module_client.rb +120 -0
- data/lib/ngrokapi/services/{endpoint_response_headers_module_client.rb → edge_route_response_headers_module_client.rb} +37 -25
- data/lib/ngrokapi/services/edge_route_saml_module_client.rb +120 -0
- data/lib/ngrokapi/services/{endpoint_webhook_validation_module_client.rb → edge_route_webhook_verification_module_client.rb} +37 -25
- data/lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb +120 -0
- data/lib/ngrokapi/services/edges_https_client.rb +227 -0
- data/lib/ngrokapi/services/edges_https_routes_client.rb +244 -0
- data/lib/ngrokapi/services/edges_tcp_client.rb +227 -0
- data/lib/ngrokapi/services/edges_tls_client.rb +239 -0
- data/lib/ngrokapi/services/endpoints_client.rb +114 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +2 -4
- data/lib/ngrokapi/services/event_subscriptions_client.rb +3 -3
- data/lib/ngrokapi/services/failover_backends_client.rb +214 -0
- data/lib/ngrokapi/services/http_response_backends_client.rb +199 -0
- data/lib/ngrokapi/services/{endpoint_saml_module_client.rb → https_edge_mutual_tls_module_client.rb} +25 -25
- data/lib/ngrokapi/services/{endpoint_request_headers_module_client.rb → https_edge_tls_termination_module_client.rb} +25 -25
- data/lib/ngrokapi/services/ip_policies_client.rb +1 -3
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +3 -1
- data/lib/ngrokapi/services/ip_restrictions_client.rb +1 -1
- data/lib/ngrokapi/services/reserved_addrs_client.rb +0 -37
- data/lib/ngrokapi/services/reserved_domains_client.rb +0 -74
- data/lib/ngrokapi/services/{endpoint_logging_module_client.rb → tcp_edge_backend_module_client.rb} +25 -25
- data/lib/ngrokapi/services/{endpoint_ip_policy_module_client.rb → tcp_edge_ip_restriction_module_client.rb} +15 -15
- data/lib/ngrokapi/services/{endpoint_oidc_module_client.rb → tls_edge_backend_module_client.rb} +25 -25
- data/lib/ngrokapi/services/{endpoint_o_auth_module_client.rb → tls_edge_ip_restriction_module_client.rb} +25 -25
- data/lib/ngrokapi/services/{endpoint_mutual_tls_module_client.rb → tls_edge_mutual_tls_module_client.rb} +15 -15
- data/lib/ngrokapi/services/{endpoint_tls_termination_module_client.rb → tls_edge_tls_termination_module_client.rb} +15 -15
- data/lib/ngrokapi/services/tunnel_group_backends_client.rb +212 -0
- data/lib/ngrokapi/services/tunnels_client.rb +35 -0
- data/lib/ngrokapi/services/weighted_backends_client.rb +214 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/spec/ngrokapi/client_spec.rb +44 -23
- data/spec/ngrokapi/models/endpoint_backend_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_backend_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_tls_termination_at_edge_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_websocket_tcp_converter_spec.rb +21 -0
- data/spec/ngrokapi/models/failover_backend_spec.rb +45 -0
- data/spec/ngrokapi/models/http_response_backend_spec.rb +51 -0
- data/spec/ngrokapi/models/https_edge_route_spec.rb +81 -0
- data/spec/ngrokapi/models/https_edge_spec.rb +51 -0
- data/spec/ngrokapi/models/tcp_edge_spec.rb +51 -0
- data/spec/ngrokapi/models/tls_edge_spec.rb +57 -0
- data/spec/ngrokapi/models/tunnel_group_backend_spec.rb +45 -0
- data/spec/ngrokapi/models/weighted_backend_spec.rb +45 -0
- data/spec/ngrokapi/services/edge_route_backend_module_client_spec.rb +139 -0
- data/spec/ngrokapi/services/{endpoint_circuit_breaker_module_client_spec.rb → edge_route_circuit_breaker_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/{endpoint_compression_module_client_spec.rb → edge_route_compression_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/edge_route_ip_restriction_module_client_spec.rb +139 -0
- data/spec/ngrokapi/services/{endpoint_o_auth_module_client_spec.rb → edge_route_o_auth_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/{endpoint_oidc_module_client_spec.rb → edge_route_oidc_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/{endpoint_request_headers_module_client_spec.rb → edge_route_request_headers_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/{endpoint_response_headers_module_client_spec.rb → edge_route_response_headers_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/{endpoint_saml_module_client_spec.rb → edge_route_saml_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/{endpoint_webhook_validation_module_client_spec.rb → edge_route_webhook_verification_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/edge_route_websocket_tcp_converter_module_client_spec.rb +139 -0
- data/spec/ngrokapi/services/{event_streams_client_spec.rb → edges_https_client_spec.rb} +106 -108
- data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +241 -0
- data/spec/ngrokapi/services/edges_tcp_client_spec.rb +175 -0
- data/spec/ngrokapi/services/edges_tls_client_spec.rb +187 -0
- data/spec/ngrokapi/services/endpoints_client_spec.rb +57 -0
- data/spec/ngrokapi/services/failover_backends_client_spec.rb +163 -0
- data/spec/ngrokapi/services/http_response_backends_client_spec.rb +175 -0
- data/spec/ngrokapi/services/{endpoint_mutual_tls_module_client_spec.rb → https_edge_mutual_tls_module_client_spec.rb} +17 -17
- data/spec/ngrokapi/services/{endpoint_tls_termination_module_client_spec.rb → https_edge_tls_termination_module_client_spec.rb} +17 -17
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +0 -1
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +3 -1
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +0 -44
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +0 -88
- data/spec/ngrokapi/services/{endpoint_logging_module_client_spec.rb → tcp_edge_backend_module_client_spec.rb} +40 -40
- data/spec/ngrokapi/services/{endpoint_ip_policy_module_client_spec.rb → tcp_edge_ip_restriction_module_client_spec.rb} +17 -17
- data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb +163 -0
- data/spec/ngrokapi/services/tunnels_client_spec.rb +36 -0
- data/spec/ngrokapi/services/weighted_backends_client_spec.rb +163 -0
- data/spec/spec_helper.rb +326 -33
- metadata +166 -74
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +0 -289
- data/lib/ngrokapi/services/event_streams_client.rb +0 -224
- data/spec/ngrokapi/models/endpoint_configuration_spec.rb +0 -78
- data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +0 -21
- data/spec/ngrokapi/models/endpoint_logging_spec.rb +0 -21
- data/spec/ngrokapi/models/event_stream_spec.rb +0 -51
- data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +0 -237
@@ -4,7 +4,7 @@
|
|
4
4
|
<meta charset="utf-8">
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
6
|
<title>
|
7
|
-
Class: NgrokAPI::Services::
|
7
|
+
Class: NgrokAPI::Services::EdgesHTTPSRoutesClient
|
8
8
|
|
9
9
|
— Documentation by YARD 0.9.27
|
10
10
|
|
@@ -15,7 +15,7 @@
|
|
15
15
|
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
16
16
|
|
17
17
|
<script type="text/javascript">
|
18
|
-
pathId = "NgrokAPI::Services::
|
18
|
+
pathId = "NgrokAPI::Services::EdgesHTTPSRoutesClient";
|
19
19
|
relpath = '../../';
|
20
20
|
</script>
|
21
21
|
|
@@ -39,7 +39,7 @@
|
|
39
39
|
<a href="../../_index.html">Index (E)</a> »
|
40
40
|
<span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> » <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span>
|
41
41
|
»
|
42
|
-
<span class="title">
|
42
|
+
<span class="title">EdgesHTTPSRoutesClient</span>
|
43
43
|
|
44
44
|
</div>
|
45
45
|
|
@@ -59,7 +59,7 @@
|
|
59
59
|
<div class="clear"></div>
|
60
60
|
</div>
|
61
61
|
|
62
|
-
<div id="content"><h1>Class: NgrokAPI::Services::
|
62
|
+
<div id="content"><h1>Class: NgrokAPI::Services::EdgesHTTPSRoutesClient
|
63
63
|
|
64
64
|
|
65
65
|
|
@@ -74,7 +74,7 @@
|
|
74
74
|
<ul class="fullTree">
|
75
75
|
<li>Object</li>
|
76
76
|
|
77
|
-
<li class="next">NgrokAPI::Services::
|
77
|
+
<li class="next">NgrokAPI::Services::EdgesHTTPSRoutesClient</li>
|
78
78
|
|
79
79
|
</ul>
|
80
80
|
<a href="#" class="inheritanceTree">show all</a>
|
@@ -94,7 +94,7 @@
|
|
94
94
|
|
95
95
|
<dl>
|
96
96
|
<dt>Defined in:</dt>
|
97
|
-
<dd>lib/ngrokapi/services/
|
97
|
+
<dd>lib/ngrokapi/services/edges_https_routes_client.rb</dd>
|
98
98
|
</dl>
|
99
99
|
|
100
100
|
</div>
|
@@ -102,9 +102,7 @@
|
|
102
102
|
<h2>Overview</h2><div class="docstring">
|
103
103
|
<div class="discussion">
|
104
104
|
|
105
|
-
<p
|
106
|
-
|
107
|
-
<p><a href="https://ngrok.com/docs/api#api-endpoint-configurations">ngrok.com/docs/api#api-endpoint-configurations</a></p>
|
105
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-https-routes">ngrok.com/docs/api#api-edges-https-routes</a></p>
|
108
106
|
|
109
107
|
|
110
108
|
</div>
|
@@ -135,23 +133,7 @@
|
|
135
133
|
|
136
134
|
</div>
|
137
135
|
</dt>
|
138
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/
|
139
|
-
|
140
|
-
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
|
141
|
-
<div class="docstring">
|
142
|
-
<div class="discussion">
|
143
|
-
|
144
|
-
<p>The List Property from the resulting API for list calls</p>
|
145
|
-
|
146
|
-
|
147
|
-
</div>
|
148
|
-
</div>
|
149
|
-
<div class="tags">
|
150
|
-
|
151
|
-
|
152
|
-
</div>
|
153
|
-
</dt>
|
154
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>endpoint_configurations</span><span class='tstring_end'>'</span></span></pre></dd>
|
136
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes</span><span class='tstring_end'>'</span></span></pre></dd>
|
155
137
|
|
156
138
|
</dl>
|
157
139
|
|
@@ -207,7 +189,7 @@
|
|
207
189
|
<li class="public ">
|
208
190
|
<span class="summary_signature">
|
209
191
|
|
210
|
-
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(
|
192
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute </a>
|
211
193
|
|
212
194
|
|
213
195
|
|
@@ -222,7 +204,7 @@
|
|
222
204
|
|
223
205
|
|
224
206
|
<span class="summary_desc"><div class='inline'>
|
225
|
-
<p>Create
|
207
|
+
<p>Create an HTTPS Edge Route.</p>
|
226
208
|
</div></span>
|
227
209
|
|
228
210
|
</li>
|
@@ -231,7 +213,7 @@
|
|
231
213
|
<li class="public ">
|
232
214
|
<span class="summary_signature">
|
233
215
|
|
234
|
-
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
216
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(edge_id: "", id: "") ⇒ NgrokAPI::Models::Empty </a>
|
235
217
|
|
236
218
|
|
237
219
|
|
@@ -246,7 +228,7 @@
|
|
246
228
|
|
247
229
|
|
248
230
|
<span class="summary_desc"><div class='inline'>
|
249
|
-
<p>Delete an
|
231
|
+
<p>Delete an HTTPS Edge Route by ID.</p>
|
250
232
|
</div></span>
|
251
233
|
|
252
234
|
</li>
|
@@ -255,7 +237,7 @@
|
|
255
237
|
<li class="public ">
|
256
238
|
<span class="summary_signature">
|
257
239
|
|
258
|
-
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
240
|
+
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(edge_id: "", id: "") ⇒ NgrokAPI::Models::Empty </a>
|
259
241
|
|
260
242
|
|
261
243
|
|
@@ -270,7 +252,7 @@
|
|
270
252
|
|
271
253
|
|
272
254
|
<span class="summary_desc"><div class='inline'>
|
273
|
-
<p>Delete an
|
255
|
+
<p>Delete an HTTPS Edge Route by ID Throws an exception if API error.</p>
|
274
256
|
</div></span>
|
275
257
|
|
276
258
|
</li>
|
@@ -279,7 +261,7 @@
|
|
279
261
|
<li class="public ">
|
280
262
|
<span class="summary_signature">
|
281
263
|
|
282
|
-
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::
|
264
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(edge_id: "", id: "") ⇒ NgrokAPI::Models::HTTPSEdgeRoute </a>
|
283
265
|
|
284
266
|
|
285
267
|
|
@@ -294,7 +276,7 @@
|
|
294
276
|
|
295
277
|
|
296
278
|
<span class="summary_desc"><div class='inline'>
|
297
|
-
<p>
|
279
|
+
<p>Get an HTTPS Edge Route by ID.</p>
|
298
280
|
</div></span>
|
299
281
|
|
300
282
|
</li>
|
@@ -303,7 +285,7 @@
|
|
303
285
|
<li class="public ">
|
304
286
|
<span class="summary_signature">
|
305
287
|
|
306
|
-
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ NgrokAPI::Models::
|
288
|
+
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(edge_id: "", id: "") ⇒ NgrokAPI::Models::HTTPSEdgeRoute </a>
|
307
289
|
|
308
290
|
|
309
291
|
|
@@ -318,7 +300,7 @@
|
|
318
300
|
|
319
301
|
|
320
302
|
<span class="summary_desc"><div class='inline'>
|
321
|
-
<p>
|
303
|
+
<p>Get an HTTPS Edge Route by ID Throws an exception if API error.</p>
|
322
304
|
</div></span>
|
323
305
|
|
324
306
|
</li>
|
@@ -327,7 +309,7 @@
|
|
327
309
|
<li class="public ">
|
328
310
|
<span class="summary_signature">
|
329
311
|
|
330
|
-
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒
|
312
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒ EdgesHTTPSRoutesClient </a>
|
331
313
|
|
332
314
|
|
333
315
|
|
@@ -344,55 +326,7 @@
|
|
344
326
|
|
345
327
|
|
346
328
|
<span class="summary_desc"><div class='inline'>
|
347
|
-
<p>A new instance of
|
348
|
-
</div></span>
|
349
|
-
|
350
|
-
</li>
|
351
|
-
|
352
|
-
|
353
|
-
<li class="public ">
|
354
|
-
<span class="summary_signature">
|
355
|
-
|
356
|
-
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
357
|
-
|
358
|
-
|
359
|
-
|
360
|
-
</span>
|
361
|
-
|
362
|
-
|
363
|
-
|
364
|
-
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
|
369
|
-
|
370
|
-
<span class="summary_desc"><div class='inline'>
|
371
|
-
<p>Returns a list of all endpoint configurations on this account.</p>
|
372
|
-
</div></span>
|
373
|
-
|
374
|
-
</li>
|
375
|
-
|
376
|
-
|
377
|
-
<li class="public ">
|
378
|
-
<span class="summary_signature">
|
379
|
-
|
380
|
-
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
381
|
-
|
382
|
-
|
383
|
-
|
384
|
-
</span>
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
|
393
|
-
|
394
|
-
<span class="summary_desc"><div class='inline'>
|
395
|
-
<p>Returns a list of all endpoint configurations on this account Throws an exception if API error.</p>
|
329
|
+
<p>A new instance of EdgesHTTPSRoutesClient.</p>
|
396
330
|
</div></span>
|
397
331
|
|
398
332
|
</li>
|
@@ -401,7 +335,7 @@
|
|
401
335
|
<li class="public ">
|
402
336
|
<span class="summary_signature">
|
403
337
|
|
404
|
-
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(
|
338
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute </a>
|
405
339
|
|
406
340
|
|
407
341
|
|
@@ -416,7 +350,7 @@
|
|
416
350
|
|
417
351
|
|
418
352
|
<span class="summary_desc"><div class='inline'>
|
419
|
-
<p>Updates an
|
353
|
+
<p>Updates an HTTPS Edge Route by ID.</p>
|
420
354
|
</div></span>
|
421
355
|
|
422
356
|
</li>
|
@@ -425,7 +359,7 @@
|
|
425
359
|
<li class="public ">
|
426
360
|
<span class="summary_signature">
|
427
361
|
|
428
|
-
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(
|
362
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute </a>
|
429
363
|
|
430
364
|
|
431
365
|
|
@@ -440,7 +374,7 @@
|
|
440
374
|
|
441
375
|
|
442
376
|
<span class="summary_desc"><div class='inline'>
|
443
|
-
<p>Updates an
|
377
|
+
<p>Updates an HTTPS Edge Route by ID.</p>
|
444
378
|
</div></span>
|
445
379
|
|
446
380
|
</li>
|
@@ -455,7 +389,7 @@
|
|
455
389
|
<div class="method_details first">
|
456
390
|
<h3 class="signature first" id="initialize-instance_method">
|
457
391
|
|
458
|
-
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::
|
392
|
+
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::EdgesHTTPSRoutesClient (class)">EdgesHTTPSRoutesClient</a></span></tt>
|
459
393
|
|
460
394
|
|
461
395
|
|
@@ -464,7 +398,7 @@
|
|
464
398
|
</h3><div class="docstring">
|
465
399
|
<div class="discussion">
|
466
400
|
|
467
|
-
<p>Returns a new instance of
|
401
|
+
<p>Returns a new instance of EdgesHTTPSRoutesClient.</p>
|
468
402
|
|
469
403
|
|
470
404
|
</div>
|
@@ -478,12 +412,12 @@
|
|
478
412
|
<pre class="lines">
|
479
413
|
|
480
414
|
|
481
|
-
|
482
|
-
|
483
|
-
|
415
|
+
13
|
416
|
+
14
|
417
|
+
15</pre>
|
484
418
|
</td>
|
485
419
|
<td>
|
486
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
420
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 13</span>
|
487
421
|
|
488
422
|
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
|
489
423
|
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
@@ -526,12 +460,12 @@
|
|
526
460
|
<pre class="lines">
|
527
461
|
|
528
462
|
|
529
|
-
|
530
|
-
|
531
|
-
|
463
|
+
11
|
464
|
+
12
|
465
|
+
13</pre>
|
532
466
|
</td>
|
533
467
|
<td>
|
534
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
468
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 11</span>
|
535
469
|
|
536
470
|
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
537
471
|
<span class='ivar'>@client</span>
|
@@ -551,7 +485,7 @@
|
|
551
485
|
<div class="method_details first">
|
552
486
|
<h3 class="signature first" id="create-instance_method">
|
553
487
|
|
554
|
-
#<strong>create</strong>(
|
488
|
+
#<strong>create</strong>(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>
|
555
489
|
|
556
490
|
|
557
491
|
|
@@ -560,9 +494,9 @@
|
|
560
494
|
</h3><div class="docstring">
|
561
495
|
<div class="discussion">
|
562
496
|
|
563
|
-
<p>Create
|
497
|
+
<p>Create an HTTPS Edge Route</p>
|
564
498
|
|
565
|
-
<p><a href="https://ngrok.com/docs/api#api-
|
499
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-https-routes-create">ngrok.com/docs/api#api-edges-https-routes-create</a></p>
|
566
500
|
|
567
501
|
|
568
502
|
</div>
|
@@ -573,7 +507,7 @@
|
|
573
507
|
|
574
508
|
<li>
|
575
509
|
|
576
|
-
<span class='name'>
|
510
|
+
<span class='name'>edge_id</span>
|
577
511
|
|
578
512
|
|
579
513
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -584,32 +518,46 @@
|
|
584
518
|
|
585
519
|
—
|
586
520
|
<div class='inline'>
|
587
|
-
<p>
|
521
|
+
<p>unique identifier of this edge</p>
|
588
522
|
</div>
|
589
523
|
|
590
524
|
</li>
|
591
525
|
|
592
526
|
<li>
|
593
527
|
|
594
|
-
<span class='name'>
|
528
|
+
<span class='name'>match_type</span>
|
595
529
|
|
596
530
|
|
597
531
|
<span class='type'>(<tt>string</tt>)</span>
|
598
532
|
|
599
533
|
|
600
|
-
|
534
|
+
|
535
|
+
—
|
536
|
+
<div class='inline'>
|
537
|
+
<p>Type of match to use for this route. Valid values are “exact_path” and “path_prefix”.</p>
|
538
|
+
</div>
|
539
|
+
|
540
|
+
</li>
|
541
|
+
|
542
|
+
<li>
|
543
|
+
|
544
|
+
<span class='name'>match</span>
|
545
|
+
|
546
|
+
|
547
|
+
<span class='type'>(<tt>string</tt>)</span>
|
548
|
+
|
601
549
|
|
602
550
|
|
603
551
|
—
|
604
552
|
<div class='inline'>
|
605
|
-
<p>
|
553
|
+
<p>Route selector: “/blog” or “example.com” or “example.com/blog”</p>
|
606
554
|
</div>
|
607
555
|
|
608
556
|
</li>
|
609
557
|
|
610
558
|
<li>
|
611
559
|
|
612
|
-
<span class='name'>
|
560
|
+
<span class='name'>description</span>
|
613
561
|
|
614
562
|
|
615
563
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -620,35 +568,35 @@
|
|
620
568
|
|
621
569
|
—
|
622
570
|
<div class='inline'>
|
623
|
-
<p>
|
571
|
+
<p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
|
624
572
|
</div>
|
625
573
|
|
626
574
|
</li>
|
627
575
|
|
628
576
|
<li>
|
629
577
|
|
630
|
-
<span class='name'>
|
578
|
+
<span class='name'>metadata</span>
|
631
579
|
|
632
580
|
|
633
|
-
<span class='type'>(<tt>
|
581
|
+
<span class='type'>(<tt>string</tt>)</span>
|
634
582
|
|
635
583
|
|
636
|
-
<em class="default">(defaults to: <tt
|
584
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
637
585
|
|
638
586
|
|
639
587
|
—
|
640
588
|
<div class='inline'>
|
641
|
-
<p>
|
589
|
+
<p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
|
642
590
|
</div>
|
643
591
|
|
644
592
|
</li>
|
645
593
|
|
646
594
|
<li>
|
647
595
|
|
648
|
-
<span class='name'>
|
596
|
+
<span class='name'>backend</span>
|
649
597
|
|
650
598
|
|
651
|
-
<span class='type'>(<tt>
|
599
|
+
<span class='type'>(<tt>EndpointBackendMutate</tt>)</span>
|
652
600
|
|
653
601
|
|
654
602
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -656,17 +604,17 @@
|
|
656
604
|
|
657
605
|
—
|
658
606
|
<div class='inline'>
|
659
|
-
<p>
|
607
|
+
<p>backend module configuration or <code>null</code></p>
|
660
608
|
</div>
|
661
609
|
|
662
610
|
</li>
|
663
611
|
|
664
612
|
<li>
|
665
613
|
|
666
|
-
<span class='name'>
|
614
|
+
<span class='name'>ip_restriction</span>
|
667
615
|
|
668
616
|
|
669
|
-
<span class='type'>(<tt>
|
617
|
+
<span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
|
670
618
|
|
671
619
|
|
672
620
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -674,17 +622,17 @@
|
|
674
622
|
|
675
623
|
—
|
676
624
|
<div class='inline'>
|
677
|
-
<p>
|
625
|
+
<p>ip restriction module configuration or <code>null</code></p>
|
678
626
|
</div>
|
679
627
|
|
680
628
|
</li>
|
681
629
|
|
682
630
|
<li>
|
683
631
|
|
684
|
-
<span class='name'>
|
632
|
+
<span class='name'>circuit_breaker</span>
|
685
633
|
|
686
634
|
|
687
|
-
<span class='type'>(<tt>
|
635
|
+
<span class='type'>(<tt>EndpointCircuitBreaker</tt>)</span>
|
688
636
|
|
689
637
|
|
690
638
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -692,17 +640,17 @@
|
|
692
640
|
|
693
641
|
—
|
694
642
|
<div class='inline'>
|
695
|
-
<p>
|
643
|
+
<p>circuit breaker module configuration or <code>null</code></p>
|
696
644
|
</div>
|
697
645
|
|
698
646
|
</li>
|
699
647
|
|
700
648
|
<li>
|
701
649
|
|
702
|
-
<span class='name'>
|
650
|
+
<span class='name'>compression</span>
|
703
651
|
|
704
652
|
|
705
|
-
<span class='type'>(<tt>
|
653
|
+
<span class='type'>(<tt>EndpointCompression</tt>)</span>
|
706
654
|
|
707
655
|
|
708
656
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -710,17 +658,17 @@
|
|
710
658
|
|
711
659
|
—
|
712
660
|
<div class='inline'>
|
713
|
-
<p>
|
661
|
+
<p>compression module configuration or <code>null</code></p>
|
714
662
|
</div>
|
715
663
|
|
716
664
|
</li>
|
717
665
|
|
718
666
|
<li>
|
719
667
|
|
720
|
-
<span class='name'>
|
668
|
+
<span class='name'>request_headers</span>
|
721
669
|
|
722
670
|
|
723
|
-
<span class='type'>(<tt>
|
671
|
+
<span class='type'>(<tt>EndpointRequestHeaders</tt>)</span>
|
724
672
|
|
725
673
|
|
726
674
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -728,17 +676,17 @@
|
|
728
676
|
|
729
677
|
—
|
730
678
|
<div class='inline'>
|
731
|
-
<p>
|
679
|
+
<p>request headers module configuration or <code>null</code></p>
|
732
680
|
</div>
|
733
681
|
|
734
682
|
</li>
|
735
683
|
|
736
684
|
<li>
|
737
685
|
|
738
|
-
<span class='name'>
|
686
|
+
<span class='name'>response_headers</span>
|
739
687
|
|
740
688
|
|
741
|
-
<span class='type'>(<tt>
|
689
|
+
<span class='type'>(<tt>EndpointResponseHeaders</tt>)</span>
|
742
690
|
|
743
691
|
|
744
692
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -746,14 +694,14 @@
|
|
746
694
|
|
747
695
|
—
|
748
696
|
<div class='inline'>
|
749
|
-
<p>
|
697
|
+
<p>response headers module configuration or <code>null</code></p>
|
750
698
|
</div>
|
751
699
|
|
752
700
|
</li>
|
753
701
|
|
754
702
|
<li>
|
755
703
|
|
756
|
-
<span class='name'>
|
704
|
+
<span class='name'>webhook_verification</span>
|
757
705
|
|
758
706
|
|
759
707
|
<span class='type'>(<tt>EndpointWebhookValidation</tt>)</span>
|
@@ -764,7 +712,7 @@
|
|
764
712
|
|
765
713
|
—
|
766
714
|
<div class='inline'>
|
767
|
-
<p>webhook
|
715
|
+
<p>webhook verification module configuration or <code>null</code></p>
|
768
716
|
</div>
|
769
717
|
|
770
718
|
</li>
|
@@ -789,10 +737,10 @@
|
|
789
737
|
|
790
738
|
<li>
|
791
739
|
|
792
|
-
<span class='name'>
|
740
|
+
<span class='name'>saml</span>
|
793
741
|
|
794
742
|
|
795
|
-
<span class='type'>(<tt>
|
743
|
+
<span class='type'>(<tt>EndpointSAMLMutate</tt>)</span>
|
796
744
|
|
797
745
|
|
798
746
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -800,17 +748,17 @@
|
|
800
748
|
|
801
749
|
—
|
802
750
|
<div class='inline'>
|
803
|
-
<p>
|
751
|
+
<p>saml module configuration or <code>null</code></p>
|
804
752
|
</div>
|
805
753
|
|
806
754
|
</li>
|
807
755
|
|
808
756
|
<li>
|
809
757
|
|
810
|
-
<span class='name'>
|
758
|
+
<span class='name'>oidc</span>
|
811
759
|
|
812
760
|
|
813
|
-
<span class='type'>(<tt>
|
761
|
+
<span class='type'>(<tt>EndpointOIDC</tt>)</span>
|
814
762
|
|
815
763
|
|
816
764
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -818,17 +766,17 @@
|
|
818
766
|
|
819
767
|
—
|
820
768
|
<div class='inline'>
|
821
|
-
<p>
|
769
|
+
<p>oidc module configuration or <code>null</code></p>
|
822
770
|
</div>
|
823
771
|
|
824
772
|
</li>
|
825
773
|
|
826
774
|
<li>
|
827
775
|
|
828
|
-
<span class='name'>
|
776
|
+
<span class='name'>websocket_tcp_converter</span>
|
829
777
|
|
830
778
|
|
831
|
-
<span class='type'>(<tt>
|
779
|
+
<span class='type'>(<tt>EndpointWebsocketTCPConverter</tt>)</span>
|
832
780
|
|
833
781
|
|
834
782
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -836,7 +784,7 @@
|
|
836
784
|
|
837
785
|
—
|
838
786
|
<div class='inline'>
|
839
|
-
<p>
|
787
|
+
<p>websocket to tcp adapter configuration or <code>null</code></p>
|
840
788
|
</div>
|
841
789
|
|
842
790
|
</li>
|
@@ -849,7 +797,7 @@
|
|
849
797
|
<li>
|
850
798
|
|
851
799
|
|
852
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
800
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>)</span>
|
853
801
|
|
854
802
|
|
855
803
|
|
@@ -868,6 +816,11 @@
|
|
868
816
|
<pre class="lines">
|
869
817
|
|
870
818
|
|
819
|
+
39
|
820
|
+
40
|
821
|
+
41
|
822
|
+
42
|
823
|
+
43
|
871
824
|
44
|
872
825
|
45
|
873
826
|
46
|
@@ -886,37 +839,34 @@
|
|
886
839
|
59
|
887
840
|
60
|
888
841
|
61
|
889
|
-
62
|
890
|
-
63
|
891
|
-
64
|
892
|
-
65
|
893
|
-
66</pre>
|
842
|
+
62</pre>
|
894
843
|
</td>
|
895
844
|
<td>
|
896
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
845
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 39</span>
|
897
846
|
|
898
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>
|
899
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/
|
847
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match_type:</span><span class='comma'>,</span> <span class='label'>match:</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>webhook_verification:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>websocket_tcp_converter:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
848
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes</span><span class='tstring_end'>'</span></span>
|
900
849
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
850
|
+
<span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
|
901
851
|
<span class='rbrace'>}</span>
|
902
852
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
903
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:
|
853
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:match_type</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_match_type'>match_type</span> <span class='kw'>if</span> <span class='id identifier rubyid_match_type'>match_type</span>
|
854
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:match</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_match'>match</span> <span class='kw'>if</span> <span class='id identifier rubyid_match'>match</span>
|
904
855
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
905
856
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
857
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:backend</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_backend'>backend</span> <span class='kw'>if</span> <span class='id identifier rubyid_backend'>backend</span>
|
858
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_restriction</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span>
|
906
859
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:circuit_breaker</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span> <span class='kw'>if</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span>
|
907
860
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:compression</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_compression'>compression</span> <span class='kw'>if</span> <span class='id identifier rubyid_compression'>compression</span>
|
908
861
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:request_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_request_headers'>request_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_request_headers'>request_headers</span>
|
909
862
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:response_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_response_headers'>response_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_response_headers'>response_headers</span>
|
910
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:
|
911
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:mutual_tls</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span> <span class='kw'>if</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span>
|
912
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:tls_termination</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span> <span class='kw'>if</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span>
|
913
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:webhook_validation</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span> <span class='kw'>if</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span>
|
863
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:webhook_verification</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_webhook_verification'>webhook_verification</span> <span class='kw'>if</span> <span class='id identifier rubyid_webhook_verification'>webhook_verification</span>
|
914
864
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oauth</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth'>oauth</span> <span class='kw'>if</span> <span class='id identifier rubyid_oauth'>oauth</span>
|
915
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:logging</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_logging'>logging</span> <span class='kw'>if</span> <span class='id identifier rubyid_logging'>logging</span>
|
916
865
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:saml</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_saml'>saml</span> <span class='kw'>if</span> <span class='id identifier rubyid_saml'>saml</span>
|
917
866
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oidc</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oidc'>oidc</span> <span class='kw'>if</span> <span class='id identifier rubyid_oidc'>oidc</span>
|
867
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:websocket_tcp_converter</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_websocket_tcp_converter'>websocket_tcp_converter</span> <span class='kw'>if</span> <span class='id identifier rubyid_websocket_tcp_converter'>websocket_tcp_converter</span>
|
918
868
|
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
919
|
-
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/
|
869
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">HTTPSEdgeRoute</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html#initialize-instance_method" title="NgrokAPI::Models::HTTPSEdgeRoute#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
920
870
|
<span class='kw'>end</span></pre>
|
921
871
|
</td>
|
922
872
|
</tr>
|
@@ -926,7 +876,7 @@
|
|
926
876
|
<div class="method_details ">
|
927
877
|
<h3 class="signature " id="delete-instance_method">
|
928
878
|
|
929
|
-
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
879
|
+
#<strong>delete</strong>(edge_id: "", id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
930
880
|
|
931
881
|
|
932
882
|
|
@@ -935,9 +885,9 @@
|
|
935
885
|
</h3><div class="docstring">
|
936
886
|
<div class="discussion">
|
937
887
|
|
938
|
-
<p>Delete an
|
888
|
+
<p>Delete an HTTPS Edge Route by ID</p>
|
939
889
|
|
940
|
-
<p><a href="https://ngrok.com/docs/api#api-
|
890
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-https-routes-delete">ngrok.com/docs/api#api-edges-https-routes-delete</a></p>
|
941
891
|
|
942
892
|
|
943
893
|
</div>
|
@@ -946,6 +896,24 @@
|
|
946
896
|
<p class="tag_title">Parameters:</p>
|
947
897
|
<ul class="param">
|
948
898
|
|
899
|
+
<li>
|
900
|
+
|
901
|
+
<span class='name'>edge_id</span>
|
902
|
+
|
903
|
+
|
904
|
+
<span class='type'>(<tt>string</tt>)</span>
|
905
|
+
|
906
|
+
|
907
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
908
|
+
|
909
|
+
|
910
|
+
—
|
911
|
+
<div class='inline'>
|
912
|
+
<p>unique identifier of this edge</p>
|
913
|
+
</div>
|
914
|
+
|
915
|
+
</li>
|
916
|
+
|
949
917
|
<li>
|
950
918
|
|
951
919
|
<span class='name'>id</span>
|
@@ -959,7 +927,7 @@
|
|
959
927
|
|
960
928
|
—
|
961
929
|
<div class='inline'>
|
962
|
-
<p>
|
930
|
+
<p>unique identifier of this edge route</p>
|
963
931
|
</div>
|
964
932
|
|
965
933
|
</li>
|
@@ -991,20 +959,22 @@
|
|
991
959
|
<pre class="lines">
|
992
960
|
|
993
961
|
|
994
|
-
|
995
|
-
|
996
|
-
|
997
|
-
|
998
|
-
|
999
|
-
|
1000
|
-
|
962
|
+
216
|
963
|
+
217
|
964
|
+
218
|
965
|
+
219
|
966
|
+
220
|
967
|
+
221
|
968
|
+
222
|
969
|
+
223</pre>
|
1001
970
|
</td>
|
1002
971
|
<td>
|
1003
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
972
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 216</span>
|
1004
973
|
|
1005
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
1006
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/
|
974
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
975
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes/%{id}</span><span class='tstring_end'>'</span></span>
|
1007
976
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
977
|
+
<span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
|
1008
978
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1009
979
|
<span class='rbrace'>}</span>
|
1010
980
|
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='rparen'>)</span>
|
@@ -1017,7 +987,7 @@
|
|
1017
987
|
<div class="method_details ">
|
1018
988
|
<h3 class="signature " id="delete!-instance_method">
|
1019
989
|
|
1020
|
-
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
990
|
+
#<strong>delete!</strong>(edge_id: "", id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
1021
991
|
|
1022
992
|
|
1023
993
|
|
@@ -1026,9 +996,9 @@
|
|
1026
996
|
</h3><div class="docstring">
|
1027
997
|
<div class="discussion">
|
1028
998
|
|
1029
|
-
<p>Delete an
|
999
|
+
<p>Delete an HTTPS Edge Route by ID Throws an exception if API error.</p>
|
1030
1000
|
|
1031
|
-
<p><a href="https://ngrok.com/docs/api#api-
|
1001
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-https-routes-delete">ngrok.com/docs/api#api-edges-https-routes-delete</a></p>
|
1032
1002
|
|
1033
1003
|
|
1034
1004
|
</div>
|
@@ -1037,6 +1007,24 @@
|
|
1037
1007
|
<p class="tag_title">Parameters:</p>
|
1038
1008
|
<ul class="param">
|
1039
1009
|
|
1010
|
+
<li>
|
1011
|
+
|
1012
|
+
<span class='name'>edge_id</span>
|
1013
|
+
|
1014
|
+
|
1015
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1016
|
+
|
1017
|
+
|
1018
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1019
|
+
|
1020
|
+
|
1021
|
+
—
|
1022
|
+
<div class='inline'>
|
1023
|
+
<p>unique identifier of this edge</p>
|
1024
|
+
</div>
|
1025
|
+
|
1026
|
+
</li>
|
1027
|
+
|
1040
1028
|
<li>
|
1041
1029
|
|
1042
1030
|
<span class='name'>id</span>
|
@@ -1050,7 +1038,7 @@
|
|
1050
1038
|
|
1051
1039
|
—
|
1052
1040
|
<div class='inline'>
|
1053
|
-
<p>
|
1041
|
+
<p>unique identifier of this edge route</p>
|
1054
1042
|
</div>
|
1055
1043
|
|
1056
1044
|
</li>
|
@@ -1082,20 +1070,22 @@
|
|
1082
1070
|
<pre class="lines">
|
1083
1071
|
|
1084
1072
|
|
1085
|
-
|
1086
|
-
|
1087
|
-
|
1088
|
-
|
1089
|
-
|
1090
|
-
|
1091
|
-
|
1073
|
+
234
|
1074
|
+
235
|
1075
|
+
236
|
1076
|
+
237
|
1077
|
+
238
|
1078
|
+
239
|
1079
|
+
240
|
1080
|
+
241</pre>
|
1092
1081
|
</td>
|
1093
1082
|
<td>
|
1094
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
1083
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 234</span>
|
1095
1084
|
|
1096
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
1097
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/
|
1085
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
1086
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes/%{id}</span><span class='tstring_end'>'</span></span>
|
1098
1087
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1088
|
+
<span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
|
1099
1089
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1100
1090
|
<span class='rbrace'>}</span>
|
1101
1091
|
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
@@ -1108,7 +1098,7 @@
|
|
1108
1098
|
<div class="method_details ">
|
1109
1099
|
<h3 class="signature " id="get-instance_method">
|
1110
1100
|
|
1111
|
-
#<strong>get</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/
|
1101
|
+
#<strong>get</strong>(edge_id: "", id: "") ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>
|
1112
1102
|
|
1113
1103
|
|
1114
1104
|
|
@@ -1117,9 +1107,9 @@
|
|
1117
1107
|
</h3><div class="docstring">
|
1118
1108
|
<div class="discussion">
|
1119
1109
|
|
1120
|
-
<p>
|
1110
|
+
<p>Get an HTTPS Edge Route by ID</p>
|
1121
1111
|
|
1122
|
-
<p><a href="https://ngrok.com/docs/api#api-
|
1112
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-https-routes-get">ngrok.com/docs/api#api-edges-https-routes-get</a></p>
|
1123
1113
|
|
1124
1114
|
|
1125
1115
|
</div>
|
@@ -1128,6 +1118,24 @@
|
|
1128
1118
|
<p class="tag_title">Parameters:</p>
|
1129
1119
|
<ul class="param">
|
1130
1120
|
|
1121
|
+
<li>
|
1122
|
+
|
1123
|
+
<span class='name'>edge_id</span>
|
1124
|
+
|
1125
|
+
|
1126
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1127
|
+
|
1128
|
+
|
1129
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1130
|
+
|
1131
|
+
|
1132
|
+
—
|
1133
|
+
<div class='inline'>
|
1134
|
+
<p>unique identifier of this edge</p>
|
1135
|
+
</div>
|
1136
|
+
|
1137
|
+
</li>
|
1138
|
+
|
1131
1139
|
<li>
|
1132
1140
|
|
1133
1141
|
<span class='name'>id</span>
|
@@ -1141,7 +1149,7 @@
|
|
1141
1149
|
|
1142
1150
|
—
|
1143
1151
|
<div class='inline'>
|
1144
|
-
<p>
|
1152
|
+
<p>unique identifier of this edge route</p>
|
1145
1153
|
</div>
|
1146
1154
|
|
1147
1155
|
</li>
|
@@ -1154,7 +1162,7 @@
|
|
1154
1162
|
<li>
|
1155
1163
|
|
1156
1164
|
|
1157
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
1165
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>)</span>
|
1158
1166
|
|
1159
1167
|
|
1160
1168
|
|
@@ -1173,27 +1181,29 @@
|
|
1173
1181
|
<pre class="lines">
|
1174
1182
|
|
1175
1183
|
|
1176
|
-
|
1177
|
-
|
1178
|
-
|
1179
|
-
|
1180
|
-
|
1181
|
-
|
1182
|
-
|
1183
|
-
|
1184
|
-
|
1184
|
+
72
|
1185
|
+
73
|
1186
|
+
74
|
1187
|
+
75
|
1188
|
+
76
|
1189
|
+
77
|
1190
|
+
78
|
1191
|
+
79
|
1192
|
+
80
|
1193
|
+
81</pre>
|
1185
1194
|
</td>
|
1186
1195
|
<td>
|
1187
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
1196
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 72</span>
|
1188
1197
|
|
1189
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
1190
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/
|
1198
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
1199
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes/%{id}</span><span class='tstring_end'>'</span></span>
|
1191
1200
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1201
|
+
<span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
|
1192
1202
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1193
1203
|
<span class='rbrace'>}</span>
|
1194
1204
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1195
1205
|
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
1196
|
-
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/
|
1206
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">HTTPSEdgeRoute</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html#initialize-instance_method" title="NgrokAPI::Models::HTTPSEdgeRoute#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
1197
1207
|
<span class='kw'>end</span></pre>
|
1198
1208
|
</td>
|
1199
1209
|
</tr>
|
@@ -1203,7 +1213,7 @@
|
|
1203
1213
|
<div class="method_details ">
|
1204
1214
|
<h3 class="signature " id="get!-instance_method">
|
1205
1215
|
|
1206
|
-
#<strong>get!</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/
|
1216
|
+
#<strong>get!</strong>(edge_id: "", id: "") ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>
|
1207
1217
|
|
1208
1218
|
|
1209
1219
|
|
@@ -1212,9 +1222,9 @@
|
|
1212
1222
|
</h3><div class="docstring">
|
1213
1223
|
<div class="discussion">
|
1214
1224
|
|
1215
|
-
<p>
|
1225
|
+
<p>Get an HTTPS Edge Route by ID Throws an exception if API error.</p>
|
1216
1226
|
|
1217
|
-
<p><a href="https://ngrok.com/docs/api#api-
|
1227
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-https-routes-get">ngrok.com/docs/api#api-edges-https-routes-get</a></p>
|
1218
1228
|
|
1219
1229
|
|
1220
1230
|
</div>
|
@@ -1223,6 +1233,24 @@
|
|
1223
1233
|
<p class="tag_title">Parameters:</p>
|
1224
1234
|
<ul class="param">
|
1225
1235
|
|
1236
|
+
<li>
|
1237
|
+
|
1238
|
+
<span class='name'>edge_id</span>
|
1239
|
+
|
1240
|
+
|
1241
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1242
|
+
|
1243
|
+
|
1244
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1245
|
+
|
1246
|
+
|
1247
|
+
—
|
1248
|
+
<div class='inline'>
|
1249
|
+
<p>unique identifier of this edge</p>
|
1250
|
+
</div>
|
1251
|
+
|
1252
|
+
</li>
|
1253
|
+
|
1226
1254
|
<li>
|
1227
1255
|
|
1228
1256
|
<span class='name'>id</span>
|
@@ -1236,7 +1264,7 @@
|
|
1236
1264
|
|
1237
1265
|
—
|
1238
1266
|
<div class='inline'>
|
1239
|
-
<p>
|
1267
|
+
<p>unique identifier of this edge route</p>
|
1240
1268
|
</div>
|
1241
1269
|
|
1242
1270
|
</li>
|
@@ -1249,7 +1277,7 @@
|
|
1249
1277
|
<li>
|
1250
1278
|
|
1251
1279
|
|
1252
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
1280
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>)</span>
|
1253
1281
|
|
1254
1282
|
|
1255
1283
|
|
@@ -1268,27 +1296,29 @@
|
|
1268
1296
|
<pre class="lines">
|
1269
1297
|
|
1270
1298
|
|
1271
|
-
|
1272
|
-
|
1273
|
-
|
1274
|
-
|
1275
|
-
|
1276
|
-
|
1277
|
-
|
1278
|
-
|
1279
|
-
|
1299
|
+
92
|
1300
|
+
93
|
1301
|
+
94
|
1302
|
+
95
|
1303
|
+
96
|
1304
|
+
97
|
1305
|
+
98
|
1306
|
+
99
|
1307
|
+
100
|
1308
|
+
101</pre>
|
1280
1309
|
</td>
|
1281
1310
|
<td>
|
1282
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
1311
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 92</span>
|
1283
1312
|
|
1284
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
1285
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/
|
1313
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
1314
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes/%{id}</span><span class='tstring_end'>'</span></span>
|
1286
1315
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1316
|
+
<span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
|
1287
1317
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1288
1318
|
<span class='rbrace'>}</span>
|
1289
1319
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1290
1320
|
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
1291
|
-
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/
|
1321
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">HTTPSEdgeRoute</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html#initialize-instance_method" title="NgrokAPI::Models::HTTPSEdgeRoute#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
1292
1322
|
<span class='kw'>end</span></pre>
|
1293
1323
|
</td>
|
1294
1324
|
</tr>
|
@@ -1296,9 +1326,9 @@
|
|
1296
1326
|
</div>
|
1297
1327
|
|
1298
1328
|
<div class="method_details ">
|
1299
|
-
<h3 class="signature " id="
|
1329
|
+
<h3 class="signature " id="update-instance_method">
|
1300
1330
|
|
1301
|
-
#<strong>
|
1331
|
+
#<strong>update</strong>(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>
|
1302
1332
|
|
1303
1333
|
|
1304
1334
|
|
@@ -1307,9 +1337,9 @@
|
|
1307
1337
|
</h3><div class="docstring">
|
1308
1338
|
<div class="discussion">
|
1309
1339
|
|
1310
|
-
<p>
|
1340
|
+
<p>Updates an HTTPS Edge Route by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.</p>
|
1311
1341
|
|
1312
|
-
<p><a href="https://ngrok.com/docs/api#api-
|
1342
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-https-routes-update">ngrok.com/docs/api#api-edges-https-routes-update</a></p>
|
1313
1343
|
|
1314
1344
|
|
1315
1345
|
</div>
|
@@ -1320,281 +1350,97 @@
|
|
1320
1350
|
|
1321
1351
|
<li>
|
1322
1352
|
|
1323
|
-
<span class='name'>
|
1353
|
+
<span class='name'>edge_id</span>
|
1324
1354
|
|
1325
1355
|
|
1326
1356
|
<span class='type'>(<tt>string</tt>)</span>
|
1327
1357
|
|
1328
1358
|
|
1329
|
-
<em class="default">(defaults to: <tt
|
1359
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1360
|
+
|
1330
1361
|
|
1362
|
+
—
|
1363
|
+
<div class='inline'>
|
1364
|
+
<p>unique identifier of this edge</p>
|
1365
|
+
</div>
|
1331
1366
|
|
1332
1367
|
</li>
|
1333
1368
|
|
1334
1369
|
<li>
|
1335
1370
|
|
1336
|
-
<span class='name'>
|
1371
|
+
<span class='name'>id</span>
|
1337
1372
|
|
1338
1373
|
|
1339
1374
|
<span class='type'>(<tt>string</tt>)</span>
|
1340
1375
|
|
1341
1376
|
|
1342
|
-
<em class="default">(defaults to: <tt
|
1377
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1343
1378
|
|
1344
1379
|
|
1380
|
+
—
|
1381
|
+
<div class='inline'>
|
1382
|
+
<p>unique identifier of this edge route</p>
|
1383
|
+
</div>
|
1384
|
+
|
1345
1385
|
</li>
|
1346
1386
|
|
1347
1387
|
<li>
|
1348
1388
|
|
1349
|
-
<span class='name'>
|
1389
|
+
<span class='name'>match_type</span>
|
1350
1390
|
|
1351
1391
|
|
1352
1392
|
<span class='type'>(<tt>string</tt>)</span>
|
1353
1393
|
|
1354
1394
|
|
1355
|
-
<em class="default">(defaults to: <tt
|
1395
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1356
1396
|
|
1357
1397
|
|
1358
1398
|
—
|
1359
1399
|
<div class='inline'>
|
1360
|
-
<p>
|
1400
|
+
<p>Type of match to use for this route. Valid values are “exact_path” and “path_prefix”.</p>
|
1361
1401
|
</div>
|
1362
1402
|
|
1363
1403
|
</li>
|
1364
1404
|
|
1365
|
-
</ul>
|
1366
|
-
|
1367
|
-
<p class="tag_title">Returns:</p>
|
1368
|
-
<ul class="return">
|
1369
|
-
|
1370
1405
|
<li>
|
1371
1406
|
|
1407
|
+
<span class='name'>match</span>
|
1408
|
+
|
1409
|
+
|
1410
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1372
1411
|
|
1373
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
|
1374
1412
|
|
1413
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1375
1414
|
|
1376
1415
|
|
1377
1416
|
—
|
1378
1417
|
<div class='inline'>
|
1379
|
-
<p>
|
1418
|
+
<p>Route selector: “/blog” or “example.com” or “example.com/blog”</p>
|
1380
1419
|
</div>
|
1381
1420
|
|
1382
1421
|
</li>
|
1383
1422
|
|
1384
|
-
</ul>
|
1385
|
-
|
1386
|
-
</div><table class="source_code">
|
1387
|
-
<tr>
|
1388
|
-
<td>
|
1389
|
-
<pre class="lines">
|
1390
|
-
|
1391
|
-
|
1392
|
-
145
|
1393
|
-
146
|
1394
|
-
147
|
1395
|
-
148
|
1396
|
-
149
|
1397
|
-
150
|
1398
|
-
151
|
1399
|
-
152
|
1400
|
-
153
|
1401
|
-
154
|
1402
|
-
155
|
1403
|
-
156
|
1404
|
-
157
|
1405
|
-
158
|
1406
|
-
159
|
1407
|
-
160</pre>
|
1408
|
-
</td>
|
1409
|
-
<td>
|
1410
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 145</span>
|
1411
|
-
|
1412
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
1413
|
-
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1414
|
-
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
1415
|
-
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
1416
|
-
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
1417
|
-
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
1418
|
-
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::PATH (constant)">PATH</a></span></span>
|
1419
|
-
<span class='rparen'>)</span>
|
1420
|
-
|
1421
|
-
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
|
1422
|
-
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
1423
|
-
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
1424
|
-
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
1425
|
-
<span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span>
|
1426
|
-
<span class='rparen'>)</span>
|
1427
|
-
<span class='kw'>end</span></pre>
|
1428
|
-
</td>
|
1429
|
-
</tr>
|
1430
|
-
</table>
|
1431
|
-
</div>
|
1432
|
-
|
1433
|
-
<div class="method_details ">
|
1434
|
-
<h3 class="signature " id="list!-instance_method">
|
1435
|
-
|
1436
|
-
#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
1437
|
-
|
1438
|
-
|
1439
|
-
|
1440
|
-
|
1441
|
-
|
1442
|
-
</h3><div class="docstring">
|
1443
|
-
<div class="discussion">
|
1444
|
-
|
1445
|
-
<p>Returns a list of all endpoint configurations on this account Throws an exception if API error.</p>
|
1446
|
-
|
1447
|
-
<p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-list">ngrok.com/docs/api#api-endpoint-configurations-list</a></p>
|
1448
|
-
|
1449
|
-
|
1450
|
-
</div>
|
1451
|
-
</div>
|
1452
|
-
<div class="tags">
|
1453
|
-
<p class="tag_title">Parameters:</p>
|
1454
|
-
<ul class="param">
|
1455
|
-
|
1456
|
-
<li>
|
1457
|
-
|
1458
|
-
<span class='name'>before_id</span>
|
1459
|
-
|
1460
|
-
|
1461
|
-
<span class='type'>(<tt>string</tt>)</span>
|
1462
|
-
|
1463
|
-
|
1464
|
-
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1465
|
-
|
1466
|
-
|
1467
|
-
</li>
|
1468
|
-
|
1469
1423
|
<li>
|
1470
1424
|
|
1471
|
-
<span class='name'>
|
1472
|
-
|
1473
|
-
|
1474
|
-
<span class='type'>(<tt>string</tt>)</span>
|
1475
|
-
|
1476
|
-
|
1477
|
-
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1478
|
-
|
1479
|
-
|
1480
|
-
</li>
|
1481
|
-
|
1482
|
-
<li>
|
1483
|
-
|
1484
|
-
<span class='name'>url</span>
|
1425
|
+
<span class='name'>description</span>
|
1485
1426
|
|
1486
1427
|
|
1487
1428
|
<span class='type'>(<tt>string</tt>)</span>
|
1488
1429
|
|
1489
1430
|
|
1490
|
-
<em class="default">(defaults to: <tt
|
1491
|
-
|
1492
|
-
|
1493
|
-
—
|
1494
|
-
<div class='inline'>
|
1495
|
-
<p>optional and mutually exclusive from before_id and limit</p>
|
1496
|
-
</div>
|
1497
|
-
|
1498
|
-
</li>
|
1499
|
-
|
1500
|
-
</ul>
|
1501
|
-
|
1502
|
-
<p class="tag_title">Returns:</p>
|
1503
|
-
<ul class="return">
|
1504
|
-
|
1505
|
-
<li>
|
1506
|
-
|
1507
|
-
|
1508
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
|
1509
|
-
|
1431
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1510
1432
|
|
1511
1433
|
|
1512
1434
|
—
|
1513
1435
|
<div class='inline'>
|
1514
|
-
<p>
|
1436
|
+
<p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
|
1515
1437
|
</div>
|
1516
1438
|
|
1517
1439
|
</li>
|
1518
1440
|
|
1519
|
-
</ul>
|
1520
|
-
|
1521
|
-
</div><table class="source_code">
|
1522
|
-
<tr>
|
1523
|
-
<td>
|
1524
|
-
<pre class="lines">
|
1525
|
-
|
1526
|
-
|
1527
|
-
172
|
1528
|
-
173
|
1529
|
-
174
|
1530
|
-
175
|
1531
|
-
176
|
1532
|
-
177
|
1533
|
-
178
|
1534
|
-
179
|
1535
|
-
180
|
1536
|
-
181
|
1537
|
-
182
|
1538
|
-
183
|
1539
|
-
184
|
1540
|
-
185
|
1541
|
-
186
|
1542
|
-
187
|
1543
|
-
188
|
1544
|
-
189</pre>
|
1545
|
-
</td>
|
1546
|
-
<td>
|
1547
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 172</span>
|
1548
|
-
|
1549
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
1550
|
-
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1551
|
-
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
1552
|
-
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
1553
|
-
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
1554
|
-
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
1555
|
-
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
1556
|
-
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::PATH (constant)">PATH</a></span></span>
|
1557
|
-
<span class='rparen'>)</span>
|
1558
|
-
|
1559
|
-
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
|
1560
|
-
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
1561
|
-
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
1562
|
-
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EndpointConfigurationsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
1563
|
-
<span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span></span><span class='comma'>,</span>
|
1564
|
-
<span class='label'>danger:</span> <span class='kw'>true</span>
|
1565
|
-
<span class='rparen'>)</span>
|
1566
|
-
<span class='kw'>end</span></pre>
|
1567
|
-
</td>
|
1568
|
-
</tr>
|
1569
|
-
</table>
|
1570
|
-
</div>
|
1571
|
-
|
1572
|
-
<div class="method_details ">
|
1573
|
-
<h3 class="signature " id="update-instance_method">
|
1574
|
-
|
1575
|
-
#<strong>update</strong>(id: "", description: nil, metadata: nil, basic_auth: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil, backend: nil) ⇒ <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
|
1576
|
-
|
1577
|
-
|
1578
|
-
|
1579
|
-
|
1580
|
-
|
1581
|
-
</h3><div class="docstring">
|
1582
|
-
<div class="discussion">
|
1583
|
-
|
1584
|
-
<p>Updates an endpoint configuration. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.</p>
|
1585
|
-
|
1586
|
-
<p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-update">ngrok.com/docs/api#api-endpoint-configurations-update</a></p>
|
1587
|
-
|
1588
|
-
|
1589
|
-
</div>
|
1590
|
-
</div>
|
1591
|
-
<div class="tags">
|
1592
|
-
<p class="tag_title">Parameters:</p>
|
1593
|
-
<ul class="param">
|
1594
|
-
|
1595
1441
|
<li>
|
1596
1442
|
|
1597
|
-
<span class='name'>
|
1443
|
+
<span class='name'>metadata</span>
|
1598
1444
|
|
1599
1445
|
|
1600
1446
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -1605,17 +1451,17 @@
|
|
1605
1451
|
|
1606
1452
|
—
|
1607
1453
|
<div class='inline'>
|
1608
|
-
<p>
|
1454
|
+
<p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
|
1609
1455
|
</div>
|
1610
1456
|
|
1611
1457
|
</li>
|
1612
1458
|
|
1613
1459
|
<li>
|
1614
1460
|
|
1615
|
-
<span class='name'>
|
1461
|
+
<span class='name'>backend</span>
|
1616
1462
|
|
1617
1463
|
|
1618
|
-
<span class='type'>(<tt>
|
1464
|
+
<span class='type'>(<tt>EndpointBackendMutate</tt>)</span>
|
1619
1465
|
|
1620
1466
|
|
1621
1467
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -1623,17 +1469,17 @@
|
|
1623
1469
|
|
1624
1470
|
—
|
1625
1471
|
<div class='inline'>
|
1626
|
-
<p>
|
1472
|
+
<p>backend module configuration or <code>null</code></p>
|
1627
1473
|
</div>
|
1628
1474
|
|
1629
1475
|
</li>
|
1630
1476
|
|
1631
1477
|
<li>
|
1632
1478
|
|
1633
|
-
<span class='name'>
|
1479
|
+
<span class='name'>ip_restriction</span>
|
1634
1480
|
|
1635
1481
|
|
1636
|
-
<span class='type'>(<tt>
|
1482
|
+
<span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
|
1637
1483
|
|
1638
1484
|
|
1639
1485
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -1641,7 +1487,7 @@
|
|
1641
1487
|
|
1642
1488
|
—
|
1643
1489
|
<div class='inline'>
|
1644
|
-
<p>
|
1490
|
+
<p>ip restriction module configuration or <code>null</code></p>
|
1645
1491
|
</div>
|
1646
1492
|
|
1647
1493
|
</li>
|
@@ -1720,61 +1566,7 @@
|
|
1720
1566
|
|
1721
1567
|
<li>
|
1722
1568
|
|
1723
|
-
<span class='name'>
|
1724
|
-
|
1725
|
-
|
1726
|
-
<span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
|
1727
|
-
|
1728
|
-
|
1729
|
-
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1730
|
-
|
1731
|
-
|
1732
|
-
—
|
1733
|
-
<div class='inline'>
|
1734
|
-
<p>ip policy module configuration or <code>null</code></p>
|
1735
|
-
</div>
|
1736
|
-
|
1737
|
-
</li>
|
1738
|
-
|
1739
|
-
<li>
|
1740
|
-
|
1741
|
-
<span class='name'>mutual_tls</span>
|
1742
|
-
|
1743
|
-
|
1744
|
-
<span class='type'>(<tt>EndpointMutualTLSMutate</tt>)</span>
|
1745
|
-
|
1746
|
-
|
1747
|
-
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1748
|
-
|
1749
|
-
|
1750
|
-
—
|
1751
|
-
<div class='inline'>
|
1752
|
-
<p>mutual TLS module configuration or <code>null</code></p>
|
1753
|
-
</div>
|
1754
|
-
|
1755
|
-
</li>
|
1756
|
-
|
1757
|
-
<li>
|
1758
|
-
|
1759
|
-
<span class='name'>tls_termination</span>
|
1760
|
-
|
1761
|
-
|
1762
|
-
<span class='type'>(<tt>EndpointTLSTermination</tt>)</span>
|
1763
|
-
|
1764
|
-
|
1765
|
-
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1766
|
-
|
1767
|
-
|
1768
|
-
—
|
1769
|
-
<div class='inline'>
|
1770
|
-
<p>TLS termination module configuration or <code>null</code></p>
|
1771
|
-
</div>
|
1772
|
-
|
1773
|
-
</li>
|
1774
|
-
|
1775
|
-
<li>
|
1776
|
-
|
1777
|
-
<span class='name'>webhook_validation</span>
|
1569
|
+
<span class='name'>webhook_verification</span>
|
1778
1570
|
|
1779
1571
|
|
1780
1572
|
<span class='type'>(<tt>EndpointWebhookValidation</tt>)</span>
|
@@ -1785,7 +1577,7 @@
|
|
1785
1577
|
|
1786
1578
|
—
|
1787
1579
|
<div class='inline'>
|
1788
|
-
<p>webhook
|
1580
|
+
<p>webhook verification module configuration or <code>null</code></p>
|
1789
1581
|
</div>
|
1790
1582
|
|
1791
1583
|
</li>
|
@@ -1810,10 +1602,10 @@
|
|
1810
1602
|
|
1811
1603
|
<li>
|
1812
1604
|
|
1813
|
-
<span class='name'>
|
1605
|
+
<span class='name'>saml</span>
|
1814
1606
|
|
1815
1607
|
|
1816
|
-
<span class='type'>(<tt>
|
1608
|
+
<span class='type'>(<tt>EndpointSAMLMutate</tt>)</span>
|
1817
1609
|
|
1818
1610
|
|
1819
1611
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -1821,17 +1613,17 @@
|
|
1821
1613
|
|
1822
1614
|
—
|
1823
1615
|
<div class='inline'>
|
1824
|
-
<p>
|
1616
|
+
<p>saml module configuration or <code>null</code></p>
|
1825
1617
|
</div>
|
1826
1618
|
|
1827
1619
|
</li>
|
1828
1620
|
|
1829
1621
|
<li>
|
1830
1622
|
|
1831
|
-
<span class='name'>
|
1623
|
+
<span class='name'>oidc</span>
|
1832
1624
|
|
1833
1625
|
|
1834
|
-
<span class='type'>(<tt>
|
1626
|
+
<span class='type'>(<tt>EndpointOIDC</tt>)</span>
|
1835
1627
|
|
1836
1628
|
|
1837
1629
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -1839,17 +1631,17 @@
|
|
1839
1631
|
|
1840
1632
|
—
|
1841
1633
|
<div class='inline'>
|
1842
|
-
<p>
|
1634
|
+
<p>oidc module configuration or <code>null</code></p>
|
1843
1635
|
</div>
|
1844
1636
|
|
1845
1637
|
</li>
|
1846
1638
|
|
1847
1639
|
<li>
|
1848
1640
|
|
1849
|
-
<span class='name'>
|
1641
|
+
<span class='name'>websocket_tcp_converter</span>
|
1850
1642
|
|
1851
1643
|
|
1852
|
-
<span class='type'>(<tt>
|
1644
|
+
<span class='type'>(<tt>EndpointWebsocketTCPConverter</tt>)</span>
|
1853
1645
|
|
1854
1646
|
|
1855
1647
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -1857,7 +1649,7 @@
|
|
1857
1649
|
|
1858
1650
|
—
|
1859
1651
|
<div class='inline'>
|
1860
|
-
<p>
|
1652
|
+
<p>websocket to tcp adapter configuration or <code>null</code></p>
|
1861
1653
|
</div>
|
1862
1654
|
|
1863
1655
|
</li>
|
@@ -1870,7 +1662,7 @@
|
|
1870
1662
|
<li>
|
1871
1663
|
|
1872
1664
|
|
1873
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
1665
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>)</span>
|
1874
1666
|
|
1875
1667
|
|
1876
1668
|
|
@@ -1889,55 +1681,59 @@
|
|
1889
1681
|
<pre class="lines">
|
1890
1682
|
|
1891
1683
|
|
1892
|
-
|
1893
|
-
|
1894
|
-
|
1895
|
-
|
1896
|
-
|
1897
|
-
|
1898
|
-
|
1899
|
-
|
1900
|
-
|
1901
|
-
|
1902
|
-
|
1903
|
-
|
1904
|
-
|
1905
|
-
|
1906
|
-
|
1907
|
-
|
1908
|
-
|
1909
|
-
|
1910
|
-
|
1911
|
-
|
1912
|
-
|
1913
|
-
|
1914
|
-
|
1684
|
+
129
|
1685
|
+
130
|
1686
|
+
131
|
1687
|
+
132
|
1688
|
+
133
|
1689
|
+
134
|
1690
|
+
135
|
1691
|
+
136
|
1692
|
+
137
|
1693
|
+
138
|
1694
|
+
139
|
1695
|
+
140
|
1696
|
+
141
|
1697
|
+
142
|
1698
|
+
143
|
1699
|
+
144
|
1700
|
+
145
|
1701
|
+
146
|
1702
|
+
147
|
1703
|
+
148
|
1704
|
+
149
|
1705
|
+
150
|
1706
|
+
151
|
1707
|
+
152
|
1708
|
+
153</pre>
|
1915
1709
|
</td>
|
1916
1710
|
<td>
|
1917
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
1711
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 129</span>
|
1918
1712
|
|
1919
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>
|
1920
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/
|
1713
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match_type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>webhook_verification:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>websocket_tcp_converter:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1714
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes/%{id}</span><span class='tstring_end'>'</span></span>
|
1921
1715
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1716
|
+
<span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
|
1922
1717
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1923
1718
|
<span class='rbrace'>}</span>
|
1924
1719
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1720
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:match_type</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_match_type'>match_type</span> <span class='kw'>if</span> <span class='id identifier rubyid_match_type'>match_type</span>
|
1721
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:match</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_match'>match</span> <span class='kw'>if</span> <span class='id identifier rubyid_match'>match</span>
|
1925
1722
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
1926
1723
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
1724
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:backend</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_backend'>backend</span> <span class='kw'>if</span> <span class='id identifier rubyid_backend'>backend</span>
|
1725
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_restriction</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span>
|
1927
1726
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:circuit_breaker</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span> <span class='kw'>if</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span>
|
1928
1727
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:compression</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_compression'>compression</span> <span class='kw'>if</span> <span class='id identifier rubyid_compression'>compression</span>
|
1929
1728
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:request_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_request_headers'>request_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_request_headers'>request_headers</span>
|
1930
1729
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:response_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_response_headers'>response_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_response_headers'>response_headers</span>
|
1931
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:
|
1932
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:mutual_tls</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span> <span class='kw'>if</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span>
|
1933
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:tls_termination</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span> <span class='kw'>if</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span>
|
1934
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:webhook_validation</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span> <span class='kw'>if</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span>
|
1730
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:webhook_verification</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_webhook_verification'>webhook_verification</span> <span class='kw'>if</span> <span class='id identifier rubyid_webhook_verification'>webhook_verification</span>
|
1935
1731
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oauth</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth'>oauth</span> <span class='kw'>if</span> <span class='id identifier rubyid_oauth'>oauth</span>
|
1936
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:logging</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_logging'>logging</span> <span class='kw'>if</span> <span class='id identifier rubyid_logging'>logging</span>
|
1937
1732
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:saml</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_saml'>saml</span> <span class='kw'>if</span> <span class='id identifier rubyid_saml'>saml</span>
|
1938
1733
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oidc</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oidc'>oidc</span> <span class='kw'>if</span> <span class='id identifier rubyid_oidc'>oidc</span>
|
1734
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:websocket_tcp_converter</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_websocket_tcp_converter'>websocket_tcp_converter</span> <span class='kw'>if</span> <span class='id identifier rubyid_websocket_tcp_converter'>websocket_tcp_converter</span>
|
1939
1735
|
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
1940
|
-
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/
|
1736
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">HTTPSEdgeRoute</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html#initialize-instance_method" title="NgrokAPI::Models::HTTPSEdgeRoute#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
1941
1737
|
<span class='kw'>end</span></pre>
|
1942
1738
|
</td>
|
1943
1739
|
</tr>
|
@@ -1947,7 +1743,7 @@
|
|
1947
1743
|
<div class="method_details ">
|
1948
1744
|
<h3 class="signature " id="update!-instance_method">
|
1949
1745
|
|
1950
|
-
#<strong>update!</strong>(
|
1746
|
+
#<strong>update!</strong>(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>
|
1951
1747
|
|
1952
1748
|
|
1953
1749
|
|
@@ -1956,9 +1752,9 @@
|
|
1956
1752
|
</h3><div class="docstring">
|
1957
1753
|
<div class="discussion">
|
1958
1754
|
|
1959
|
-
<p>Updates an
|
1755
|
+
<p>Updates an HTTPS Edge Route by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API. Throws an exception if API error.</p>
|
1960
1756
|
|
1961
|
-
<p><a href="https://ngrok.com/docs/api#api-
|
1757
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-https-routes-update">ngrok.com/docs/api#api-edges-https-routes-update</a></p>
|
1962
1758
|
|
1963
1759
|
|
1964
1760
|
</div>
|
@@ -1967,6 +1763,24 @@
|
|
1967
1763
|
<p class="tag_title">Parameters:</p>
|
1968
1764
|
<ul class="param">
|
1969
1765
|
|
1766
|
+
<li>
|
1767
|
+
|
1768
|
+
<span class='name'>edge_id</span>
|
1769
|
+
|
1770
|
+
|
1771
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1772
|
+
|
1773
|
+
|
1774
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1775
|
+
|
1776
|
+
|
1777
|
+
—
|
1778
|
+
<div class='inline'>
|
1779
|
+
<p>unique identifier of this edge</p>
|
1780
|
+
</div>
|
1781
|
+
|
1782
|
+
</li>
|
1783
|
+
|
1970
1784
|
<li>
|
1971
1785
|
|
1972
1786
|
<span class='name'>id</span>
|
@@ -1980,89 +1794,89 @@
|
|
1980
1794
|
|
1981
1795
|
—
|
1982
1796
|
<div class='inline'>
|
1983
|
-
<p>unique identifier of this
|
1797
|
+
<p>unique identifier of this edge route</p>
|
1984
1798
|
</div>
|
1985
1799
|
|
1986
1800
|
</li>
|
1987
1801
|
|
1988
1802
|
<li>
|
1989
1803
|
|
1990
|
-
<span class='name'>
|
1804
|
+
<span class='name'>match_type</span>
|
1991
1805
|
|
1992
1806
|
|
1993
1807
|
<span class='type'>(<tt>string</tt>)</span>
|
1994
1808
|
|
1995
1809
|
|
1996
|
-
<em class="default">(defaults to: <tt
|
1810
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1997
1811
|
|
1998
1812
|
|
1999
1813
|
—
|
2000
1814
|
<div class='inline'>
|
2001
|
-
<p>
|
1815
|
+
<p>Type of match to use for this route. Valid values are “exact_path” and “path_prefix”.</p>
|
2002
1816
|
</div>
|
2003
1817
|
|
2004
1818
|
</li>
|
2005
1819
|
|
2006
1820
|
<li>
|
2007
1821
|
|
2008
|
-
<span class='name'>
|
1822
|
+
<span class='name'>match</span>
|
2009
1823
|
|
2010
1824
|
|
2011
1825
|
<span class='type'>(<tt>string</tt>)</span>
|
2012
1826
|
|
2013
1827
|
|
2014
|
-
<em class="default">(defaults to: <tt
|
1828
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
2015
1829
|
|
2016
1830
|
|
2017
1831
|
—
|
2018
1832
|
<div class='inline'>
|
2019
|
-
<p>
|
1833
|
+
<p>Route selector: “/blog” or “example.com” or “example.com/blog”</p>
|
2020
1834
|
</div>
|
2021
1835
|
|
2022
1836
|
</li>
|
2023
1837
|
|
2024
1838
|
<li>
|
2025
1839
|
|
2026
|
-
<span class='name'>
|
1840
|
+
<span class='name'>description</span>
|
2027
1841
|
|
2028
1842
|
|
2029
|
-
<span class='type'>(<tt>
|
1843
|
+
<span class='type'>(<tt>string</tt>)</span>
|
2030
1844
|
|
2031
1845
|
|
2032
|
-
<em class="default">(defaults to: <tt
|
1846
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
2033
1847
|
|
2034
1848
|
|
2035
1849
|
—
|
2036
1850
|
<div class='inline'>
|
2037
|
-
<p>
|
1851
|
+
<p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
|
2038
1852
|
</div>
|
2039
1853
|
|
2040
1854
|
</li>
|
2041
1855
|
|
2042
1856
|
<li>
|
2043
1857
|
|
2044
|
-
<span class='name'>
|
1858
|
+
<span class='name'>metadata</span>
|
2045
1859
|
|
2046
1860
|
|
2047
|
-
<span class='type'>(<tt>
|
1861
|
+
<span class='type'>(<tt>string</tt>)</span>
|
2048
1862
|
|
2049
1863
|
|
2050
|
-
<em class="default">(defaults to: <tt
|
1864
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
2051
1865
|
|
2052
1866
|
|
2053
1867
|
—
|
2054
1868
|
<div class='inline'>
|
2055
|
-
<p>
|
1869
|
+
<p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
|
2056
1870
|
</div>
|
2057
1871
|
|
2058
1872
|
</li>
|
2059
1873
|
|
2060
1874
|
<li>
|
2061
1875
|
|
2062
|
-
<span class='name'>
|
1876
|
+
<span class='name'>backend</span>
|
2063
1877
|
|
2064
1878
|
|
2065
|
-
<span class='type'>(<tt>
|
1879
|
+
<span class='type'>(<tt>EndpointBackendMutate</tt>)</span>
|
2066
1880
|
|
2067
1881
|
|
2068
1882
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -2070,17 +1884,17 @@
|
|
2070
1884
|
|
2071
1885
|
—
|
2072
1886
|
<div class='inline'>
|
2073
|
-
<p>
|
1887
|
+
<p>backend module configuration or <code>null</code></p>
|
2074
1888
|
</div>
|
2075
1889
|
|
2076
1890
|
</li>
|
2077
1891
|
|
2078
1892
|
<li>
|
2079
1893
|
|
2080
|
-
<span class='name'>
|
1894
|
+
<span class='name'>ip_restriction</span>
|
2081
1895
|
|
2082
1896
|
|
2083
|
-
<span class='type'>(<tt>
|
1897
|
+
<span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
|
2084
1898
|
|
2085
1899
|
|
2086
1900
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -2088,17 +1902,17 @@
|
|
2088
1902
|
|
2089
1903
|
—
|
2090
1904
|
<div class='inline'>
|
2091
|
-
<p>
|
1905
|
+
<p>ip restriction module configuration or <code>null</code></p>
|
2092
1906
|
</div>
|
2093
1907
|
|
2094
1908
|
</li>
|
2095
1909
|
|
2096
1910
|
<li>
|
2097
1911
|
|
2098
|
-
<span class='name'>
|
1912
|
+
<span class='name'>circuit_breaker</span>
|
2099
1913
|
|
2100
1914
|
|
2101
|
-
<span class='type'>(<tt>
|
1915
|
+
<span class='type'>(<tt>EndpointCircuitBreaker</tt>)</span>
|
2102
1916
|
|
2103
1917
|
|
2104
1918
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -2106,17 +1920,17 @@
|
|
2106
1920
|
|
2107
1921
|
—
|
2108
1922
|
<div class='inline'>
|
2109
|
-
<p>
|
1923
|
+
<p>circuit breaker module configuration or <code>null</code></p>
|
2110
1924
|
</div>
|
2111
1925
|
|
2112
1926
|
</li>
|
2113
1927
|
|
2114
1928
|
<li>
|
2115
1929
|
|
2116
|
-
<span class='name'>
|
1930
|
+
<span class='name'>compression</span>
|
2117
1931
|
|
2118
1932
|
|
2119
|
-
<span class='type'>(<tt>
|
1933
|
+
<span class='type'>(<tt>EndpointCompression</tt>)</span>
|
2120
1934
|
|
2121
1935
|
|
2122
1936
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -2124,17 +1938,17 @@
|
|
2124
1938
|
|
2125
1939
|
—
|
2126
1940
|
<div class='inline'>
|
2127
|
-
<p>
|
1941
|
+
<p>compression module configuration or <code>null</code></p>
|
2128
1942
|
</div>
|
2129
1943
|
|
2130
1944
|
</li>
|
2131
1945
|
|
2132
1946
|
<li>
|
2133
1947
|
|
2134
|
-
<span class='name'>
|
1948
|
+
<span class='name'>request_headers</span>
|
2135
1949
|
|
2136
1950
|
|
2137
|
-
<span class='type'>(<tt>
|
1951
|
+
<span class='type'>(<tt>EndpointRequestHeaders</tt>)</span>
|
2138
1952
|
|
2139
1953
|
|
2140
1954
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -2142,17 +1956,17 @@
|
|
2142
1956
|
|
2143
1957
|
—
|
2144
1958
|
<div class='inline'>
|
2145
|
-
<p>
|
1959
|
+
<p>request headers module configuration or <code>null</code></p>
|
2146
1960
|
</div>
|
2147
1961
|
|
2148
1962
|
</li>
|
2149
1963
|
|
2150
1964
|
<li>
|
2151
1965
|
|
2152
|
-
<span class='name'>
|
1966
|
+
<span class='name'>response_headers</span>
|
2153
1967
|
|
2154
1968
|
|
2155
|
-
<span class='type'>(<tt>
|
1969
|
+
<span class='type'>(<tt>EndpointResponseHeaders</tt>)</span>
|
2156
1970
|
|
2157
1971
|
|
2158
1972
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -2160,17 +1974,17 @@
|
|
2160
1974
|
|
2161
1975
|
—
|
2162
1976
|
<div class='inline'>
|
2163
|
-
<p>
|
1977
|
+
<p>response headers module configuration or <code>null</code></p>
|
2164
1978
|
</div>
|
2165
1979
|
|
2166
1980
|
</li>
|
2167
1981
|
|
2168
1982
|
<li>
|
2169
1983
|
|
2170
|
-
<span class='name'>
|
1984
|
+
<span class='name'>webhook_verification</span>
|
2171
1985
|
|
2172
1986
|
|
2173
|
-
<span class='type'>(<tt>
|
1987
|
+
<span class='type'>(<tt>EndpointWebhookValidation</tt>)</span>
|
2174
1988
|
|
2175
1989
|
|
2176
1990
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -2178,17 +1992,17 @@
|
|
2178
1992
|
|
2179
1993
|
—
|
2180
1994
|
<div class='inline'>
|
2181
|
-
<p>
|
1995
|
+
<p>webhook verification module configuration or <code>null</code></p>
|
2182
1996
|
</div>
|
2183
1997
|
|
2184
1998
|
</li>
|
2185
1999
|
|
2186
2000
|
<li>
|
2187
2001
|
|
2188
|
-
<span class='name'>
|
2002
|
+
<span class='name'>oauth</span>
|
2189
2003
|
|
2190
2004
|
|
2191
|
-
<span class='type'>(<tt>
|
2005
|
+
<span class='type'>(<tt>EndpointOAuth</tt>)</span>
|
2192
2006
|
|
2193
2007
|
|
2194
2008
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -2196,7 +2010,7 @@
|
|
2196
2010
|
|
2197
2011
|
—
|
2198
2012
|
<div class='inline'>
|
2199
|
-
<p>
|
2013
|
+
<p>oauth module configuration or <code>null</code></p>
|
2200
2014
|
</div>
|
2201
2015
|
|
2202
2016
|
</li>
|
@@ -2233,6 +2047,24 @@
|
|
2233
2047
|
—
|
2234
2048
|
<div class='inline'>
|
2235
2049
|
<p>oidc module configuration or <code>null</code></p>
|
2050
|
+
</div>
|
2051
|
+
|
2052
|
+
</li>
|
2053
|
+
|
2054
|
+
<li>
|
2055
|
+
|
2056
|
+
<span class='name'>websocket_tcp_converter</span>
|
2057
|
+
|
2058
|
+
|
2059
|
+
<span class='type'>(<tt>EndpointWebsocketTCPConverter</tt>)</span>
|
2060
|
+
|
2061
|
+
|
2062
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
2063
|
+
|
2064
|
+
|
2065
|
+
—
|
2066
|
+
<div class='inline'>
|
2067
|
+
<p>websocket to tcp adapter configuration or <code>null</code></p>
|
2236
2068
|
</div>
|
2237
2069
|
|
2238
2070
|
</li>
|
@@ -2245,7 +2077,7 @@
|
|
2245
2077
|
<li>
|
2246
2078
|
|
2247
2079
|
|
2248
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
2080
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>)</span>
|
2249
2081
|
|
2250
2082
|
|
2251
2083
|
|
@@ -2264,55 +2096,59 @@
|
|
2264
2096
|
<pre class="lines">
|
2265
2097
|
|
2266
2098
|
|
2267
|
-
|
2268
|
-
|
2269
|
-
|
2270
|
-
|
2271
|
-
|
2272
|
-
|
2273
|
-
|
2274
|
-
|
2275
|
-
|
2276
|
-
|
2277
|
-
|
2278
|
-
|
2279
|
-
|
2280
|
-
|
2281
|
-
|
2282
|
-
|
2283
|
-
|
2284
|
-
|
2285
|
-
|
2286
|
-
|
2287
|
-
|
2288
|
-
|
2289
|
-
|
2099
|
+
182
|
2100
|
+
183
|
2101
|
+
184
|
2102
|
+
185
|
2103
|
+
186
|
2104
|
+
187
|
2105
|
+
188
|
2106
|
+
189
|
2107
|
+
190
|
2108
|
+
191
|
2109
|
+
192
|
2110
|
+
193
|
2111
|
+
194
|
2112
|
+
195
|
2113
|
+
196
|
2114
|
+
197
|
2115
|
+
198
|
2116
|
+
199
|
2117
|
+
200
|
2118
|
+
201
|
2119
|
+
202
|
2120
|
+
203
|
2121
|
+
204
|
2122
|
+
205
|
2123
|
+
206</pre>
|
2290
2124
|
</td>
|
2291
2125
|
<td>
|
2292
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
2126
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 182</span>
|
2293
2127
|
|
2294
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>
|
2295
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/
|
2128
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match_type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>webhook_verification:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>websocket_tcp_converter:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
2129
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes/%{id}</span><span class='tstring_end'>'</span></span>
|
2296
2130
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
2131
|
+
<span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
|
2297
2132
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
2298
2133
|
<span class='rbrace'>}</span>
|
2299
2134
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
2135
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:match_type</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_match_type'>match_type</span> <span class='kw'>if</span> <span class='id identifier rubyid_match_type'>match_type</span>
|
2136
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:match</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_match'>match</span> <span class='kw'>if</span> <span class='id identifier rubyid_match'>match</span>
|
2300
2137
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
2301
2138
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
2139
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:backend</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_backend'>backend</span> <span class='kw'>if</span> <span class='id identifier rubyid_backend'>backend</span>
|
2140
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_restriction</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span>
|
2302
2141
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:circuit_breaker</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span> <span class='kw'>if</span> <span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span>
|
2303
2142
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:compression</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_compression'>compression</span> <span class='kw'>if</span> <span class='id identifier rubyid_compression'>compression</span>
|
2304
2143
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:request_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_request_headers'>request_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_request_headers'>request_headers</span>
|
2305
2144
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:response_headers</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_response_headers'>response_headers</span> <span class='kw'>if</span> <span class='id identifier rubyid_response_headers'>response_headers</span>
|
2306
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:
|
2307
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:mutual_tls</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span> <span class='kw'>if</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span>
|
2308
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:tls_termination</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span> <span class='kw'>if</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span>
|
2309
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:webhook_validation</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span> <span class='kw'>if</span> <span class='id identifier rubyid_webhook_validation'>webhook_validation</span>
|
2145
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:webhook_verification</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_webhook_verification'>webhook_verification</span> <span class='kw'>if</span> <span class='id identifier rubyid_webhook_verification'>webhook_verification</span>
|
2310
2146
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oauth</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oauth'>oauth</span> <span class='kw'>if</span> <span class='id identifier rubyid_oauth'>oauth</span>
|
2311
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:logging</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_logging'>logging</span> <span class='kw'>if</span> <span class='id identifier rubyid_logging'>logging</span>
|
2312
2147
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:saml</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_saml'>saml</span> <span class='kw'>if</span> <span class='id identifier rubyid_saml'>saml</span>
|
2313
2148
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oidc</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oidc'>oidc</span> <span class='kw'>if</span> <span class='id identifier rubyid_oidc'>oidc</span>
|
2149
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:websocket_tcp_converter</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_websocket_tcp_converter'>websocket_tcp_converter</span> <span class='kw'>if</span> <span class='id identifier rubyid_websocket_tcp_converter'>websocket_tcp_converter</span>
|
2314
2150
|
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
2315
|
-
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/
|
2151
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">HTTPSEdgeRoute</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html#initialize-instance_method" title="NgrokAPI::Models::HTTPSEdgeRoute#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
2316
2152
|
<span class='kw'>end</span></pre>
|
2317
2153
|
</td>
|
2318
2154
|
</tr>
|
@@ -2324,9 +2160,9 @@
|
|
2324
2160
|
</div>
|
2325
2161
|
|
2326
2162
|
<div id="footer">
|
2327
|
-
Generated on Thu
|
2163
|
+
Generated on Thu Mar 10 04:54:54 2022 by
|
2328
2164
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
2329
|
-
0.9.27 (ruby-
|
2165
|
+
0.9.27 (ruby-2.7.5).
|
2330
2166
|
</div>
|
2331
2167
|
|
2332
2168
|
</div>
|