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
data/doc/NgrokAPI/Client.html
CHANGED
@@ -128,7 +128,7 @@
|
|
128
128
|
<li class="public ">
|
129
129
|
<span class="summary_signature">
|
130
130
|
|
131
|
-
<a href="#
|
131
|
+
<a href="#abuse_reports-instance_method" title="#abuse_reports (instance method)">#<strong>abuse_reports</strong> ⇒ NgrokAPI::Services::AbuseReportsClient </a>
|
132
132
|
|
133
133
|
|
134
134
|
|
@@ -143,7 +143,79 @@
|
|
143
143
|
|
144
144
|
|
145
145
|
<span class="summary_desc"><div class='inline'>
|
146
|
-
<p>
|
146
|
+
<p>Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.</p>
|
147
|
+
</div></span>
|
148
|
+
|
149
|
+
</li>
|
150
|
+
|
151
|
+
|
152
|
+
<li class="public ">
|
153
|
+
<span class="summary_signature">
|
154
|
+
|
155
|
+
<a href="#api_keys-instance_method" title="#api_keys (instance method)">#<strong>api_keys</strong> ⇒ NgrokAPI::Services::APIKeysClient </a>
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
</span>
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
<span class="summary_desc"><div class='inline'>
|
170
|
+
<p>API Keys are used to authenticate to the (<a href="https://ngrok.com/docs/api#authentication)ngrok">ngrok.com/docs/api#authentication)ngrok</a> API.</p>
|
171
|
+
</div></span>
|
172
|
+
|
173
|
+
</li>
|
174
|
+
|
175
|
+
|
176
|
+
<li class="public ">
|
177
|
+
<span class="summary_signature">
|
178
|
+
|
179
|
+
<a href="#certificate_authorities-instance_method" title="#certificate_authorities (instance method)">#<strong>certificate_authorities</strong> ⇒ NgrokAPI::Services::CertificateAuthoritiesClient </a>
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
</span>
|
184
|
+
|
185
|
+
|
186
|
+
|
187
|
+
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
<span class="summary_desc"><div class='inline'>
|
194
|
+
<p>Certificate Authorities are x509 certificates that are used to sign other x509 certificates.</p>
|
195
|
+
</div></span>
|
196
|
+
|
197
|
+
</li>
|
198
|
+
|
199
|
+
|
200
|
+
<li class="public ">
|
201
|
+
<span class="summary_signature">
|
202
|
+
|
203
|
+
<a href="#credentials-instance_method" title="#credentials (instance method)">#<strong>credentials</strong> ⇒ NgrokAPI::Services::CredentialsClient </a>
|
204
|
+
|
205
|
+
|
206
|
+
|
207
|
+
</span>
|
208
|
+
|
209
|
+
|
210
|
+
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
|
215
|
+
|
216
|
+
|
217
|
+
<span class="summary_desc"><div class='inline'>
|
218
|
+
<p>Tunnel Credentials are ngrok agent authtokens.</p>
|
147
219
|
</div></span>
|
148
220
|
|
149
221
|
</li>
|
@@ -156,107 +228,1392 @@
|
|
156
228
|
|
157
229
|
|
158
230
|
|
159
|
-
</span>
|
231
|
+
</span>
|
232
|
+
|
233
|
+
|
234
|
+
|
235
|
+
|
236
|
+
|
237
|
+
|
238
|
+
|
239
|
+
|
240
|
+
|
241
|
+
<span class="summary_desc"><div class='inline'>
|
242
|
+
<p>Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled.</p>
|
243
|
+
</div></span>
|
244
|
+
|
245
|
+
</li>
|
246
|
+
|
247
|
+
|
248
|
+
<li class="public ">
|
249
|
+
<span class="summary_signature">
|
250
|
+
|
251
|
+
<a href="#event_destinations-instance_method" title="#event_destinations (instance method)">#<strong>event_destinations</strong> ⇒ Object </a>
|
252
|
+
|
253
|
+
|
254
|
+
|
255
|
+
</span>
|
256
|
+
|
257
|
+
|
258
|
+
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
|
263
|
+
|
264
|
+
|
265
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
266
|
+
|
267
|
+
</li>
|
268
|
+
|
269
|
+
|
270
|
+
<li class="public ">
|
271
|
+
<span class="summary_signature">
|
272
|
+
|
273
|
+
<a href="#event_sources-instance_method" title="#event_sources (instance method)">#<strong>event_sources</strong> ⇒ Object </a>
|
274
|
+
|
275
|
+
|
276
|
+
|
277
|
+
</span>
|
278
|
+
|
279
|
+
|
280
|
+
|
281
|
+
|
282
|
+
|
283
|
+
|
284
|
+
|
285
|
+
|
286
|
+
|
287
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
288
|
+
|
289
|
+
</li>
|
290
|
+
|
291
|
+
|
292
|
+
<li class="public ">
|
293
|
+
<span class="summary_signature">
|
294
|
+
|
295
|
+
<a href="#event_streams-instance_method" title="#event_streams (instance method)">#<strong>event_streams</strong> ⇒ Object </a>
|
296
|
+
|
297
|
+
|
298
|
+
|
299
|
+
</span>
|
300
|
+
|
301
|
+
|
302
|
+
|
303
|
+
|
304
|
+
|
305
|
+
|
306
|
+
|
307
|
+
|
308
|
+
|
309
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
310
|
+
|
311
|
+
</li>
|
312
|
+
|
313
|
+
|
314
|
+
<li class="public ">
|
315
|
+
<span class="summary_signature">
|
316
|
+
|
317
|
+
<a href="#event_subscriptions-instance_method" title="#event_subscriptions (instance method)">#<strong>event_subscriptions</strong> ⇒ Object </a>
|
318
|
+
|
319
|
+
|
320
|
+
|
321
|
+
</span>
|
322
|
+
|
323
|
+
|
324
|
+
|
325
|
+
|
326
|
+
|
327
|
+
|
328
|
+
|
329
|
+
|
330
|
+
|
331
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
332
|
+
|
333
|
+
</li>
|
334
|
+
|
335
|
+
|
336
|
+
<li class="public ">
|
337
|
+
<span class="summary_signature">
|
338
|
+
|
339
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(api_key:, base_url: 'https://api.ngrok.com') ⇒ Client </a>
|
340
|
+
|
341
|
+
|
342
|
+
|
343
|
+
</span>
|
344
|
+
|
345
|
+
|
346
|
+
<span class="note title constructor">constructor</span>
|
347
|
+
|
348
|
+
|
349
|
+
|
350
|
+
|
351
|
+
|
352
|
+
|
353
|
+
|
354
|
+
|
355
|
+
<span class="summary_desc"><div class='inline'>
|
356
|
+
<p>A new instance of Client.</p>
|
357
|
+
</div></span>
|
358
|
+
|
359
|
+
</li>
|
360
|
+
|
361
|
+
|
362
|
+
<li class="public ">
|
363
|
+
<span class="summary_signature">
|
364
|
+
|
365
|
+
<a href="#ip_policies-instance_method" title="#ip_policies (instance method)">#<strong>ip_policies</strong> ⇒ NgrokAPI::Services::IPPoliciesClient </a>
|
366
|
+
|
367
|
+
|
368
|
+
|
369
|
+
</span>
|
370
|
+
|
371
|
+
|
372
|
+
|
373
|
+
|
374
|
+
|
375
|
+
|
376
|
+
|
377
|
+
|
378
|
+
|
379
|
+
<span class="summary_desc"><div class='inline'>
|
380
|
+
<p>IP Policies are reusable groups of CIDR ranges with an allow or deny action.</p>
|
381
|
+
</div></span>
|
382
|
+
|
383
|
+
</li>
|
384
|
+
|
385
|
+
|
386
|
+
<li class="public ">
|
387
|
+
<span class="summary_signature">
|
388
|
+
|
389
|
+
<a href="#ip_policy_rules-instance_method" title="#ip_policy_rules (instance method)">#<strong>ip_policy_rules</strong> ⇒ NgrokAPI::Services::IPPolicyRulesClient </a>
|
390
|
+
|
391
|
+
|
392
|
+
|
393
|
+
</span>
|
394
|
+
|
395
|
+
|
396
|
+
|
397
|
+
|
398
|
+
|
399
|
+
|
400
|
+
|
401
|
+
|
402
|
+
|
403
|
+
<span class="summary_desc"><div class='inline'>
|
404
|
+
<p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.</p>
|
405
|
+
</div></span>
|
406
|
+
|
407
|
+
</li>
|
408
|
+
|
409
|
+
|
410
|
+
<li class="public ">
|
411
|
+
<span class="summary_signature">
|
412
|
+
|
413
|
+
<a href="#ip_restrictions-instance_method" title="#ip_restrictions (instance method)">#<strong>ip_restrictions</strong> ⇒ NgrokAPI::Services::IPRestrictionsClient </a>
|
414
|
+
|
415
|
+
|
416
|
+
|
417
|
+
</span>
|
418
|
+
|
419
|
+
|
420
|
+
|
421
|
+
|
422
|
+
|
423
|
+
|
424
|
+
|
425
|
+
|
426
|
+
|
427
|
+
<span class="summary_desc"><div class='inline'>
|
428
|
+
<p>An IP restriction is a restriction placed on the CIDRs that are allowed to initate traffic to a specific aspect of your ngrok account.</p>
|
429
|
+
</div></span>
|
430
|
+
|
431
|
+
</li>
|
432
|
+
|
433
|
+
|
434
|
+
<li class="public ">
|
435
|
+
<span class="summary_signature">
|
436
|
+
|
437
|
+
<a href="#ip_whitelist-instance_method" title="#ip_whitelist (instance method)">#<strong>ip_whitelist</strong> ⇒ NgrokAPI::Services::IPWhitelistClient </a>
|
438
|
+
|
439
|
+
|
440
|
+
|
441
|
+
</span>
|
442
|
+
|
443
|
+
|
444
|
+
|
445
|
+
|
446
|
+
|
447
|
+
|
448
|
+
|
449
|
+
|
450
|
+
|
451
|
+
<span class="summary_desc"><div class='inline'>
|
452
|
+
<p>The IP Whitelist is deprecated and will be removed.</p>
|
453
|
+
</div></span>
|
454
|
+
|
455
|
+
</li>
|
456
|
+
|
457
|
+
|
458
|
+
<li class="public ">
|
459
|
+
<span class="summary_signature">
|
460
|
+
|
461
|
+
<a href="#reserved_addrs-instance_method" title="#reserved_addrs (instance method)">#<strong>reserved_addrs</strong> ⇒ NgrokAPI::Services::ReservedAddrsClient </a>
|
462
|
+
|
463
|
+
|
464
|
+
|
465
|
+
</span>
|
466
|
+
|
467
|
+
|
468
|
+
|
469
|
+
|
470
|
+
|
471
|
+
|
472
|
+
|
473
|
+
|
474
|
+
|
475
|
+
<span class="summary_desc"><div class='inline'>
|
476
|
+
<p>Reserved Addresses are TCP addresses that can be used to listen for traffic.</p>
|
477
|
+
</div></span>
|
478
|
+
|
479
|
+
</li>
|
480
|
+
|
481
|
+
|
482
|
+
<li class="public ">
|
483
|
+
<span class="summary_signature">
|
484
|
+
|
485
|
+
<a href="#reserved_domains-instance_method" title="#reserved_domains (instance method)">#<strong>reserved_domains</strong> ⇒ NgrokAPI::Services::ReservedDomainsClient </a>
|
486
|
+
|
487
|
+
|
488
|
+
|
489
|
+
</span>
|
490
|
+
|
491
|
+
|
492
|
+
|
493
|
+
|
494
|
+
|
495
|
+
|
496
|
+
|
497
|
+
|
498
|
+
|
499
|
+
<span class="summary_desc"><div class='inline'>
|
500
|
+
<p>Reserved Domains are hostnames that you can listen for traffic on.</p>
|
501
|
+
</div></span>
|
502
|
+
|
503
|
+
</li>
|
504
|
+
|
505
|
+
|
506
|
+
<li class="public ">
|
507
|
+
<span class="summary_signature">
|
508
|
+
|
509
|
+
<a href="#ssh_certificate_authorities-instance_method" title="#ssh_certificate_authorities (instance method)">#<strong>ssh_certificate_authorities</strong> ⇒ NgrokAPI::Services::SSHCertificateAuthoritiesClient </a>
|
510
|
+
|
511
|
+
|
512
|
+
|
513
|
+
</span>
|
514
|
+
|
515
|
+
|
516
|
+
|
517
|
+
|
518
|
+
|
519
|
+
|
520
|
+
|
521
|
+
|
522
|
+
|
523
|
+
<span class="summary_desc"><div class='inline'>
|
524
|
+
<p>An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.</p>
|
525
|
+
</div></span>
|
526
|
+
|
527
|
+
</li>
|
528
|
+
|
529
|
+
|
530
|
+
<li class="public ">
|
531
|
+
<span class="summary_signature">
|
532
|
+
|
533
|
+
<a href="#ssh_credentials-instance_method" title="#ssh_credentials (instance method)">#<strong>ssh_credentials</strong> ⇒ NgrokAPI::Services::SSHCredentialsClient </a>
|
534
|
+
|
535
|
+
|
536
|
+
|
537
|
+
</span>
|
538
|
+
|
539
|
+
|
540
|
+
|
541
|
+
|
542
|
+
|
543
|
+
|
544
|
+
|
545
|
+
|
546
|
+
|
547
|
+
<span class="summary_desc"><div class='inline'>
|
548
|
+
<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.</p>
|
549
|
+
</div></span>
|
550
|
+
|
551
|
+
</li>
|
552
|
+
|
553
|
+
|
554
|
+
<li class="public ">
|
555
|
+
<span class="summary_signature">
|
556
|
+
|
557
|
+
<a href="#ssh_host_certificates-instance_method" title="#ssh_host_certificates (instance method)">#<strong>ssh_host_certificates</strong> ⇒ NgrokAPI::Services::SSHHostCertificatesClient </a>
|
558
|
+
|
559
|
+
|
560
|
+
|
561
|
+
</span>
|
562
|
+
|
563
|
+
|
564
|
+
|
565
|
+
|
566
|
+
|
567
|
+
|
568
|
+
|
569
|
+
|
570
|
+
|
571
|
+
<span class="summary_desc"><div class='inline'>
|
572
|
+
<p>SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.</p>
|
573
|
+
</div></span>
|
574
|
+
|
575
|
+
</li>
|
576
|
+
|
577
|
+
|
578
|
+
<li class="public ">
|
579
|
+
<span class="summary_signature">
|
580
|
+
|
581
|
+
<a href="#ssh_user_certificates-instance_method" title="#ssh_user_certificates (instance method)">#<strong>ssh_user_certificates</strong> ⇒ NgrokAPI::Services::SSHUserCertificatesClient </a>
|
582
|
+
|
583
|
+
|
584
|
+
|
585
|
+
</span>
|
586
|
+
|
587
|
+
|
588
|
+
|
589
|
+
|
590
|
+
|
591
|
+
|
592
|
+
|
593
|
+
|
594
|
+
|
595
|
+
<span class="summary_desc"><div class='inline'>
|
596
|
+
<p>SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection.</p>
|
597
|
+
</div></span>
|
598
|
+
|
599
|
+
</li>
|
600
|
+
|
601
|
+
|
602
|
+
<li class="public ">
|
603
|
+
<span class="summary_signature">
|
604
|
+
|
605
|
+
<a href="#tls_certificates-instance_method" title="#tls_certificates (instance method)">#<strong>tls_certificates</strong> ⇒ NgrokAPI::Services::TLSCertificatesClient </a>
|
606
|
+
|
607
|
+
|
608
|
+
|
609
|
+
</span>
|
610
|
+
|
611
|
+
|
612
|
+
|
613
|
+
|
614
|
+
|
615
|
+
|
616
|
+
|
617
|
+
|
618
|
+
|
619
|
+
<span class="summary_desc"><div class='inline'>
|
620
|
+
<p>TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic.</p>
|
621
|
+
</div></span>
|
622
|
+
|
623
|
+
</li>
|
624
|
+
|
625
|
+
|
626
|
+
<li class="public ">
|
627
|
+
<span class="summary_signature">
|
628
|
+
|
629
|
+
<a href="#tunnel_sessions-instance_method" title="#tunnel_sessions (instance method)">#<strong>tunnel_sessions</strong> ⇒ NgrokAPI::Services::TunnelSessionsClient </a>
|
630
|
+
|
631
|
+
|
632
|
+
|
633
|
+
</span>
|
634
|
+
|
635
|
+
|
636
|
+
|
637
|
+
|
638
|
+
|
639
|
+
|
640
|
+
|
641
|
+
|
642
|
+
|
643
|
+
<span class="summary_desc"><div class='inline'>
|
644
|
+
<p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service.</p>
|
645
|
+
</div></span>
|
646
|
+
|
647
|
+
</li>
|
648
|
+
|
649
|
+
|
650
|
+
<li class="public ">
|
651
|
+
<span class="summary_signature">
|
652
|
+
|
653
|
+
<a href="#tunnels-instance_method" title="#tunnels (instance method)">#<strong>tunnels</strong> ⇒ NgrokAPI::Services::TunnelsClient </a>
|
654
|
+
|
655
|
+
|
656
|
+
|
657
|
+
</span>
|
658
|
+
|
659
|
+
|
660
|
+
|
661
|
+
|
662
|
+
|
663
|
+
|
664
|
+
|
665
|
+
|
666
|
+
|
667
|
+
<span class="summary_desc"><div class='inline'>
|
668
|
+
<p>Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.</p>
|
669
|
+
</div></span>
|
670
|
+
|
671
|
+
</li>
|
672
|
+
|
673
|
+
|
674
|
+
</ul>
|
675
|
+
|
676
|
+
|
677
|
+
<div id="constructor_details" class="method_details_list">
|
678
|
+
<h2>Constructor Details</h2>
|
679
|
+
|
680
|
+
<div class="method_details first">
|
681
|
+
<h3 class="signature first" id="initialize-instance_method">
|
682
|
+
|
683
|
+
#<strong>initialize</strong>(api_key:, base_url: 'https://api.ngrok.com') ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Client (class)">Client</a></span></tt>
|
684
|
+
|
685
|
+
|
686
|
+
|
687
|
+
|
688
|
+
|
689
|
+
</h3><div class="docstring">
|
690
|
+
<div class="discussion">
|
691
|
+
|
692
|
+
<p>Returns a new instance of Client.</p>
|
693
|
+
|
694
|
+
|
695
|
+
</div>
|
696
|
+
</div>
|
697
|
+
<div class="tags">
|
698
|
+
|
699
|
+
|
700
|
+
</div><table class="source_code">
|
701
|
+
<tr>
|
702
|
+
<td>
|
703
|
+
<pre class="lines">
|
704
|
+
|
705
|
+
|
706
|
+
8
|
707
|
+
9
|
708
|
+
10
|
709
|
+
11
|
710
|
+
12
|
711
|
+
13</pre>
|
712
|
+
</td>
|
713
|
+
<td>
|
714
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 8</span>
|
715
|
+
|
716
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span>
|
717
|
+
<span class='label'>api_key:</span><span class='comma'>,</span>
|
718
|
+
<span class='label'>base_url:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://api.ngrok.com</span><span class='tstring_end'>'</span></span>
|
719
|
+
<span class='rparen'>)</span>
|
720
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="HttpClient.html" title="NgrokAPI::HttpClient (class)">HttpClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="HttpClient.html#initialize-instance_method" title="NgrokAPI::HttpClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='id identifier rubyid_api_key'>api_key</span><span class='comma'>,</span> <span class='label'>base_url:</span> <span class='id identifier rubyid_base_url'>base_url</span><span class='rparen'>)</span>
|
721
|
+
<span class='kw'>end</span></pre>
|
722
|
+
</td>
|
723
|
+
</tr>
|
724
|
+
</table>
|
725
|
+
</div>
|
726
|
+
|
727
|
+
</div>
|
728
|
+
|
729
|
+
|
730
|
+
<div id="instance_method_details" class="method_details_list">
|
731
|
+
<h2>Instance Method Details</h2>
|
732
|
+
|
733
|
+
|
734
|
+
<div class="method_details first">
|
735
|
+
<h3 class="signature first" id="abuse_reports-instance_method">
|
736
|
+
|
737
|
+
#<strong>abuse_reports</strong> ⇒ <tt><span class='object_link'><a href="Services/AbuseReportsClient.html" title="NgrokAPI::Services::AbuseReportsClient (class)">NgrokAPI::Services::AbuseReportsClient</a></span></tt>
|
738
|
+
|
739
|
+
|
740
|
+
|
741
|
+
|
742
|
+
|
743
|
+
</h3><div class="docstring">
|
744
|
+
<div class="discussion">
|
745
|
+
|
746
|
+
<p>Abuse Reports allow you to submit take-down requests for URLs hosted by</p>
|
747
|
+
|
748
|
+
<pre class="code ruby"><code class="ruby">ngrok that violate ngrok's terms of service.
|
749
|
+
</code></pre>
|
750
|
+
|
751
|
+
|
752
|
+
</div>
|
753
|
+
</div>
|
754
|
+
<div class="tags">
|
755
|
+
|
756
|
+
<p class="tag_title">Returns:</p>
|
757
|
+
<ul class="return">
|
758
|
+
|
759
|
+
<li>
|
760
|
+
|
761
|
+
|
762
|
+
<span class='type'>(<tt><span class='object_link'><a href="Services/AbuseReportsClient.html" title="NgrokAPI::Services::AbuseReportsClient (class)">NgrokAPI::Services::AbuseReportsClient</a></span></tt>)</span>
|
763
|
+
|
764
|
+
|
765
|
+
|
766
|
+
</li>
|
767
|
+
|
768
|
+
</ul>
|
769
|
+
|
770
|
+
</div><table class="source_code">
|
771
|
+
<tr>
|
772
|
+
<td>
|
773
|
+
<pre class="lines">
|
774
|
+
|
775
|
+
|
776
|
+
20
|
777
|
+
21
|
778
|
+
22</pre>
|
779
|
+
</td>
|
780
|
+
<td>
|
781
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 20</span>
|
782
|
+
|
783
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_abuse_reports'>abuse_reports</span>
|
784
|
+
<span class='ivar'>@_abuse_reports</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/AbuseReportsClient.html" title="NgrokAPI::Services::AbuseReportsClient (class)">AbuseReportsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/AbuseReportsClient.html#initialize-instance_method" title="NgrokAPI::Services::AbuseReportsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
785
|
+
<span class='kw'>end</span></pre>
|
786
|
+
</td>
|
787
|
+
</tr>
|
788
|
+
</table>
|
789
|
+
</div>
|
790
|
+
|
791
|
+
<div class="method_details ">
|
792
|
+
<h3 class="signature " id="api_keys-instance_method">
|
793
|
+
|
794
|
+
#<strong>api_keys</strong> ⇒ <tt><span class='object_link'><a href="Services/APIKeysClient.html" title="NgrokAPI::Services::APIKeysClient (class)">NgrokAPI::Services::APIKeysClient</a></span></tt>
|
795
|
+
|
796
|
+
|
797
|
+
|
798
|
+
|
799
|
+
|
800
|
+
</h3><div class="docstring">
|
801
|
+
<div class="discussion">
|
802
|
+
|
803
|
+
<p>API Keys are used to authenticate to the (<a href="https://ngrok.com/docs/api#authentication)ngrok">ngrok.com/docs/api#authentication)ngrok</a></p>
|
804
|
+
|
805
|
+
<pre class="code ruby"><code class="ruby">API. You may use the API itself
|
806
|
+
to provision and manage API Keys but you'll need to provision your first API
|
807
|
+
key from the (https://dashboard.ngrok.com/api/keys)API Keys page on your
|
808
|
+
ngrok.com dashboard.
|
809
|
+
</code></pre>
|
810
|
+
|
811
|
+
|
812
|
+
</div>
|
813
|
+
</div>
|
814
|
+
<div class="tags">
|
815
|
+
|
816
|
+
<p class="tag_title">Returns:</p>
|
817
|
+
<ul class="return">
|
818
|
+
|
819
|
+
<li>
|
820
|
+
|
821
|
+
|
822
|
+
<span class='type'>(<tt><span class='object_link'><a href="Services/APIKeysClient.html" title="NgrokAPI::Services::APIKeysClient (class)">NgrokAPI::Services::APIKeysClient</a></span></tt>)</span>
|
823
|
+
|
824
|
+
|
825
|
+
|
826
|
+
</li>
|
827
|
+
|
828
|
+
</ul>
|
829
|
+
|
830
|
+
</div><table class="source_code">
|
831
|
+
<tr>
|
832
|
+
<td>
|
833
|
+
<pre class="lines">
|
834
|
+
|
835
|
+
|
836
|
+
33
|
837
|
+
34
|
838
|
+
35</pre>
|
839
|
+
</td>
|
840
|
+
<td>
|
841
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 33</span>
|
842
|
+
|
843
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_api_keys'>api_keys</span>
|
844
|
+
<span class='ivar'>@_api_keys</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/APIKeysClient.html" title="NgrokAPI::Services::APIKeysClient (class)">APIKeysClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/APIKeysClient.html#initialize-instance_method" title="NgrokAPI::Services::APIKeysClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
845
|
+
<span class='kw'>end</span></pre>
|
846
|
+
</td>
|
847
|
+
</tr>
|
848
|
+
</table>
|
849
|
+
</div>
|
850
|
+
|
851
|
+
<div class="method_details ">
|
852
|
+
<h3 class="signature " id="certificate_authorities-instance_method">
|
853
|
+
|
854
|
+
#<strong>certificate_authorities</strong> ⇒ <tt><span class='object_link'><a href="Services/CertificateAuthoritiesClient.html" title="NgrokAPI::Services::CertificateAuthoritiesClient (class)">NgrokAPI::Services::CertificateAuthoritiesClient</a></span></tt>
|
855
|
+
|
856
|
+
|
857
|
+
|
858
|
+
|
859
|
+
|
860
|
+
</h3><div class="docstring">
|
861
|
+
<div class="discussion">
|
862
|
+
|
863
|
+
<p>Certificate Authorities are x509 certificates that are used to sign other</p>
|
864
|
+
|
865
|
+
<pre class="code ruby"><code class="ruby">x509 certificates. Attach a Certificate Authority to the Mutual TLS module
|
866
|
+
to verify that the TLS certificate presented by a client has been signed by
|
867
|
+
this CA. Certificate Authorities are used only for mTLS validation only and
|
868
|
+
thus a private key is not included in the resource.
|
869
|
+
</code></pre>
|
870
|
+
|
871
|
+
|
872
|
+
</div>
|
873
|
+
</div>
|
874
|
+
<div class="tags">
|
875
|
+
|
876
|
+
<p class="tag_title">Returns:</p>
|
877
|
+
<ul class="return">
|
878
|
+
|
879
|
+
<li>
|
880
|
+
|
881
|
+
|
882
|
+
<span class='type'>(<tt><span class='object_link'><a href="Services/CertificateAuthoritiesClient.html" title="NgrokAPI::Services::CertificateAuthoritiesClient (class)">NgrokAPI::Services::CertificateAuthoritiesClient</a></span></tt>)</span>
|
883
|
+
|
884
|
+
|
885
|
+
|
886
|
+
</li>
|
887
|
+
|
888
|
+
</ul>
|
889
|
+
|
890
|
+
</div><table class="source_code">
|
891
|
+
<tr>
|
892
|
+
<td>
|
893
|
+
<pre class="lines">
|
894
|
+
|
895
|
+
|
896
|
+
45
|
897
|
+
46
|
898
|
+
47</pre>
|
899
|
+
</td>
|
900
|
+
<td>
|
901
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 45</span>
|
902
|
+
|
903
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_certificate_authorities'>certificate_authorities</span>
|
904
|
+
<span class='ivar'>@_certificate_authorities</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/CertificateAuthoritiesClient.html" title="NgrokAPI::Services::CertificateAuthoritiesClient (class)">CertificateAuthoritiesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/CertificateAuthoritiesClient.html#initialize-instance_method" title="NgrokAPI::Services::CertificateAuthoritiesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
905
|
+
<span class='kw'>end</span></pre>
|
906
|
+
</td>
|
907
|
+
</tr>
|
908
|
+
</table>
|
909
|
+
</div>
|
910
|
+
|
911
|
+
<div class="method_details ">
|
912
|
+
<h3 class="signature " id="credentials-instance_method">
|
913
|
+
|
914
|
+
#<strong>credentials</strong> ⇒ <tt><span class='object_link'><a href="Services/CredentialsClient.html" title="NgrokAPI::Services::CredentialsClient (class)">NgrokAPI::Services::CredentialsClient</a></span></tt>
|
915
|
+
|
916
|
+
|
917
|
+
|
918
|
+
|
919
|
+
|
920
|
+
</h3><div class="docstring">
|
921
|
+
<div class="discussion">
|
922
|
+
|
923
|
+
<p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok</p>
|
924
|
+
|
925
|
+
<pre class="code ruby"><code class="ruby">agent to connect the ngrok service as your account. They are installed with
|
926
|
+
the ngrok authtoken command or by specifying it in the ngrok.yml
|
927
|
+
configuration file with the authtoken property.
|
928
|
+
</code></pre>
|
929
|
+
|
930
|
+
|
931
|
+
</div>
|
932
|
+
</div>
|
933
|
+
<div class="tags">
|
934
|
+
|
935
|
+
<p class="tag_title">Returns:</p>
|
936
|
+
<ul class="return">
|
937
|
+
|
938
|
+
<li>
|
939
|
+
|
940
|
+
|
941
|
+
<span class='type'>(<tt><span class='object_link'><a href="Services/CredentialsClient.html" title="NgrokAPI::Services::CredentialsClient (class)">NgrokAPI::Services::CredentialsClient</a></span></tt>)</span>
|
942
|
+
|
943
|
+
|
944
|
+
|
945
|
+
</li>
|
946
|
+
|
947
|
+
</ul>
|
948
|
+
|
949
|
+
</div><table class="source_code">
|
950
|
+
<tr>
|
951
|
+
<td>
|
952
|
+
<pre class="lines">
|
953
|
+
|
954
|
+
|
955
|
+
56
|
956
|
+
57
|
957
|
+
58</pre>
|
958
|
+
</td>
|
959
|
+
<td>
|
960
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 56</span>
|
961
|
+
|
962
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_credentials'>credentials</span>
|
963
|
+
<span class='ivar'>@_credentials</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/CredentialsClient.html" title="NgrokAPI::Services::CredentialsClient (class)">CredentialsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/CredentialsClient.html#initialize-instance_method" title="NgrokAPI::Services::CredentialsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
964
|
+
<span class='kw'>end</span></pre>
|
965
|
+
</td>
|
966
|
+
</tr>
|
967
|
+
</table>
|
968
|
+
</div>
|
969
|
+
|
970
|
+
<div class="method_details ">
|
971
|
+
<h3 class="signature " id="endpoint_configurations-instance_method">
|
972
|
+
|
973
|
+
#<strong>endpoint_configurations</strong> ⇒ <tt><span class='object_link'><a href="Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">NgrokAPI::Services::EndpointConfigurationsClient</a></span></tt>
|
974
|
+
|
975
|
+
|
976
|
+
|
977
|
+
|
978
|
+
|
979
|
+
</h3><div class="docstring">
|
980
|
+
<div class="discussion">
|
981
|
+
|
982
|
+
<p>Endpoint Configurations are a reusable group of modules that encapsulate how</p>
|
983
|
+
|
984
|
+
<pre class="code ruby"><code class="ruby">traffic to a domain or address is handled. Endpoint configurations are only
|
985
|
+
applied to Domains and TCP Addresses they have been attached to.
|
986
|
+
</code></pre>
|
987
|
+
|
988
|
+
|
989
|
+
</div>
|
990
|
+
</div>
|
991
|
+
<div class="tags">
|
992
|
+
|
993
|
+
<p class="tag_title">Returns:</p>
|
994
|
+
<ul class="return">
|
995
|
+
|
996
|
+
<li>
|
997
|
+
|
998
|
+
|
999
|
+
<span class='type'>(<tt><span class='object_link'><a href="Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">NgrokAPI::Services::EndpointConfigurationsClient</a></span></tt>)</span>
|
1000
|
+
|
1001
|
+
|
1002
|
+
|
1003
|
+
</li>
|
1004
|
+
|
1005
|
+
</ul>
|
1006
|
+
|
1007
|
+
</div><table class="source_code">
|
1008
|
+
<tr>
|
1009
|
+
<td>
|
1010
|
+
<pre class="lines">
|
1011
|
+
|
1012
|
+
|
1013
|
+
66
|
1014
|
+
67
|
1015
|
+
68</pre>
|
1016
|
+
</td>
|
1017
|
+
<td>
|
1018
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 66</span>
|
1019
|
+
|
1020
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_endpoint_configurations'>endpoint_configurations</span>
|
1021
|
+
<span class='ivar'>@_endpoint_configurations</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">EndpointConfigurationsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointConfigurationsClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointConfigurationsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1022
|
+
<span class='kw'>end</span></pre>
|
1023
|
+
</td>
|
1024
|
+
</tr>
|
1025
|
+
</table>
|
1026
|
+
</div>
|
1027
|
+
|
1028
|
+
<div class="method_details ">
|
1029
|
+
<h3 class="signature " id="event_destinations-instance_method">
|
1030
|
+
|
1031
|
+
#<strong>event_destinations</strong> ⇒ <tt>Object</tt>
|
1032
|
+
|
1033
|
+
|
1034
|
+
|
1035
|
+
|
1036
|
+
|
1037
|
+
</h3><table class="source_code">
|
1038
|
+
<tr>
|
1039
|
+
<td>
|
1040
|
+
<pre class="lines">
|
1041
|
+
|
1042
|
+
|
1043
|
+
74
|
1044
|
+
75
|
1045
|
+
76</pre>
|
1046
|
+
</td>
|
1047
|
+
<td>
|
1048
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 74</span>
|
1049
|
+
|
1050
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_event_destinations'>event_destinations</span>
|
1051
|
+
<span class='ivar'>@_event_destinations</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventDestinationsClient.html" title="NgrokAPI::Services::EventDestinationsClient (class)">EventDestinationsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventDestinationsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventDestinationsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1052
|
+
<span class='kw'>end</span></pre>
|
1053
|
+
</td>
|
1054
|
+
</tr>
|
1055
|
+
</table>
|
1056
|
+
</div>
|
1057
|
+
|
1058
|
+
<div class="method_details ">
|
1059
|
+
<h3 class="signature " id="event_sources-instance_method">
|
1060
|
+
|
1061
|
+
#<strong>event_sources</strong> ⇒ <tt>Object</tt>
|
1062
|
+
|
1063
|
+
|
1064
|
+
|
1065
|
+
|
1066
|
+
|
1067
|
+
</h3><table class="source_code">
|
1068
|
+
<tr>
|
1069
|
+
<td>
|
1070
|
+
<pre class="lines">
|
1071
|
+
|
1072
|
+
|
1073
|
+
82
|
1074
|
+
83
|
1075
|
+
84</pre>
|
1076
|
+
</td>
|
1077
|
+
<td>
|
1078
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 82</span>
|
1079
|
+
|
1080
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_event_sources'>event_sources</span>
|
1081
|
+
<span class='ivar'>@_event_sources</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventSourcesClient.html" title="NgrokAPI::Services::EventSourcesClient (class)">EventSourcesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventSourcesClient.html#initialize-instance_method" title="NgrokAPI::Services::EventSourcesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1082
|
+
<span class='kw'>end</span></pre>
|
1083
|
+
</td>
|
1084
|
+
</tr>
|
1085
|
+
</table>
|
1086
|
+
</div>
|
1087
|
+
|
1088
|
+
<div class="method_details ">
|
1089
|
+
<h3 class="signature " id="event_streams-instance_method">
|
1090
|
+
|
1091
|
+
#<strong>event_streams</strong> ⇒ <tt>Object</tt>
|
1092
|
+
|
1093
|
+
|
1094
|
+
|
1095
|
+
|
1096
|
+
|
1097
|
+
</h3><table class="source_code">
|
1098
|
+
<tr>
|
1099
|
+
<td>
|
1100
|
+
<pre class="lines">
|
1101
|
+
|
1102
|
+
|
1103
|
+
70
|
1104
|
+
71
|
1105
|
+
72</pre>
|
1106
|
+
</td>
|
1107
|
+
<td>
|
1108
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 70</span>
|
1109
|
+
|
1110
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_event_streams'>event_streams</span>
|
1111
|
+
<span class='ivar'>@_event_streams</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventStreamsClient.html" title="NgrokAPI::Services::EventStreamsClient (class)">EventStreamsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventStreamsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventStreamsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1112
|
+
<span class='kw'>end</span></pre>
|
1113
|
+
</td>
|
1114
|
+
</tr>
|
1115
|
+
</table>
|
1116
|
+
</div>
|
1117
|
+
|
1118
|
+
<div class="method_details ">
|
1119
|
+
<h3 class="signature " id="event_subscriptions-instance_method">
|
1120
|
+
|
1121
|
+
#<strong>event_subscriptions</strong> ⇒ <tt>Object</tt>
|
1122
|
+
|
1123
|
+
|
1124
|
+
|
1125
|
+
|
1126
|
+
|
1127
|
+
</h3><table class="source_code">
|
1128
|
+
<tr>
|
1129
|
+
<td>
|
1130
|
+
<pre class="lines">
|
1131
|
+
|
1132
|
+
|
1133
|
+
78
|
1134
|
+
79
|
1135
|
+
80</pre>
|
1136
|
+
</td>
|
1137
|
+
<td>
|
1138
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 78</span>
|
1139
|
+
|
1140
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_event_subscriptions'>event_subscriptions</span>
|
1141
|
+
<span class='ivar'>@_event_subscriptions</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventSubscriptionsClient.html" title="NgrokAPI::Services::EventSubscriptionsClient (class)">EventSubscriptionsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventSubscriptionsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventSubscriptionsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1142
|
+
<span class='kw'>end</span></pre>
|
1143
|
+
</td>
|
1144
|
+
</tr>
|
1145
|
+
</table>
|
1146
|
+
</div>
|
1147
|
+
|
1148
|
+
<div class="method_details ">
|
1149
|
+
<h3 class="signature " id="ip_policies-instance_method">
|
1150
|
+
|
1151
|
+
#<strong>ip_policies</strong> ⇒ <tt><span class='object_link'><a href="Services/IPPoliciesClient.html" title="NgrokAPI::Services::IPPoliciesClient (class)">NgrokAPI::Services::IPPoliciesClient</a></span></tt>
|
1152
|
+
|
1153
|
+
|
1154
|
+
|
1155
|
+
|
1156
|
+
|
1157
|
+
</h3><div class="docstring">
|
1158
|
+
<div class="discussion">
|
1159
|
+
|
1160
|
+
<p>IP Policies are reusable groups of CIDR ranges with an allow or deny</p>
|
1161
|
+
|
1162
|
+
<pre class="code ruby"><code class="ruby">action. They can be attached to endpoints via the Endpoint Configuration IP
|
1163
|
+
Policy module. They can also be used with IP Restrictions to control source
|
1164
|
+
IP ranges that can start tunnel sessions and connect to the API and dashboard.
|
1165
|
+
</code></pre>
|
1166
|
+
|
1167
|
+
|
1168
|
+
</div>
|
1169
|
+
</div>
|
1170
|
+
<div class="tags">
|
1171
|
+
|
1172
|
+
<p class="tag_title">Returns:</p>
|
1173
|
+
<ul class="return">
|
1174
|
+
|
1175
|
+
<li>
|
1176
|
+
|
1177
|
+
|
1178
|
+
<span class='type'>(<tt><span class='object_link'><a href="Services/IPPoliciesClient.html" title="NgrokAPI::Services::IPPoliciesClient (class)">NgrokAPI::Services::IPPoliciesClient</a></span></tt>)</span>
|
1179
|
+
|
1180
|
+
|
1181
|
+
|
1182
|
+
</li>
|
1183
|
+
|
1184
|
+
</ul>
|
1185
|
+
|
1186
|
+
</div><table class="source_code">
|
1187
|
+
<tr>
|
1188
|
+
<td>
|
1189
|
+
<pre class="lines">
|
1190
|
+
|
1191
|
+
|
1192
|
+
93
|
1193
|
+
94
|
1194
|
+
95</pre>
|
1195
|
+
</td>
|
1196
|
+
<td>
|
1197
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 93</span>
|
1198
|
+
|
1199
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_ip_policies'>ip_policies</span>
|
1200
|
+
<span class='ivar'>@_ip_policies</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/IPPoliciesClient.html" title="NgrokAPI::Services::IPPoliciesClient (class)">IPPoliciesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/IPPoliciesClient.html#initialize-instance_method" title="NgrokAPI::Services::IPPoliciesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1201
|
+
<span class='kw'>end</span></pre>
|
1202
|
+
</td>
|
1203
|
+
</tr>
|
1204
|
+
</table>
|
1205
|
+
</div>
|
1206
|
+
|
1207
|
+
<div class="method_details ">
|
1208
|
+
<h3 class="signature " id="ip_policy_rules-instance_method">
|
1209
|
+
|
1210
|
+
#<strong>ip_policy_rules</strong> ⇒ <tt><span class='object_link'><a href="Services/IPPolicyRulesClient.html" title="NgrokAPI::Services::IPPolicyRulesClient (class)">NgrokAPI::Services::IPPolicyRulesClient</a></span></tt>
|
1211
|
+
|
1212
|
+
|
1213
|
+
|
1214
|
+
|
1215
|
+
|
1216
|
+
</h3><div class="docstring">
|
1217
|
+
<div class="discussion">
|
1218
|
+
|
1219
|
+
<p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that</p>
|
1220
|
+
|
1221
|
+
<pre class="code ruby"><code class="ruby">make up an IP Policy.
|
1222
|
+
</code></pre>
|
1223
|
+
|
1224
|
+
|
1225
|
+
</div>
|
1226
|
+
</div>
|
1227
|
+
<div class="tags">
|
1228
|
+
|
1229
|
+
<p class="tag_title">Returns:</p>
|
1230
|
+
<ul class="return">
|
1231
|
+
|
1232
|
+
<li>
|
1233
|
+
|
1234
|
+
|
1235
|
+
<span class='type'>(<tt><span class='object_link'><a href="Services/IPPolicyRulesClient.html" title="NgrokAPI::Services::IPPolicyRulesClient (class)">NgrokAPI::Services::IPPolicyRulesClient</a></span></tt>)</span>
|
1236
|
+
|
1237
|
+
|
1238
|
+
|
1239
|
+
</li>
|
1240
|
+
|
1241
|
+
</ul>
|
1242
|
+
|
1243
|
+
</div><table class="source_code">
|
1244
|
+
<tr>
|
1245
|
+
<td>
|
1246
|
+
<pre class="lines">
|
1247
|
+
|
1248
|
+
|
1249
|
+
102
|
1250
|
+
103
|
1251
|
+
104</pre>
|
1252
|
+
</td>
|
1253
|
+
<td>
|
1254
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 102</span>
|
1255
|
+
|
1256
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_ip_policy_rules'>ip_policy_rules</span>
|
1257
|
+
<span class='ivar'>@_ip_policy_rules</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/IPPolicyRulesClient.html" title="NgrokAPI::Services::IPPolicyRulesClient (class)">IPPolicyRulesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/IPPolicyRulesClient.html#initialize-instance_method" title="NgrokAPI::Services::IPPolicyRulesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1258
|
+
<span class='kw'>end</span></pre>
|
1259
|
+
</td>
|
1260
|
+
</tr>
|
1261
|
+
</table>
|
1262
|
+
</div>
|
1263
|
+
|
1264
|
+
<div class="method_details ">
|
1265
|
+
<h3 class="signature " id="ip_restrictions-instance_method">
|
1266
|
+
|
1267
|
+
#<strong>ip_restrictions</strong> ⇒ <tt><span class='object_link'><a href="Services/IPRestrictionsClient.html" title="NgrokAPI::Services::IPRestrictionsClient (class)">NgrokAPI::Services::IPRestrictionsClient</a></span></tt>
|
1268
|
+
|
1269
|
+
|
1270
|
+
|
1271
|
+
|
1272
|
+
|
1273
|
+
</h3><div class="docstring">
|
1274
|
+
<div class="discussion">
|
1275
|
+
|
1276
|
+
<p>An IP restriction is a restriction placed on the CIDRs that are allowed to</p>
|
1277
|
+
|
1278
|
+
<pre class="code ruby"><code class="ruby">initate traffic to a specific aspect of your ngrok account. An IP
|
1279
|
+
restriction has a type which defines the ingress it applies to. IP
|
1280
|
+
restrictions can be used to enforce the source IPs that can make API
|
1281
|
+
requests, log in to the dashboard, start ngrok agents, and connect to your
|
1282
|
+
public-facing endpoints.
|
1283
|
+
</code></pre>
|
1284
|
+
|
1285
|
+
|
1286
|
+
</div>
|
1287
|
+
</div>
|
1288
|
+
<div class="tags">
|
1289
|
+
|
1290
|
+
<p class="tag_title">Returns:</p>
|
1291
|
+
<ul class="return">
|
1292
|
+
|
1293
|
+
<li>
|
1294
|
+
|
1295
|
+
|
1296
|
+
<span class='type'>(<tt><span class='object_link'><a href="Services/IPRestrictionsClient.html" title="NgrokAPI::Services::IPRestrictionsClient (class)">NgrokAPI::Services::IPRestrictionsClient</a></span></tt>)</span>
|
1297
|
+
|
1298
|
+
|
1299
|
+
|
1300
|
+
</li>
|
1301
|
+
|
1302
|
+
</ul>
|
1303
|
+
|
1304
|
+
</div><table class="source_code">
|
1305
|
+
<tr>
|
1306
|
+
<td>
|
1307
|
+
<pre class="lines">
|
1308
|
+
|
1309
|
+
|
1310
|
+
115
|
1311
|
+
116
|
1312
|
+
117</pre>
|
1313
|
+
</td>
|
1314
|
+
<td>
|
1315
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 115</span>
|
1316
|
+
|
1317
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_ip_restrictions'>ip_restrictions</span>
|
1318
|
+
<span class='ivar'>@_ip_restrictions</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/IPRestrictionsClient.html" title="NgrokAPI::Services::IPRestrictionsClient (class)">IPRestrictionsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/IPRestrictionsClient.html#initialize-instance_method" title="NgrokAPI::Services::IPRestrictionsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1319
|
+
<span class='kw'>end</span></pre>
|
1320
|
+
</td>
|
1321
|
+
</tr>
|
1322
|
+
</table>
|
1323
|
+
</div>
|
1324
|
+
|
1325
|
+
<div class="method_details ">
|
1326
|
+
<h3 class="signature " id="ip_whitelist-instance_method">
|
1327
|
+
|
1328
|
+
#<strong>ip_whitelist</strong> ⇒ <tt><span class='object_link'><a href="Services/IPWhitelistClient.html" title="NgrokAPI::Services::IPWhitelistClient (class)">NgrokAPI::Services::IPWhitelistClient</a></span></tt>
|
1329
|
+
|
1330
|
+
|
1331
|
+
|
1332
|
+
|
1333
|
+
|
1334
|
+
</h3><div class="docstring">
|
1335
|
+
<div class="discussion">
|
1336
|
+
|
1337
|
+
<p>The IP Whitelist is deprecated and will be removed. Use an IP Restriction</p>
|
1338
|
+
|
1339
|
+
<pre class="code ruby"><code class="ruby">with an endpoints type instead.
|
1340
|
+
</code></pre>
|
1341
|
+
|
1342
|
+
|
1343
|
+
</div>
|
1344
|
+
</div>
|
1345
|
+
<div class="tags">
|
1346
|
+
|
1347
|
+
<p class="tag_title">Returns:</p>
|
1348
|
+
<ul class="return">
|
1349
|
+
|
1350
|
+
<li>
|
1351
|
+
|
1352
|
+
|
1353
|
+
<span class='type'>(<tt><span class='object_link'><a href="Services/IPWhitelistClient.html" title="NgrokAPI::Services::IPWhitelistClient (class)">NgrokAPI::Services::IPWhitelistClient</a></span></tt>)</span>
|
1354
|
+
|
1355
|
+
|
1356
|
+
|
1357
|
+
</li>
|
1358
|
+
|
1359
|
+
</ul>
|
1360
|
+
|
1361
|
+
</div><table class="source_code">
|
1362
|
+
<tr>
|
1363
|
+
<td>
|
1364
|
+
<pre class="lines">
|
1365
|
+
|
1366
|
+
|
1367
|
+
124
|
1368
|
+
125
|
1369
|
+
126</pre>
|
1370
|
+
</td>
|
1371
|
+
<td>
|
1372
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 124</span>
|
1373
|
+
|
1374
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_ip_whitelist'>ip_whitelist</span>
|
1375
|
+
<span class='ivar'>@_ip_whitelist</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/IPWhitelistClient.html" title="NgrokAPI::Services::IPWhitelistClient (class)">IPWhitelistClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/IPWhitelistClient.html#initialize-instance_method" title="NgrokAPI::Services::IPWhitelistClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1376
|
+
<span class='kw'>end</span></pre>
|
1377
|
+
</td>
|
1378
|
+
</tr>
|
1379
|
+
</table>
|
1380
|
+
</div>
|
1381
|
+
|
1382
|
+
<div class="method_details ">
|
1383
|
+
<h3 class="signature " id="reserved_addrs-instance_method">
|
160
1384
|
|
1385
|
+
#<strong>reserved_addrs</strong> ⇒ <tt><span class='object_link'><a href="Services/ReservedAddrsClient.html" title="NgrokAPI::Services::ReservedAddrsClient (class)">NgrokAPI::Services::ReservedAddrsClient</a></span></tt>
|
161
1386
|
|
1387
|
+
|
162
1388
|
|
1389
|
+
|
163
1390
|
|
1391
|
+
</h3><div class="docstring">
|
1392
|
+
<div class="discussion">
|
1393
|
+
|
1394
|
+
<p>Reserved Addresses are TCP addresses that can be used to listen for traffic.</p>
|
1395
|
+
|
1396
|
+
<pre class="code ruby"><code class="ruby">TCP address hostnames and ports are assigned by ngrok, they cannot be
|
1397
|
+
chosen.
|
1398
|
+
</code></pre>
|
1399
|
+
|
1400
|
+
|
1401
|
+
</div>
|
1402
|
+
</div>
|
1403
|
+
<div class="tags">
|
164
1404
|
|
1405
|
+
<p class="tag_title">Returns:</p>
|
1406
|
+
<ul class="return">
|
165
1407
|
|
1408
|
+
<li>
|
1409
|
+
|
1410
|
+
|
1411
|
+
<span class='type'>(<tt><span class='object_link'><a href="Services/ReservedAddrsClient.html" title="NgrokAPI::Services::ReservedAddrsClient (class)">NgrokAPI::Services::ReservedAddrsClient</a></span></tt>)</span>
|
1412
|
+
|
1413
|
+
|
1414
|
+
|
1415
|
+
</li>
|
166
1416
|
|
1417
|
+
</ul>
|
167
1418
|
|
168
|
-
|
169
|
-
|
170
|
-
<
|
171
|
-
|
172
|
-
|
173
|
-
</li>
|
1419
|
+
</div><table class="source_code">
|
1420
|
+
<tr>
|
1421
|
+
<td>
|
1422
|
+
<pre class="lines">
|
174
1423
|
|
175
|
-
|
176
|
-
<li class="public ">
|
177
|
-
<span class="summary_signature">
|
178
|
-
|
179
|
-
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(api_key:, base_url: 'https://api.ngrok.com') ⇒ Client </a>
|
180
|
-
|
181
1424
|
|
1425
|
+
134
|
1426
|
+
135
|
1427
|
+
136</pre>
|
1428
|
+
</td>
|
1429
|
+
<td>
|
1430
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 134</span>
|
1431
|
+
|
1432
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_reserved_addrs'>reserved_addrs</span>
|
1433
|
+
<span class='ivar'>@_reserved_addrs</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/ReservedAddrsClient.html" title="NgrokAPI::Services::ReservedAddrsClient (class)">ReservedAddrsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/ReservedAddrsClient.html#initialize-instance_method" title="NgrokAPI::Services::ReservedAddrsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1434
|
+
<span class='kw'>end</span></pre>
|
1435
|
+
</td>
|
1436
|
+
</tr>
|
1437
|
+
</table>
|
1438
|
+
</div>
|
182
1439
|
|
183
|
-
|
184
|
-
|
1440
|
+
<div class="method_details ">
|
1441
|
+
<h3 class="signature " id="reserved_domains-instance_method">
|
185
1442
|
|
186
|
-
<span class="
|
1443
|
+
#<strong>reserved_domains</strong> ⇒ <tt><span class='object_link'><a href="Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">NgrokAPI::Services::ReservedDomainsClient</a></span></tt>
|
187
1444
|
|
1445
|
+
|
188
1446
|
|
1447
|
+
|
189
1448
|
|
1449
|
+
</h3><div class="docstring">
|
1450
|
+
<div class="discussion">
|
1451
|
+
|
1452
|
+
<p>Reserved Domains are hostnames that you can listen for traffic on. Domains</p>
|
1453
|
+
|
1454
|
+
<pre class="code ruby"><code class="ruby">can be used to listen for http, https or tls traffic. You may use a domain
|
1455
|
+
that you own by creating a CNAME record specified in the returned resource.
|
1456
|
+
This CNAME record points traffic for that domain to ngrok's edge servers.
|
1457
|
+
</code></pre>
|
1458
|
+
|
1459
|
+
|
1460
|
+
</div>
|
1461
|
+
</div>
|
1462
|
+
<div class="tags">
|
190
1463
|
|
1464
|
+
<p class="tag_title">Returns:</p>
|
1465
|
+
<ul class="return">
|
191
1466
|
|
1467
|
+
<li>
|
1468
|
+
|
1469
|
+
|
1470
|
+
<span class='type'>(<tt><span class='object_link'><a href="Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">NgrokAPI::Services::ReservedDomainsClient</a></span></tt>)</span>
|
1471
|
+
|
1472
|
+
|
1473
|
+
|
1474
|
+
</li>
|
192
1475
|
|
1476
|
+
</ul>
|
193
1477
|
|
194
|
-
|
195
|
-
|
196
|
-
<
|
197
|
-
|
198
|
-
|
199
|
-
</li>
|
1478
|
+
</div><table class="source_code">
|
1479
|
+
<tr>
|
1480
|
+
<td>
|
1481
|
+
<pre class="lines">
|
200
1482
|
|
201
|
-
|
202
|
-
<li class="public ">
|
203
|
-
<span class="summary_signature">
|
204
|
-
|
205
|
-
<a href="#reserved_domains-instance_method" title="#reserved_domains (instance method)">#<strong>reserved_domains</strong> ⇒ NgrokAPI::Services::ReservedDomainsClient </a>
|
206
|
-
|
207
1483
|
|
1484
|
+
145
|
1485
|
+
146
|
1486
|
+
147</pre>
|
1487
|
+
</td>
|
1488
|
+
<td>
|
1489
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 145</span>
|
1490
|
+
|
1491
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_reserved_domains'>reserved_domains</span>
|
1492
|
+
<span class='ivar'>@_reserved_domains</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">ReservedDomainsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/ReservedDomainsClient.html#initialize-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1493
|
+
<span class='kw'>end</span></pre>
|
1494
|
+
</td>
|
1495
|
+
</tr>
|
1496
|
+
</table>
|
1497
|
+
</div>
|
208
1498
|
|
209
|
-
|
1499
|
+
<div class="method_details ">
|
1500
|
+
<h3 class="signature " id="ssh_certificate_authorities-instance_method">
|
210
1501
|
|
1502
|
+
#<strong>ssh_certificate_authorities</strong> ⇒ <tt><span class='object_link'><a href="Services/SSHCertificateAuthoritiesClient.html" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient (class)">NgrokAPI::Services::SSHCertificateAuthoritiesClient</a></span></tt>
|
211
1503
|
|
1504
|
+
|
212
1505
|
|
1506
|
+
|
213
1507
|
|
1508
|
+
</h3><div class="docstring">
|
1509
|
+
<div class="discussion">
|
1510
|
+
|
1511
|
+
<p>An SSH Certificate Authority is a pair of an SSH Certificate and its private</p>
|
1512
|
+
|
1513
|
+
<pre class="code ruby"><code class="ruby">key that can be used to sign other SSH host and user certificates.
|
1514
|
+
</code></pre>
|
1515
|
+
|
1516
|
+
|
1517
|
+
</div>
|
1518
|
+
</div>
|
1519
|
+
<div class="tags">
|
214
1520
|
|
1521
|
+
<p class="tag_title">Returns:</p>
|
1522
|
+
<ul class="return">
|
215
1523
|
|
1524
|
+
<li>
|
1525
|
+
|
1526
|
+
|
1527
|
+
<span class='type'>(<tt><span class='object_link'><a href="Services/SSHCertificateAuthoritiesClient.html" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient (class)">NgrokAPI::Services::SSHCertificateAuthoritiesClient</a></span></tt>)</span>
|
1528
|
+
|
1529
|
+
|
1530
|
+
|
1531
|
+
</li>
|
216
1532
|
|
1533
|
+
</ul>
|
217
1534
|
|
218
|
-
|
219
|
-
|
220
|
-
<
|
221
|
-
|
222
|
-
|
223
|
-
</li>
|
1535
|
+
</div><table class="source_code">
|
1536
|
+
<tr>
|
1537
|
+
<td>
|
1538
|
+
<pre class="lines">
|
224
1539
|
|
225
|
-
|
226
|
-
<li class="public ">
|
227
|
-
<span class="summary_signature">
|
228
|
-
|
229
|
-
<a href="#tls_certificates-instance_method" title="#tls_certificates (instance method)">#<strong>tls_certificates</strong> ⇒ NgrokAPI::Services::TlsCertificatesClient </a>
|
230
|
-
|
231
1540
|
|
1541
|
+
154
|
1542
|
+
155
|
1543
|
+
156</pre>
|
1544
|
+
</td>
|
1545
|
+
<td>
|
1546
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 154</span>
|
1547
|
+
|
1548
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_ssh_certificate_authorities'>ssh_certificate_authorities</span>
|
1549
|
+
<span class='ivar'>@_ssh_certificate_authorities</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHCertificateAuthoritiesClient.html" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient (class)">SSHCertificateAuthoritiesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHCertificateAuthoritiesClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1550
|
+
<span class='kw'>end</span></pre>
|
1551
|
+
</td>
|
1552
|
+
</tr>
|
1553
|
+
</table>
|
1554
|
+
</div>
|
232
1555
|
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
|
1556
|
+
<div class="method_details ">
|
1557
|
+
<h3 class="signature " id="ssh_credentials-instance_method">
|
237
1558
|
|
1559
|
+
#<strong>ssh_credentials</strong> ⇒ <tt><span class='object_link'><a href="Services/SSHCredentialsClient.html" title="NgrokAPI::Services::SSHCredentialsClient (class)">NgrokAPI::Services::SSHCredentialsClient</a></span></tt>
|
238
1560
|
|
1561
|
+
|
239
1562
|
|
1563
|
+
|
240
1564
|
|
1565
|
+
</h3><div class="docstring">
|
1566
|
+
<div class="discussion">
|
1567
|
+
|
1568
|
+
<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels</p>
|
241
1569
|
|
1570
|
+
<pre class="code ruby"><code class="ruby">via the ngrok SSH tunnel gateway.
|
1571
|
+
</code></pre>
|
1572
|
+
|
1573
|
+
|
1574
|
+
</div>
|
1575
|
+
</div>
|
1576
|
+
<div class="tags">
|
242
1577
|
|
243
|
-
|
244
|
-
<
|
245
|
-
</div></span>
|
1578
|
+
<p class="tag_title">Returns:</p>
|
1579
|
+
<ul class="return">
|
246
1580
|
|
247
|
-
|
248
|
-
|
1581
|
+
<li>
|
249
1582
|
|
250
|
-
|
1583
|
+
|
1584
|
+
<span class='type'>(<tt><span class='object_link'><a href="Services/SSHCredentialsClient.html" title="NgrokAPI::Services::SSHCredentialsClient (class)">NgrokAPI::Services::SSHCredentialsClient</a></span></tt>)</span>
|
1585
|
+
|
1586
|
+
|
1587
|
+
|
1588
|
+
</li>
|
251
1589
|
|
1590
|
+
</ul>
|
252
1591
|
|
253
|
-
|
254
|
-
<
|
255
|
-
|
256
|
-
|
257
|
-
|
1592
|
+
</div><table class="source_code">
|
1593
|
+
<tr>
|
1594
|
+
<td>
|
1595
|
+
<pre class="lines">
|
1596
|
+
|
1597
|
+
|
1598
|
+
163
|
1599
|
+
164
|
1600
|
+
165</pre>
|
1601
|
+
</td>
|
1602
|
+
<td>
|
1603
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 163</span>
|
1604
|
+
|
1605
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_ssh_credentials'>ssh_credentials</span>
|
1606
|
+
<span class='ivar'>@_ssh_credentials</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHCredentialsClient.html" title="NgrokAPI::Services::SSHCredentialsClient (class)">SSHCredentialsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHCredentialsClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHCredentialsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
1607
|
+
<span class='kw'>end</span></pre>
|
1608
|
+
</td>
|
1609
|
+
</tr>
|
1610
|
+
</table>
|
1611
|
+
</div>
|
1612
|
+
|
1613
|
+
<div class="method_details ">
|
1614
|
+
<h3 class="signature " id="ssh_host_certificates-instance_method">
|
258
1615
|
|
259
|
-
#<strong>
|
1616
|
+
#<strong>ssh_host_certificates</strong> ⇒ <tt><span class='object_link'><a href="Services/SSHHostCertificatesClient.html" title="NgrokAPI::Services::SSHHostCertificatesClient (class)">NgrokAPI::Services::SSHHostCertificatesClient</a></span></tt>
|
260
1617
|
|
261
1618
|
|
262
1619
|
|
@@ -265,13 +1622,30 @@
|
|
265
1622
|
</h3><div class="docstring">
|
266
1623
|
<div class="discussion">
|
267
1624
|
|
268
|
-
<p>
|
1625
|
+
<p>SSH Host Certificates along with the corresponding private key allows an SSH</p>
|
1626
|
+
|
1627
|
+
<pre class="code ruby"><code class="ruby">server to assert its authenticity to connecting SSH clients who trust the
|
1628
|
+
SSH Certificate Authority that was used to sign the certificate.
|
1629
|
+
</code></pre>
|
269
1630
|
|
270
1631
|
|
271
1632
|
</div>
|
272
1633
|
</div>
|
273
1634
|
<div class="tags">
|
274
1635
|
|
1636
|
+
<p class="tag_title">Returns:</p>
|
1637
|
+
<ul class="return">
|
1638
|
+
|
1639
|
+
<li>
|
1640
|
+
|
1641
|
+
|
1642
|
+
<span class='type'>(<tt><span class='object_link'><a href="Services/SSHHostCertificatesClient.html" title="NgrokAPI::Services::SSHHostCertificatesClient (class)">NgrokAPI::Services::SSHHostCertificatesClient</a></span></tt>)</span>
|
1643
|
+
|
1644
|
+
|
1645
|
+
|
1646
|
+
</li>
|
1647
|
+
|
1648
|
+
</ul>
|
275
1649
|
|
276
1650
|
</div><table class="source_code">
|
277
1651
|
<tr>
|
@@ -279,38 +1653,25 @@
|
|
279
1653
|
<pre class="lines">
|
280
1654
|
|
281
1655
|
|
282
|
-
|
283
|
-
|
284
|
-
|
285
|
-
11
|
286
|
-
12
|
287
|
-
13</pre>
|
1656
|
+
173
|
1657
|
+
174
|
1658
|
+
175</pre>
|
288
1659
|
</td>
|
289
1660
|
<td>
|
290
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1661
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 173</span>
|
291
1662
|
|
292
|
-
<span class='kw'>def</span> <span class='id identifier
|
293
|
-
<span class='label'>
|
294
|
-
<span class='label'>base_url:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https://api.ngrok.com</span><span class='tstring_end'>'</span></span>
|
295
|
-
<span class='rparen'>)</span>
|
296
|
-
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="HttpClient.html" title="NgrokAPI::HttpClient (class)">HttpClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="HttpClient.html#initialize-instance_method" title="NgrokAPI::HttpClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='id identifier rubyid_api_key'>api_key</span><span class='comma'>,</span> <span class='label'>base_url:</span> <span class='id identifier rubyid_base_url'>base_url</span><span class='rparen'>)</span>
|
1663
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_ssh_host_certificates'>ssh_host_certificates</span>
|
1664
|
+
<span class='ivar'>@_ssh_host_certificates</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHHostCertificatesClient.html" title="NgrokAPI::Services::SSHHostCertificatesClient (class)">SSHHostCertificatesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHHostCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHHostCertificatesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
297
1665
|
<span class='kw'>end</span></pre>
|
298
1666
|
</td>
|
299
1667
|
</tr>
|
300
1668
|
</table>
|
301
1669
|
</div>
|
302
|
-
|
303
|
-
</div>
|
304
|
-
|
305
|
-
|
306
|
-
<div id="instance_method_details" class="method_details_list">
|
307
|
-
<h2>Instance Method Details</h2>
|
308
|
-
|
309
1670
|
|
310
|
-
<div class="method_details
|
311
|
-
<h3 class="signature
|
1671
|
+
<div class="method_details ">
|
1672
|
+
<h3 class="signature " id="ssh_user_certificates-instance_method">
|
312
1673
|
|
313
|
-
#<strong>
|
1674
|
+
#<strong>ssh_user_certificates</strong> ⇒ <tt><span class='object_link'><a href="Services/SSHUserCertificatesClient.html" title="NgrokAPI::Services::SSHUserCertificatesClient (class)">NgrokAPI::Services::SSHUserCertificatesClient</a></span></tt>
|
314
1675
|
|
315
1676
|
|
316
1677
|
|
@@ -319,7 +1680,11 @@
|
|
319
1680
|
</h3><div class="docstring">
|
320
1681
|
<div class="discussion">
|
321
1682
|
|
322
|
-
<p>
|
1683
|
+
<p>SSH User Certificates are presented by SSH clients when connecting to an SSH</p>
|
1684
|
+
|
1685
|
+
<pre class="code ruby"><code class="ruby">server to authenticate their connection. The SSH server must trust the SSH
|
1686
|
+
Certificate Authority used to sign the certificate.
|
1687
|
+
</code></pre>
|
323
1688
|
|
324
1689
|
|
325
1690
|
</div>
|
@@ -332,7 +1697,7 @@
|
|
332
1697
|
<li>
|
333
1698
|
|
334
1699
|
|
335
|
-
<span class='type'>(<tt><span class='object_link'><a href="Services/
|
1700
|
+
<span class='type'>(<tt><span class='object_link'><a href="Services/SSHUserCertificatesClient.html" title="NgrokAPI::Services::SSHUserCertificatesClient (class)">NgrokAPI::Services::SSHUserCertificatesClient</a></span></tt>)</span>
|
336
1701
|
|
337
1702
|
|
338
1703
|
|
@@ -346,15 +1711,15 @@
|
|
346
1711
|
<pre class="lines">
|
347
1712
|
|
348
1713
|
|
349
|
-
|
350
|
-
|
351
|
-
|
1714
|
+
183
|
1715
|
+
184
|
1716
|
+
185</pre>
|
352
1717
|
</td>
|
353
1718
|
<td>
|
354
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1719
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 183</span>
|
355
1720
|
|
356
|
-
<span class='kw'>def</span> <span class='id identifier
|
357
|
-
<span class='ivar'>@
|
1721
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_ssh_user_certificates'>ssh_user_certificates</span>
|
1722
|
+
<span class='ivar'>@_ssh_user_certificates</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHUserCertificatesClient.html" title="NgrokAPI::Services::SSHUserCertificatesClient (class)">SSHUserCertificatesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHUserCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHUserCertificatesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
358
1723
|
<span class='kw'>end</span></pre>
|
359
1724
|
</td>
|
360
1725
|
</tr>
|
@@ -362,9 +1727,9 @@
|
|
362
1727
|
</div>
|
363
1728
|
|
364
1729
|
<div class="method_details ">
|
365
|
-
<h3 class="signature " id="
|
1730
|
+
<h3 class="signature " id="tls_certificates-instance_method">
|
366
1731
|
|
367
|
-
#<strong>
|
1732
|
+
#<strong>tls_certificates</strong> ⇒ <tt><span class='object_link'><a href="Services/TLSCertificatesClient.html" title="NgrokAPI::Services::TLSCertificatesClient (class)">NgrokAPI::Services::TLSCertificatesClient</a></span></tt>
|
368
1733
|
|
369
1734
|
|
370
1735
|
|
@@ -373,7 +1738,13 @@
|
|
373
1738
|
</h3><div class="docstring">
|
374
1739
|
<div class="discussion">
|
375
1740
|
|
376
|
-
<p>
|
1741
|
+
<p>TLS Certificates are pairs of x509 certificates and their matching private</p>
|
1742
|
+
|
1743
|
+
<pre class="code ruby"><code class="ruby">key that can be used to terminate TLS traffic. TLS certificates are unused
|
1744
|
+
until they are attached to a Domain. TLS Certificates may also be
|
1745
|
+
provisioned by ngrok automatically for domains on which you have enabled
|
1746
|
+
automated certificate provisioning.
|
1747
|
+
</code></pre>
|
377
1748
|
|
378
1749
|
|
379
1750
|
</div>
|
@@ -386,7 +1757,7 @@
|
|
386
1757
|
<li>
|
387
1758
|
|
388
1759
|
|
389
|
-
<span class='type'>(<tt><span class='object_link'><a href="Services/
|
1760
|
+
<span class='type'>(<tt><span class='object_link'><a href="Services/TLSCertificatesClient.html" title="NgrokAPI::Services::TLSCertificatesClient (class)">NgrokAPI::Services::TLSCertificatesClient</a></span></tt>)</span>
|
390
1761
|
|
391
1762
|
|
392
1763
|
|
@@ -400,19 +1771,15 @@
|
|
400
1771
|
<pre class="lines">
|
401
1772
|
|
402
1773
|
|
403
|
-
|
404
|
-
|
405
|
-
|
406
|
-
30
|
407
|
-
31</pre>
|
1774
|
+
195
|
1775
|
+
196
|
1776
|
+
197</pre>
|
408
1777
|
</td>
|
409
1778
|
<td>
|
410
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1779
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 195</span>
|
411
1780
|
|
412
|
-
<span class='kw'>def</span> <span class='id identifier
|
413
|
-
<span class='ivar'>@
|
414
|
-
<span class='label'>client:</span> <span class='ivar'>@client</span>
|
415
|
-
<span class='rparen'>)</span>
|
1781
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_tls_certificates'>tls_certificates</span>
|
1782
|
+
<span class='ivar'>@_tls_certificates</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TLSCertificatesClient.html" title="NgrokAPI::Services::TLSCertificatesClient (class)">TLSCertificatesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TLSCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::TLSCertificatesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
416
1783
|
<span class='kw'>end</span></pre>
|
417
1784
|
</td>
|
418
1785
|
</tr>
|
@@ -420,9 +1787,9 @@
|
|
420
1787
|
</div>
|
421
1788
|
|
422
1789
|
<div class="method_details ">
|
423
|
-
<h3 class="signature " id="
|
1790
|
+
<h3 class="signature " id="tunnel_sessions-instance_method">
|
424
1791
|
|
425
|
-
#<strong>
|
1792
|
+
#<strong>tunnel_sessions</strong> ⇒ <tt><span class='object_link'><a href="Services/TunnelSessionsClient.html" title="NgrokAPI::Services::TunnelSessionsClient (class)">NgrokAPI::Services::TunnelSessionsClient</a></span></tt>
|
426
1793
|
|
427
1794
|
|
428
1795
|
|
@@ -431,7 +1798,11 @@
|
|
431
1798
|
</h3><div class="docstring">
|
432
1799
|
<div class="discussion">
|
433
1800
|
|
434
|
-
<p>
|
1801
|
+
<p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel</p>
|
1802
|
+
|
1803
|
+
<pre class="code ruby"><code class="ruby">sessions that are running and connected to the ngrok service. Each tunnel
|
1804
|
+
session can include one or more Tunnels.
|
1805
|
+
</code></pre>
|
435
1806
|
|
436
1807
|
|
437
1808
|
</div>
|
@@ -444,7 +1815,7 @@
|
|
444
1815
|
<li>
|
445
1816
|
|
446
1817
|
|
447
|
-
<span class='type'>(<tt><span class='object_link'><a href="Services/
|
1818
|
+
<span class='type'>(<tt><span class='object_link'><a href="Services/TunnelSessionsClient.html" title="NgrokAPI::Services::TunnelSessionsClient (class)">NgrokAPI::Services::TunnelSessionsClient</a></span></tt>)</span>
|
448
1819
|
|
449
1820
|
|
450
1821
|
|
@@ -458,15 +1829,15 @@
|
|
458
1829
|
<pre class="lines">
|
459
1830
|
|
460
1831
|
|
461
|
-
|
462
|
-
|
463
|
-
|
1832
|
+
205
|
1833
|
+
206
|
1834
|
+
207</pre>
|
464
1835
|
</td>
|
465
1836
|
<td>
|
466
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1837
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 205</span>
|
467
1838
|
|
468
|
-
<span class='kw'>def</span> <span class='id identifier
|
469
|
-
<span class='ivar'>@
|
1839
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_tunnel_sessions'>tunnel_sessions</span>
|
1840
|
+
<span class='ivar'>@_tunnel_sessions</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TunnelSessionsClient.html" title="NgrokAPI::Services::TunnelSessionsClient (class)">TunnelSessionsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TunnelSessionsClient.html#initialize-instance_method" title="NgrokAPI::Services::TunnelSessionsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
470
1841
|
<span class='kw'>end</span></pre>
|
471
1842
|
</td>
|
472
1843
|
</tr>
|
@@ -474,9 +1845,9 @@
|
|
474
1845
|
</div>
|
475
1846
|
|
476
1847
|
<div class="method_details ">
|
477
|
-
<h3 class="signature " id="
|
1848
|
+
<h3 class="signature " id="tunnels-instance_method">
|
478
1849
|
|
479
|
-
#<strong>
|
1850
|
+
#<strong>tunnels</strong> ⇒ <tt><span class='object_link'><a href="Services/TunnelsClient.html" title="NgrokAPI::Services::TunnelsClient (class)">NgrokAPI::Services::TunnelsClient</a></span></tt>
|
480
1851
|
|
481
1852
|
|
482
1853
|
|
@@ -485,7 +1856,10 @@
|
|
485
1856
|
</h3><div class="docstring">
|
486
1857
|
<div class="discussion">
|
487
1858
|
|
488
|
-
<p>
|
1859
|
+
<p>Tunnels provide endpoints to access services exposed by a running ngrok</p>
|
1860
|
+
|
1861
|
+
<pre class="code ruby"><code class="ruby">agent tunnel session or an SSH reverse tunnel session.
|
1862
|
+
</code></pre>
|
489
1863
|
|
490
1864
|
|
491
1865
|
</div>
|
@@ -498,7 +1872,7 @@
|
|
498
1872
|
<li>
|
499
1873
|
|
500
1874
|
|
501
|
-
<span class='type'>(<tt><span class='object_link'><a href="Services/
|
1875
|
+
<span class='type'>(<tt><span class='object_link'><a href="Services/TunnelsClient.html" title="NgrokAPI::Services::TunnelsClient (class)">NgrokAPI::Services::TunnelsClient</a></span></tt>)</span>
|
502
1876
|
|
503
1877
|
|
504
1878
|
|
@@ -512,15 +1886,15 @@
|
|
512
1886
|
<pre class="lines">
|
513
1887
|
|
514
1888
|
|
515
|
-
|
516
|
-
|
517
|
-
|
1889
|
+
214
|
1890
|
+
215
|
1891
|
+
216</pre>
|
518
1892
|
</td>
|
519
1893
|
<td>
|
520
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line
|
1894
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 214</span>
|
521
1895
|
|
522
|
-
<span class='kw'>def</span> <span class='id identifier
|
523
|
-
<span class='ivar'>@
|
1896
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_tunnels'>tunnels</span>
|
1897
|
+
<span class='ivar'>@_tunnels</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TunnelsClient.html" title="NgrokAPI::Services::TunnelsClient (class)">TunnelsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TunnelsClient.html#initialize-instance_method" title="NgrokAPI::Services::TunnelsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
|
524
1898
|
<span class='kw'>end</span></pre>
|
525
1899
|
</td>
|
526
1900
|
</tr>
|
@@ -532,7 +1906,7 @@
|
|
532
1906
|
</div>
|
533
1907
|
|
534
1908
|
<div id="footer">
|
535
|
-
Generated on
|
1909
|
+
Generated on Mon Oct 4 23:24:15 2021 by
|
536
1910
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
537
1911
|
0.9.26 (ruby-3.0.1).
|
538
1912
|
</div>
|