ngrok-api 0.15.0 → 0.18.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +1 -1
- data/doc/NgrokAPI/Client.html +325 -267
- data/doc/NgrokAPI/Error.html +3 -3
- data/doc/NgrokAPI/Errors/NotFoundError.html +3 -3
- data/doc/NgrokAPI/Errors.html +3 -3
- data/doc/NgrokAPI/HttpClient.html +30 -36
- data/doc/NgrokAPI/Models/APIKey.html +3 -3
- data/doc/NgrokAPI/Models/AWSAuth.html +3 -3
- data/doc/NgrokAPI/Models/AWSCredentials.html +3 -3
- data/doc/NgrokAPI/Models/AWSRole.html +3 -3
- data/doc/NgrokAPI/Models/AbuseReport.html +3 -3
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +3 -3
- data/doc/NgrokAPI/Models/AgentIngress.html +1217 -0
- data/doc/NgrokAPI/Models/CertificateAuthority.html +3 -3
- data/doc/NgrokAPI/Models/Credential.html +3 -3
- data/doc/NgrokAPI/Models/Endpoint.html +1431 -0
- data/doc/NgrokAPI/Models/{EndpointLogging.html → EndpointBackend.html} +42 -42
- data/{docs/NgrokAPI/Models/EndpointLoggingMutate.html → doc/NgrokAPI/Models/EndpointBackendMutate.html} +42 -42
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +3 -3
- data/doc/NgrokAPI/Models/EndpointCompression.html +3 -3
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +3 -3
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +3 -3
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +3 -3
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuth.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOIDC.html +3 -3
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +3 -3
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +3 -3
- data/doc/NgrokAPI/Models/EndpointSAML.html +3 -3
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +3 -3
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +3 -3
- data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +617 -0
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +3 -3
- data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +543 -0
- data/doc/NgrokAPI/Models/EventDestination.html +7 -7
- data/doc/NgrokAPI/Models/EventSource.html +3 -3
- data/doc/NgrokAPI/Models/EventSourceList.html +3 -3
- data/doc/NgrokAPI/Models/EventSourceReplace.html +3 -3
- data/doc/NgrokAPI/Models/EventSubscription.html +3 -3
- data/doc/NgrokAPI/Models/EventTarget.html +3 -3
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +3 -3
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +3 -3
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +3 -3
- data/doc/NgrokAPI/Models/FailoverBackend.html +1075 -0
- data/doc/NgrokAPI/Models/HTTPResponseBackend.html +1231 -0
- data/{docs/NgrokAPI/Models/EventStream.html → doc/NgrokAPI/Models/HTTPSEdge.html} +119 -119
- data/doc/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +203 -265
- data/doc/NgrokAPI/Models/IPPolicy.html +3 -3
- data/doc/NgrokAPI/Models/IPPolicyRule.html +97 -23
- data/doc/NgrokAPI/Models/IPRestriction.html +3 -3
- data/doc/NgrokAPI/Models/Listable.html +3 -3
- data/doc/NgrokAPI/Models/Ref.html +3 -3
- data/doc/NgrokAPI/Models/ReservedAddr.html +3 -3
- data/doc/NgrokAPI/Models/ReservedDomain.html +3 -3
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +3 -3
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +3 -3
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +3 -3
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +3 -3
- data/doc/NgrokAPI/Models/SSHCredential.html +3 -3
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +3 -3
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +3 -3
- data/doc/NgrokAPI/Models/TCPEdge.html +1235 -0
- data/doc/NgrokAPI/Models/TLSCertificate.html +3 -3
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +3 -3
- data/doc/NgrokAPI/Models/TLSEdge.html +1395 -0
- data/doc/NgrokAPI/Models/Tunnel.html +314 -18
- data/doc/NgrokAPI/Models/TunnelGroupBackend.html +1149 -0
- data/doc/NgrokAPI/Models/TunnelSession.html +3 -3
- data/doc/NgrokAPI/Models/{IPWhitelistEntry.html → WeightedBackend.html} +80 -74
- data/doc/NgrokAPI/Models.html +5 -5
- data/doc/NgrokAPI/PagedIterator.html +3 -3
- data/doc/NgrokAPI/Services/APIKeysClient.html +99 -149
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +19 -33
- data/doc/NgrokAPI/Services/{IPWhitelistClient.html → AgentIngressesClient.html} +209 -265
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +104 -156
- data/doc/NgrokAPI/Services/CredentialsClient.html +108 -164
- data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1153 -0
- data/{docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html → doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html} +177 -95
- data/doc/NgrokAPI/Services/{EndpointCompressionModuleClient.html → EdgeRouteCompressionModuleClient.html} +177 -95
- 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} +177 -95
- data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1153 -0
- data/{docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html → doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html} +177 -95
- data/{docs/NgrokAPI/Services/EndpointSAMLModuleClient.html → doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html} +177 -95
- data/doc/NgrokAPI/Services/{EndpointWebhookValidationModuleClient.html → EdgeRouteWebhookVerificationModuleClient.html} +177 -95
- data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1153 -0
- data/doc/NgrokAPI/Services/{EventStreamsClient.html → EdgesHTTPSClient.html} +248 -353
- data/{docs/NgrokAPI/Services/EndpointConfigurationsClient.html → doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html} +461 -761
- 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 +119 -187
- data/doc/NgrokAPI/Services/EventSourcesClient.html +95 -157
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +116 -178
- data/doc/NgrokAPI/Services/FailoverBackendsClient.html +1644 -0
- data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +1744 -0
- data/doc/NgrokAPI/Services/{EndpointSAMLModuleClient.html → HTTPSEdgeMutualTLSModuleClient.html} +101 -129
- data/doc/NgrokAPI/Services/{EndpointRequestHeadersModuleClient.html → HTTPSEdgeTLSTerminationModuleClient.html} +101 -129
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +114 -184
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +126 -164
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +117 -181
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +117 -473
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +209 -899
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +110 -166
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +111 -169
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +111 -171
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +111 -175
- data/{docs/NgrokAPI/Services/EndpointLoggingModuleClient.html → doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html} +101 -129
- data/{docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html → doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html} +83 -111
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +107 -161
- data/doc/NgrokAPI/Services/{EndpointLoggingModuleClient.html → TLSEdgeBackendModuleClient.html} +101 -129
- data/doc/NgrokAPI/Services/{EndpointIPPolicyModuleClient.html → TLSEdgeIPRestrictionModuleClient.html} +83 -111
- data/{docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html → doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html} +83 -111
- data/{docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html → doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html} +83 -111
- data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +1644 -0
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +87 -135
- data/doc/NgrokAPI/Services/TunnelsClient.html +252 -26
- data/doc/NgrokAPI/Services/WeightedBackendsClient.html +1644 -0
- data/doc/NgrokAPI/Services.html +5 -5
- data/doc/NgrokAPI.html +4 -4
- data/doc/_index.html +253 -76
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +3 -3
- data/doc/frames.html +1 -1
- data/doc/index.html +3 -3
- data/doc/method_list.html +3559 -1583
- data/doc/top-level-namespace.html +3 -3
- data/docs/NgrokAPI/Client.html +325 -267
- data/docs/NgrokAPI/Error.html +3 -3
- data/docs/NgrokAPI/Errors/NotFoundError.html +3 -3
- data/docs/NgrokAPI/Errors.html +3 -3
- data/docs/NgrokAPI/HttpClient.html +30 -36
- data/docs/NgrokAPI/Models/APIKey.html +3 -3
- data/docs/NgrokAPI/Models/AWSAuth.html +3 -3
- data/docs/NgrokAPI/Models/AWSCredentials.html +3 -3
- data/docs/NgrokAPI/Models/AWSRole.html +3 -3
- data/docs/NgrokAPI/Models/AbuseReport.html +3 -3
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +3 -3
- data/docs/NgrokAPI/Models/AgentIngress.html +1217 -0
- data/docs/NgrokAPI/Models/CertificateAuthority.html +3 -3
- data/docs/NgrokAPI/Models/Credential.html +3 -3
- data/docs/NgrokAPI/Models/Endpoint.html +1431 -0
- data/docs/NgrokAPI/Models/{EndpointLogging.html → EndpointBackend.html} +42 -42
- data/{doc/NgrokAPI/Models/EndpointLoggingMutate.html → docs/NgrokAPI/Models/EndpointBackendMutate.html} +42 -42
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +3 -3
- data/docs/NgrokAPI/Models/EndpointCompression.html +3 -3
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +3 -3
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +3 -3
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +3 -3
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuth.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOIDC.html +3 -3
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +3 -3
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +3 -3
- data/docs/NgrokAPI/Models/EndpointSAML.html +3 -3
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +3 -3
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +3 -3
- data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +617 -0
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +3 -3
- data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +543 -0
- data/docs/NgrokAPI/Models/EventDestination.html +7 -7
- data/docs/NgrokAPI/Models/EventSource.html +3 -3
- data/docs/NgrokAPI/Models/EventSourceList.html +3 -3
- data/docs/NgrokAPI/Models/EventSourceReplace.html +3 -3
- data/docs/NgrokAPI/Models/EventSubscription.html +3 -3
- data/docs/NgrokAPI/Models/EventTarget.html +3 -3
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +3 -3
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +3 -3
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +3 -3
- data/docs/NgrokAPI/Models/FailoverBackend.html +1075 -0
- data/docs/NgrokAPI/Models/HTTPResponseBackend.html +1231 -0
- data/{doc/NgrokAPI/Models/EventStream.html → docs/NgrokAPI/Models/HTTPSEdge.html} +119 -119
- data/docs/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +203 -265
- data/docs/NgrokAPI/Models/IPPolicy.html +3 -3
- data/docs/NgrokAPI/Models/IPPolicyRule.html +97 -23
- data/docs/NgrokAPI/Models/IPRestriction.html +3 -3
- data/docs/NgrokAPI/Models/Listable.html +3 -3
- data/docs/NgrokAPI/Models/Ref.html +3 -3
- data/docs/NgrokAPI/Models/ReservedAddr.html +3 -3
- data/docs/NgrokAPI/Models/ReservedDomain.html +3 -3
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +3 -3
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +3 -3
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +3 -3
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +3 -3
- data/docs/NgrokAPI/Models/SSHCredential.html +3 -3
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +3 -3
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +3 -3
- data/docs/NgrokAPI/Models/TCPEdge.html +1235 -0
- data/docs/NgrokAPI/Models/TLSCertificate.html +3 -3
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +3 -3
- data/docs/NgrokAPI/Models/TLSEdge.html +1395 -0
- data/docs/NgrokAPI/Models/Tunnel.html +314 -18
- data/docs/NgrokAPI/Models/TunnelGroupBackend.html +1149 -0
- data/docs/NgrokAPI/Models/TunnelSession.html +3 -3
- data/docs/NgrokAPI/Models/{IPWhitelistEntry.html → WeightedBackend.html} +80 -74
- data/docs/NgrokAPI/Models.html +5 -5
- data/docs/NgrokAPI/PagedIterator.html +3 -3
- data/docs/NgrokAPI/Services/APIKeysClient.html +99 -149
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +19 -33
- data/docs/NgrokAPI/Services/{IPWhitelistClient.html → AgentIngressesClient.html} +209 -265
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +104 -156
- data/docs/NgrokAPI/Services/CredentialsClient.html +108 -164
- data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1153 -0
- data/{doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html → docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html} +177 -95
- data/docs/NgrokAPI/Services/{EndpointCompressionModuleClient.html → EdgeRouteCompressionModuleClient.html} +177 -95
- 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} +177 -95
- data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +1153 -0
- data/docs/NgrokAPI/Services/{EndpointWebhookValidationModuleClient.html → EdgeRouteWebhookVerificationModuleClient.html} +177 -95
- data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1153 -0
- data/docs/NgrokAPI/Services/{EventStreamsClient.html → EdgesHTTPSClient.html} +248 -353
- data/{doc/NgrokAPI/Services/EndpointConfigurationsClient.html → docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html} +461 -761
- 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 +119 -187
- data/docs/NgrokAPI/Services/EventSourcesClient.html +95 -157
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +116 -178
- data/docs/NgrokAPI/Services/FailoverBackendsClient.html +1644 -0
- data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +1744 -0
- data/{doc/NgrokAPI/Services/EndpointOIDCModuleClient.html → docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html} +101 -129
- data/docs/NgrokAPI/Services/{EndpointRequestHeadersModuleClient.html → HTTPSEdgeTLSTerminationModuleClient.html} +101 -129
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +114 -184
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +126 -164
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +117 -181
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +117 -473
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +209 -899
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +110 -166
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +111 -169
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +111 -171
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +111 -175
- data/{doc/NgrokAPI/Services/EndpointOAuthModuleClient.html → docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html} +101 -129
- data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +107 -161
- data/docs/NgrokAPI/Services/{EndpointOAuthModuleClient.html → TLSEdgeBackendModuleClient.html} +101 -129
- data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +1043 -0
- data/{doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html → docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html} +83 -111
- data/{doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html → docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html} +83 -111
- data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +1644 -0
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +87 -135
- data/docs/NgrokAPI/Services/TunnelsClient.html +252 -26
- data/docs/NgrokAPI/Services/WeightedBackendsClient.html +1644 -0
- data/docs/NgrokAPI/Services.html +5 -5
- data/docs/NgrokAPI.html +4 -4
- data/docs/_index.html +253 -76
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +3 -3
- data/docs/frames.html +1 -1
- data/docs/index.html +3 -3
- data/docs/method_list.html +3559 -1583
- data/docs/top-level-namespace.html +3 -3
- data/lib/ngrokapi/client.rb +52 -37
- data/lib/ngrokapi/http_client.rb +1 -4
- data/lib/ngrokapi/models/{ip_whitelist_entry.rb → agent_ingress.rb} +13 -9
- 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/abuse_reports_client.rb +3 -10
- data/lib/ngrokapi/services/agent_ingresses_client.rb +206 -0
- data/lib/ngrokapi/services/api_keys_client.rb +11 -36
- data/lib/ngrokapi/services/certificate_authorities_client.rb +11 -37
- data/lib/ngrokapi/services/credentials_client.rb +11 -39
- 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 -39
- data/lib/ngrokapi/services/{endpoint_compression_module_client.rb → edge_route_compression_module_client.rb} +37 -39
- data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +120 -0
- data/lib/ngrokapi/services/{endpoint_o_auth_module_client.rb → edge_route_o_auth_module_client.rb} +37 -39
- data/lib/ngrokapi/services/{endpoint_oidc_module_client.rb → edge_route_oidc_module_client.rb} +37 -39
- data/lib/ngrokapi/services/{endpoint_request_headers_module_client.rb → edge_route_request_headers_module_client.rb} +37 -39
- data/lib/ngrokapi/services/{endpoint_response_headers_module_client.rb → edge_route_response_headers_module_client.rb} +37 -39
- data/lib/ngrokapi/services/{endpoint_saml_module_client.rb → edge_route_saml_module_client.rb} +37 -39
- data/lib/ngrokapi/services/{endpoint_webhook_validation_module_client.rb → edge_route_webhook_verification_module_client.rb} +37 -39
- 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 +13 -49
- data/lib/ngrokapi/services/event_sources_client.rb +9 -40
- data/lib/ngrokapi/services/event_subscriptions_client.rb +14 -45
- 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/https_edge_mutual_tls_module_client.rb +108 -0
- data/lib/ngrokapi/services/https_edge_tls_termination_module_client.rb +108 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +11 -39
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +13 -40
- data/lib/ngrokapi/services/ip_restrictions_client.rb +12 -44
- data/lib/ngrokapi/services/reserved_addrs_client.rb +11 -81
- data/lib/ngrokapi/services/reserved_domains_client.rb +15 -144
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +11 -39
- data/lib/ngrokapi/services/ssh_credentials_client.rb +11 -40
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +11 -41
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +11 -43
- data/lib/ngrokapi/services/{endpoint_logging_module_client.rb → tcp_edge_backend_module_client.rb} +31 -45
- data/lib/ngrokapi/services/{endpoint_ip_policy_module_client.rb → tcp_edge_ip_restriction_module_client.rb} +21 -35
- data/lib/ngrokapi/services/tls_certificates_client.rb +11 -38
- data/lib/ngrokapi/services/tls_edge_backend_module_client.rb +108 -0
- data/lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb +108 -0
- data/lib/ngrokapi/services/{endpoint_mutual_tls_module_client.rb → tls_edge_mutual_tls_module_client.rb} +21 -35
- data/lib/ngrokapi/services/{endpoint_tls_termination_module_client.rb → tls_edge_tls_termination_module_client.rb} +21 -35
- data/lib/ngrokapi/services/{ip_whitelist_client.rb → tunnel_group_backends_client.rb} +70 -93
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +12 -36
- data/lib/ngrokapi/services/tunnels_client.rb +39 -10
- data/lib/ngrokapi/services/weighted_backends_client.rb +214 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/lib/ngrokapi.rb +1 -1
- data/ngrok-api.gemspec +1 -1
- data/spec/ngrokapi/client_spec.rb +50 -29
- data/spec/ngrokapi/models/agent_ingress_spec.rb +42 -0
- 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/{ip_whitelist_client_spec.rb → agent_ingresses_client_spec.rb} +49 -49
- 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 +1389 -1045
- metadata +175 -83
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +0 -357
- data/lib/ngrokapi/services/event_streams_client.rb +0 -259
- 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/models/ip_whitelist_entry_spec.rb +0 -42
- data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +0 -237
@@ -4,9 +4,9 @@
|
|
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
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.27
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -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,73 +839,34 @@
|
|
886
839
|
59
|
887
840
|
60
|
888
841
|
61
|
889
|
-
62
|
890
|
-
63
|
891
|
-
64
|
892
|
-
65
|
893
|
-
66
|
894
|
-
67
|
895
|
-
68
|
896
|
-
69
|
897
|
-
70
|
898
|
-
71
|
899
|
-
72
|
900
|
-
73
|
901
|
-
74
|
902
|
-
75
|
903
|
-
76
|
904
|
-
77
|
905
|
-
78
|
906
|
-
79
|
907
|
-
80
|
908
|
-
81
|
909
|
-
82
|
910
|
-
83
|
911
|
-
84</pre>
|
842
|
+
62</pre>
|
912
843
|
</td>
|
913
844
|
<td>
|
914
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
915
|
-
|
916
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
|
917
|
-
<span class='
|
918
|
-
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
919
|
-
<span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
920
|
-
<span class='label'>basic_auth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
921
|
-
<span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
922
|
-
<span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
923
|
-
<span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
924
|
-
<span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
925
|
-
<span class='label'>ip_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
926
|
-
<span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
927
|
-
<span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
928
|
-
<span class='label'>webhook_validation:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
929
|
-
<span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
930
|
-
<span class='label'>logging:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
931
|
-
<span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
932
|
-
<span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
933
|
-
<span class='label'>backend:</span> <span class='kw'>nil</span>
|
934
|
-
<span class='rparen'>)</span>
|
935
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoint_configurations</span><span class='tstring_end'>'</span></span>
|
845
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 39</span>
|
846
|
+
|
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>
|
936
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>
|
937
851
|
<span class='rbrace'>}</span>
|
938
852
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
939
|
-
<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>
|
940
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>
|
941
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>
|
942
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>
|
943
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>
|
944
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>
|
945
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>
|
946
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:
|
947
|
-
<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>
|
948
|
-
<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>
|
949
|
-
<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>
|
950
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>
|
951
|
-
<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>
|
952
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>
|
953
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>
|
954
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>
|
955
|
-
<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>
|
956
870
|
<span class='kw'>end</span></pre>
|
957
871
|
</td>
|
958
872
|
</tr>
|
@@ -962,7 +876,7 @@
|
|
962
876
|
<div class="method_details ">
|
963
877
|
<h3 class="signature " id="delete-instance_method">
|
964
878
|
|
965
|
-
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
879
|
+
#<strong>delete</strong>(edge_id: "", id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
966
880
|
|
967
881
|
|
968
882
|
|
@@ -971,9 +885,9 @@
|
|
971
885
|
</h3><div class="docstring">
|
972
886
|
<div class="discussion">
|
973
887
|
|
974
|
-
<p>Delete an
|
888
|
+
<p>Delete an HTTPS Edge Route by ID</p>
|
975
889
|
|
976
|
-
<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>
|
977
891
|
|
978
892
|
|
979
893
|
</div>
|
@@ -982,6 +896,24 @@
|
|
982
896
|
<p class="tag_title">Parameters:</p>
|
983
897
|
<ul class="param">
|
984
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
|
+
|
985
917
|
<li>
|
986
918
|
|
987
919
|
<span class='name'>id</span>
|
@@ -995,7 +927,7 @@
|
|
995
927
|
|
996
928
|
—
|
997
929
|
<div class='inline'>
|
998
|
-
<p>
|
930
|
+
<p>unique identifier of this edge route</p>
|
999
931
|
</div>
|
1000
932
|
|
1001
933
|
</li>
|
@@ -1027,24 +959,22 @@
|
|
1027
959
|
<pre class="lines">
|
1028
960
|
|
1029
961
|
|
1030
|
-
|
1031
|
-
|
1032
|
-
|
1033
|
-
|
1034
|
-
|
1035
|
-
|
1036
|
-
|
1037
|
-
|
1038
|
-
102</pre>
|
962
|
+
216
|
963
|
+
217
|
964
|
+
218
|
965
|
+
219
|
966
|
+
220
|
967
|
+
221
|
968
|
+
222
|
969
|
+
223</pre>
|
1039
970
|
</td>
|
1040
971
|
<td>
|
1041
|
-
<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>
|
1042
973
|
|
1043
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span>
|
1044
|
-
<span class='
|
1045
|
-
<span class='rparen'>)</span>
|
1046
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoint_configurations/%{id}</span><span class='tstring_end'>'</span></span>
|
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>
|
1047
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>
|
1048
978
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1049
979
|
<span class='rbrace'>}</span>
|
1050
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>
|
@@ -1057,7 +987,7 @@
|
|
1057
987
|
<div class="method_details ">
|
1058
988
|
<h3 class="signature " id="delete!-instance_method">
|
1059
989
|
|
1060
|
-
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
990
|
+
#<strong>delete!</strong>(edge_id: "", id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
1061
991
|
|
1062
992
|
|
1063
993
|
|
@@ -1066,9 +996,9 @@
|
|
1066
996
|
</h3><div class="docstring">
|
1067
997
|
<div class="discussion">
|
1068
998
|
|
1069
|
-
<p>Delete an
|
999
|
+
<p>Delete an HTTPS Edge Route by ID Throws an exception if API error.</p>
|
1070
1000
|
|
1071
|
-
<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>
|
1072
1002
|
|
1073
1003
|
|
1074
1004
|
</div>
|
@@ -1077,6 +1007,24 @@
|
|
1077
1007
|
<p class="tag_title">Parameters:</p>
|
1078
1008
|
<ul class="param">
|
1079
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
|
+
|
1080
1028
|
<li>
|
1081
1029
|
|
1082
1030
|
<span class='name'>id</span>
|
@@ -1090,7 +1038,7 @@
|
|
1090
1038
|
|
1091
1039
|
—
|
1092
1040
|
<div class='inline'>
|
1093
|
-
<p>
|
1041
|
+
<p>unique identifier of this edge route</p>
|
1094
1042
|
</div>
|
1095
1043
|
|
1096
1044
|
</li>
|
@@ -1122,24 +1070,22 @@
|
|
1122
1070
|
<pre class="lines">
|
1123
1071
|
|
1124
1072
|
|
1125
|
-
|
1126
|
-
|
1127
|
-
|
1128
|
-
|
1129
|
-
|
1130
|
-
|
1131
|
-
|
1132
|
-
|
1133
|
-
121</pre>
|
1073
|
+
234
|
1074
|
+
235
|
1075
|
+
236
|
1076
|
+
237
|
1077
|
+
238
|
1078
|
+
239
|
1079
|
+
240
|
1080
|
+
241</pre>
|
1134
1081
|
</td>
|
1135
1082
|
<td>
|
1136
|
-
<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>
|
1137
1084
|
|
1138
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span>
|
1139
|
-
<span class='
|
1140
|
-
<span class='rparen'>)</span>
|
1141
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoint_configurations/%{id}</span><span class='tstring_end'>'</span></span>
|
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>
|
1142
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>
|
1143
1089
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1144
1090
|
<span class='rbrace'>}</span>
|
1145
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>
|
@@ -1152,7 +1098,7 @@
|
|
1152
1098
|
<div class="method_details ">
|
1153
1099
|
<h3 class="signature " id="get-instance_method">
|
1154
1100
|
|
1155
|
-
#<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>
|
1156
1102
|
|
1157
1103
|
|
1158
1104
|
|
@@ -1161,9 +1107,9 @@
|
|
1161
1107
|
</h3><div class="docstring">
|
1162
1108
|
<div class="discussion">
|
1163
1109
|
|
1164
|
-
<p>
|
1110
|
+
<p>Get an HTTPS Edge Route by ID</p>
|
1165
1111
|
|
1166
|
-
<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>
|
1167
1113
|
|
1168
1114
|
|
1169
1115
|
</div>
|
@@ -1172,6 +1118,24 @@
|
|
1172
1118
|
<p class="tag_title">Parameters:</p>
|
1173
1119
|
<ul class="param">
|
1174
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
|
+
|
1175
1139
|
<li>
|
1176
1140
|
|
1177
1141
|
<span class='name'>id</span>
|
@@ -1185,7 +1149,7 @@
|
|
1185
1149
|
|
1186
1150
|
—
|
1187
1151
|
<div class='inline'>
|
1188
|
-
<p>
|
1152
|
+
<p>unique identifier of this edge route</p>
|
1189
1153
|
</div>
|
1190
1154
|
|
1191
1155
|
</li>
|
@@ -1198,7 +1162,7 @@
|
|
1198
1162
|
<li>
|
1199
1163
|
|
1200
1164
|
|
1201
|
-
<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>
|
1202
1166
|
|
1203
1167
|
|
1204
1168
|
|
@@ -1217,31 +1181,29 @@
|
|
1217
1181
|
<pre class="lines">
|
1218
1182
|
|
1219
1183
|
|
1220
|
-
|
1221
|
-
|
1222
|
-
|
1223
|
-
|
1224
|
-
|
1225
|
-
|
1226
|
-
|
1227
|
-
|
1228
|
-
|
1229
|
-
|
1230
|
-
140</pre>
|
1184
|
+
72
|
1185
|
+
73
|
1186
|
+
74
|
1187
|
+
75
|
1188
|
+
76
|
1189
|
+
77
|
1190
|
+
78
|
1191
|
+
79
|
1192
|
+
80
|
1193
|
+
81</pre>
|
1231
1194
|
</td>
|
1232
1195
|
<td>
|
1233
|
-
<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>
|
1234
1197
|
|
1235
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span>
|
1236
|
-
<span class='
|
1237
|
-
<span class='rparen'>)</span>
|
1238
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoint_configurations/%{id}</span><span class='tstring_end'>'</span></span>
|
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>
|
1239
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>
|
1240
1202
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1241
1203
|
<span class='rbrace'>}</span>
|
1242
1204
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1243
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>
|
1244
|
-
<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>
|
1245
1207
|
<span class='kw'>end</span></pre>
|
1246
1208
|
</td>
|
1247
1209
|
</tr>
|
@@ -1251,7 +1213,7 @@
|
|
1251
1213
|
<div class="method_details ">
|
1252
1214
|
<h3 class="signature " id="get!-instance_method">
|
1253
1215
|
|
1254
|
-
#<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>
|
1255
1217
|
|
1256
1218
|
|
1257
1219
|
|
@@ -1260,9 +1222,9 @@
|
|
1260
1222
|
</h3><div class="docstring">
|
1261
1223
|
<div class="discussion">
|
1262
1224
|
|
1263
|
-
<p>
|
1225
|
+
<p>Get an HTTPS Edge Route by ID Throws an exception if API error.</p>
|
1264
1226
|
|
1265
|
-
<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>
|
1266
1228
|
|
1267
1229
|
|
1268
1230
|
</div>
|
@@ -1271,6 +1233,24 @@
|
|
1271
1233
|
<p class="tag_title">Parameters:</p>
|
1272
1234
|
<ul class="param">
|
1273
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
|
+
|
1274
1254
|
<li>
|
1275
1255
|
|
1276
1256
|
<span class='name'>id</span>
|
@@ -1284,7 +1264,7 @@
|
|
1284
1264
|
|
1285
1265
|
—
|
1286
1266
|
<div class='inline'>
|
1287
|
-
<p>
|
1267
|
+
<p>unique identifier of this edge route</p>
|
1288
1268
|
</div>
|
1289
1269
|
|
1290
1270
|
</li>
|
@@ -1297,7 +1277,7 @@
|
|
1297
1277
|
<li>
|
1298
1278
|
|
1299
1279
|
|
1300
|
-
<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>
|
1301
1281
|
|
1302
1282
|
|
1303
1283
|
|
@@ -1316,31 +1296,29 @@
|
|
1316
1296
|
<pre class="lines">
|
1317
1297
|
|
1318
1298
|
|
1319
|
-
|
1320
|
-
|
1321
|
-
|
1322
|
-
|
1323
|
-
|
1324
|
-
|
1325
|
-
|
1326
|
-
|
1327
|
-
|
1328
|
-
|
1329
|
-
160</pre>
|
1299
|
+
92
|
1300
|
+
93
|
1301
|
+
94
|
1302
|
+
95
|
1303
|
+
96
|
1304
|
+
97
|
1305
|
+
98
|
1306
|
+
99
|
1307
|
+
100
|
1308
|
+
101</pre>
|
1330
1309
|
</td>
|
1331
1310
|
<td>
|
1332
|
-
<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>
|
1333
1312
|
|
1334
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span>
|
1335
|
-
<span class='
|
1336
|
-
<span class='rparen'>)</span>
|
1337
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoint_configurations/%{id}</span><span class='tstring_end'>'</span></span>
|
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>
|
1338
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>
|
1339
1317
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1340
1318
|
<span class='rbrace'>}</span>
|
1341
1319
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1342
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>
|
1343
|
-
<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>
|
1344
1322
|
<span class='kw'>end</span></pre>
|
1345
1323
|
</td>
|
1346
1324
|
</tr>
|
@@ -1348,9 +1326,9 @@
|
|
1348
1326
|
</div>
|
1349
1327
|
|
1350
1328
|
<div class="method_details ">
|
1351
|
-
<h3 class="signature " id="
|
1329
|
+
<h3 class="signature " id="update-instance_method">
|
1352
1330
|
|
1353
|
-
#<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>
|
1354
1332
|
|
1355
1333
|
|
1356
1334
|
|
@@ -1359,9 +1337,9 @@
|
|
1359
1337
|
</h3><div class="docstring">
|
1360
1338
|
<div class="discussion">
|
1361
1339
|
|
1362
|
-
<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>
|
1363
1341
|
|
1364
|
-
<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>
|
1365
1343
|
|
1366
1344
|
|
1367
1345
|
</div>
|
@@ -1372,293 +1350,97 @@
|
|
1372
1350
|
|
1373
1351
|
<li>
|
1374
1352
|
|
1375
|
-
<span class='name'>
|
1353
|
+
<span class='name'>edge_id</span>
|
1376
1354
|
|
1377
1355
|
|
1378
1356
|
<span class='type'>(<tt>string</tt>)</span>
|
1379
1357
|
|
1380
1358
|
|
1381
|
-
<em class="default">(defaults to: <tt
|
1359
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1360
|
+
|
1382
1361
|
|
1362
|
+
—
|
1363
|
+
<div class='inline'>
|
1364
|
+
<p>unique identifier of this edge</p>
|
1365
|
+
</div>
|
1383
1366
|
|
1384
1367
|
</li>
|
1385
1368
|
|
1386
1369
|
<li>
|
1387
1370
|
|
1388
|
-
<span class='name'>
|
1371
|
+
<span class='name'>id</span>
|
1389
1372
|
|
1390
1373
|
|
1391
1374
|
<span class='type'>(<tt>string</tt>)</span>
|
1392
1375
|
|
1393
1376
|
|
1394
|
-
<em class="default">(defaults to: <tt
|
1377
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1395
1378
|
|
1396
1379
|
|
1380
|
+
—
|
1381
|
+
<div class='inline'>
|
1382
|
+
<p>unique identifier of this edge route</p>
|
1383
|
+
</div>
|
1384
|
+
|
1397
1385
|
</li>
|
1398
1386
|
|
1399
1387
|
<li>
|
1400
1388
|
|
1401
|
-
<span class='name'>
|
1389
|
+
<span class='name'>match_type</span>
|
1402
1390
|
|
1403
1391
|
|
1404
1392
|
<span class='type'>(<tt>string</tt>)</span>
|
1405
1393
|
|
1406
1394
|
|
1407
|
-
<em class="default">(defaults to: <tt
|
1395
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1408
1396
|
|
1409
1397
|
|
1410
1398
|
—
|
1411
1399
|
<div class='inline'>
|
1412
|
-
<p>
|
1400
|
+
<p>Type of match to use for this route. Valid values are “exact_path” and “path_prefix”.</p>
|
1413
1401
|
</div>
|
1414
1402
|
|
1415
1403
|
</li>
|
1416
1404
|
|
1417
|
-
</ul>
|
1418
|
-
|
1419
|
-
<p class="tag_title">Returns:</p>
|
1420
|
-
<ul class="return">
|
1421
|
-
|
1422
1405
|
<li>
|
1423
1406
|
|
1407
|
+
<span class='name'>match</span>
|
1424
1408
|
|
1425
|
-
<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>
|
1426
1409
|
|
1410
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1427
1411
|
|
1428
1412
|
|
1429
|
-
|
1430
|
-
<div class='inline'>
|
1431
|
-
<p>result from the API request</p>
|
1432
|
-
</div>
|
1433
|
-
|
1434
|
-
</li>
|
1435
|
-
|
1436
|
-
</ul>
|
1437
|
-
|
1438
|
-
</div><table class="source_code">
|
1439
|
-
<tr>
|
1440
|
-
<td>
|
1441
|
-
<pre class="lines">
|
1442
|
-
|
1443
|
-
|
1444
|
-
171
|
1445
|
-
172
|
1446
|
-
173
|
1447
|
-
174
|
1448
|
-
175
|
1449
|
-
176
|
1450
|
-
177
|
1451
|
-
178
|
1452
|
-
179
|
1453
|
-
180
|
1454
|
-
181
|
1455
|
-
182
|
1456
|
-
183
|
1457
|
-
184
|
1458
|
-
185
|
1459
|
-
186
|
1460
|
-
187
|
1461
|
-
188
|
1462
|
-
189</pre>
|
1463
|
-
</td>
|
1464
|
-
<td>
|
1465
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 171</span>
|
1466
|
-
|
1467
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
1468
|
-
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
1469
|
-
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
1470
|
-
<span class='label'>url:</span> <span class='kw'>nil</span>
|
1471
|
-
<span class='rparen'>)</span>
|
1472
|
-
<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>
|
1473
|
-
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
1474
|
-
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
1475
|
-
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
1476
|
-
<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>
|
1477
|
-
<span class='rparen'>)</span>
|
1478
|
-
|
1479
|
-
<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>
|
1480
|
-
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
1481
|
-
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
1482
|
-
<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>
|
1483
|
-
<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>
|
1484
|
-
<span class='rparen'>)</span>
|
1485
|
-
<span class='kw'>end</span></pre>
|
1486
|
-
</td>
|
1487
|
-
</tr>
|
1488
|
-
</table>
|
1489
|
-
</div>
|
1490
|
-
|
1491
|
-
<div class="method_details ">
|
1492
|
-
<h3 class="signature " id="list!-instance_method">
|
1493
|
-
|
1494
|
-
#<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>
|
1495
|
-
|
1496
|
-
|
1497
|
-
|
1498
|
-
|
1499
|
-
|
1500
|
-
</h3><div class="docstring">
|
1501
|
-
<div class="discussion">
|
1502
|
-
|
1503
|
-
<p>Returns a list of all endpoint configurations on this account Throws an exception if API error.</p>
|
1504
|
-
|
1505
|
-
<p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-list">ngrok.com/docs/api#api-endpoint-configurations-list</a></p>
|
1506
|
-
|
1507
|
-
|
1508
|
-
</div>
|
1509
|
-
</div>
|
1510
|
-
<div class="tags">
|
1511
|
-
<p class="tag_title">Parameters:</p>
|
1512
|
-
<ul class="param">
|
1513
|
-
|
1514
|
-
<li>
|
1515
|
-
|
1516
|
-
<span class='name'>before_id</span>
|
1517
|
-
|
1518
|
-
|
1519
|
-
<span class='type'>(<tt>string</tt>)</span>
|
1520
|
-
|
1521
|
-
|
1522
|
-
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1523
|
-
|
1524
|
-
|
1525
|
-
</li>
|
1526
|
-
|
1527
|
-
<li>
|
1528
|
-
|
1529
|
-
<span class='name'>limit</span>
|
1530
|
-
|
1531
|
-
|
1532
|
-
<span class='type'>(<tt>string</tt>)</span>
|
1533
|
-
|
1534
|
-
|
1535
|
-
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1536
|
-
|
1537
|
-
|
1538
|
-
</li>
|
1539
|
-
|
1540
|
-
<li>
|
1541
|
-
|
1542
|
-
<span class='name'>url</span>
|
1543
|
-
|
1544
|
-
|
1545
|
-
<span class='type'>(<tt>string</tt>)</span>
|
1546
|
-
|
1547
|
-
|
1548
|
-
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1413
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1549
1414
|
|
1550
1415
|
|
1551
1416
|
—
|
1552
1417
|
<div class='inline'>
|
1553
|
-
<p>
|
1418
|
+
<p>Route selector: “/blog” or “example.com” or “example.com/blog”</p>
|
1554
1419
|
</div>
|
1555
1420
|
|
1556
1421
|
</li>
|
1557
1422
|
|
1558
|
-
</ul>
|
1559
|
-
|
1560
|
-
<p class="tag_title">Returns:</p>
|
1561
|
-
<ul class="return">
|
1562
|
-
|
1563
1423
|
<li>
|
1564
1424
|
|
1425
|
+
<span class='name'>description</span>
|
1426
|
+
|
1427
|
+
|
1428
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1565
1429
|
|
1566
|
-
<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>
|
1567
1430
|
|
1431
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1568
1432
|
|
1569
1433
|
|
1570
1434
|
—
|
1571
1435
|
<div class='inline'>
|
1572
|
-
<p>
|
1436
|
+
<p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
|
1573
1437
|
</div>
|
1574
1438
|
|
1575
1439
|
</li>
|
1576
1440
|
|
1577
|
-
</ul>
|
1578
|
-
|
1579
|
-
</div><table class="source_code">
|
1580
|
-
<tr>
|
1581
|
-
<td>
|
1582
|
-
<pre class="lines">
|
1583
|
-
|
1584
|
-
|
1585
|
-
201
|
1586
|
-
202
|
1587
|
-
203
|
1588
|
-
204
|
1589
|
-
205
|
1590
|
-
206
|
1591
|
-
207
|
1592
|
-
208
|
1593
|
-
209
|
1594
|
-
210
|
1595
|
-
211
|
1596
|
-
212
|
1597
|
-
213
|
1598
|
-
214
|
1599
|
-
215
|
1600
|
-
216
|
1601
|
-
217
|
1602
|
-
218
|
1603
|
-
219
|
1604
|
-
220
|
1605
|
-
221</pre>
|
1606
|
-
</td>
|
1607
|
-
<td>
|
1608
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 201</span>
|
1609
|
-
|
1610
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
|
1611
|
-
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
1612
|
-
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
1613
|
-
<span class='label'>url:</span> <span class='kw'>nil</span>
|
1614
|
-
<span class='rparen'>)</span>
|
1615
|
-
<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>
|
1616
|
-
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
1617
|
-
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
1618
|
-
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
1619
|
-
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
1620
|
-
<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>
|
1621
|
-
<span class='rparen'>)</span>
|
1622
|
-
|
1623
|
-
<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>
|
1624
|
-
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
1625
|
-
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
1626
|
-
<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>
|
1627
|
-
<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>
|
1628
|
-
<span class='label'>danger:</span> <span class='kw'>true</span>
|
1629
|
-
<span class='rparen'>)</span>
|
1630
|
-
<span class='kw'>end</span></pre>
|
1631
|
-
</td>
|
1632
|
-
</tr>
|
1633
|
-
</table>
|
1634
|
-
</div>
|
1635
|
-
|
1636
|
-
<div class="method_details ">
|
1637
|
-
<h3 class="signature " id="update-instance_method">
|
1638
|
-
|
1639
|
-
#<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>
|
1640
|
-
|
1641
|
-
|
1642
|
-
|
1643
|
-
|
1644
|
-
|
1645
|
-
</h3><div class="docstring">
|
1646
|
-
<div class="discussion">
|
1647
|
-
|
1648
|
-
<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>
|
1649
|
-
|
1650
|
-
<p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-update">ngrok.com/docs/api#api-endpoint-configurations-update</a></p>
|
1651
|
-
|
1652
|
-
|
1653
|
-
</div>
|
1654
|
-
</div>
|
1655
|
-
<div class="tags">
|
1656
|
-
<p class="tag_title">Parameters:</p>
|
1657
|
-
<ul class="param">
|
1658
|
-
|
1659
1441
|
<li>
|
1660
1442
|
|
1661
|
-
<span class='name'>
|
1443
|
+
<span class='name'>metadata</span>
|
1662
1444
|
|
1663
1445
|
|
1664
1446
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -1669,17 +1451,17 @@
|
|
1669
1451
|
|
1670
1452
|
—
|
1671
1453
|
<div class='inline'>
|
1672
|
-
<p>
|
1454
|
+
<p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
|
1673
1455
|
</div>
|
1674
1456
|
|
1675
1457
|
</li>
|
1676
1458
|
|
1677
1459
|
<li>
|
1678
1460
|
|
1679
|
-
<span class='name'>
|
1461
|
+
<span class='name'>backend</span>
|
1680
1462
|
|
1681
1463
|
|
1682
|
-
<span class='type'>(<tt>
|
1464
|
+
<span class='type'>(<tt>EndpointBackendMutate</tt>)</span>
|
1683
1465
|
|
1684
1466
|
|
1685
1467
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -1687,17 +1469,17 @@
|
|
1687
1469
|
|
1688
1470
|
—
|
1689
1471
|
<div class='inline'>
|
1690
|
-
<p>
|
1472
|
+
<p>backend module configuration or <code>null</code></p>
|
1691
1473
|
</div>
|
1692
1474
|
|
1693
1475
|
</li>
|
1694
1476
|
|
1695
1477
|
<li>
|
1696
1478
|
|
1697
|
-
<span class='name'>
|
1479
|
+
<span class='name'>ip_restriction</span>
|
1698
1480
|
|
1699
1481
|
|
1700
|
-
<span class='type'>(<tt>
|
1482
|
+
<span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
|
1701
1483
|
|
1702
1484
|
|
1703
1485
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -1705,7 +1487,7 @@
|
|
1705
1487
|
|
1706
1488
|
—
|
1707
1489
|
<div class='inline'>
|
1708
|
-
<p>
|
1490
|
+
<p>ip restriction module configuration or <code>null</code></p>
|
1709
1491
|
</div>
|
1710
1492
|
|
1711
1493
|
</li>
|
@@ -1784,61 +1566,7 @@
|
|
1784
1566
|
|
1785
1567
|
<li>
|
1786
1568
|
|
1787
|
-
<span class='name'>
|
1788
|
-
|
1789
|
-
|
1790
|
-
<span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
|
1791
|
-
|
1792
|
-
|
1793
|
-
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1794
|
-
|
1795
|
-
|
1796
|
-
—
|
1797
|
-
<div class='inline'>
|
1798
|
-
<p>ip policy module configuration or <code>null</code></p>
|
1799
|
-
</div>
|
1800
|
-
|
1801
|
-
</li>
|
1802
|
-
|
1803
|
-
<li>
|
1804
|
-
|
1805
|
-
<span class='name'>mutual_tls</span>
|
1806
|
-
|
1807
|
-
|
1808
|
-
<span class='type'>(<tt>EndpointMutualTLSMutate</tt>)</span>
|
1809
|
-
|
1810
|
-
|
1811
|
-
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1812
|
-
|
1813
|
-
|
1814
|
-
—
|
1815
|
-
<div class='inline'>
|
1816
|
-
<p>mutual TLS module configuration or <code>null</code></p>
|
1817
|
-
</div>
|
1818
|
-
|
1819
|
-
</li>
|
1820
|
-
|
1821
|
-
<li>
|
1822
|
-
|
1823
|
-
<span class='name'>tls_termination</span>
|
1824
|
-
|
1825
|
-
|
1826
|
-
<span class='type'>(<tt>EndpointTLSTermination</tt>)</span>
|
1827
|
-
|
1828
|
-
|
1829
|
-
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1830
|
-
|
1831
|
-
|
1832
|
-
—
|
1833
|
-
<div class='inline'>
|
1834
|
-
<p>TLS termination module configuration or <code>null</code></p>
|
1835
|
-
</div>
|
1836
|
-
|
1837
|
-
</li>
|
1838
|
-
|
1839
|
-
<li>
|
1840
|
-
|
1841
|
-
<span class='name'>webhook_validation</span>
|
1569
|
+
<span class='name'>webhook_verification</span>
|
1842
1570
|
|
1843
1571
|
|
1844
1572
|
<span class='type'>(<tt>EndpointWebhookValidation</tt>)</span>
|
@@ -1849,7 +1577,7 @@
|
|
1849
1577
|
|
1850
1578
|
—
|
1851
1579
|
<div class='inline'>
|
1852
|
-
<p>webhook
|
1580
|
+
<p>webhook verification module configuration or <code>null</code></p>
|
1853
1581
|
</div>
|
1854
1582
|
|
1855
1583
|
</li>
|
@@ -1874,10 +1602,10 @@
|
|
1874
1602
|
|
1875
1603
|
<li>
|
1876
1604
|
|
1877
|
-
<span class='name'>
|
1605
|
+
<span class='name'>saml</span>
|
1878
1606
|
|
1879
1607
|
|
1880
|
-
<span class='type'>(<tt>
|
1608
|
+
<span class='type'>(<tt>EndpointSAMLMutate</tt>)</span>
|
1881
1609
|
|
1882
1610
|
|
1883
1611
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -1885,17 +1613,17 @@
|
|
1885
1613
|
|
1886
1614
|
—
|
1887
1615
|
<div class='inline'>
|
1888
|
-
<p>
|
1616
|
+
<p>saml module configuration or <code>null</code></p>
|
1889
1617
|
</div>
|
1890
1618
|
|
1891
1619
|
</li>
|
1892
1620
|
|
1893
1621
|
<li>
|
1894
1622
|
|
1895
|
-
<span class='name'>
|
1623
|
+
<span class='name'>oidc</span>
|
1896
1624
|
|
1897
1625
|
|
1898
|
-
<span class='type'>(<tt>
|
1626
|
+
<span class='type'>(<tt>EndpointOIDC</tt>)</span>
|
1899
1627
|
|
1900
1628
|
|
1901
1629
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -1903,17 +1631,17 @@
|
|
1903
1631
|
|
1904
1632
|
—
|
1905
1633
|
<div class='inline'>
|
1906
|
-
<p>
|
1634
|
+
<p>oidc module configuration or <code>null</code></p>
|
1907
1635
|
</div>
|
1908
1636
|
|
1909
1637
|
</li>
|
1910
1638
|
|
1911
1639
|
<li>
|
1912
1640
|
|
1913
|
-
<span class='name'>
|
1641
|
+
<span class='name'>websocket_tcp_converter</span>
|
1914
1642
|
|
1915
1643
|
|
1916
|
-
<span class='type'>(<tt>
|
1644
|
+
<span class='type'>(<tt>EndpointWebsocketTCPConverter</tt>)</span>
|
1917
1645
|
|
1918
1646
|
|
1919
1647
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -1921,7 +1649,7 @@
|
|
1921
1649
|
|
1922
1650
|
—
|
1923
1651
|
<div class='inline'>
|
1924
|
-
<p>
|
1652
|
+
<p>websocket to tcp adapter configuration or <code>null</code></p>
|
1925
1653
|
</div>
|
1926
1654
|
|
1927
1655
|
</li>
|
@@ -1934,7 +1662,7 @@
|
|
1934
1662
|
<li>
|
1935
1663
|
|
1936
1664
|
|
1937
|
-
<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>
|
1938
1666
|
|
1939
1667
|
|
1940
1668
|
|
@@ -1953,91 +1681,59 @@
|
|
1953
1681
|
<pre class="lines">
|
1954
1682
|
|
1955
1683
|
|
1956
|
-
|
1957
|
-
|
1958
|
-
|
1959
|
-
|
1960
|
-
|
1961
|
-
|
1962
|
-
|
1963
|
-
|
1964
|
-
|
1965
|
-
|
1966
|
-
|
1967
|
-
|
1968
|
-
|
1969
|
-
|
1970
|
-
|
1971
|
-
|
1972
|
-
|
1973
|
-
|
1974
|
-
|
1975
|
-
|
1976
|
-
|
1977
|
-
|
1978
|
-
|
1979
|
-
|
1980
|
-
|
1981
|
-
272
|
1982
|
-
273
|
1983
|
-
274
|
1984
|
-
275
|
1985
|
-
276
|
1986
|
-
277
|
1987
|
-
278
|
1988
|
-
279
|
1989
|
-
280
|
1990
|
-
281
|
1991
|
-
282
|
1992
|
-
283
|
1993
|
-
284
|
1994
|
-
285
|
1995
|
-
286
|
1996
|
-
287</pre>
|
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>
|
1997
1709
|
</td>
|
1998
1710
|
<td>
|
1999
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
2000
|
-
|
2001
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
|
2002
|
-
<span class='
|
2003
|
-
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2004
|
-
<span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2005
|
-
<span class='label'>basic_auth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2006
|
-
<span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2007
|
-
<span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2008
|
-
<span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2009
|
-
<span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2010
|
-
<span class='label'>ip_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2011
|
-
<span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2012
|
-
<span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2013
|
-
<span class='label'>webhook_validation:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2014
|
-
<span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2015
|
-
<span class='label'>logging:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2016
|
-
<span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2017
|
-
<span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2018
|
-
<span class='label'>backend:</span> <span class='kw'>nil</span>
|
2019
|
-
<span class='rparen'>)</span>
|
2020
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoint_configurations/%{id}</span><span class='tstring_end'>'</span></span>
|
1711
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 129</span>
|
1712
|
+
|
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>
|
2021
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>
|
2022
1717
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
2023
1718
|
<span class='rbrace'>}</span>
|
2024
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>
|
2025
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>
|
2026
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>
|
2027
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>
|
2028
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>
|
2029
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>
|
2030
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>
|
2031
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:
|
2032
|
-
<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>
|
2033
|
-
<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>
|
2034
|
-
<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>
|
2035
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>
|
2036
|
-
<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>
|
2037
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>
|
2038
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>
|
2039
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>
|
2040
|
-
<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>
|
2041
1737
|
<span class='kw'>end</span></pre>
|
2042
1738
|
</td>
|
2043
1739
|
</tr>
|
@@ -2047,7 +1743,7 @@
|
|
2047
1743
|
<div class="method_details ">
|
2048
1744
|
<h3 class="signature " id="update!-instance_method">
|
2049
1745
|
|
2050
|
-
#<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>
|
2051
1747
|
|
2052
1748
|
|
2053
1749
|
|
@@ -2056,9 +1752,9 @@
|
|
2056
1752
|
</h3><div class="docstring">
|
2057
1753
|
<div class="discussion">
|
2058
1754
|
|
2059
|
-
<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>
|
2060
1756
|
|
2061
|
-
<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>
|
2062
1758
|
|
2063
1759
|
|
2064
1760
|
</div>
|
@@ -2067,6 +1763,24 @@
|
|
2067
1763
|
<p class="tag_title">Parameters:</p>
|
2068
1764
|
<ul class="param">
|
2069
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
|
+
|
2070
1784
|
<li>
|
2071
1785
|
|
2072
1786
|
<span class='name'>id</span>
|
@@ -2080,89 +1794,89 @@
|
|
2080
1794
|
|
2081
1795
|
—
|
2082
1796
|
<div class='inline'>
|
2083
|
-
<p>unique identifier of this
|
1797
|
+
<p>unique identifier of this edge route</p>
|
2084
1798
|
</div>
|
2085
1799
|
|
2086
1800
|
</li>
|
2087
1801
|
|
2088
1802
|
<li>
|
2089
1803
|
|
2090
|
-
<span class='name'>
|
1804
|
+
<span class='name'>match_type</span>
|
2091
1805
|
|
2092
1806
|
|
2093
1807
|
<span class='type'>(<tt>string</tt>)</span>
|
2094
1808
|
|
2095
1809
|
|
2096
|
-
<em class="default">(defaults to: <tt
|
1810
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
2097
1811
|
|
2098
1812
|
|
2099
1813
|
—
|
2100
1814
|
<div class='inline'>
|
2101
|
-
<p>
|
1815
|
+
<p>Type of match to use for this route. Valid values are “exact_path” and “path_prefix”.</p>
|
2102
1816
|
</div>
|
2103
1817
|
|
2104
1818
|
</li>
|
2105
1819
|
|
2106
1820
|
<li>
|
2107
1821
|
|
2108
|
-
<span class='name'>
|
1822
|
+
<span class='name'>match</span>
|
2109
1823
|
|
2110
1824
|
|
2111
1825
|
<span class='type'>(<tt>string</tt>)</span>
|
2112
1826
|
|
2113
1827
|
|
2114
|
-
<em class="default">(defaults to: <tt
|
1828
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
2115
1829
|
|
2116
1830
|
|
2117
1831
|
—
|
2118
1832
|
<div class='inline'>
|
2119
|
-
<p>
|
1833
|
+
<p>Route selector: “/blog” or “example.com” or “example.com/blog”</p>
|
2120
1834
|
</div>
|
2121
1835
|
|
2122
1836
|
</li>
|
2123
1837
|
|
2124
1838
|
<li>
|
2125
1839
|
|
2126
|
-
<span class='name'>
|
1840
|
+
<span class='name'>description</span>
|
2127
1841
|
|
2128
1842
|
|
2129
|
-
<span class='type'>(<tt>
|
1843
|
+
<span class='type'>(<tt>string</tt>)</span>
|
2130
1844
|
|
2131
1845
|
|
2132
|
-
<em class="default">(defaults to: <tt
|
1846
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
2133
1847
|
|
2134
1848
|
|
2135
1849
|
—
|
2136
1850
|
<div class='inline'>
|
2137
|
-
<p>
|
1851
|
+
<p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
|
2138
1852
|
</div>
|
2139
1853
|
|
2140
1854
|
</li>
|
2141
1855
|
|
2142
1856
|
<li>
|
2143
1857
|
|
2144
|
-
<span class='name'>
|
1858
|
+
<span class='name'>metadata</span>
|
2145
1859
|
|
2146
1860
|
|
2147
|
-
<span class='type'>(<tt>
|
1861
|
+
<span class='type'>(<tt>string</tt>)</span>
|
2148
1862
|
|
2149
1863
|
|
2150
|
-
<em class="default">(defaults to: <tt
|
1864
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
2151
1865
|
|
2152
1866
|
|
2153
1867
|
—
|
2154
1868
|
<div class='inline'>
|
2155
|
-
<p>
|
1869
|
+
<p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
|
2156
1870
|
</div>
|
2157
1871
|
|
2158
1872
|
</li>
|
2159
1873
|
|
2160
1874
|
<li>
|
2161
1875
|
|
2162
|
-
<span class='name'>
|
1876
|
+
<span class='name'>backend</span>
|
2163
1877
|
|
2164
1878
|
|
2165
|
-
<span class='type'>(<tt>
|
1879
|
+
<span class='type'>(<tt>EndpointBackendMutate</tt>)</span>
|
2166
1880
|
|
2167
1881
|
|
2168
1882
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -2170,17 +1884,17 @@
|
|
2170
1884
|
|
2171
1885
|
—
|
2172
1886
|
<div class='inline'>
|
2173
|
-
<p>
|
1887
|
+
<p>backend module configuration or <code>null</code></p>
|
2174
1888
|
</div>
|
2175
1889
|
|
2176
1890
|
</li>
|
2177
1891
|
|
2178
1892
|
<li>
|
2179
1893
|
|
2180
|
-
<span class='name'>
|
1894
|
+
<span class='name'>ip_restriction</span>
|
2181
1895
|
|
2182
1896
|
|
2183
|
-
<span class='type'>(<tt>
|
1897
|
+
<span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
|
2184
1898
|
|
2185
1899
|
|
2186
1900
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -2188,17 +1902,17 @@
|
|
2188
1902
|
|
2189
1903
|
—
|
2190
1904
|
<div class='inline'>
|
2191
|
-
<p>
|
1905
|
+
<p>ip restriction module configuration or <code>null</code></p>
|
2192
1906
|
</div>
|
2193
1907
|
|
2194
1908
|
</li>
|
2195
1909
|
|
2196
1910
|
<li>
|
2197
1911
|
|
2198
|
-
<span class='name'>
|
1912
|
+
<span class='name'>circuit_breaker</span>
|
2199
1913
|
|
2200
1914
|
|
2201
|
-
<span class='type'>(<tt>
|
1915
|
+
<span class='type'>(<tt>EndpointCircuitBreaker</tt>)</span>
|
2202
1916
|
|
2203
1917
|
|
2204
1918
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -2206,17 +1920,17 @@
|
|
2206
1920
|
|
2207
1921
|
—
|
2208
1922
|
<div class='inline'>
|
2209
|
-
<p>
|
1923
|
+
<p>circuit breaker module configuration or <code>null</code></p>
|
2210
1924
|
</div>
|
2211
1925
|
|
2212
1926
|
</li>
|
2213
1927
|
|
2214
1928
|
<li>
|
2215
1929
|
|
2216
|
-
<span class='name'>
|
1930
|
+
<span class='name'>compression</span>
|
2217
1931
|
|
2218
1932
|
|
2219
|
-
<span class='type'>(<tt>
|
1933
|
+
<span class='type'>(<tt>EndpointCompression</tt>)</span>
|
2220
1934
|
|
2221
1935
|
|
2222
1936
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -2224,17 +1938,17 @@
|
|
2224
1938
|
|
2225
1939
|
—
|
2226
1940
|
<div class='inline'>
|
2227
|
-
<p>
|
1941
|
+
<p>compression module configuration or <code>null</code></p>
|
2228
1942
|
</div>
|
2229
1943
|
|
2230
1944
|
</li>
|
2231
1945
|
|
2232
1946
|
<li>
|
2233
1947
|
|
2234
|
-
<span class='name'>
|
1948
|
+
<span class='name'>request_headers</span>
|
2235
1949
|
|
2236
1950
|
|
2237
|
-
<span class='type'>(<tt>
|
1951
|
+
<span class='type'>(<tt>EndpointRequestHeaders</tt>)</span>
|
2238
1952
|
|
2239
1953
|
|
2240
1954
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -2242,17 +1956,17 @@
|
|
2242
1956
|
|
2243
1957
|
—
|
2244
1958
|
<div class='inline'>
|
2245
|
-
<p>
|
1959
|
+
<p>request headers module configuration or <code>null</code></p>
|
2246
1960
|
</div>
|
2247
1961
|
|
2248
1962
|
</li>
|
2249
1963
|
|
2250
1964
|
<li>
|
2251
1965
|
|
2252
|
-
<span class='name'>
|
1966
|
+
<span class='name'>response_headers</span>
|
2253
1967
|
|
2254
1968
|
|
2255
|
-
<span class='type'>(<tt>
|
1969
|
+
<span class='type'>(<tt>EndpointResponseHeaders</tt>)</span>
|
2256
1970
|
|
2257
1971
|
|
2258
1972
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -2260,17 +1974,17 @@
|
|
2260
1974
|
|
2261
1975
|
—
|
2262
1976
|
<div class='inline'>
|
2263
|
-
<p>
|
1977
|
+
<p>response headers module configuration or <code>null</code></p>
|
2264
1978
|
</div>
|
2265
1979
|
|
2266
1980
|
</li>
|
2267
1981
|
|
2268
1982
|
<li>
|
2269
1983
|
|
2270
|
-
<span class='name'>
|
1984
|
+
<span class='name'>webhook_verification</span>
|
2271
1985
|
|
2272
1986
|
|
2273
|
-
<span class='type'>(<tt>
|
1987
|
+
<span class='type'>(<tt>EndpointWebhookValidation</tt>)</span>
|
2274
1988
|
|
2275
1989
|
|
2276
1990
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -2278,17 +1992,17 @@
|
|
2278
1992
|
|
2279
1993
|
—
|
2280
1994
|
<div class='inline'>
|
2281
|
-
<p>
|
1995
|
+
<p>webhook verification module configuration or <code>null</code></p>
|
2282
1996
|
</div>
|
2283
1997
|
|
2284
1998
|
</li>
|
2285
1999
|
|
2286
2000
|
<li>
|
2287
2001
|
|
2288
|
-
<span class='name'>
|
2002
|
+
<span class='name'>oauth</span>
|
2289
2003
|
|
2290
2004
|
|
2291
|
-
<span class='type'>(<tt>
|
2005
|
+
<span class='type'>(<tt>EndpointOAuth</tt>)</span>
|
2292
2006
|
|
2293
2007
|
|
2294
2008
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -2296,7 +2010,7 @@
|
|
2296
2010
|
|
2297
2011
|
—
|
2298
2012
|
<div class='inline'>
|
2299
|
-
<p>
|
2013
|
+
<p>oauth module configuration or <code>null</code></p>
|
2300
2014
|
</div>
|
2301
2015
|
|
2302
2016
|
</li>
|
@@ -2333,6 +2047,24 @@
|
|
2333
2047
|
—
|
2334
2048
|
<div class='inline'>
|
2335
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>
|
2336
2068
|
</div>
|
2337
2069
|
|
2338
2070
|
</li>
|
@@ -2345,7 +2077,7 @@
|
|
2345
2077
|
<li>
|
2346
2078
|
|
2347
2079
|
|
2348
|
-
<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>
|
2349
2081
|
|
2350
2082
|
|
2351
2083
|
|
@@ -2364,91 +2096,59 @@
|
|
2364
2096
|
<pre class="lines">
|
2365
2097
|
|
2366
2098
|
|
2367
|
-
|
2368
|
-
|
2369
|
-
|
2370
|
-
|
2371
|
-
|
2372
|
-
|
2373
|
-
|
2374
|
-
|
2375
|
-
|
2376
|
-
|
2377
|
-
|
2378
|
-
|
2379
|
-
|
2380
|
-
|
2381
|
-
|
2382
|
-
|
2383
|
-
|
2384
|
-
|
2385
|
-
|
2386
|
-
|
2387
|
-
|
2388
|
-
|
2389
|
-
|
2390
|
-
|
2391
|
-
|
2392
|
-
339
|
2393
|
-
340
|
2394
|
-
341
|
2395
|
-
342
|
2396
|
-
343
|
2397
|
-
344
|
2398
|
-
345
|
2399
|
-
346
|
2400
|
-
347
|
2401
|
-
348
|
2402
|
-
349
|
2403
|
-
350
|
2404
|
-
351
|
2405
|
-
352
|
2406
|
-
353
|
2407
|
-
354</pre>
|
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>
|
2408
2124
|
</td>
|
2409
2125
|
<td>
|
2410
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
2411
|
-
|
2412
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
|
2413
|
-
<span class='
|
2414
|
-
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2415
|
-
<span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2416
|
-
<span class='label'>basic_auth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2417
|
-
<span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2418
|
-
<span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2419
|
-
<span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2420
|
-
<span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2421
|
-
<span class='label'>ip_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2422
|
-
<span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2423
|
-
<span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2424
|
-
<span class='label'>webhook_validation:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2425
|
-
<span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2426
|
-
<span class='label'>logging:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2427
|
-
<span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2428
|
-
<span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
2429
|
-
<span class='label'>backend:</span> <span class='kw'>nil</span>
|
2430
|
-
<span class='rparen'>)</span>
|
2431
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoint_configurations/%{id}</span><span class='tstring_end'>'</span></span>
|
2126
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 182</span>
|
2127
|
+
|
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>
|
2432
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>
|
2433
2132
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
2434
2133
|
<span class='rbrace'>}</span>
|
2435
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>
|
2436
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>
|
2437
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>
|
2438
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>
|
2439
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>
|
2440
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>
|
2441
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>
|
2442
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:
|
2443
|
-
<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>
|
2444
|
-
<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>
|
2445
|
-
<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>
|
2446
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>
|
2447
|
-
<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>
|
2448
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>
|
2449
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>
|
2450
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>
|
2451
|
-
<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>
|
2452
2152
|
<span class='kw'>end</span></pre>
|
2453
2153
|
</td>
|
2454
2154
|
</tr>
|
@@ -2460,9 +2160,9 @@
|
|
2460
2160
|
</div>
|
2461
2161
|
|
2462
2162
|
<div id="footer">
|
2463
|
-
Generated on
|
2163
|
+
Generated on Thu Mar 10 16:54:46 2022 by
|
2464
2164
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
2465
|
-
0.9.
|
2165
|
+
0.9.27 (ruby-2.7.5).
|
2466
2166
|
</div>
|
2467
2167
|
|
2468
2168
|
</div>
|