ngrok-api 0.9.0 → 0.16.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 +2 -2
- data/.yardopts +1 -0
- data/LICENSE +7 -0
- data/doc/NgrokAPI/Client.html +1469 -125
- data/doc/NgrokAPI/Error.html +3 -3
- data/doc/NgrokAPI/Errors/NotFoundError.html +3 -3
- data/doc/NgrokAPI/Errors.html +3 -3
- data/doc/NgrokAPI/HttpClient.html +66 -36
- data/doc/NgrokAPI/Models/{ApiKey.html → APIKey.html} +110 -179
- 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/AgentIngress.html +1217 -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 +1323 -512
- 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/EventSourceList.html +617 -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/{TlsCertificate.html → IPPolicy.html} +172 -167
- data/doc/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/doc/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/doc/NgrokAPI/Models/Listable.html +120 -52
- data/doc/NgrokAPI/Models/Ref.html +617 -0
- data/doc/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/doc/NgrokAPI/Models/ReservedDomain.html +186 -1108
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +765 -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 +6 -6
- data/doc/NgrokAPI/PagedIterator.html +16 -12
- data/{docs/NgrokAPI/Services/ApiKeysClient.html → doc/NgrokAPI/Services/APIKeysClient.html} +404 -153
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +706 -0
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +1600 -0
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +1602 -0
- data/doc/NgrokAPI/Services/CredentialsClient.html +1644 -0
- data/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +503 -370
- data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +1712 -0
- data/doc/NgrokAPI/Services/EventSourcesClient.html +1532 -0
- data/doc/NgrokAPI/Services/EventStreamsClient.html +1792 -0
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +1712 -0
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +1602 -0
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +1660 -0
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +1720 -0
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +1894 -0
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +585 -344
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1644 -0
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +1662 -0
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +1680 -0
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +1720 -0
- data/{docs/NgrokAPI/Services/TlsCertificatesClient.html → doc/NgrokAPI/Services/TLSCertificatesClient.html} +404 -201
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +1587 -0
- data/doc/NgrokAPI/Services/TunnelsClient.html +669 -0
- data/doc/NgrokAPI/Services.html +6 -6
- data/doc/NgrokAPI.html +5 -5
- data/doc/README +94 -0
- data/doc/_index.html +621 -25
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +55 -28
- data/doc/frames.html +1 -1
- data/doc/index.html +55 -28
- data/doc/method_list.html +7526 -286
- data/doc/top-level-namespace.html +3 -3
- data/docs/.gitkeep +0 -0
- data/docs/CNAME +1 -0
- data/docs/NgrokAPI/Client.html +1469 -125
- data/docs/NgrokAPI/Error.html +3 -3
- data/docs/NgrokAPI/Errors/NotFoundError.html +3 -3
- data/docs/NgrokAPI/Errors.html +3 -3
- data/docs/NgrokAPI/HttpClient.html +66 -36
- data/docs/NgrokAPI/Models/{ApiKey.html → APIKey.html} +110 -179
- 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/AgentIngress.html +1217 -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 +1323 -512
- 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/EventSourceList.html +617 -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/{TlsCertificate.html → IPPolicy.html} +172 -167
- data/docs/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/docs/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/docs/NgrokAPI/Models/Listable.html +120 -52
- data/docs/NgrokAPI/Models/Ref.html +617 -0
- data/docs/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/docs/NgrokAPI/Models/ReservedDomain.html +186 -1108
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +765 -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 +6 -6
- data/docs/NgrokAPI/PagedIterator.html +16 -12
- data/{doc/NgrokAPI/Services/ApiKeysClient.html → docs/NgrokAPI/Services/APIKeysClient.html} +404 -153
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +706 -0
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +1600 -0
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +1602 -0
- data/docs/NgrokAPI/Services/CredentialsClient.html +1644 -0
- data/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +503 -370
- data/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +1712 -0
- data/docs/NgrokAPI/Services/EventSourcesClient.html +1532 -0
- data/docs/NgrokAPI/Services/EventStreamsClient.html +1792 -0
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +1712 -0
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +1602 -0
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +1660 -0
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +1720 -0
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +1894 -0
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +585 -344
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1644 -0
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +1662 -0
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +1680 -0
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +1720 -0
- data/{doc/NgrokAPI/Services/TlsCertificatesClient.html → docs/NgrokAPI/Services/TLSCertificatesClient.html} +404 -201
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +1587 -0
- data/docs/NgrokAPI/Services/TunnelsClient.html +669 -0
- data/docs/NgrokAPI/Services.html +6 -6
- data/docs/NgrokAPI.html +5 -5
- data/docs/README +94 -0
- data/docs/_index.html +621 -25
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +55 -28
- data/docs/frames.html +1 -1
- data/docs/index.html +55 -28
- data/docs/method_list.html +7526 -286
- data/docs/top-level-namespace.html +3 -3
- data/lib/ngrokapi/client.rb +229 -49
- data/lib/ngrokapi/http_client.rb +6 -7
- data/lib/ngrokapi/models/abuse_report.rb +37 -0
- data/lib/ngrokapi/models/abuse_report_hostname.rb +27 -0
- data/lib/ngrokapi/models/agent_ingress.rb +66 -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_list.rb +27 -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/listable.rb +13 -2
- data/lib/ngrokapi/models/ref.rb +27 -0
- data/lib/ngrokapi/models/reserved_addr.rb +49 -0
- data/lib/ngrokapi/models/reserved_domain.rb +61 -211
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +31 -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/paged_iterator.rb +4 -2
- data/lib/ngrokapi/services/.gitkeep +0 -0
- data/lib/ngrokapi/services/abuse_reports_client.rb +77 -0
- data/lib/ngrokapi/services/agent_ingresses_client.rb +206 -0
- data/lib/ngrokapi/services/api_keys_client.rb +210 -144
- data/lib/ngrokapi/services/certificate_authorities_client.rb +211 -0
- data/lib/ngrokapi/services/credentials_client.rb +217 -0
- data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_compression_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +289 -313
- data/lib/ngrokapi/services/endpoint_ip_policy_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_logging_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_o_auth_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_oidc_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_request_headers_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_response_headers_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_saml_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_tls_termination_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb +108 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +221 -0
- data/lib/ngrokapi/services/event_sources_client.rb +185 -0
- data/lib/ngrokapi/services/event_streams_client.rb +224 -0
- data/lib/ngrokapi/services/event_subscriptions_client.rb +215 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +215 -0
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +214 -0
- data/lib/ngrokapi/services/ip_restrictions_client.rb +224 -0
- data/lib/ngrokapi/services/reserved_addrs_client.rb +246 -0
- data/lib/ngrokapi/services/reserved_domains_client.rb +360 -313
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +212 -0
- data/lib/ngrokapi/services/ssh_credentials_client.rb +215 -0
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +217 -0
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +221 -0
- data/lib/ngrokapi/services/tls_certificates_client.rb +213 -161
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +237 -0
- data/lib/ngrokapi/services/tunnels_client.rb +78 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/lib/ngrokapi.rb +1 -1
- data/ngrok-api.gemspec +1 -1
- data/spec/ngrokapi/client_spec.rb +158 -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/agent_ingress_spec.rb +42 -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_list_spec.rb +21 -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/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_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 +7 -7
- data/spec/ngrokapi/services/.gitkeep +0 -0
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +65 -0
- data/spec/ngrokapi/services/agent_ingresses_client_spec.rb +159 -0
- data/spec/ngrokapi/services/api_keys_client_spec.rb +157 -127
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +159 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +163 -0
- data/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +237 -0
- data/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +172 -0
- data/spec/ngrokapi/services/event_sources_client_spec.rb +192 -0
- data/spec/ngrokapi/services/event_streams_client_spec.rb +177 -0
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +169 -0
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +159 -0
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +165 -0
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +171 -0
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +206 -0
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +349 -0
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +163 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +165 -0
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +167 -0
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +171 -0
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +161 -0
- data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +183 -0
- data/spec/ngrokapi/services/tunnels_client_spec.rb +21 -0
- data/spec/spec_helper.rb +1096 -80
- metadata +360 -11
|
@@ -0,0 +1,1587 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: NgrokAPI::Services::TunnelSessionsClient
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.27
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "NgrokAPI::Services::TunnelSessionsClient";
|
|
19
|
+
relpath = '../../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../../_index.html">Index (T)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> » <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">TunnelSessionsClient</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: NgrokAPI::Services::TunnelSessionsClient
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">NgrokAPI::Services::TunnelSessionsClient</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/ngrokapi/services/tunnel_sessions_client.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service. Each tunnel session can include one or more Tunnels.</p>
|
|
106
|
+
|
|
107
|
+
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions">ngrok.com/docs/api#api-tunnel-sessions</a></p>
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
</div>
|
|
111
|
+
</div>
|
|
112
|
+
<div class="tags">
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</div>
|
|
116
|
+
|
|
117
|
+
<h2>
|
|
118
|
+
Constant Summary
|
|
119
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
120
|
+
</h2>
|
|
121
|
+
|
|
122
|
+
<dl class="constants">
|
|
123
|
+
|
|
124
|
+
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
|
|
125
|
+
<div class="docstring">
|
|
126
|
+
<div class="discussion">
|
|
127
|
+
|
|
128
|
+
<p>The List Property from the resulting API for list calls</p>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
</div>
|
|
132
|
+
</div>
|
|
133
|
+
<div class="tags">
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
</div>
|
|
137
|
+
</dt>
|
|
138
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>tunnel_sessions</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
139
|
+
|
|
140
|
+
<dt id="PATH-constant" class="">PATH =
|
|
141
|
+
<div class="docstring">
|
|
142
|
+
<div class="discussion">
|
|
143
|
+
|
|
144
|
+
<p>The API path for the requests</p>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
</div>
|
|
148
|
+
</div>
|
|
149
|
+
<div class="tags">
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
</div>
|
|
153
|
+
</dt>
|
|
154
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tunnel_sessions</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
155
|
+
|
|
156
|
+
</dl>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
163
|
+
<ul class="summary">
|
|
164
|
+
|
|
165
|
+
<li class="public ">
|
|
166
|
+
<span class="summary_signature">
|
|
167
|
+
|
|
168
|
+
<a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> ⇒ Object </a>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
</span>
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
<span class="note title readonly">readonly</span>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
<span class="summary_desc"><div class='inline'>
|
|
188
|
+
<p>Returns the value of attribute client.</p>
|
|
189
|
+
</div></span>
|
|
190
|
+
|
|
191
|
+
</li>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
</ul>
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
<h2>
|
|
201
|
+
Instance Method Summary
|
|
202
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
203
|
+
</h2>
|
|
204
|
+
|
|
205
|
+
<ul class="summary">
|
|
206
|
+
|
|
207
|
+
<li class="public ">
|
|
208
|
+
<span class="summary_signature">
|
|
209
|
+
|
|
210
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::TunnelSession </a>
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
</span>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
<span class="summary_desc"><div class='inline'>
|
|
225
|
+
<p>Get the detailed status of a tunnel session by ID.</p>
|
|
226
|
+
</div></span>
|
|
227
|
+
|
|
228
|
+
</li>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<li class="public ">
|
|
232
|
+
<span class="summary_signature">
|
|
233
|
+
|
|
234
|
+
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ NgrokAPI::Models::TunnelSession </a>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
</span>
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
<span class="summary_desc"><div class='inline'>
|
|
249
|
+
<p>Get the detailed status of a tunnel session by ID Throws an exception if API error.</p>
|
|
250
|
+
</div></span>
|
|
251
|
+
|
|
252
|
+
</li>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
<li class="public ">
|
|
256
|
+
<span class="summary_signature">
|
|
257
|
+
|
|
258
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒ TunnelSessionsClient </a>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
</span>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
<span class="note title constructor">constructor</span>
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
<span class="summary_desc"><div class='inline'>
|
|
275
|
+
<p>A new instance of TunnelSessionsClient.</p>
|
|
276
|
+
</div></span>
|
|
277
|
+
|
|
278
|
+
</li>
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
<li class="public ">
|
|
282
|
+
<span class="summary_signature">
|
|
283
|
+
|
|
284
|
+
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
</span>
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
<span class="summary_desc"><div class='inline'>
|
|
299
|
+
<p>List all online tunnel sessions running on this account.</p>
|
|
300
|
+
</div></span>
|
|
301
|
+
|
|
302
|
+
</li>
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
<li class="public ">
|
|
306
|
+
<span class="summary_signature">
|
|
307
|
+
|
|
308
|
+
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
</span>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
<span class="summary_desc"><div class='inline'>
|
|
323
|
+
<p>List all online tunnel sessions running on this account.</p>
|
|
324
|
+
</div></span>
|
|
325
|
+
|
|
326
|
+
</li>
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
<li class="public ">
|
|
330
|
+
<span class="summary_signature">
|
|
331
|
+
|
|
332
|
+
<a href="#restart-instance_method" title="#restart (instance method)">#<strong>restart</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
</span>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
<span class="summary_desc"><div class='inline'>
|
|
347
|
+
<p>Issues a command instructing the ngrok agent to restart.</p>
|
|
348
|
+
</div></span>
|
|
349
|
+
|
|
350
|
+
</li>
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
<li class="public ">
|
|
354
|
+
<span class="summary_signature">
|
|
355
|
+
|
|
356
|
+
<a href="#restart!-instance_method" title="#restart! (instance method)">#<strong>restart!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
</span>
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
<span class="summary_desc"><div class='inline'>
|
|
371
|
+
<p>Issues a command instructing the ngrok agent to restart.</p>
|
|
372
|
+
</div></span>
|
|
373
|
+
|
|
374
|
+
</li>
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
<li class="public ">
|
|
378
|
+
<span class="summary_signature">
|
|
379
|
+
|
|
380
|
+
<a href="#stop-instance_method" title="#stop (instance method)">#<strong>stop</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
</span>
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
<span class="summary_desc"><div class='inline'>
|
|
395
|
+
<p>Issues a command instructing the ngrok agent that started this tunnel session to exit.</p>
|
|
396
|
+
</div></span>
|
|
397
|
+
|
|
398
|
+
</li>
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
<li class="public ">
|
|
402
|
+
<span class="summary_signature">
|
|
403
|
+
|
|
404
|
+
<a href="#stop!-instance_method" title="#stop! (instance method)">#<strong>stop!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
</span>
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
<span class="summary_desc"><div class='inline'>
|
|
419
|
+
<p>Issues a command instructing the ngrok agent that started this tunnel session to exit.</p>
|
|
420
|
+
</div></span>
|
|
421
|
+
|
|
422
|
+
</li>
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
<li class="public ">
|
|
426
|
+
<span class="summary_signature">
|
|
427
|
+
|
|
428
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", version: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
</span>
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
<span class="summary_desc"><div class='inline'>
|
|
443
|
+
<p>Issues a command instructing the ngrok agent to update itself to the latest version.</p>
|
|
444
|
+
</div></span>
|
|
445
|
+
|
|
446
|
+
</li>
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
<li class="public ">
|
|
450
|
+
<span class="summary_signature">
|
|
451
|
+
|
|
452
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", version: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
</span>
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
<span class="summary_desc"><div class='inline'>
|
|
467
|
+
<p>Issues a command instructing the ngrok agent to update itself to the latest version.</p>
|
|
468
|
+
</div></span>
|
|
469
|
+
|
|
470
|
+
</li>
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
</ul>
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
<div id="constructor_details" class="method_details_list">
|
|
477
|
+
<h2>Constructor Details</h2>
|
|
478
|
+
|
|
479
|
+
<div class="method_details first">
|
|
480
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
481
|
+
|
|
482
|
+
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::TunnelSessionsClient (class)">TunnelSessionsClient</a></span></tt>
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
</h3><div class="docstring">
|
|
489
|
+
<div class="discussion">
|
|
490
|
+
|
|
491
|
+
<p>Returns a new instance of TunnelSessionsClient.</p>
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
</div>
|
|
495
|
+
</div>
|
|
496
|
+
<div class="tags">
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
</div><table class="source_code">
|
|
500
|
+
<tr>
|
|
501
|
+
<td>
|
|
502
|
+
<pre class="lines">
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
19
|
|
506
|
+
20
|
|
507
|
+
21</pre>
|
|
508
|
+
</td>
|
|
509
|
+
<td>
|
|
510
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 19</span>
|
|
511
|
+
|
|
512
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
|
|
513
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
514
|
+
<span class='kw'>end</span></pre>
|
|
515
|
+
</td>
|
|
516
|
+
</tr>
|
|
517
|
+
</table>
|
|
518
|
+
</div>
|
|
519
|
+
|
|
520
|
+
</div>
|
|
521
|
+
|
|
522
|
+
<div id="instance_attr_details" class="attr_details">
|
|
523
|
+
<h2>Instance Attribute Details</h2>
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
<span id=""></span>
|
|
527
|
+
<div class="method_details first">
|
|
528
|
+
<h3 class="signature first" id="client-instance_method">
|
|
529
|
+
|
|
530
|
+
#<strong>client</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
</h3><div class="docstring">
|
|
537
|
+
<div class="discussion">
|
|
538
|
+
|
|
539
|
+
<p>Returns the value of attribute client.</p>
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
</div>
|
|
543
|
+
</div>
|
|
544
|
+
<div class="tags">
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
</div><table class="source_code">
|
|
548
|
+
<tr>
|
|
549
|
+
<td>
|
|
550
|
+
<pre class="lines">
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
17
|
|
554
|
+
18
|
|
555
|
+
19</pre>
|
|
556
|
+
</td>
|
|
557
|
+
<td>
|
|
558
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 17</span>
|
|
559
|
+
|
|
560
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
561
|
+
<span class='ivar'>@client</span>
|
|
562
|
+
<span class='kw'>end</span></pre>
|
|
563
|
+
</td>
|
|
564
|
+
</tr>
|
|
565
|
+
</table>
|
|
566
|
+
</div>
|
|
567
|
+
|
|
568
|
+
</div>
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
<div id="instance_method_details" class="method_details_list">
|
|
572
|
+
<h2>Instance Method Details</h2>
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
<div class="method_details first">
|
|
576
|
+
<h3 class="signature first" id="get-instance_method">
|
|
577
|
+
|
|
578
|
+
#<strong>get</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">NgrokAPI::Models::TunnelSession</a></span></tt>
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
</h3><div class="docstring">
|
|
585
|
+
<div class="discussion">
|
|
586
|
+
|
|
587
|
+
<p>Get the detailed status of a tunnel session by ID</p>
|
|
588
|
+
|
|
589
|
+
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-get">ngrok.com/docs/api#api-tunnel-sessions-get</a></p>
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
</div>
|
|
593
|
+
</div>
|
|
594
|
+
<div class="tags">
|
|
595
|
+
<p class="tag_title">Parameters:</p>
|
|
596
|
+
<ul class="param">
|
|
597
|
+
|
|
598
|
+
<li>
|
|
599
|
+
|
|
600
|
+
<span class='name'>id</span>
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
—
|
|
610
|
+
<div class='inline'>
|
|
611
|
+
<p>a resource identifier</p>
|
|
612
|
+
</div>
|
|
613
|
+
|
|
614
|
+
</li>
|
|
615
|
+
|
|
616
|
+
</ul>
|
|
617
|
+
|
|
618
|
+
<p class="tag_title">Returns:</p>
|
|
619
|
+
<ul class="return">
|
|
620
|
+
|
|
621
|
+
<li>
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">NgrokAPI::Models::TunnelSession</a></span></tt>)</span>
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
—
|
|
629
|
+
<div class='inline'>
|
|
630
|
+
<p>result from the API request</p>
|
|
631
|
+
</div>
|
|
632
|
+
|
|
633
|
+
</li>
|
|
634
|
+
|
|
635
|
+
</ul>
|
|
636
|
+
|
|
637
|
+
</div><table class="source_code">
|
|
638
|
+
<tr>
|
|
639
|
+
<td>
|
|
640
|
+
<pre class="lines">
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
85
|
|
644
|
+
86
|
|
645
|
+
87
|
|
646
|
+
88
|
|
647
|
+
89
|
|
648
|
+
90
|
|
649
|
+
91
|
|
650
|
+
92
|
|
651
|
+
93</pre>
|
|
652
|
+
</td>
|
|
653
|
+
<td>
|
|
654
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 85</span>
|
|
655
|
+
|
|
656
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
657
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tunnel_sessions/%{id}</span><span class='tstring_end'>'</span></span>
|
|
658
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
659
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
660
|
+
<span class='rbrace'>}</span>
|
|
661
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
662
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
663
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">TunnelSession</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TunnelSession.html#initialize-instance_method" title="NgrokAPI::Models::TunnelSession#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
664
|
+
<span class='kw'>end</span></pre>
|
|
665
|
+
</td>
|
|
666
|
+
</tr>
|
|
667
|
+
</table>
|
|
668
|
+
</div>
|
|
669
|
+
|
|
670
|
+
<div class="method_details ">
|
|
671
|
+
<h3 class="signature " id="get!-instance_method">
|
|
672
|
+
|
|
673
|
+
#<strong>get!</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">NgrokAPI::Models::TunnelSession</a></span></tt>
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
</h3><div class="docstring">
|
|
680
|
+
<div class="discussion">
|
|
681
|
+
|
|
682
|
+
<p>Get the detailed status of a tunnel session by ID Throws an exception if API error.</p>
|
|
683
|
+
|
|
684
|
+
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-get">ngrok.com/docs/api#api-tunnel-sessions-get</a></p>
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
</div>
|
|
688
|
+
</div>
|
|
689
|
+
<div class="tags">
|
|
690
|
+
<p class="tag_title">Parameters:</p>
|
|
691
|
+
<ul class="param">
|
|
692
|
+
|
|
693
|
+
<li>
|
|
694
|
+
|
|
695
|
+
<span class='name'>id</span>
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
—
|
|
705
|
+
<div class='inline'>
|
|
706
|
+
<p>a resource identifier</p>
|
|
707
|
+
</div>
|
|
708
|
+
|
|
709
|
+
</li>
|
|
710
|
+
|
|
711
|
+
</ul>
|
|
712
|
+
|
|
713
|
+
<p class="tag_title">Returns:</p>
|
|
714
|
+
<ul class="return">
|
|
715
|
+
|
|
716
|
+
<li>
|
|
717
|
+
|
|
718
|
+
|
|
719
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">NgrokAPI::Models::TunnelSession</a></span></tt>)</span>
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
—
|
|
724
|
+
<div class='inline'>
|
|
725
|
+
<p>result from the API request</p>
|
|
726
|
+
</div>
|
|
727
|
+
|
|
728
|
+
</li>
|
|
729
|
+
|
|
730
|
+
</ul>
|
|
731
|
+
|
|
732
|
+
</div><table class="source_code">
|
|
733
|
+
<tr>
|
|
734
|
+
<td>
|
|
735
|
+
<pre class="lines">
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
103
|
|
739
|
+
104
|
|
740
|
+
105
|
|
741
|
+
106
|
|
742
|
+
107
|
|
743
|
+
108
|
|
744
|
+
109
|
|
745
|
+
110
|
|
746
|
+
111</pre>
|
|
747
|
+
</td>
|
|
748
|
+
<td>
|
|
749
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 103</span>
|
|
750
|
+
|
|
751
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
752
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tunnel_sessions/%{id}</span><span class='tstring_end'>'</span></span>
|
|
753
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
754
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
755
|
+
<span class='rbrace'>}</span>
|
|
756
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
757
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
758
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">TunnelSession</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TunnelSession.html#initialize-instance_method" title="NgrokAPI::Models::TunnelSession#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
759
|
+
<span class='kw'>end</span></pre>
|
|
760
|
+
</td>
|
|
761
|
+
</tr>
|
|
762
|
+
</table>
|
|
763
|
+
</div>
|
|
764
|
+
|
|
765
|
+
<div class="method_details ">
|
|
766
|
+
<h3 class="signature " id="list-instance_method">
|
|
767
|
+
|
|
768
|
+
#<strong>list</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
</h3><div class="docstring">
|
|
775
|
+
<div class="discussion">
|
|
776
|
+
|
|
777
|
+
<p>List all online tunnel sessions running on this account.</p>
|
|
778
|
+
|
|
779
|
+
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-list">ngrok.com/docs/api#api-tunnel-sessions-list</a></p>
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
</div>
|
|
783
|
+
</div>
|
|
784
|
+
<div class="tags">
|
|
785
|
+
<p class="tag_title">Parameters:</p>
|
|
786
|
+
<ul class="param">
|
|
787
|
+
|
|
788
|
+
<li>
|
|
789
|
+
|
|
790
|
+
<span class='name'>before_id</span>
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
</li>
|
|
800
|
+
|
|
801
|
+
<li>
|
|
802
|
+
|
|
803
|
+
<span class='name'>limit</span>
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
</li>
|
|
813
|
+
|
|
814
|
+
<li>
|
|
815
|
+
|
|
816
|
+
<span class='name'>url</span>
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
—
|
|
826
|
+
<div class='inline'>
|
|
827
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
828
|
+
</div>
|
|
829
|
+
|
|
830
|
+
</li>
|
|
831
|
+
|
|
832
|
+
</ul>
|
|
833
|
+
|
|
834
|
+
<p class="tag_title">Returns:</p>
|
|
835
|
+
<ul class="return">
|
|
836
|
+
|
|
837
|
+
<li>
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
|
|
841
|
+
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
—
|
|
845
|
+
<div class='inline'>
|
|
846
|
+
<p>result from the API request</p>
|
|
847
|
+
</div>
|
|
848
|
+
|
|
849
|
+
</li>
|
|
850
|
+
|
|
851
|
+
</ul>
|
|
852
|
+
|
|
853
|
+
</div><table class="source_code">
|
|
854
|
+
<tr>
|
|
855
|
+
<td>
|
|
856
|
+
<pre class="lines">
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
32
|
|
860
|
+
33
|
|
861
|
+
34
|
|
862
|
+
35
|
|
863
|
+
36
|
|
864
|
+
37
|
|
865
|
+
38
|
|
866
|
+
39
|
|
867
|
+
40
|
|
868
|
+
41
|
|
869
|
+
42
|
|
870
|
+
43
|
|
871
|
+
44
|
|
872
|
+
45
|
|
873
|
+
46
|
|
874
|
+
47</pre>
|
|
875
|
+
</td>
|
|
876
|
+
<td>
|
|
877
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 32</span>
|
|
878
|
+
|
|
879
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
880
|
+
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
881
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
|
882
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
883
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
884
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
885
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TunnelSessionsClient::PATH (constant)">PATH</a></span></span>
|
|
886
|
+
<span class='rparen'>)</span>
|
|
887
|
+
|
|
888
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
|
|
889
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
890
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
891
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::TunnelSessionsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
892
|
+
<span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">TunnelSession</a></span></span>
|
|
893
|
+
<span class='rparen'>)</span>
|
|
894
|
+
<span class='kw'>end</span></pre>
|
|
895
|
+
</td>
|
|
896
|
+
</tr>
|
|
897
|
+
</table>
|
|
898
|
+
</div>
|
|
899
|
+
|
|
900
|
+
<div class="method_details ">
|
|
901
|
+
<h3 class="signature " id="list!-instance_method">
|
|
902
|
+
|
|
903
|
+
#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
|
|
907
|
+
|
|
908
|
+
|
|
909
|
+
</h3><div class="docstring">
|
|
910
|
+
<div class="discussion">
|
|
911
|
+
|
|
912
|
+
<p>List all online tunnel sessions running on this account. Throws an exception if API error.</p>
|
|
913
|
+
|
|
914
|
+
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-list">ngrok.com/docs/api#api-tunnel-sessions-list</a></p>
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
</div>
|
|
918
|
+
</div>
|
|
919
|
+
<div class="tags">
|
|
920
|
+
<p class="tag_title">Parameters:</p>
|
|
921
|
+
<ul class="param">
|
|
922
|
+
|
|
923
|
+
<li>
|
|
924
|
+
|
|
925
|
+
<span class='name'>before_id</span>
|
|
926
|
+
|
|
927
|
+
|
|
928
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
929
|
+
|
|
930
|
+
|
|
931
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
</li>
|
|
935
|
+
|
|
936
|
+
<li>
|
|
937
|
+
|
|
938
|
+
<span class='name'>limit</span>
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
942
|
+
|
|
943
|
+
|
|
944
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
945
|
+
|
|
946
|
+
|
|
947
|
+
</li>
|
|
948
|
+
|
|
949
|
+
<li>
|
|
950
|
+
|
|
951
|
+
<span class='name'>url</span>
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
955
|
+
|
|
956
|
+
|
|
957
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
958
|
+
|
|
959
|
+
|
|
960
|
+
—
|
|
961
|
+
<div class='inline'>
|
|
962
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
963
|
+
</div>
|
|
964
|
+
|
|
965
|
+
</li>
|
|
966
|
+
|
|
967
|
+
</ul>
|
|
968
|
+
|
|
969
|
+
<p class="tag_title">Returns:</p>
|
|
970
|
+
<ul class="return">
|
|
971
|
+
|
|
972
|
+
<li>
|
|
973
|
+
|
|
974
|
+
|
|
975
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
—
|
|
980
|
+
<div class='inline'>
|
|
981
|
+
<p>result from the API request</p>
|
|
982
|
+
</div>
|
|
983
|
+
|
|
984
|
+
</li>
|
|
985
|
+
|
|
986
|
+
</ul>
|
|
987
|
+
|
|
988
|
+
</div><table class="source_code">
|
|
989
|
+
<tr>
|
|
990
|
+
<td>
|
|
991
|
+
<pre class="lines">
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
59
|
|
995
|
+
60
|
|
996
|
+
61
|
|
997
|
+
62
|
|
998
|
+
63
|
|
999
|
+
64
|
|
1000
|
+
65
|
|
1001
|
+
66
|
|
1002
|
+
67
|
|
1003
|
+
68
|
|
1004
|
+
69
|
|
1005
|
+
70
|
|
1006
|
+
71
|
|
1007
|
+
72
|
|
1008
|
+
73
|
|
1009
|
+
74
|
|
1010
|
+
75
|
|
1011
|
+
76</pre>
|
|
1012
|
+
</td>
|
|
1013
|
+
<td>
|
|
1014
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 59</span>
|
|
1015
|
+
|
|
1016
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1017
|
+
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1018
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
|
1019
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1020
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1021
|
+
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1022
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1023
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TunnelSessionsClient::PATH (constant)">PATH</a></span></span>
|
|
1024
|
+
<span class='rparen'>)</span>
|
|
1025
|
+
|
|
1026
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
|
|
1027
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1028
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1029
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::TunnelSessionsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1030
|
+
<span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">TunnelSession</a></span></span><span class='comma'>,</span>
|
|
1031
|
+
<span class='label'>danger:</span> <span class='kw'>true</span>
|
|
1032
|
+
<span class='rparen'>)</span>
|
|
1033
|
+
<span class='kw'>end</span></pre>
|
|
1034
|
+
</td>
|
|
1035
|
+
</tr>
|
|
1036
|
+
</table>
|
|
1037
|
+
</div>
|
|
1038
|
+
|
|
1039
|
+
<div class="method_details ">
|
|
1040
|
+
<h3 class="signature " id="restart-instance_method">
|
|
1041
|
+
|
|
1042
|
+
#<strong>restart</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
1043
|
+
|
|
1044
|
+
|
|
1045
|
+
|
|
1046
|
+
|
|
1047
|
+
|
|
1048
|
+
</h3><div class="docstring">
|
|
1049
|
+
<div class="discussion">
|
|
1050
|
+
|
|
1051
|
+
<p>Issues a command instructing the ngrok agent to restart. The agent restarts itself by calling exec() on platforms that support it. This operation is notably not supported on Windows. When an agent restarts, it reconnects with a new tunnel session ID.</p>
|
|
1052
|
+
|
|
1053
|
+
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-restart">ngrok.com/docs/api#api-tunnel-sessions-restart</a></p>
|
|
1054
|
+
|
|
1055
|
+
|
|
1056
|
+
</div>
|
|
1057
|
+
</div>
|
|
1058
|
+
<div class="tags">
|
|
1059
|
+
<p class="tag_title">Parameters:</p>
|
|
1060
|
+
<ul class="param">
|
|
1061
|
+
|
|
1062
|
+
<li>
|
|
1063
|
+
|
|
1064
|
+
<span class='name'>id</span>
|
|
1065
|
+
|
|
1066
|
+
|
|
1067
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1071
|
+
|
|
1072
|
+
|
|
1073
|
+
—
|
|
1074
|
+
<div class='inline'>
|
|
1075
|
+
<p>a resource identifier</p>
|
|
1076
|
+
</div>
|
|
1077
|
+
|
|
1078
|
+
</li>
|
|
1079
|
+
|
|
1080
|
+
</ul>
|
|
1081
|
+
|
|
1082
|
+
<p class="tag_title">Returns:</p>
|
|
1083
|
+
<ul class="return">
|
|
1084
|
+
|
|
1085
|
+
<li>
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
1089
|
+
|
|
1090
|
+
|
|
1091
|
+
|
|
1092
|
+
—
|
|
1093
|
+
<div class='inline'>
|
|
1094
|
+
<p>result from the API request</p>
|
|
1095
|
+
</div>
|
|
1096
|
+
|
|
1097
|
+
</li>
|
|
1098
|
+
|
|
1099
|
+
</ul>
|
|
1100
|
+
|
|
1101
|
+
</div><table class="source_code">
|
|
1102
|
+
<tr>
|
|
1103
|
+
<td>
|
|
1104
|
+
<pre class="lines">
|
|
1105
|
+
|
|
1106
|
+
|
|
1107
|
+
123
|
|
1108
|
+
124
|
|
1109
|
+
125
|
|
1110
|
+
126
|
|
1111
|
+
127
|
|
1112
|
+
128
|
|
1113
|
+
129</pre>
|
|
1114
|
+
</td>
|
|
1115
|
+
<td>
|
|
1116
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 123</span>
|
|
1117
|
+
|
|
1118
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_restart'>restart</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1119
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tunnel_sessions/%{id}/restart</span><span class='tstring_end'>'</span></span>
|
|
1120
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1121
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1122
|
+
<span class='rbrace'>}</span>
|
|
1123
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='rparen'>)</span>
|
|
1124
|
+
<span class='kw'>end</span></pre>
|
|
1125
|
+
</td>
|
|
1126
|
+
</tr>
|
|
1127
|
+
</table>
|
|
1128
|
+
</div>
|
|
1129
|
+
|
|
1130
|
+
<div class="method_details ">
|
|
1131
|
+
<h3 class="signature " id="restart!-instance_method">
|
|
1132
|
+
|
|
1133
|
+
#<strong>restart!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
1134
|
+
|
|
1135
|
+
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
|
|
1139
|
+
</h3><div class="docstring">
|
|
1140
|
+
<div class="discussion">
|
|
1141
|
+
|
|
1142
|
+
<p>Issues a command instructing the ngrok agent to restart. The agent restarts itself by calling exec() on platforms that support it. This operation is notably not supported on Windows. When an agent restarts, it reconnects with a new tunnel session ID. Throws an exception if API error.</p>
|
|
1143
|
+
|
|
1144
|
+
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-restart">ngrok.com/docs/api#api-tunnel-sessions-restart</a></p>
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
</div>
|
|
1148
|
+
</div>
|
|
1149
|
+
<div class="tags">
|
|
1150
|
+
<p class="tag_title">Parameters:</p>
|
|
1151
|
+
<ul class="param">
|
|
1152
|
+
|
|
1153
|
+
<li>
|
|
1154
|
+
|
|
1155
|
+
<span class='name'>id</span>
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1159
|
+
|
|
1160
|
+
|
|
1161
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1162
|
+
|
|
1163
|
+
|
|
1164
|
+
—
|
|
1165
|
+
<div class='inline'>
|
|
1166
|
+
<p>a resource identifier</p>
|
|
1167
|
+
</div>
|
|
1168
|
+
|
|
1169
|
+
</li>
|
|
1170
|
+
|
|
1171
|
+
</ul>
|
|
1172
|
+
|
|
1173
|
+
<p class="tag_title">Returns:</p>
|
|
1174
|
+
<ul class="return">
|
|
1175
|
+
|
|
1176
|
+
<li>
|
|
1177
|
+
|
|
1178
|
+
|
|
1179
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
—
|
|
1184
|
+
<div class='inline'>
|
|
1185
|
+
<p>result from the API request</p>
|
|
1186
|
+
</div>
|
|
1187
|
+
|
|
1188
|
+
</li>
|
|
1189
|
+
|
|
1190
|
+
</ul>
|
|
1191
|
+
|
|
1192
|
+
</div><table class="source_code">
|
|
1193
|
+
<tr>
|
|
1194
|
+
<td>
|
|
1195
|
+
<pre class="lines">
|
|
1196
|
+
|
|
1197
|
+
|
|
1198
|
+
142
|
|
1199
|
+
143
|
|
1200
|
+
144
|
|
1201
|
+
145
|
|
1202
|
+
146
|
|
1203
|
+
147
|
|
1204
|
+
148</pre>
|
|
1205
|
+
</td>
|
|
1206
|
+
<td>
|
|
1207
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 142</span>
|
|
1208
|
+
|
|
1209
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_restart!'>restart!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1210
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tunnel_sessions/%{id}/restart</span><span class='tstring_end'>'</span></span>
|
|
1211
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1212
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1213
|
+
<span class='rbrace'>}</span>
|
|
1214
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
1215
|
+
<span class='kw'>end</span></pre>
|
|
1216
|
+
</td>
|
|
1217
|
+
</tr>
|
|
1218
|
+
</table>
|
|
1219
|
+
</div>
|
|
1220
|
+
|
|
1221
|
+
<div class="method_details ">
|
|
1222
|
+
<h3 class="signature " id="stop-instance_method">
|
|
1223
|
+
|
|
1224
|
+
#<strong>stop</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
1225
|
+
|
|
1226
|
+
|
|
1227
|
+
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
</h3><div class="docstring">
|
|
1231
|
+
<div class="discussion">
|
|
1232
|
+
|
|
1233
|
+
<p>Issues a command instructing the ngrok agent that started this tunnel session to exit.</p>
|
|
1234
|
+
|
|
1235
|
+
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-stop">ngrok.com/docs/api#api-tunnel-sessions-stop</a></p>
|
|
1236
|
+
|
|
1237
|
+
|
|
1238
|
+
</div>
|
|
1239
|
+
</div>
|
|
1240
|
+
<div class="tags">
|
|
1241
|
+
<p class="tag_title">Parameters:</p>
|
|
1242
|
+
<ul class="param">
|
|
1243
|
+
|
|
1244
|
+
<li>
|
|
1245
|
+
|
|
1246
|
+
<span class='name'>id</span>
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1250
|
+
|
|
1251
|
+
|
|
1252
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1253
|
+
|
|
1254
|
+
|
|
1255
|
+
—
|
|
1256
|
+
<div class='inline'>
|
|
1257
|
+
<p>a resource identifier</p>
|
|
1258
|
+
</div>
|
|
1259
|
+
|
|
1260
|
+
</li>
|
|
1261
|
+
|
|
1262
|
+
</ul>
|
|
1263
|
+
|
|
1264
|
+
<p class="tag_title">Returns:</p>
|
|
1265
|
+
<ul class="return">
|
|
1266
|
+
|
|
1267
|
+
<li>
|
|
1268
|
+
|
|
1269
|
+
|
|
1270
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
1271
|
+
|
|
1272
|
+
|
|
1273
|
+
|
|
1274
|
+
—
|
|
1275
|
+
<div class='inline'>
|
|
1276
|
+
<p>result from the API request</p>
|
|
1277
|
+
</div>
|
|
1278
|
+
|
|
1279
|
+
</li>
|
|
1280
|
+
|
|
1281
|
+
</ul>
|
|
1282
|
+
|
|
1283
|
+
</div><table class="source_code">
|
|
1284
|
+
<tr>
|
|
1285
|
+
<td>
|
|
1286
|
+
<pre class="lines">
|
|
1287
|
+
|
|
1288
|
+
|
|
1289
|
+
158
|
|
1290
|
+
159
|
|
1291
|
+
160
|
|
1292
|
+
161
|
|
1293
|
+
162
|
|
1294
|
+
163
|
|
1295
|
+
164</pre>
|
|
1296
|
+
</td>
|
|
1297
|
+
<td>
|
|
1298
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 158</span>
|
|
1299
|
+
|
|
1300
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_stop'>stop</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1301
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tunnel_sessions/%{id}/stop</span><span class='tstring_end'>'</span></span>
|
|
1302
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1303
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1304
|
+
<span class='rbrace'>}</span>
|
|
1305
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='rparen'>)</span>
|
|
1306
|
+
<span class='kw'>end</span></pre>
|
|
1307
|
+
</td>
|
|
1308
|
+
</tr>
|
|
1309
|
+
</table>
|
|
1310
|
+
</div>
|
|
1311
|
+
|
|
1312
|
+
<div class="method_details ">
|
|
1313
|
+
<h3 class="signature " id="stop!-instance_method">
|
|
1314
|
+
|
|
1315
|
+
#<strong>stop!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
1316
|
+
|
|
1317
|
+
|
|
1318
|
+
|
|
1319
|
+
|
|
1320
|
+
|
|
1321
|
+
</h3><div class="docstring">
|
|
1322
|
+
<div class="discussion">
|
|
1323
|
+
|
|
1324
|
+
<p>Issues a command instructing the ngrok agent that started this tunnel session to exit. Throws an exception if API error.</p>
|
|
1325
|
+
|
|
1326
|
+
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-stop">ngrok.com/docs/api#api-tunnel-sessions-stop</a></p>
|
|
1327
|
+
|
|
1328
|
+
|
|
1329
|
+
</div>
|
|
1330
|
+
</div>
|
|
1331
|
+
<div class="tags">
|
|
1332
|
+
<p class="tag_title">Parameters:</p>
|
|
1333
|
+
<ul class="param">
|
|
1334
|
+
|
|
1335
|
+
<li>
|
|
1336
|
+
|
|
1337
|
+
<span class='name'>id</span>
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1341
|
+
|
|
1342
|
+
|
|
1343
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1344
|
+
|
|
1345
|
+
|
|
1346
|
+
—
|
|
1347
|
+
<div class='inline'>
|
|
1348
|
+
<p>a resource identifier</p>
|
|
1349
|
+
</div>
|
|
1350
|
+
|
|
1351
|
+
</li>
|
|
1352
|
+
|
|
1353
|
+
</ul>
|
|
1354
|
+
|
|
1355
|
+
<p class="tag_title">Returns:</p>
|
|
1356
|
+
<ul class="return">
|
|
1357
|
+
|
|
1358
|
+
<li>
|
|
1359
|
+
|
|
1360
|
+
|
|
1361
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
1362
|
+
|
|
1363
|
+
|
|
1364
|
+
|
|
1365
|
+
—
|
|
1366
|
+
<div class='inline'>
|
|
1367
|
+
<p>result from the API request</p>
|
|
1368
|
+
</div>
|
|
1369
|
+
|
|
1370
|
+
</li>
|
|
1371
|
+
|
|
1372
|
+
</ul>
|
|
1373
|
+
|
|
1374
|
+
</div><table class="source_code">
|
|
1375
|
+
<tr>
|
|
1376
|
+
<td>
|
|
1377
|
+
<pre class="lines">
|
|
1378
|
+
|
|
1379
|
+
|
|
1380
|
+
175
|
|
1381
|
+
176
|
|
1382
|
+
177
|
|
1383
|
+
178
|
|
1384
|
+
179
|
|
1385
|
+
180
|
|
1386
|
+
181</pre>
|
|
1387
|
+
</td>
|
|
1388
|
+
<td>
|
|
1389
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 175</span>
|
|
1390
|
+
|
|
1391
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_stop!'>stop!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1392
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tunnel_sessions/%{id}/stop</span><span class='tstring_end'>'</span></span>
|
|
1393
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1394
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1395
|
+
<span class='rbrace'>}</span>
|
|
1396
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
1397
|
+
<span class='kw'>end</span></pre>
|
|
1398
|
+
</td>
|
|
1399
|
+
</tr>
|
|
1400
|
+
</table>
|
|
1401
|
+
</div>
|
|
1402
|
+
|
|
1403
|
+
<div class="method_details ">
|
|
1404
|
+
<h3 class="signature " id="update-instance_method">
|
|
1405
|
+
|
|
1406
|
+
#<strong>update</strong>(id: "", version: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
1407
|
+
|
|
1408
|
+
|
|
1409
|
+
|
|
1410
|
+
|
|
1411
|
+
|
|
1412
|
+
</h3><div class="docstring">
|
|
1413
|
+
<div class="discussion">
|
|
1414
|
+
|
|
1415
|
+
<p>Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent's configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted</p>
|
|
1416
|
+
|
|
1417
|
+
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-update">ngrok.com/docs/api#api-tunnel-sessions-update</a></p>
|
|
1418
|
+
|
|
1419
|
+
|
|
1420
|
+
</div>
|
|
1421
|
+
</div>
|
|
1422
|
+
<div class="tags">
|
|
1423
|
+
<p class="tag_title">Parameters:</p>
|
|
1424
|
+
<ul class="param">
|
|
1425
|
+
|
|
1426
|
+
<li>
|
|
1427
|
+
|
|
1428
|
+
<span class='name'>id</span>
|
|
1429
|
+
|
|
1430
|
+
|
|
1431
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1432
|
+
|
|
1433
|
+
|
|
1434
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1435
|
+
|
|
1436
|
+
|
|
1437
|
+
</li>
|
|
1438
|
+
|
|
1439
|
+
</ul>
|
|
1440
|
+
|
|
1441
|
+
<p class="tag_title">Returns:</p>
|
|
1442
|
+
<ul class="return">
|
|
1443
|
+
|
|
1444
|
+
<li>
|
|
1445
|
+
|
|
1446
|
+
|
|
1447
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
1448
|
+
|
|
1449
|
+
|
|
1450
|
+
|
|
1451
|
+
—
|
|
1452
|
+
<div class='inline'>
|
|
1453
|
+
<p>result from the API request</p>
|
|
1454
|
+
</div>
|
|
1455
|
+
|
|
1456
|
+
</li>
|
|
1457
|
+
|
|
1458
|
+
</ul>
|
|
1459
|
+
|
|
1460
|
+
</div><table class="source_code">
|
|
1461
|
+
<tr>
|
|
1462
|
+
<td>
|
|
1463
|
+
<pre class="lines">
|
|
1464
|
+
|
|
1465
|
+
|
|
1466
|
+
201
|
|
1467
|
+
202
|
|
1468
|
+
203
|
|
1469
|
+
204
|
|
1470
|
+
205
|
|
1471
|
+
206
|
|
1472
|
+
207</pre>
|
|
1473
|
+
</td>
|
|
1474
|
+
<td>
|
|
1475
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 201</span>
|
|
1476
|
+
|
|
1477
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>version:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1478
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tunnel_sessions/%{id}/update</span><span class='tstring_end'>'</span></span>
|
|
1479
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1480
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1481
|
+
<span class='rbrace'>}</span>
|
|
1482
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='rparen'>)</span>
|
|
1483
|
+
<span class='kw'>end</span></pre>
|
|
1484
|
+
</td>
|
|
1485
|
+
</tr>
|
|
1486
|
+
</table>
|
|
1487
|
+
</div>
|
|
1488
|
+
|
|
1489
|
+
<div class="method_details ">
|
|
1490
|
+
<h3 class="signature " id="update!-instance_method">
|
|
1491
|
+
|
|
1492
|
+
#<strong>update!</strong>(id: "", version: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
1493
|
+
|
|
1494
|
+
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
|
|
1498
|
+
</h3><div class="docstring">
|
|
1499
|
+
<div class="discussion">
|
|
1500
|
+
|
|
1501
|
+
<p>Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent's configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted Throws an exception if API error.</p>
|
|
1502
|
+
|
|
1503
|
+
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-update">ngrok.com/docs/api#api-tunnel-sessions-update</a></p>
|
|
1504
|
+
|
|
1505
|
+
|
|
1506
|
+
</div>
|
|
1507
|
+
</div>
|
|
1508
|
+
<div class="tags">
|
|
1509
|
+
<p class="tag_title">Parameters:</p>
|
|
1510
|
+
<ul class="param">
|
|
1511
|
+
|
|
1512
|
+
<li>
|
|
1513
|
+
|
|
1514
|
+
<span class='name'>id</span>
|
|
1515
|
+
|
|
1516
|
+
|
|
1517
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1518
|
+
|
|
1519
|
+
|
|
1520
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1521
|
+
|
|
1522
|
+
|
|
1523
|
+
</li>
|
|
1524
|
+
|
|
1525
|
+
</ul>
|
|
1526
|
+
|
|
1527
|
+
<p class="tag_title">Returns:</p>
|
|
1528
|
+
<ul class="return">
|
|
1529
|
+
|
|
1530
|
+
<li>
|
|
1531
|
+
|
|
1532
|
+
|
|
1533
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
1534
|
+
|
|
1535
|
+
|
|
1536
|
+
|
|
1537
|
+
—
|
|
1538
|
+
<div class='inline'>
|
|
1539
|
+
<p>result from the API request</p>
|
|
1540
|
+
</div>
|
|
1541
|
+
|
|
1542
|
+
</li>
|
|
1543
|
+
|
|
1544
|
+
</ul>
|
|
1545
|
+
|
|
1546
|
+
</div><table class="source_code">
|
|
1547
|
+
<tr>
|
|
1548
|
+
<td>
|
|
1549
|
+
<pre class="lines">
|
|
1550
|
+
|
|
1551
|
+
|
|
1552
|
+
228
|
|
1553
|
+
229
|
|
1554
|
+
230
|
|
1555
|
+
231
|
|
1556
|
+
232
|
|
1557
|
+
233
|
|
1558
|
+
234</pre>
|
|
1559
|
+
</td>
|
|
1560
|
+
<td>
|
|
1561
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 228</span>
|
|
1562
|
+
|
|
1563
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>version:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1564
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tunnel_sessions/%{id}/update</span><span class='tstring_end'>'</span></span>
|
|
1565
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1566
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1567
|
+
<span class='rbrace'>}</span>
|
|
1568
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
1569
|
+
<span class='kw'>end</span></pre>
|
|
1570
|
+
</td>
|
|
1571
|
+
</tr>
|
|
1572
|
+
</table>
|
|
1573
|
+
</div>
|
|
1574
|
+
|
|
1575
|
+
</div>
|
|
1576
|
+
|
|
1577
|
+
</div>
|
|
1578
|
+
|
|
1579
|
+
<div id="footer">
|
|
1580
|
+
Generated on Thu Dec 2 18:48:55 2021 by
|
|
1581
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1582
|
+
0.9.27 (ruby-3.0.1).
|
|
1583
|
+
</div>
|
|
1584
|
+
|
|
1585
|
+
</div>
|
|
1586
|
+
</body>
|
|
1587
|
+
</html>
|