ngrok-api 0.9.0 → 0.12.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/.gitkeep +0 -0
- data/doc/NgrokAPI/Client.html +1499 -125
- data/doc/NgrokAPI/Error.html +1 -1
- data/doc/NgrokAPI/Errors/NotFoundError.html +1 -1
- data/doc/NgrokAPI/Errors.html +1 -1
- data/doc/NgrokAPI/HttpClient.html +1 -1
- data/doc/NgrokAPI/Models/{ApiKey.html → APIKey.html} +108 -177
- data/doc/NgrokAPI/Models/AWSAuth.html +617 -0
- data/doc/NgrokAPI/Models/AWSCredentials.html +617 -0
- data/doc/NgrokAPI/Models/AWSRole.html +543 -0
- data/doc/NgrokAPI/Models/AbuseReport.html +987 -0
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +617 -0
- data/doc/NgrokAPI/Models/CertificateAuthority.html +1439 -0
- data/doc/NgrokAPI/Models/Credential.html +1149 -0
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
- data/doc/NgrokAPI/Models/EndpointCompression.html +543 -0
- data/doc/NgrokAPI/Models/EndpointConfiguration.html +1321 -510
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointLogging.html +617 -0
- data/doc/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointOAuth.html +987 -0
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
- data/doc/NgrokAPI/Models/EndpointOIDC.html +1135 -0
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
- data/doc/NgrokAPI/Models/EndpointSAML.html +1653 -0
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
- data/doc/NgrokAPI/Models/EventDestination.html +1058 -0
- data/doc/NgrokAPI/Models/EventSource.html +765 -0
- data/doc/NgrokAPI/Models/EventSourceReplace.html +691 -0
- data/doc/NgrokAPI/Models/EventStream.html +1309 -0
- data/doc/NgrokAPI/Models/EventSubscription.html +1058 -0
- data/doc/NgrokAPI/Models/EventTarget.html +765 -0
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +617 -0
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +617 -0
- data/doc/NgrokAPI/Models/IPPolicy.html +1069 -0
- data/doc/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/doc/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/doc/NgrokAPI/Models/{TlsCertificate.html → IPWhitelistEntry.html} +168 -163
- data/doc/NgrokAPI/Models/Listable.html +1 -1
- data/doc/NgrokAPI/Models/Ref.html +617 -0
- data/doc/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/doc/NgrokAPI/Models/ReservedDomain.html +111 -1107
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +839 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertNSTarget.html +617 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
- data/doc/NgrokAPI/Models/SSHCredential.html +1149 -0
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
- data/doc/NgrokAPI/Models/TLSCertificate.html +2179 -0
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
- data/doc/NgrokAPI/Models/Tunnel.html +987 -0
- data/doc/NgrokAPI/Models/TunnelSession.html +1209 -0
- data/doc/NgrokAPI/Models.html +4 -4
- data/doc/NgrokAPI/PagedIterator.html +1 -1
- data/{docs/NgrokAPI/Services/ApiKeysClient.html → doc/NgrokAPI/Services/APIKeysClient.html} +287 -151
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +723 -0
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +1489 -0
- data/doc/NgrokAPI/Services/CredentialsClient.html +1534 -0
- data/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +473 -371
- data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +1609 -0
- data/doc/NgrokAPI/Services/EventSourcesClient.html +1348 -0
- data/doc/NgrokAPI/Services/EventStreamsClient.html +1691 -0
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +1603 -0
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +1488 -0
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +1550 -0
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +1620 -0
- data/doc/NgrokAPI/Services/IPWhitelistClient.html +1488 -0
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +1793 -0
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +518 -333
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1532 -0
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +1552 -0
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +1573 -0
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +1617 -0
- data/{docs/NgrokAPI/Services/TlsCertificatesClient.html → doc/NgrokAPI/Services/TLSCertificatesClient.html} +290 -198
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +1468 -0
- data/doc/NgrokAPI/Services/TunnelsClient.html +513 -0
- data/doc/NgrokAPI/Services.html +4 -4
- data/doc/NgrokAPI.html +3 -3
- data/doc/_index.html +624 -28
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +1 -1
- data/doc/index.html +1 -1
- data/doc/method_list.html +7318 -286
- data/doc/top-level-namespace.html +1 -1
- data/docs/.gitkeep +0 -0
- data/docs/NgrokAPI/Client.html +1499 -125
- data/docs/NgrokAPI/Error.html +1 -1
- data/docs/NgrokAPI/Errors/NotFoundError.html +1 -1
- data/docs/NgrokAPI/Errors.html +1 -1
- data/docs/NgrokAPI/HttpClient.html +1 -1
- data/docs/NgrokAPI/Models/{ApiKey.html → APIKey.html} +108 -177
- data/docs/NgrokAPI/Models/AWSAuth.html +617 -0
- data/docs/NgrokAPI/Models/AWSCredentials.html +617 -0
- data/docs/NgrokAPI/Models/AWSRole.html +543 -0
- data/docs/NgrokAPI/Models/AbuseReport.html +987 -0
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +617 -0
- data/docs/NgrokAPI/Models/CertificateAuthority.html +1439 -0
- data/docs/NgrokAPI/Models/Credential.html +1149 -0
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
- data/docs/NgrokAPI/Models/EndpointCompression.html +543 -0
- data/docs/NgrokAPI/Models/EndpointConfiguration.html +1321 -510
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointLogging.html +617 -0
- data/docs/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointOAuth.html +987 -0
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
- data/docs/NgrokAPI/Models/EndpointOIDC.html +1135 -0
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
- data/docs/NgrokAPI/Models/EndpointSAML.html +1653 -0
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
- data/docs/NgrokAPI/Models/EventDestination.html +1058 -0
- data/docs/NgrokAPI/Models/EventSource.html +765 -0
- data/docs/NgrokAPI/Models/EventSourceReplace.html +691 -0
- data/docs/NgrokAPI/Models/EventStream.html +1309 -0
- data/docs/NgrokAPI/Models/EventSubscription.html +1058 -0
- data/docs/NgrokAPI/Models/EventTarget.html +765 -0
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +617 -0
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +617 -0
- data/docs/NgrokAPI/Models/IPPolicy.html +1069 -0
- data/docs/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/docs/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/docs/NgrokAPI/Models/{TlsCertificate.html → IPWhitelistEntry.html} +168 -163
- data/docs/NgrokAPI/Models/Listable.html +1 -1
- data/docs/NgrokAPI/Models/Ref.html +617 -0
- data/docs/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/docs/NgrokAPI/Models/ReservedDomain.html +111 -1107
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +839 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertNSTarget.html +617 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
- data/docs/NgrokAPI/Models/SSHCredential.html +1149 -0
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
- data/docs/NgrokAPI/Models/TLSCertificate.html +2179 -0
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
- data/docs/NgrokAPI/Models/Tunnel.html +987 -0
- data/docs/NgrokAPI/Models/TunnelSession.html +1209 -0
- data/docs/NgrokAPI/Models.html +4 -4
- data/docs/NgrokAPI/PagedIterator.html +1 -1
- data/{doc/NgrokAPI/Services/ApiKeysClient.html → docs/NgrokAPI/Services/APIKeysClient.html} +287 -151
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +723 -0
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +1489 -0
- data/docs/NgrokAPI/Services/CredentialsClient.html +1534 -0
- data/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +473 -371
- data/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +1609 -0
- data/docs/NgrokAPI/Services/EventSourcesClient.html +1348 -0
- data/docs/NgrokAPI/Services/EventStreamsClient.html +1691 -0
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +1603 -0
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +1488 -0
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +1550 -0
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +1620 -0
- data/docs/NgrokAPI/Services/IPWhitelistClient.html +1488 -0
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +1793 -0
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +518 -333
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1532 -0
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +1552 -0
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +1573 -0
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +1617 -0
- data/{doc/NgrokAPI/Services/TlsCertificatesClient.html → docs/NgrokAPI/Services/TLSCertificatesClient.html} +290 -198
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +1468 -0
- data/docs/NgrokAPI/Services/TunnelsClient.html +513 -0
- data/docs/NgrokAPI/Services.html +4 -4
- data/docs/NgrokAPI.html +3 -3
- data/docs/_index.html +624 -28
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +1 -1
- data/docs/index.html +1 -1
- data/docs/method_list.html +7318 -286
- data/docs/top-level-namespace.html +1 -1
- data/lib/ngrokapi/client.rb +218 -49
- data/lib/ngrokapi/models/abuse_report.rb +37 -0
- data/lib/ngrokapi/models/abuse_report_hostname.rb +27 -0
- data/lib/ngrokapi/models/api_key.rb +62 -64
- data/lib/ngrokapi/models/aws_auth.rb +27 -0
- data/lib/ngrokapi/models/aws_credentials.rb +27 -0
- data/lib/ngrokapi/models/aws_role.rb +25 -0
- data/lib/ngrokapi/models/certificate_authority.rb +72 -0
- data/lib/ngrokapi/models/credential.rb +67 -0
- data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +35 -0
- data/lib/ngrokapi/models/endpoint_compression.rb +25 -0
- data/lib/ngrokapi/models/endpoint_configuration.rb +130 -119
- data/lib/ngrokapi/models/endpoint_ip_policy.rb +27 -0
- data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_logging.rb +27 -0
- data/lib/ngrokapi/models/endpoint_logging_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls.rb +27 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_o_auth.rb +37 -0
- data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +37 -0
- data/lib/ngrokapi/models/endpoint_o_auth_google.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +31 -0
- data/lib/ngrokapi/models/endpoint_oidc.rb +41 -0
- data/lib/ngrokapi/models/endpoint_request_headers.rb +29 -0
- data/lib/ngrokapi/models/endpoint_response_headers.rb +29 -0
- data/lib/ngrokapi/models/endpoint_saml.rb +55 -0
- data/lib/ngrokapi/models/endpoint_saml_mutate.rb +45 -0
- data/lib/ngrokapi/models/endpoint_tls_termination.rb +29 -0
- data/lib/ngrokapi/models/endpoint_webhook_validation.rb +29 -0
- data/lib/ngrokapi/models/event_destination.rb +49 -0
- data/lib/ngrokapi/models/event_source.rb +31 -0
- data/lib/ngrokapi/models/event_source_replace.rb +29 -0
- data/lib/ngrokapi/models/event_stream.rb +77 -0
- data/lib/ngrokapi/models/event_subscription.rb +47 -0
- data/lib/ngrokapi/models/event_target.rb +31 -0
- data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +27 -0
- data/lib/ngrokapi/models/event_target_firehose.rb +27 -0
- data/lib/ngrokapi/models/event_target_kinesis.rb +27 -0
- data/lib/ngrokapi/models/ip_policy.rb +64 -0
- data/lib/ngrokapi/models/ip_policy_rule.rb +67 -0
- data/lib/ngrokapi/models/ip_restriction.rb +49 -0
- data/lib/ngrokapi/models/ip_whitelist_entry.rb +62 -0
- data/lib/ngrokapi/models/ref.rb +27 -0
- data/lib/ngrokapi/models/reserved_addr.rb +49 -0
- data/lib/ngrokapi/models/reserved_domain.rb +59 -211
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +33 -0
- data/lib/ngrokapi/models/reserved_domain_cert_ns_target.rb +27 -0
- data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +27 -0
- data/lib/ngrokapi/models/reserved_domain_cert_status.rb +27 -0
- data/lib/ngrokapi/models/ssh_certificate_authority.rb +64 -0
- data/lib/ngrokapi/models/ssh_credential.rb +67 -0
- data/lib/ngrokapi/models/ssh_host_certificate.rb +74 -0
- data/lib/ngrokapi/models/ssh_user_certificate.rb +78 -0
- data/lib/ngrokapi/models/tls_certificate.rb +92 -62
- data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +27 -0
- data/lib/ngrokapi/models/tunnel.rb +37 -0
- data/lib/ngrokapi/models/tunnel_session.rb +43 -0
- data/lib/ngrokapi/services/.gitkeep +0 -0
- data/lib/ngrokapi/services/abuse_reports_client.rb +84 -0
- data/lib/ngrokapi/services/api_keys_client.rb +203 -144
- data/lib/ngrokapi/services/certificate_authorities_client.rb +204 -0
- data/lib/ngrokapi/services/credentials_client.rb +212 -0
- data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_compression_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +324 -313
- data/lib/ngrokapi/services/endpoint_ip_policy_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_logging_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_o_auth_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_oidc_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_request_headers_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_response_headers_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_saml_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_tls_termination_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb +122 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +222 -0
- data/lib/ngrokapi/services/event_sources_client.rb +177 -0
- data/lib/ngrokapi/services/event_streams_client.rb +226 -0
- data/lib/ngrokapi/services/event_subscriptions_client.rb +213 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +208 -0
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +210 -0
- data/lib/ngrokapi/services/ip_restrictions_client.rb +223 -0
- data/lib/ngrokapi/services/ip_whitelist_client.rb +202 -0
- data/lib/ngrokapi/services/reserved_addrs_client.rb +246 -0
- data/lib/ngrokapi/services/reserved_domains_client.rb +382 -313
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +207 -0
- data/lib/ngrokapi/services/ssh_credentials_client.rb +211 -0
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +214 -0
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +220 -0
- data/lib/ngrokapi/services/tls_certificates_client.rb +207 -161
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +228 -0
- data/lib/ngrokapi/services/tunnels_client.rb +51 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/spec/ngrokapi/client_spec.rb +139 -33
- data/spec/ngrokapi/models/abuse_report_hostname_spec.rb +21 -0
- data/spec/ngrokapi/models/abuse_report_spec.rb +21 -0
- data/spec/ngrokapi/models/api_key_spec.rb +42 -43
- data/spec/ngrokapi/models/aws_auth_spec.rb +21 -0
- data/spec/ngrokapi/models/aws_credentials_spec.rb +21 -0
- data/spec/ngrokapi/models/aws_role_spec.rb +21 -0
- data/spec/ngrokapi/models/certificate_authority_spec.rb +42 -0
- data/spec/ngrokapi/models/credential_spec.rb +45 -0
- data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_compression_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_configuration_spec.rb +78 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_logging_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_oidc_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_saml_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +21 -0
- data/spec/ngrokapi/models/event_destination_spec.rb +28 -0
- data/spec/ngrokapi/models/event_source_replace_spec.rb +21 -0
- data/spec/ngrokapi/models/event_source_spec.rb +21 -0
- data/spec/ngrokapi/models/event_stream_spec.rb +51 -0
- data/spec/ngrokapi/models/event_subscription_spec.rb +28 -0
- data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_firehose_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_kinesis_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_spec.rb +21 -0
- data/spec/ngrokapi/models/ip_policy_rule_spec.rb +45 -0
- data/spec/ngrokapi/models/ip_policy_spec.rb +42 -0
- data/spec/ngrokapi/models/ip_restriction_spec.rb +28 -0
- data/spec/ngrokapi/models/ip_whitelist_entry_spec.rb +42 -0
- data/spec/ngrokapi/models/listable_spec.rb +4 -4
- data/spec/ngrokapi/models/ref_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_addr_spec.rb +28 -0
- data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_ns_target_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_spec.rb +28 -100
- data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +42 -0
- data/spec/ngrokapi/models/ssh_credential_spec.rb +45 -0
- data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +21 -0
- data/spec/ngrokapi/models/tls_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/tunnel_session_spec.rb +21 -0
- data/spec/ngrokapi/models/tunnel_spec.rb +21 -0
- data/spec/ngrokapi/paged_iterator_spec.rb +5 -5
- data/spec/ngrokapi/services/.gitkeep +0 -0
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +67 -0
- data/spec/ngrokapi/services/api_keys_client_spec.rb +160 -127
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +162 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +166 -0
- data/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +240 -0
- data/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +175 -0
- data/spec/ngrokapi/services/event_sources_client_spec.rb +162 -0
- data/spec/ngrokapi/services/event_streams_client_spec.rb +180 -0
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +172 -0
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +162 -0
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +168 -0
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +174 -0
- data/spec/ngrokapi/services/ip_whitelist_client_spec.rb +162 -0
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +209 -0
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +352 -0
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +166 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +168 -0
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +170 -0
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +174 -0
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +164 -0
- data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +184 -0
- data/spec/ngrokapi/services/tunnels_client_spec.rb +21 -0
- data/spec/spec_helper.rb +958 -0
- metadata +355 -10
|
@@ -102,7 +102,11 @@
|
|
|
102
102
|
<h2>Overview</h2><div class="docstring">
|
|
103
103
|
<div class="discussion">
|
|
104
104
|
|
|
105
|
-
<p>
|
|
105
|
+
<p>Endpoint Configurations are a reusable group of modules that encapsulate how</p>
|
|
106
|
+
|
|
107
|
+
<pre class="code ruby"><code class="ruby">traffic to a domain or address is handled. Endpoint configurations are only
|
|
108
|
+
applied to Domains and TCP Addresses they have been attached to.
|
|
109
|
+
</code></pre>
|
|
106
110
|
|
|
107
111
|
<p><a href="https://ngrok.com/docs/api#api-endpoint-configurations">ngrok.com/docs/api#api-endpoint-configurations</a></p>
|
|
108
112
|
|
|
@@ -121,11 +125,11 @@
|
|
|
121
125
|
|
|
122
126
|
<dl class="constants">
|
|
123
127
|
|
|
124
|
-
<dt id="
|
|
128
|
+
<dt id="PATH-constant" class="">PATH =
|
|
125
129
|
<div class="docstring">
|
|
126
130
|
<div class="discussion">
|
|
127
131
|
|
|
128
|
-
<p>The
|
|
132
|
+
<p>The API path for the requests</p>
|
|
129
133
|
|
|
130
134
|
|
|
131
135
|
</div>
|
|
@@ -135,13 +139,13 @@
|
|
|
135
139
|
|
|
136
140
|
</div>
|
|
137
141
|
</dt>
|
|
138
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'
|
|
142
|
+
<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>
|
|
139
143
|
|
|
140
|
-
<dt id="
|
|
144
|
+
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
|
|
141
145
|
<div class="docstring">
|
|
142
146
|
<div class="discussion">
|
|
143
147
|
|
|
144
|
-
<p>The API
|
|
148
|
+
<p>The List Property from the resulting API for list calls</p>
|
|
145
149
|
|
|
146
150
|
|
|
147
151
|
</div>
|
|
@@ -151,7 +155,7 @@
|
|
|
151
155
|
|
|
152
156
|
</div>
|
|
153
157
|
</dt>
|
|
154
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'
|
|
158
|
+
<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>
|
|
155
159
|
|
|
156
160
|
</dl>
|
|
157
161
|
|
|
@@ -207,7 +211,7 @@
|
|
|
207
211
|
<li class="public ">
|
|
208
212
|
<span class="summary_signature">
|
|
209
213
|
|
|
210
|
-
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description:
|
|
214
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(type: "", description: "", metadata: "", 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) ⇒ NgrokAPI::Models::EndpointConfiguration </a>
|
|
211
215
|
|
|
212
216
|
|
|
213
217
|
|
|
@@ -231,7 +235,7 @@
|
|
|
231
235
|
<li class="public ">
|
|
232
236
|
<span class="summary_signature">
|
|
233
237
|
|
|
234
|
-
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id:
|
|
238
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
235
239
|
|
|
236
240
|
|
|
237
241
|
|
|
@@ -255,7 +259,7 @@
|
|
|
255
259
|
<li class="public ">
|
|
256
260
|
<span class="summary_signature">
|
|
257
261
|
|
|
258
|
-
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id:
|
|
262
|
+
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
259
263
|
|
|
260
264
|
|
|
261
265
|
|
|
@@ -279,7 +283,7 @@
|
|
|
279
283
|
<li class="public ">
|
|
280
284
|
<span class="summary_signature">
|
|
281
285
|
|
|
282
|
-
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id:
|
|
286
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::EndpointConfiguration </a>
|
|
283
287
|
|
|
284
288
|
|
|
285
289
|
|
|
@@ -294,7 +298,7 @@
|
|
|
294
298
|
|
|
295
299
|
|
|
296
300
|
<span class="summary_desc"><div class='inline'>
|
|
297
|
-
<p>Returns detailed information about an endpoint configuration
|
|
301
|
+
<p>Returns detailed information about an endpoint configuration.</p>
|
|
298
302
|
</div></span>
|
|
299
303
|
|
|
300
304
|
</li>
|
|
@@ -303,7 +307,7 @@
|
|
|
303
307
|
<li class="public ">
|
|
304
308
|
<span class="summary_signature">
|
|
305
309
|
|
|
306
|
-
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id:
|
|
310
|
+
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ NgrokAPI::Models::EndpointConfiguration </a>
|
|
307
311
|
|
|
308
312
|
|
|
309
313
|
|
|
@@ -318,7 +322,7 @@
|
|
|
318
322
|
|
|
319
323
|
|
|
320
324
|
<span class="summary_desc"><div class='inline'>
|
|
321
|
-
<p>Returns detailed information about an endpoint configuration
|
|
325
|
+
<p>Returns detailed information about an endpoint configuration Throws an exception if API error.</p>
|
|
322
326
|
</div></span>
|
|
323
327
|
|
|
324
328
|
</li>
|
|
@@ -377,7 +381,7 @@
|
|
|
377
381
|
<li class="public ">
|
|
378
382
|
<span class="summary_signature">
|
|
379
383
|
|
|
380
|
-
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id:
|
|
384
|
+
<a href="#update-instance_method" title="#update (instance method)">#<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) ⇒ NgrokAPI::Models::EndpointConfiguration </a>
|
|
381
385
|
|
|
382
386
|
|
|
383
387
|
|
|
@@ -401,7 +405,7 @@
|
|
|
401
405
|
<li class="public ">
|
|
402
406
|
<span class="summary_signature">
|
|
403
407
|
|
|
404
|
-
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id:
|
|
408
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<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) ⇒ NgrokAPI::Models::EndpointConfiguration </a>
|
|
405
409
|
|
|
406
410
|
|
|
407
411
|
|
|
@@ -454,15 +458,15 @@
|
|
|
454
458
|
<pre class="lines">
|
|
455
459
|
|
|
456
460
|
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
461
|
+
19
|
|
462
|
+
20
|
|
463
|
+
21</pre>
|
|
460
464
|
</td>
|
|
461
465
|
<td>
|
|
462
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line
|
|
466
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 19</span>
|
|
463
467
|
|
|
464
|
-
<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>
|
|
465
|
-
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
468
|
+
<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>
|
|
469
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
466
470
|
<span class='kw'>end</span></pre>
|
|
467
471
|
</td>
|
|
468
472
|
</tr>
|
|
@@ -502,12 +506,12 @@
|
|
|
502
506
|
<pre class="lines">
|
|
503
507
|
|
|
504
508
|
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
509
|
+
17
|
|
510
|
+
18
|
|
511
|
+
19</pre>
|
|
508
512
|
</td>
|
|
509
513
|
<td>
|
|
510
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line
|
|
514
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 17</span>
|
|
511
515
|
|
|
512
516
|
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
513
517
|
<span class='ivar'>@client</span>
|
|
@@ -527,7 +531,7 @@
|
|
|
527
531
|
<div class="method_details first">
|
|
528
532
|
<h3 class="signature first" id="create-instance_method">
|
|
529
533
|
|
|
530
|
-
#<strong>create</strong>(description:
|
|
534
|
+
#<strong>create</strong>(type: "", description: "", metadata: "", 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>
|
|
531
535
|
|
|
532
536
|
|
|
533
537
|
|
|
@@ -549,54 +553,54 @@
|
|
|
549
553
|
|
|
550
554
|
<li>
|
|
551
555
|
|
|
552
|
-
<span class='name'>
|
|
556
|
+
<span class='name'>type</span>
|
|
553
557
|
|
|
554
558
|
|
|
555
559
|
<span class='type'>(<tt>string</tt>)</span>
|
|
556
560
|
|
|
557
561
|
|
|
558
|
-
<em class="default">(defaults to: <tt
|
|
562
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
559
563
|
|
|
560
564
|
|
|
561
565
|
—
|
|
562
566
|
<div class='inline'>
|
|
563
|
-
<p>
|
|
567
|
+
<p>they type of traffic this endpoint configuration can be applied to. one of: “http“, “https“, “tcp“</p>
|
|
564
568
|
</div>
|
|
565
569
|
|
|
566
570
|
</li>
|
|
567
571
|
|
|
568
572
|
<li>
|
|
569
573
|
|
|
570
|
-
<span class='name'>
|
|
574
|
+
<span class='name'>description</span>
|
|
571
575
|
|
|
572
576
|
|
|
573
577
|
<span class='type'>(<tt>string</tt>)</span>
|
|
574
578
|
|
|
575
579
|
|
|
576
|
-
<em class="default">(defaults to: <tt
|
|
580
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
577
581
|
|
|
578
582
|
|
|
579
583
|
—
|
|
580
584
|
<div class='inline'>
|
|
581
|
-
<p>
|
|
585
|
+
<p>human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes</p>
|
|
582
586
|
</div>
|
|
583
587
|
|
|
584
588
|
</li>
|
|
585
589
|
|
|
586
590
|
<li>
|
|
587
591
|
|
|
588
|
-
<span class='name'>
|
|
592
|
+
<span class='name'>metadata</span>
|
|
589
593
|
|
|
590
594
|
|
|
591
595
|
<span class='type'>(<tt>string</tt>)</span>
|
|
592
596
|
|
|
593
597
|
|
|
594
|
-
<em class="default">(defaults to: <tt
|
|
598
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
595
599
|
|
|
596
600
|
|
|
597
601
|
—
|
|
598
602
|
<div class='inline'>
|
|
599
|
-
<p>
|
|
603
|
+
<p>arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.</p>
|
|
600
604
|
</div>
|
|
601
605
|
|
|
602
606
|
</li>
|
|
@@ -606,7 +610,7 @@
|
|
|
606
610
|
<span class='name'>circuit_breaker</span>
|
|
607
611
|
|
|
608
612
|
|
|
609
|
-
<span class='type'>(<tt>
|
|
613
|
+
<span class='type'>(<tt>EndpointCircuitBreaker</tt>)</span>
|
|
610
614
|
|
|
611
615
|
|
|
612
616
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -614,7 +618,7 @@
|
|
|
614
618
|
|
|
615
619
|
—
|
|
616
620
|
<div class='inline'>
|
|
617
|
-
<p>circuit breaker module configuration
|
|
621
|
+
<p>circuit breaker module configuration or “null“</p>
|
|
618
622
|
</div>
|
|
619
623
|
|
|
620
624
|
</li>
|
|
@@ -624,7 +628,7 @@
|
|
|
624
628
|
<span class='name'>compression</span>
|
|
625
629
|
|
|
626
630
|
|
|
627
|
-
<span class='type'>(<tt>
|
|
631
|
+
<span class='type'>(<tt>EndpointCompression</tt>)</span>
|
|
628
632
|
|
|
629
633
|
|
|
630
634
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -632,7 +636,7 @@
|
|
|
632
636
|
|
|
633
637
|
—
|
|
634
638
|
<div class='inline'>
|
|
635
|
-
<p>compression module configuration
|
|
639
|
+
<p>compression module configuration or “null“</p>
|
|
636
640
|
</div>
|
|
637
641
|
|
|
638
642
|
</li>
|
|
@@ -642,7 +646,7 @@
|
|
|
642
646
|
<span class='name'>request_headers</span>
|
|
643
647
|
|
|
644
648
|
|
|
645
|
-
<span class='type'>(<tt>
|
|
649
|
+
<span class='type'>(<tt>EndpointRequestHeaders</tt>)</span>
|
|
646
650
|
|
|
647
651
|
|
|
648
652
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -650,7 +654,7 @@
|
|
|
650
654
|
|
|
651
655
|
—
|
|
652
656
|
<div class='inline'>
|
|
653
|
-
<p>request headers module configuration
|
|
657
|
+
<p>request headers module configuration or “null“</p>
|
|
654
658
|
</div>
|
|
655
659
|
|
|
656
660
|
</li>
|
|
@@ -660,7 +664,7 @@
|
|
|
660
664
|
<span class='name'>response_headers</span>
|
|
661
665
|
|
|
662
666
|
|
|
663
|
-
<span class='type'>(<tt>
|
|
667
|
+
<span class='type'>(<tt>EndpointResponseHeaders</tt>)</span>
|
|
664
668
|
|
|
665
669
|
|
|
666
670
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -668,7 +672,7 @@
|
|
|
668
672
|
|
|
669
673
|
—
|
|
670
674
|
<div class='inline'>
|
|
671
|
-
<p>response headers module configuration
|
|
675
|
+
<p>response headers module configuration or “null“</p>
|
|
672
676
|
</div>
|
|
673
677
|
|
|
674
678
|
</li>
|
|
@@ -678,7 +682,7 @@
|
|
|
678
682
|
<span class='name'>ip_policy</span>
|
|
679
683
|
|
|
680
684
|
|
|
681
|
-
<span class='type'>(<tt>
|
|
685
|
+
<span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
|
|
682
686
|
|
|
683
687
|
|
|
684
688
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -686,7 +690,7 @@
|
|
|
686
690
|
|
|
687
691
|
—
|
|
688
692
|
<div class='inline'>
|
|
689
|
-
<p>ip policy module configuration
|
|
693
|
+
<p>ip policy module configuration or “null“</p>
|
|
690
694
|
</div>
|
|
691
695
|
|
|
692
696
|
</li>
|
|
@@ -696,7 +700,7 @@
|
|
|
696
700
|
<span class='name'>mutual_tls</span>
|
|
697
701
|
|
|
698
702
|
|
|
699
|
-
<span class='type'>(<tt>
|
|
703
|
+
<span class='type'>(<tt>EndpointMutualTLSMutate</tt>)</span>
|
|
700
704
|
|
|
701
705
|
|
|
702
706
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -704,7 +708,7 @@
|
|
|
704
708
|
|
|
705
709
|
—
|
|
706
710
|
<div class='inline'>
|
|
707
|
-
<p>mutual TLS module configuration
|
|
711
|
+
<p>mutual TLS module configuration or “null“</p>
|
|
708
712
|
</div>
|
|
709
713
|
|
|
710
714
|
</li>
|
|
@@ -714,7 +718,7 @@
|
|
|
714
718
|
<span class='name'>tls_termination</span>
|
|
715
719
|
|
|
716
720
|
|
|
717
|
-
<span class='type'>(<tt>
|
|
721
|
+
<span class='type'>(<tt>EndpointTLSTermination</tt>)</span>
|
|
718
722
|
|
|
719
723
|
|
|
720
724
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -722,7 +726,7 @@
|
|
|
722
726
|
|
|
723
727
|
—
|
|
724
728
|
<div class='inline'>
|
|
725
|
-
<p>TLS termination module configuration
|
|
729
|
+
<p>TLS termination module configuration or “null“</p>
|
|
726
730
|
</div>
|
|
727
731
|
|
|
728
732
|
</li>
|
|
@@ -732,7 +736,7 @@
|
|
|
732
736
|
<span class='name'>webhook_validation</span>
|
|
733
737
|
|
|
734
738
|
|
|
735
|
-
<span class='type'>(<tt>
|
|
739
|
+
<span class='type'>(<tt>EndpointWebhookValidation</tt>)</span>
|
|
736
740
|
|
|
737
741
|
|
|
738
742
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -740,7 +744,7 @@
|
|
|
740
744
|
|
|
741
745
|
—
|
|
742
746
|
<div class='inline'>
|
|
743
|
-
<p>webhook validation module configuration
|
|
747
|
+
<p>webhook validation module configuration or “null“</p>
|
|
744
748
|
</div>
|
|
745
749
|
|
|
746
750
|
</li>
|
|
@@ -750,7 +754,7 @@
|
|
|
750
754
|
<span class='name'>oauth</span>
|
|
751
755
|
|
|
752
756
|
|
|
753
|
-
<span class='type'>(<tt>
|
|
757
|
+
<span class='type'>(<tt>EndpointOAuth</tt>)</span>
|
|
754
758
|
|
|
755
759
|
|
|
756
760
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -758,7 +762,7 @@
|
|
|
758
762
|
|
|
759
763
|
—
|
|
760
764
|
<div class='inline'>
|
|
761
|
-
<p>oauth module configuration
|
|
765
|
+
<p>oauth module configuration or “null“</p>
|
|
762
766
|
</div>
|
|
763
767
|
|
|
764
768
|
</li>
|
|
@@ -768,7 +772,7 @@
|
|
|
768
772
|
<span class='name'>logging</span>
|
|
769
773
|
|
|
770
774
|
|
|
771
|
-
<span class='type'>(<tt>
|
|
775
|
+
<span class='type'>(<tt>EndpointLoggingMutate</tt>)</span>
|
|
772
776
|
|
|
773
777
|
|
|
774
778
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -776,7 +780,7 @@
|
|
|
776
780
|
|
|
777
781
|
—
|
|
778
782
|
<div class='inline'>
|
|
779
|
-
<p>logging module configuration
|
|
783
|
+
<p>logging module configuration or “null“</p>
|
|
780
784
|
</div>
|
|
781
785
|
|
|
782
786
|
</li>
|
|
@@ -786,7 +790,7 @@
|
|
|
786
790
|
<span class='name'>saml</span>
|
|
787
791
|
|
|
788
792
|
|
|
789
|
-
<span class='type'>(<tt>
|
|
793
|
+
<span class='type'>(<tt>EndpointSAMLMutate</tt>)</span>
|
|
790
794
|
|
|
791
795
|
|
|
792
796
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -794,7 +798,7 @@
|
|
|
794
798
|
|
|
795
799
|
—
|
|
796
800
|
<div class='inline'>
|
|
797
|
-
<p>saml module configuration
|
|
801
|
+
<p>saml module configuration or “null“</p>
|
|
798
802
|
</div>
|
|
799
803
|
|
|
800
804
|
</li>
|
|
@@ -804,7 +808,7 @@
|
|
|
804
808
|
<span class='name'>oidc</span>
|
|
805
809
|
|
|
806
810
|
|
|
807
|
-
<span class='type'>(<tt>
|
|
811
|
+
<span class='type'>(<tt>EndpointOIDC</tt>)</span>
|
|
808
812
|
|
|
809
813
|
|
|
810
814
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -812,7 +816,7 @@
|
|
|
812
816
|
|
|
813
817
|
—
|
|
814
818
|
<div class='inline'>
|
|
815
|
-
<p>oidc module configuration
|
|
819
|
+
<p>oidc module configuration or “null“</p>
|
|
816
820
|
</div>
|
|
817
821
|
|
|
818
822
|
</li>
|
|
@@ -831,7 +835,7 @@
|
|
|
831
835
|
|
|
832
836
|
—
|
|
833
837
|
<div class='inline'>
|
|
834
|
-
<p>result from
|
|
838
|
+
<p>result from the API request</p>
|
|
835
839
|
</div>
|
|
836
840
|
|
|
837
841
|
</li>
|
|
@@ -880,47 +884,55 @@
|
|
|
880
884
|
77
|
|
881
885
|
78
|
|
882
886
|
79
|
|
883
|
-
80
|
|
887
|
+
80
|
|
888
|
+
81
|
|
889
|
+
82
|
|
890
|
+
83
|
|
891
|
+
84</pre>
|
|
884
892
|
</td>
|
|
885
893
|
<td>
|
|
886
894
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 44</span>
|
|
887
895
|
|
|
888
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
|
|
889
|
-
<span class='label'>
|
|
890
|
-
<span class='label'>
|
|
891
|
-
<span class='label'>
|
|
892
|
-
<span class='label'>
|
|
893
|
-
<span class='label'>
|
|
894
|
-
<span class='label'>
|
|
895
|
-
<span class='label'>
|
|
896
|
-
<span class='label'>
|
|
897
|
-
<span class='label'>
|
|
898
|
-
<span class='label'>
|
|
899
|
-
<span class='label'>
|
|
900
|
-
<span class='label'>
|
|
901
|
-
<span class='label'>
|
|
902
|
-
<span class='label'>
|
|
903
|
-
<span class='label'>
|
|
904
|
-
<span class='
|
|
905
|
-
<span class='
|
|
906
|
-
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
|
|
919
|
-
|
|
920
|
-
|
|
921
|
-
<span class='
|
|
922
|
-
<span class='id identifier
|
|
923
|
-
<span class='
|
|
896
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
|
|
897
|
+
<span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
898
|
+
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
899
|
+
<span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
900
|
+
<span class='label'>basic_auth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
901
|
+
<span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
902
|
+
<span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
903
|
+
<span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
904
|
+
<span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
905
|
+
<span class='label'>ip_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
906
|
+
<span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
907
|
+
<span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
908
|
+
<span class='label'>webhook_validation:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
909
|
+
<span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
910
|
+
<span class='label'>logging:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
911
|
+
<span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
912
|
+
<span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
913
|
+
<span class='label'>backend:</span> <span class='kw'>nil</span>
|
|
914
|
+
<span class='rparen'>)</span>
|
|
915
|
+
<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>
|
|
916
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
917
|
+
<span class='rbrace'>}</span>
|
|
918
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
919
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_type'>type</span> <span class='kw'>if</span> <span class='id identifier rubyid_type'>type</span>
|
|
920
|
+
<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>
|
|
921
|
+
<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>
|
|
922
|
+
<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>
|
|
923
|
+
<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>
|
|
924
|
+
<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>
|
|
925
|
+
<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>
|
|
926
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span>
|
|
927
|
+
<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>
|
|
928
|
+
<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>
|
|
929
|
+
<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>
|
|
930
|
+
<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>
|
|
931
|
+
<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>
|
|
932
|
+
<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>
|
|
933
|
+
<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>
|
|
934
|
+
<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>
|
|
935
|
+
<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='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#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>
|
|
924
936
|
<span class='kw'>end</span></pre>
|
|
925
937
|
</td>
|
|
926
938
|
</tr>
|
|
@@ -930,7 +942,7 @@
|
|
|
930
942
|
<div class="method_details ">
|
|
931
943
|
<h3 class="signature " id="delete-instance_method">
|
|
932
944
|
|
|
933
|
-
#<strong>delete</strong>(id:
|
|
945
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
934
946
|
|
|
935
947
|
|
|
936
948
|
|
|
@@ -958,7 +970,7 @@
|
|
|
958
970
|
<span class='type'>(<tt>string</tt>)</span>
|
|
959
971
|
|
|
960
972
|
|
|
961
|
-
<em class="default">(defaults to: <tt
|
|
973
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
962
974
|
|
|
963
975
|
|
|
964
976
|
—
|
|
@@ -976,13 +988,13 @@
|
|
|
976
988
|
<li>
|
|
977
989
|
|
|
978
990
|
|
|
979
|
-
<span class='type'>(<tt>
|
|
991
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
980
992
|
|
|
981
993
|
|
|
982
994
|
|
|
983
995
|
—
|
|
984
996
|
<div class='inline'>
|
|
985
|
-
<p>result from
|
|
997
|
+
<p>result from the API request</p>
|
|
986
998
|
</div>
|
|
987
999
|
|
|
988
1000
|
</li>
|
|
@@ -995,15 +1007,27 @@
|
|
|
995
1007
|
<pre class="lines">
|
|
996
1008
|
|
|
997
1009
|
|
|
998
|
-
|
|
999
|
-
|
|
1000
|
-
|
|
1010
|
+
94
|
|
1011
|
+
95
|
|
1012
|
+
96
|
|
1013
|
+
97
|
|
1014
|
+
98
|
|
1015
|
+
99
|
|
1016
|
+
100
|
|
1017
|
+
101
|
|
1018
|
+
102</pre>
|
|
1001
1019
|
</td>
|
|
1002
1020
|
<td>
|
|
1003
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line
|
|
1004
|
-
|
|
1005
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span
|
|
1006
|
-
<span class='
|
|
1021
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 94</span>
|
|
1022
|
+
|
|
1023
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span>
|
|
1024
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
1025
|
+
<span class='rparen'>)</span>
|
|
1026
|
+
<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>
|
|
1027
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1028
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1029
|
+
<span class='rbrace'>}</span>
|
|
1030
|
+
<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>
|
|
1007
1031
|
<span class='kw'>end</span></pre>
|
|
1008
1032
|
</td>
|
|
1009
1033
|
</tr>
|
|
@@ -1013,7 +1037,7 @@
|
|
|
1013
1037
|
<div class="method_details ">
|
|
1014
1038
|
<h3 class="signature " id="delete!-instance_method">
|
|
1015
1039
|
|
|
1016
|
-
#<strong>delete!</strong>(id:
|
|
1040
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
1017
1041
|
|
|
1018
1042
|
|
|
1019
1043
|
|
|
@@ -1022,7 +1046,7 @@
|
|
|
1022
1046
|
</h3><div class="docstring">
|
|
1023
1047
|
<div class="discussion">
|
|
1024
1048
|
|
|
1025
|
-
<p>Delete an endpoint configuration.
|
|
1049
|
+
<p>Delete an endpoint configuration. This operation will fail if the endpoint configuration is still referenced by any reserved domain or reserved address. Throws an exception if API error.</p>
|
|
1026
1050
|
|
|
1027
1051
|
<p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-delete">ngrok.com/docs/api#api-endpoint-configurations-delete</a></p>
|
|
1028
1052
|
|
|
@@ -1041,7 +1065,7 @@
|
|
|
1041
1065
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1042
1066
|
|
|
1043
1067
|
|
|
1044
|
-
<em class="default">(defaults to: <tt
|
|
1068
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1045
1069
|
|
|
1046
1070
|
|
|
1047
1071
|
—
|
|
@@ -1059,13 +1083,13 @@
|
|
|
1059
1083
|
<li>
|
|
1060
1084
|
|
|
1061
1085
|
|
|
1062
|
-
<span class='type'>(<tt>
|
|
1086
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
1063
1087
|
|
|
1064
1088
|
|
|
1065
1089
|
|
|
1066
1090
|
—
|
|
1067
1091
|
<div class='inline'>
|
|
1068
|
-
<p>result from
|
|
1092
|
+
<p>result from the API request</p>
|
|
1069
1093
|
</div>
|
|
1070
1094
|
|
|
1071
1095
|
</li>
|
|
@@ -1078,15 +1102,27 @@
|
|
|
1078
1102
|
<pre class="lines">
|
|
1079
1103
|
|
|
1080
1104
|
|
|
1081
|
-
|
|
1082
|
-
|
|
1083
|
-
|
|
1105
|
+
113
|
|
1106
|
+
114
|
|
1107
|
+
115
|
|
1108
|
+
116
|
|
1109
|
+
117
|
|
1110
|
+
118
|
|
1111
|
+
119
|
|
1112
|
+
120
|
|
1113
|
+
121</pre>
|
|
1084
1114
|
</td>
|
|
1085
1115
|
<td>
|
|
1086
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line
|
|
1087
|
-
|
|
1088
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span
|
|
1089
|
-
<span class='
|
|
1116
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 113</span>
|
|
1117
|
+
|
|
1118
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span>
|
|
1119
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
1120
|
+
<span class='rparen'>)</span>
|
|
1121
|
+
<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>
|
|
1122
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1123
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1124
|
+
<span class='rbrace'>}</span>
|
|
1125
|
+
<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>
|
|
1090
1126
|
<span class='kw'>end</span></pre>
|
|
1091
1127
|
</td>
|
|
1092
1128
|
</tr>
|
|
@@ -1096,7 +1132,7 @@
|
|
|
1096
1132
|
<div class="method_details ">
|
|
1097
1133
|
<h3 class="signature " id="get-instance_method">
|
|
1098
1134
|
|
|
1099
|
-
#<strong>get</strong>(id:
|
|
1135
|
+
#<strong>get</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
|
|
1100
1136
|
|
|
1101
1137
|
|
|
1102
1138
|
|
|
@@ -1105,7 +1141,7 @@
|
|
|
1105
1141
|
</h3><div class="docstring">
|
|
1106
1142
|
<div class="discussion">
|
|
1107
1143
|
|
|
1108
|
-
<p>Returns detailed information about an endpoint configuration
|
|
1144
|
+
<p>Returns detailed information about an endpoint configuration</p>
|
|
1109
1145
|
|
|
1110
1146
|
<p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-get">ngrok.com/docs/api#api-endpoint-configurations-get</a></p>
|
|
1111
1147
|
|
|
@@ -1124,7 +1160,7 @@
|
|
|
1124
1160
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1125
1161
|
|
|
1126
1162
|
|
|
1127
|
-
<em class="default">(defaults to: <tt
|
|
1163
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1128
1164
|
|
|
1129
1165
|
|
|
1130
1166
|
—
|
|
@@ -1148,7 +1184,7 @@
|
|
|
1148
1184
|
|
|
1149
1185
|
—
|
|
1150
1186
|
<div class='inline'>
|
|
1151
|
-
<p>result from
|
|
1187
|
+
<p>result from the API request</p>
|
|
1152
1188
|
</div>
|
|
1153
1189
|
|
|
1154
1190
|
</li>
|
|
@@ -1161,17 +1197,31 @@
|
|
|
1161
1197
|
<pre class="lines">
|
|
1162
1198
|
|
|
1163
1199
|
|
|
1164
|
-
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
|
|
1200
|
+
130
|
|
1201
|
+
131
|
|
1202
|
+
132
|
|
1203
|
+
133
|
|
1204
|
+
134
|
|
1205
|
+
135
|
|
1206
|
+
136
|
|
1207
|
+
137
|
|
1208
|
+
138
|
|
1209
|
+
139
|
|
1210
|
+
140</pre>
|
|
1168
1211
|
</td>
|
|
1169
1212
|
<td>
|
|
1170
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line
|
|
1171
|
-
|
|
1172
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span
|
|
1173
|
-
<span class='
|
|
1174
|
-
|
|
1213
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 130</span>
|
|
1214
|
+
|
|
1215
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span>
|
|
1216
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
1217
|
+
<span class='rparen'>)</span>
|
|
1218
|
+
<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>
|
|
1219
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1220
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1221
|
+
<span class='rbrace'>}</span>
|
|
1222
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1223
|
+
<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>
|
|
1224
|
+
<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='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#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>
|
|
1175
1225
|
<span class='kw'>end</span></pre>
|
|
1176
1226
|
</td>
|
|
1177
1227
|
</tr>
|
|
@@ -1181,7 +1231,7 @@
|
|
|
1181
1231
|
<div class="method_details ">
|
|
1182
1232
|
<h3 class="signature " id="get!-instance_method">
|
|
1183
1233
|
|
|
1184
|
-
#<strong>get!</strong>(id:
|
|
1234
|
+
#<strong>get!</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">NgrokAPI::Models::EndpointConfiguration</a></span></tt>
|
|
1185
1235
|
|
|
1186
1236
|
|
|
1187
1237
|
|
|
@@ -1190,7 +1240,7 @@
|
|
|
1190
1240
|
</h3><div class="docstring">
|
|
1191
1241
|
<div class="discussion">
|
|
1192
1242
|
|
|
1193
|
-
<p>Returns detailed information about an endpoint configuration
|
|
1243
|
+
<p>Returns detailed information about an endpoint configuration Throws an exception if API error.</p>
|
|
1194
1244
|
|
|
1195
1245
|
<p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-get">ngrok.com/docs/api#api-endpoint-configurations-get</a></p>
|
|
1196
1246
|
|
|
@@ -1209,7 +1259,7 @@
|
|
|
1209
1259
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1210
1260
|
|
|
1211
1261
|
|
|
1212
|
-
<em class="default">(defaults to: <tt
|
|
1262
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1213
1263
|
|
|
1214
1264
|
|
|
1215
1265
|
—
|
|
@@ -1233,7 +1283,7 @@
|
|
|
1233
1283
|
|
|
1234
1284
|
—
|
|
1235
1285
|
<div class='inline'>
|
|
1236
|
-
<p>result from
|
|
1286
|
+
<p>result from the API request</p>
|
|
1237
1287
|
</div>
|
|
1238
1288
|
|
|
1239
1289
|
</li>
|
|
@@ -1246,17 +1296,31 @@
|
|
|
1246
1296
|
<pre class="lines">
|
|
1247
1297
|
|
|
1248
1298
|
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1299
|
+
150
|
|
1300
|
+
151
|
|
1301
|
+
152
|
|
1302
|
+
153
|
|
1303
|
+
154
|
|
1304
|
+
155
|
|
1305
|
+
156
|
|
1306
|
+
157
|
|
1307
|
+
158
|
|
1308
|
+
159
|
|
1309
|
+
160</pre>
|
|
1253
1310
|
</td>
|
|
1254
1311
|
<td>
|
|
1255
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line
|
|
1256
|
-
|
|
1257
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span
|
|
1258
|
-
<span class='
|
|
1259
|
-
|
|
1312
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 150</span>
|
|
1313
|
+
|
|
1314
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span>
|
|
1315
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
1316
|
+
<span class='rparen'>)</span>
|
|
1317
|
+
<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>
|
|
1318
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1319
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1320
|
+
<span class='rbrace'>}</span>
|
|
1321
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1322
|
+
<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>
|
|
1323
|
+
<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='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#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>
|
|
1260
1324
|
<span class='kw'>end</span></pre>
|
|
1261
1325
|
</td>
|
|
1262
1326
|
</tr>
|
|
@@ -1275,7 +1339,7 @@
|
|
|
1275
1339
|
</h3><div class="docstring">
|
|
1276
1340
|
<div class="discussion">
|
|
1277
1341
|
|
|
1278
|
-
<p>Returns a list of all endpoint configurations on this account
|
|
1342
|
+
<p>Returns a list of all endpoint configurations on this account</p>
|
|
1279
1343
|
|
|
1280
1344
|
<p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-list">ngrok.com/docs/api#api-endpoint-configurations-list</a></p>
|
|
1281
1345
|
|
|
@@ -1304,7 +1368,7 @@
|
|
|
1304
1368
|
<span class='name'>limit</span>
|
|
1305
1369
|
|
|
1306
1370
|
|
|
1307
|
-
<span class='type'>(<tt>
|
|
1371
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1308
1372
|
|
|
1309
1373
|
|
|
1310
1374
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1344,7 +1408,7 @@
|
|
|
1344
1408
|
|
|
1345
1409
|
—
|
|
1346
1410
|
<div class='inline'>
|
|
1347
|
-
<p>the
|
|
1411
|
+
<p>result from the API request</p>
|
|
1348
1412
|
</div>
|
|
1349
1413
|
|
|
1350
1414
|
</li>
|
|
@@ -1357,27 +1421,45 @@
|
|
|
1357
1421
|
<pre class="lines">
|
|
1358
1422
|
|
|
1359
1423
|
|
|
1360
|
-
|
|
1361
|
-
|
|
1362
|
-
|
|
1363
|
-
|
|
1364
|
-
|
|
1365
|
-
|
|
1366
|
-
|
|
1367
|
-
|
|
1368
|
-
|
|
1424
|
+
171
|
|
1425
|
+
172
|
|
1426
|
+
173
|
|
1427
|
+
174
|
|
1428
|
+
175
|
|
1429
|
+
176
|
|
1430
|
+
177
|
|
1431
|
+
178
|
|
1432
|
+
179
|
|
1433
|
+
180
|
|
1434
|
+
181
|
|
1435
|
+
182
|
|
1436
|
+
183
|
|
1437
|
+
184
|
|
1438
|
+
185
|
|
1439
|
+
186
|
|
1440
|
+
187
|
|
1441
|
+
188</pre>
|
|
1369
1442
|
</td>
|
|
1370
1443
|
<td>
|
|
1371
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line
|
|
1372
|
-
|
|
1373
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span
|
|
1374
|
-
<span class='
|
|
1375
|
-
<span class='
|
|
1376
|
-
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
<span class='label'>
|
|
1380
|
-
|
|
1444
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 171</span>
|
|
1445
|
+
|
|
1446
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
|
1447
|
+
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1448
|
+
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1449
|
+
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1450
|
+
<span class='rparen'>)</span>
|
|
1451
|
+
<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>
|
|
1452
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1453
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1454
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1455
|
+
<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>
|
|
1456
|
+
<span class='rparen'>)</span>
|
|
1457
|
+
<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>
|
|
1458
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1459
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1460
|
+
<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>
|
|
1461
|
+
<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>
|
|
1462
|
+
<span class='rparen'>)</span>
|
|
1381
1463
|
<span class='kw'>end</span></pre>
|
|
1382
1464
|
</td>
|
|
1383
1465
|
</tr>
|
|
@@ -1387,7 +1469,7 @@
|
|
|
1387
1469
|
<div class="method_details ">
|
|
1388
1470
|
<h3 class="signature " id="update-instance_method">
|
|
1389
1471
|
|
|
1390
|
-
#<strong>update</strong>(id:
|
|
1472
|
+
#<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>
|
|
1391
1473
|
|
|
1392
1474
|
|
|
1393
1475
|
|
|
@@ -1415,7 +1497,7 @@
|
|
|
1415
1497
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1416
1498
|
|
|
1417
1499
|
|
|
1418
|
-
<em class="default">(defaults to: <tt
|
|
1500
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1419
1501
|
|
|
1420
1502
|
|
|
1421
1503
|
—
|
|
@@ -1466,7 +1548,7 @@
|
|
|
1466
1548
|
<span class='name'>circuit_breaker</span>
|
|
1467
1549
|
|
|
1468
1550
|
|
|
1469
|
-
<span class='type'>(<tt>
|
|
1551
|
+
<span class='type'>(<tt>EndpointCircuitBreaker</tt>)</span>
|
|
1470
1552
|
|
|
1471
1553
|
|
|
1472
1554
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1474,7 +1556,7 @@
|
|
|
1474
1556
|
|
|
1475
1557
|
—
|
|
1476
1558
|
<div class='inline'>
|
|
1477
|
-
<p>circuit breaker module configuration
|
|
1559
|
+
<p>circuit breaker module configuration or “null“</p>
|
|
1478
1560
|
</div>
|
|
1479
1561
|
|
|
1480
1562
|
</li>
|
|
@@ -1484,7 +1566,7 @@
|
|
|
1484
1566
|
<span class='name'>compression</span>
|
|
1485
1567
|
|
|
1486
1568
|
|
|
1487
|
-
<span class='type'>(<tt>
|
|
1569
|
+
<span class='type'>(<tt>EndpointCompression</tt>)</span>
|
|
1488
1570
|
|
|
1489
1571
|
|
|
1490
1572
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1492,7 +1574,7 @@
|
|
|
1492
1574
|
|
|
1493
1575
|
—
|
|
1494
1576
|
<div class='inline'>
|
|
1495
|
-
<p>compression module configuration
|
|
1577
|
+
<p>compression module configuration or “null“</p>
|
|
1496
1578
|
</div>
|
|
1497
1579
|
|
|
1498
1580
|
</li>
|
|
@@ -1502,7 +1584,7 @@
|
|
|
1502
1584
|
<span class='name'>request_headers</span>
|
|
1503
1585
|
|
|
1504
1586
|
|
|
1505
|
-
<span class='type'>(<tt>
|
|
1587
|
+
<span class='type'>(<tt>EndpointRequestHeaders</tt>)</span>
|
|
1506
1588
|
|
|
1507
1589
|
|
|
1508
1590
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1510,7 +1592,7 @@
|
|
|
1510
1592
|
|
|
1511
1593
|
—
|
|
1512
1594
|
<div class='inline'>
|
|
1513
|
-
<p>request headers module configuration
|
|
1595
|
+
<p>request headers module configuration or “null“</p>
|
|
1514
1596
|
</div>
|
|
1515
1597
|
|
|
1516
1598
|
</li>
|
|
@@ -1520,7 +1602,7 @@
|
|
|
1520
1602
|
<span class='name'>response_headers</span>
|
|
1521
1603
|
|
|
1522
1604
|
|
|
1523
|
-
<span class='type'>(<tt>
|
|
1605
|
+
<span class='type'>(<tt>EndpointResponseHeaders</tt>)</span>
|
|
1524
1606
|
|
|
1525
1607
|
|
|
1526
1608
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1528,7 +1610,7 @@
|
|
|
1528
1610
|
|
|
1529
1611
|
—
|
|
1530
1612
|
<div class='inline'>
|
|
1531
|
-
<p>response headers module configuration
|
|
1613
|
+
<p>response headers module configuration or “null“</p>
|
|
1532
1614
|
</div>
|
|
1533
1615
|
|
|
1534
1616
|
</li>
|
|
@@ -1538,7 +1620,7 @@
|
|
|
1538
1620
|
<span class='name'>ip_policy</span>
|
|
1539
1621
|
|
|
1540
1622
|
|
|
1541
|
-
<span class='type'>(<tt>
|
|
1623
|
+
<span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
|
|
1542
1624
|
|
|
1543
1625
|
|
|
1544
1626
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1546,7 +1628,7 @@
|
|
|
1546
1628
|
|
|
1547
1629
|
—
|
|
1548
1630
|
<div class='inline'>
|
|
1549
|
-
<p>ip policy module configuration
|
|
1631
|
+
<p>ip policy module configuration or “null“</p>
|
|
1550
1632
|
</div>
|
|
1551
1633
|
|
|
1552
1634
|
</li>
|
|
@@ -1556,7 +1638,7 @@
|
|
|
1556
1638
|
<span class='name'>mutual_tls</span>
|
|
1557
1639
|
|
|
1558
1640
|
|
|
1559
|
-
<span class='type'>(<tt>
|
|
1641
|
+
<span class='type'>(<tt>EndpointMutualTLSMutate</tt>)</span>
|
|
1560
1642
|
|
|
1561
1643
|
|
|
1562
1644
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1564,7 +1646,7 @@
|
|
|
1564
1646
|
|
|
1565
1647
|
—
|
|
1566
1648
|
<div class='inline'>
|
|
1567
|
-
<p>mutual TLS module configuration
|
|
1649
|
+
<p>mutual TLS module configuration or “null“</p>
|
|
1568
1650
|
</div>
|
|
1569
1651
|
|
|
1570
1652
|
</li>
|
|
@@ -1574,7 +1656,7 @@
|
|
|
1574
1656
|
<span class='name'>tls_termination</span>
|
|
1575
1657
|
|
|
1576
1658
|
|
|
1577
|
-
<span class='type'>(<tt>
|
|
1659
|
+
<span class='type'>(<tt>EndpointTLSTermination</tt>)</span>
|
|
1578
1660
|
|
|
1579
1661
|
|
|
1580
1662
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1582,7 +1664,7 @@
|
|
|
1582
1664
|
|
|
1583
1665
|
—
|
|
1584
1666
|
<div class='inline'>
|
|
1585
|
-
<p>TLS termination module configuration
|
|
1667
|
+
<p>TLS termination module configuration or “null“</p>
|
|
1586
1668
|
</div>
|
|
1587
1669
|
|
|
1588
1670
|
</li>
|
|
@@ -1592,7 +1674,7 @@
|
|
|
1592
1674
|
<span class='name'>webhook_validation</span>
|
|
1593
1675
|
|
|
1594
1676
|
|
|
1595
|
-
<span class='type'>(<tt>
|
|
1677
|
+
<span class='type'>(<tt>EndpointWebhookValidation</tt>)</span>
|
|
1596
1678
|
|
|
1597
1679
|
|
|
1598
1680
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1600,7 +1682,7 @@
|
|
|
1600
1682
|
|
|
1601
1683
|
—
|
|
1602
1684
|
<div class='inline'>
|
|
1603
|
-
<p>webhook validation module configuration
|
|
1685
|
+
<p>webhook validation module configuration or “null“</p>
|
|
1604
1686
|
</div>
|
|
1605
1687
|
|
|
1606
1688
|
</li>
|
|
@@ -1610,7 +1692,7 @@
|
|
|
1610
1692
|
<span class='name'>oauth</span>
|
|
1611
1693
|
|
|
1612
1694
|
|
|
1613
|
-
<span class='type'>(<tt>
|
|
1695
|
+
<span class='type'>(<tt>EndpointOAuth</tt>)</span>
|
|
1614
1696
|
|
|
1615
1697
|
|
|
1616
1698
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1618,7 +1700,7 @@
|
|
|
1618
1700
|
|
|
1619
1701
|
—
|
|
1620
1702
|
<div class='inline'>
|
|
1621
|
-
<p>oauth module configuration
|
|
1703
|
+
<p>oauth module configuration or “null“</p>
|
|
1622
1704
|
</div>
|
|
1623
1705
|
|
|
1624
1706
|
</li>
|
|
@@ -1628,7 +1710,7 @@
|
|
|
1628
1710
|
<span class='name'>logging</span>
|
|
1629
1711
|
|
|
1630
1712
|
|
|
1631
|
-
<span class='type'>(<tt>
|
|
1713
|
+
<span class='type'>(<tt>EndpointLoggingMutate</tt>)</span>
|
|
1632
1714
|
|
|
1633
1715
|
|
|
1634
1716
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1636,7 +1718,7 @@
|
|
|
1636
1718
|
|
|
1637
1719
|
—
|
|
1638
1720
|
<div class='inline'>
|
|
1639
|
-
<p>logging module configuration
|
|
1721
|
+
<p>logging module configuration or “null“</p>
|
|
1640
1722
|
</div>
|
|
1641
1723
|
|
|
1642
1724
|
</li>
|
|
@@ -1646,7 +1728,7 @@
|
|
|
1646
1728
|
<span class='name'>saml</span>
|
|
1647
1729
|
|
|
1648
1730
|
|
|
1649
|
-
<span class='type'>(<tt>
|
|
1731
|
+
<span class='type'>(<tt>EndpointSAMLMutate</tt>)</span>
|
|
1650
1732
|
|
|
1651
1733
|
|
|
1652
1734
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1654,7 +1736,7 @@
|
|
|
1654
1736
|
|
|
1655
1737
|
—
|
|
1656
1738
|
<div class='inline'>
|
|
1657
|
-
<p>saml module configuration
|
|
1739
|
+
<p>saml module configuration or “null“</p>
|
|
1658
1740
|
</div>
|
|
1659
1741
|
|
|
1660
1742
|
</li>
|
|
@@ -1664,7 +1746,7 @@
|
|
|
1664
1746
|
<span class='name'>oidc</span>
|
|
1665
1747
|
|
|
1666
1748
|
|
|
1667
|
-
<span class='type'>(<tt>
|
|
1749
|
+
<span class='type'>(<tt>EndpointOIDC</tt>)</span>
|
|
1668
1750
|
|
|
1669
1751
|
|
|
1670
1752
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1672,7 +1754,7 @@
|
|
|
1672
1754
|
|
|
1673
1755
|
—
|
|
1674
1756
|
<div class='inline'>
|
|
1675
|
-
<p>oidc module configuration
|
|
1757
|
+
<p>oidc module configuration or “null“</p>
|
|
1676
1758
|
</div>
|
|
1677
1759
|
|
|
1678
1760
|
</li>
|
|
@@ -1691,7 +1773,7 @@
|
|
|
1691
1773
|
|
|
1692
1774
|
—
|
|
1693
1775
|
<div class='inline'>
|
|
1694
|
-
<p>result from
|
|
1776
|
+
<p>result from the API request</p>
|
|
1695
1777
|
</div>
|
|
1696
1778
|
|
|
1697
1779
|
</li>
|
|
@@ -1704,81 +1786,91 @@
|
|
|
1704
1786
|
<pre class="lines">
|
|
1705
1787
|
|
|
1706
1788
|
|
|
1707
|
-
|
|
1708
|
-
|
|
1709
|
-
|
|
1710
|
-
|
|
1711
|
-
|
|
1712
|
-
|
|
1713
|
-
|
|
1714
|
-
|
|
1715
|
-
|
|
1716
|
-
|
|
1717
|
-
|
|
1718
|
-
|
|
1719
|
-
|
|
1720
|
-
|
|
1721
|
-
|
|
1722
|
-
|
|
1723
|
-
|
|
1724
|
-
|
|
1725
|
-
|
|
1726
|
-
|
|
1727
|
-
|
|
1728
|
-
|
|
1729
|
-
|
|
1730
|
-
|
|
1731
|
-
|
|
1732
|
-
|
|
1733
|
-
|
|
1734
|
-
|
|
1735
|
-
|
|
1736
|
-
|
|
1737
|
-
|
|
1738
|
-
|
|
1739
|
-
|
|
1740
|
-
|
|
1741
|
-
|
|
1742
|
-
|
|
1789
|
+
214
|
|
1790
|
+
215
|
|
1791
|
+
216
|
|
1792
|
+
217
|
|
1793
|
+
218
|
|
1794
|
+
219
|
|
1795
|
+
220
|
|
1796
|
+
221
|
|
1797
|
+
222
|
|
1798
|
+
223
|
|
1799
|
+
224
|
|
1800
|
+
225
|
|
1801
|
+
226
|
|
1802
|
+
227
|
|
1803
|
+
228
|
|
1804
|
+
229
|
|
1805
|
+
230
|
|
1806
|
+
231
|
|
1807
|
+
232
|
|
1808
|
+
233
|
|
1809
|
+
234
|
|
1810
|
+
235
|
|
1811
|
+
236
|
|
1812
|
+
237
|
|
1813
|
+
238
|
|
1814
|
+
239
|
|
1815
|
+
240
|
|
1816
|
+
241
|
|
1817
|
+
242
|
|
1818
|
+
243
|
|
1819
|
+
244
|
|
1820
|
+
245
|
|
1821
|
+
246
|
|
1822
|
+
247
|
|
1823
|
+
248
|
|
1824
|
+
249
|
|
1825
|
+
250
|
|
1826
|
+
251
|
|
1827
|
+
252
|
|
1828
|
+
253
|
|
1829
|
+
254</pre>
|
|
1743
1830
|
</td>
|
|
1744
1831
|
<td>
|
|
1745
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line
|
|
1746
|
-
|
|
1747
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
|
|
1748
|
-
<span class='label'>id:</span> <span class='
|
|
1749
|
-
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1750
|
-
<span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1751
|
-
<span class='label'>
|
|
1752
|
-
<span class='label'>
|
|
1753
|
-
<span class='label'>
|
|
1754
|
-
<span class='label'>
|
|
1755
|
-
<span class='label'>
|
|
1756
|
-
<span class='label'>
|
|
1757
|
-
<span class='label'>
|
|
1758
|
-
<span class='label'>
|
|
1759
|
-
<span class='label'>
|
|
1760
|
-
<span class='label'>
|
|
1761
|
-
<span class='label'>
|
|
1762
|
-
<span class='label'>
|
|
1763
|
-
<span class='
|
|
1764
|
-
<span class='
|
|
1765
|
-
|
|
1766
|
-
|
|
1767
|
-
|
|
1768
|
-
<span class='label'>
|
|
1769
|
-
|
|
1770
|
-
|
|
1771
|
-
|
|
1772
|
-
|
|
1773
|
-
|
|
1774
|
-
|
|
1775
|
-
|
|
1776
|
-
|
|
1777
|
-
|
|
1778
|
-
|
|
1779
|
-
<span class='
|
|
1780
|
-
<span class='id identifier
|
|
1781
|
-
<span class='
|
|
1832
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 214</span>
|
|
1833
|
+
|
|
1834
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
|
|
1835
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
1836
|
+
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1837
|
+
<span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1838
|
+
<span class='label'>basic_auth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1839
|
+
<span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1840
|
+
<span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1841
|
+
<span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1842
|
+
<span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1843
|
+
<span class='label'>ip_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1844
|
+
<span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1845
|
+
<span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1846
|
+
<span class='label'>webhook_validation:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1847
|
+
<span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1848
|
+
<span class='label'>logging:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1849
|
+
<span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1850
|
+
<span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1851
|
+
<span class='label'>backend:</span> <span class='kw'>nil</span>
|
|
1852
|
+
<span class='rparen'>)</span>
|
|
1853
|
+
<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>
|
|
1854
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1855
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1856
|
+
<span class='rbrace'>}</span>
|
|
1857
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1858
|
+
<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>
|
|
1859
|
+
<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>
|
|
1860
|
+
<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>
|
|
1861
|
+
<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>
|
|
1862
|
+
<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>
|
|
1863
|
+
<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>
|
|
1864
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span>
|
|
1865
|
+
<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>
|
|
1866
|
+
<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>
|
|
1867
|
+
<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>
|
|
1868
|
+
<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>
|
|
1869
|
+
<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>
|
|
1870
|
+
<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>
|
|
1871
|
+
<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>
|
|
1872
|
+
<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>
|
|
1873
|
+
<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='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#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>
|
|
1782
1874
|
<span class='kw'>end</span></pre>
|
|
1783
1875
|
</td>
|
|
1784
1876
|
</tr>
|
|
@@ -1788,7 +1880,7 @@
|
|
|
1788
1880
|
<div class="method_details ">
|
|
1789
1881
|
<h3 class="signature " id="update!-instance_method">
|
|
1790
1882
|
|
|
1791
|
-
#<strong>update!</strong>(id:
|
|
1883
|
+
#<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>
|
|
1792
1884
|
|
|
1793
1885
|
|
|
1794
1886
|
|
|
@@ -1797,7 +1889,7 @@
|
|
|
1797
1889
|
</h3><div class="docstring">
|
|
1798
1890
|
<div class="discussion">
|
|
1799
1891
|
|
|
1800
|
-
<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.
|
|
1892
|
+
<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. Throws an exception if API error.</p>
|
|
1801
1893
|
|
|
1802
1894
|
<p><a href="https://ngrok.com/docs/api#api-endpoint-configurations-update">ngrok.com/docs/api#api-endpoint-configurations-update</a></p>
|
|
1803
1895
|
|
|
@@ -1816,7 +1908,7 @@
|
|
|
1816
1908
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1817
1909
|
|
|
1818
1910
|
|
|
1819
|
-
<em class="default">(defaults to: <tt
|
|
1911
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1820
1912
|
|
|
1821
1913
|
|
|
1822
1914
|
—
|
|
@@ -1867,7 +1959,7 @@
|
|
|
1867
1959
|
<span class='name'>circuit_breaker</span>
|
|
1868
1960
|
|
|
1869
1961
|
|
|
1870
|
-
<span class='type'>(<tt>
|
|
1962
|
+
<span class='type'>(<tt>EndpointCircuitBreaker</tt>)</span>
|
|
1871
1963
|
|
|
1872
1964
|
|
|
1873
1965
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1875,7 +1967,7 @@
|
|
|
1875
1967
|
|
|
1876
1968
|
—
|
|
1877
1969
|
<div class='inline'>
|
|
1878
|
-
<p>circuit breaker module configuration
|
|
1970
|
+
<p>circuit breaker module configuration or “null“</p>
|
|
1879
1971
|
</div>
|
|
1880
1972
|
|
|
1881
1973
|
</li>
|
|
@@ -1885,7 +1977,7 @@
|
|
|
1885
1977
|
<span class='name'>compression</span>
|
|
1886
1978
|
|
|
1887
1979
|
|
|
1888
|
-
<span class='type'>(<tt>
|
|
1980
|
+
<span class='type'>(<tt>EndpointCompression</tt>)</span>
|
|
1889
1981
|
|
|
1890
1982
|
|
|
1891
1983
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1893,7 +1985,7 @@
|
|
|
1893
1985
|
|
|
1894
1986
|
—
|
|
1895
1987
|
<div class='inline'>
|
|
1896
|
-
<p>compression module configuration
|
|
1988
|
+
<p>compression module configuration or “null“</p>
|
|
1897
1989
|
</div>
|
|
1898
1990
|
|
|
1899
1991
|
</li>
|
|
@@ -1903,7 +1995,7 @@
|
|
|
1903
1995
|
<span class='name'>request_headers</span>
|
|
1904
1996
|
|
|
1905
1997
|
|
|
1906
|
-
<span class='type'>(<tt>
|
|
1998
|
+
<span class='type'>(<tt>EndpointRequestHeaders</tt>)</span>
|
|
1907
1999
|
|
|
1908
2000
|
|
|
1909
2001
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1911,7 +2003,7 @@
|
|
|
1911
2003
|
|
|
1912
2004
|
—
|
|
1913
2005
|
<div class='inline'>
|
|
1914
|
-
<p>request headers module configuration
|
|
2006
|
+
<p>request headers module configuration or “null“</p>
|
|
1915
2007
|
</div>
|
|
1916
2008
|
|
|
1917
2009
|
</li>
|
|
@@ -1921,7 +2013,7 @@
|
|
|
1921
2013
|
<span class='name'>response_headers</span>
|
|
1922
2014
|
|
|
1923
2015
|
|
|
1924
|
-
<span class='type'>(<tt>
|
|
2016
|
+
<span class='type'>(<tt>EndpointResponseHeaders</tt>)</span>
|
|
1925
2017
|
|
|
1926
2018
|
|
|
1927
2019
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1929,7 +2021,7 @@
|
|
|
1929
2021
|
|
|
1930
2022
|
—
|
|
1931
2023
|
<div class='inline'>
|
|
1932
|
-
<p>response headers module configuration
|
|
2024
|
+
<p>response headers module configuration or “null“</p>
|
|
1933
2025
|
</div>
|
|
1934
2026
|
|
|
1935
2027
|
</li>
|
|
@@ -1939,7 +2031,7 @@
|
|
|
1939
2031
|
<span class='name'>ip_policy</span>
|
|
1940
2032
|
|
|
1941
2033
|
|
|
1942
|
-
<span class='type'>(<tt>
|
|
2034
|
+
<span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
|
|
1943
2035
|
|
|
1944
2036
|
|
|
1945
2037
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1947,7 +2039,7 @@
|
|
|
1947
2039
|
|
|
1948
2040
|
—
|
|
1949
2041
|
<div class='inline'>
|
|
1950
|
-
<p>ip policy module configuration
|
|
2042
|
+
<p>ip policy module configuration or “null“</p>
|
|
1951
2043
|
</div>
|
|
1952
2044
|
|
|
1953
2045
|
</li>
|
|
@@ -1957,7 +2049,7 @@
|
|
|
1957
2049
|
<span class='name'>mutual_tls</span>
|
|
1958
2050
|
|
|
1959
2051
|
|
|
1960
|
-
<span class='type'>(<tt>
|
|
2052
|
+
<span class='type'>(<tt>EndpointMutualTLSMutate</tt>)</span>
|
|
1961
2053
|
|
|
1962
2054
|
|
|
1963
2055
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1965,7 +2057,7 @@
|
|
|
1965
2057
|
|
|
1966
2058
|
—
|
|
1967
2059
|
<div class='inline'>
|
|
1968
|
-
<p>mutual TLS module configuration
|
|
2060
|
+
<p>mutual TLS module configuration or “null“</p>
|
|
1969
2061
|
</div>
|
|
1970
2062
|
|
|
1971
2063
|
</li>
|
|
@@ -1975,7 +2067,7 @@
|
|
|
1975
2067
|
<span class='name'>tls_termination</span>
|
|
1976
2068
|
|
|
1977
2069
|
|
|
1978
|
-
<span class='type'>(<tt>
|
|
2070
|
+
<span class='type'>(<tt>EndpointTLSTermination</tt>)</span>
|
|
1979
2071
|
|
|
1980
2072
|
|
|
1981
2073
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1983,7 +2075,7 @@
|
|
|
1983
2075
|
|
|
1984
2076
|
—
|
|
1985
2077
|
<div class='inline'>
|
|
1986
|
-
<p>TLS termination module configuration
|
|
2078
|
+
<p>TLS termination module configuration or “null“</p>
|
|
1987
2079
|
</div>
|
|
1988
2080
|
|
|
1989
2081
|
</li>
|
|
@@ -1993,7 +2085,7 @@
|
|
|
1993
2085
|
<span class='name'>webhook_validation</span>
|
|
1994
2086
|
|
|
1995
2087
|
|
|
1996
|
-
<span class='type'>(<tt>
|
|
2088
|
+
<span class='type'>(<tt>EndpointWebhookValidation</tt>)</span>
|
|
1997
2089
|
|
|
1998
2090
|
|
|
1999
2091
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -2001,7 +2093,7 @@
|
|
|
2001
2093
|
|
|
2002
2094
|
—
|
|
2003
2095
|
<div class='inline'>
|
|
2004
|
-
<p>webhook validation module configuration
|
|
2096
|
+
<p>webhook validation module configuration or “null“</p>
|
|
2005
2097
|
</div>
|
|
2006
2098
|
|
|
2007
2099
|
</li>
|
|
@@ -2011,7 +2103,7 @@
|
|
|
2011
2103
|
<span class='name'>oauth</span>
|
|
2012
2104
|
|
|
2013
2105
|
|
|
2014
|
-
<span class='type'>(<tt>
|
|
2106
|
+
<span class='type'>(<tt>EndpointOAuth</tt>)</span>
|
|
2015
2107
|
|
|
2016
2108
|
|
|
2017
2109
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -2019,7 +2111,7 @@
|
|
|
2019
2111
|
|
|
2020
2112
|
—
|
|
2021
2113
|
<div class='inline'>
|
|
2022
|
-
<p>oauth module configuration
|
|
2114
|
+
<p>oauth module configuration or “null“</p>
|
|
2023
2115
|
</div>
|
|
2024
2116
|
|
|
2025
2117
|
</li>
|
|
@@ -2029,7 +2121,7 @@
|
|
|
2029
2121
|
<span class='name'>logging</span>
|
|
2030
2122
|
|
|
2031
2123
|
|
|
2032
|
-
<span class='type'>(<tt>
|
|
2124
|
+
<span class='type'>(<tt>EndpointLoggingMutate</tt>)</span>
|
|
2033
2125
|
|
|
2034
2126
|
|
|
2035
2127
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -2037,7 +2129,7 @@
|
|
|
2037
2129
|
|
|
2038
2130
|
—
|
|
2039
2131
|
<div class='inline'>
|
|
2040
|
-
<p>logging module configuration
|
|
2132
|
+
<p>logging module configuration or “null“</p>
|
|
2041
2133
|
</div>
|
|
2042
2134
|
|
|
2043
2135
|
</li>
|
|
@@ -2047,7 +2139,7 @@
|
|
|
2047
2139
|
<span class='name'>saml</span>
|
|
2048
2140
|
|
|
2049
2141
|
|
|
2050
|
-
<span class='type'>(<tt>
|
|
2142
|
+
<span class='type'>(<tt>EndpointSAMLMutate</tt>)</span>
|
|
2051
2143
|
|
|
2052
2144
|
|
|
2053
2145
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -2055,7 +2147,7 @@
|
|
|
2055
2147
|
|
|
2056
2148
|
—
|
|
2057
2149
|
<div class='inline'>
|
|
2058
|
-
<p>saml module configuration
|
|
2150
|
+
<p>saml module configuration or “null“</p>
|
|
2059
2151
|
</div>
|
|
2060
2152
|
|
|
2061
2153
|
</li>
|
|
@@ -2065,7 +2157,7 @@
|
|
|
2065
2157
|
<span class='name'>oidc</span>
|
|
2066
2158
|
|
|
2067
2159
|
|
|
2068
|
-
<span class='type'>(<tt>
|
|
2160
|
+
<span class='type'>(<tt>EndpointOIDC</tt>)</span>
|
|
2069
2161
|
|
|
2070
2162
|
|
|
2071
2163
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -2073,7 +2165,7 @@
|
|
|
2073
2165
|
|
|
2074
2166
|
—
|
|
2075
2167
|
<div class='inline'>
|
|
2076
|
-
<p>oidc module configuration
|
|
2168
|
+
<p>oidc module configuration or “null“</p>
|
|
2077
2169
|
</div>
|
|
2078
2170
|
|
|
2079
2171
|
</li>
|
|
@@ -2092,7 +2184,7 @@
|
|
|
2092
2184
|
|
|
2093
2185
|
—
|
|
2094
2186
|
<div class='inline'>
|
|
2095
|
-
<p>result from
|
|
2187
|
+
<p>result from the API request</p>
|
|
2096
2188
|
</div>
|
|
2097
2189
|
|
|
2098
2190
|
</li>
|
|
@@ -2105,81 +2197,91 @@
|
|
|
2105
2197
|
<pre class="lines">
|
|
2106
2198
|
|
|
2107
2199
|
|
|
2108
|
-
|
|
2109
|
-
|
|
2110
|
-
|
|
2111
|
-
|
|
2112
|
-
|
|
2113
|
-
|
|
2114
|
-
|
|
2115
|
-
|
|
2116
|
-
|
|
2117
|
-
|
|
2118
|
-
|
|
2119
|
-
|
|
2120
|
-
|
|
2121
|
-
|
|
2122
|
-
|
|
2123
|
-
|
|
2124
|
-
|
|
2125
|
-
|
|
2126
|
-
|
|
2127
|
-
|
|
2128
|
-
|
|
2129
|
-
|
|
2130
|
-
|
|
2131
|
-
|
|
2132
|
-
|
|
2133
|
-
|
|
2134
|
-
|
|
2135
|
-
|
|
2136
|
-
|
|
2137
|
-
|
|
2138
|
-
|
|
2139
|
-
|
|
2140
|
-
|
|
2141
|
-
|
|
2142
|
-
|
|
2143
|
-
|
|
2200
|
+
281
|
|
2201
|
+
282
|
|
2202
|
+
283
|
|
2203
|
+
284
|
|
2204
|
+
285
|
|
2205
|
+
286
|
|
2206
|
+
287
|
|
2207
|
+
288
|
|
2208
|
+
289
|
|
2209
|
+
290
|
|
2210
|
+
291
|
|
2211
|
+
292
|
|
2212
|
+
293
|
|
2213
|
+
294
|
|
2214
|
+
295
|
|
2215
|
+
296
|
|
2216
|
+
297
|
|
2217
|
+
298
|
|
2218
|
+
299
|
|
2219
|
+
300
|
|
2220
|
+
301
|
|
2221
|
+
302
|
|
2222
|
+
303
|
|
2223
|
+
304
|
|
2224
|
+
305
|
|
2225
|
+
306
|
|
2226
|
+
307
|
|
2227
|
+
308
|
|
2228
|
+
309
|
|
2229
|
+
310
|
|
2230
|
+
311
|
|
2231
|
+
312
|
|
2232
|
+
313
|
|
2233
|
+
314
|
|
2234
|
+
315
|
|
2235
|
+
316
|
|
2236
|
+
317
|
|
2237
|
+
318
|
|
2238
|
+
319
|
|
2239
|
+
320
|
|
2240
|
+
321</pre>
|
|
2144
2241
|
</td>
|
|
2145
2242
|
<td>
|
|
2146
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line
|
|
2147
|
-
|
|
2148
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
|
|
2149
|
-
<span class='label'>id:</span> <span class='
|
|
2150
|
-
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2151
|
-
<span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2152
|
-
<span class='label'>
|
|
2153
|
-
<span class='label'>
|
|
2154
|
-
<span class='label'>
|
|
2155
|
-
<span class='label'>
|
|
2156
|
-
<span class='label'>
|
|
2157
|
-
<span class='label'>
|
|
2158
|
-
<span class='label'>
|
|
2159
|
-
<span class='label'>
|
|
2160
|
-
<span class='label'>
|
|
2161
|
-
<span class='label'>
|
|
2162
|
-
<span class='label'>
|
|
2163
|
-
<span class='label'>
|
|
2164
|
-
<span class='
|
|
2165
|
-
<span class='
|
|
2166
|
-
|
|
2167
|
-
|
|
2168
|
-
|
|
2169
|
-
<span class='label'>
|
|
2170
|
-
|
|
2171
|
-
|
|
2172
|
-
|
|
2173
|
-
|
|
2174
|
-
|
|
2175
|
-
|
|
2176
|
-
|
|
2177
|
-
|
|
2178
|
-
|
|
2179
|
-
|
|
2180
|
-
<span class='
|
|
2181
|
-
<span class='id identifier
|
|
2182
|
-
<span class='
|
|
2243
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoint_configurations_client.rb', line 281</span>
|
|
2244
|
+
|
|
2245
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
|
|
2246
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
2247
|
+
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2248
|
+
<span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2249
|
+
<span class='label'>basic_auth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2250
|
+
<span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2251
|
+
<span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2252
|
+
<span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2253
|
+
<span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2254
|
+
<span class='label'>ip_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2255
|
+
<span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2256
|
+
<span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2257
|
+
<span class='label'>webhook_validation:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2258
|
+
<span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2259
|
+
<span class='label'>logging:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2260
|
+
<span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2261
|
+
<span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2262
|
+
<span class='label'>backend:</span> <span class='kw'>nil</span>
|
|
2263
|
+
<span class='rparen'>)</span>
|
|
2264
|
+
<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>
|
|
2265
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
2266
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
2267
|
+
<span class='rbrace'>}</span>
|
|
2268
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
2269
|
+
<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>
|
|
2270
|
+
<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>
|
|
2271
|
+
<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>
|
|
2272
|
+
<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>
|
|
2273
|
+
<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>
|
|
2274
|
+
<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>
|
|
2275
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_policy'>ip_policy</span>
|
|
2276
|
+
<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>
|
|
2277
|
+
<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>
|
|
2278
|
+
<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>
|
|
2279
|
+
<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>
|
|
2280
|
+
<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>
|
|
2281
|
+
<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>
|
|
2282
|
+
<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>
|
|
2283
|
+
<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>
|
|
2284
|
+
<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='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EndpointConfiguration.html#initialize-instance_method" title="NgrokAPI::Models::EndpointConfiguration#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>
|
|
2183
2285
|
<span class='kw'>end</span></pre>
|
|
2184
2286
|
</td>
|
|
2185
2287
|
</tr>
|
|
@@ -2191,7 +2293,7 @@
|
|
|
2191
2293
|
</div>
|
|
2192
2294
|
|
|
2193
2295
|
<div id="footer">
|
|
2194
|
-
Generated on
|
|
2296
|
+
Generated on Mon Oct 4 23:24:18 2021 by
|
|
2195
2297
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
2196
2298
|
0.9.26 (ruby-3.0.1).
|
|
2197
2299
|
</div>
|