ngrok-api 0.12.0 → 0.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.yardopts +1 -0
- data/LICENSE +7 -0
- data/doc/NgrokAPI/Client.html +184 -182
- 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 +55 -19
- data/doc/NgrokAPI/Models/APIKey.html +1 -1
- data/doc/NgrokAPI/Models/AWSAuth.html +1 -1
- data/doc/NgrokAPI/Models/AWSCredentials.html +1 -1
- data/doc/NgrokAPI/Models/AWSRole.html +1 -1
- data/doc/NgrokAPI/Models/AbuseReport.html +1 -1
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +1 -1
- data/doc/NgrokAPI/Models/CertificateAuthority.html +1 -1
- data/doc/NgrokAPI/Models/Credential.html +1 -1
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +1 -1
- data/doc/NgrokAPI/Models/EndpointCompression.html +1 -1
- data/doc/NgrokAPI/Models/EndpointConfiguration.html +1 -1
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +1 -1
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +1 -1
- data/doc/NgrokAPI/Models/EndpointLogging.html +1 -1
- data/doc/NgrokAPI/Models/EndpointLoggingMutate.html +1 -1
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +1 -1
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuth.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOIDC.html +1 -1
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +1 -1
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +1 -1
- data/doc/NgrokAPI/Models/EndpointSAML.html +1 -1
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +1 -1
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +1 -1
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +1 -1
- data/doc/NgrokAPI/Models/EventDestination.html +1 -1
- data/doc/NgrokAPI/Models/EventSource.html +1 -1
- data/doc/NgrokAPI/Models/{ReservedDomainCertNSTarget.html → EventSourceList.html} +42 -42
- data/doc/NgrokAPI/Models/EventSourceReplace.html +1 -1
- data/doc/NgrokAPI/Models/EventStream.html +1 -1
- data/doc/NgrokAPI/Models/EventSubscription.html +1 -1
- data/doc/NgrokAPI/Models/EventTarget.html +1 -1
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +1 -1
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +1 -1
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +1 -1
- data/doc/NgrokAPI/Models/IPPolicy.html +1 -1
- data/doc/NgrokAPI/Models/IPPolicyRule.html +1 -1
- data/doc/NgrokAPI/Models/IPRestriction.html +1 -1
- data/doc/NgrokAPI/Models/IPWhitelistEntry.html +1 -1
- data/doc/NgrokAPI/Models/Listable.html +118 -50
- data/doc/NgrokAPI/Models/Ref.html +1 -1
- data/doc/NgrokAPI/Models/ReservedAddr.html +1 -1
- data/doc/NgrokAPI/Models/ReservedDomain.html +91 -17
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +12 -86
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +1 -1
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +1 -1
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +1 -1
- data/doc/NgrokAPI/Models/SSHCredential.html +1 -1
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +1 -1
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +1 -1
- data/doc/NgrokAPI/Models/TLSCertificate.html +1 -1
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +1 -1
- data/doc/NgrokAPI/Models/Tunnel.html +1 -1
- data/doc/NgrokAPI/Models/TunnelSession.html +1 -1
- data/doc/NgrokAPI/Models.html +3 -3
- data/doc/NgrokAPI/PagedIterator.html +14 -10
- data/doc/NgrokAPI/Services/APIKeysClient.html +227 -62
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +2 -5
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +206 -41
- data/doc/NgrokAPI/Services/CredentialsClient.html +213 -47
- data/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +281 -114
- data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +221 -50
- data/doc/NgrokAPI/Services/EventSourcesClient.html +279 -33
- data/doc/NgrokAPI/Services/EventStreamsClient.html +218 -47
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +213 -42
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +207 -41
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +210 -42
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +215 -51
- data/doc/NgrokAPI/Services/IPWhitelistClient.html +206 -38
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +230 -63
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +308 -142
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +208 -40
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +213 -45
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +207 -40
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +209 -42
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +208 -43
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +260 -93
- data/doc/NgrokAPI/Services/TunnelsClient.html +174 -6
- data/doc/NgrokAPI/Services.html +1 -1
- data/doc/NgrokAPI.html +2 -2
- data/doc/README +94 -0
- data/doc/_index.html +8 -8
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +53 -26
- data/doc/index.html +53 -26
- data/doc/method_list.html +822 -630
- data/doc/top-level-namespace.html +1 -1
- data/docs/NgrokAPI/Client.html +184 -182
- 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 +55 -19
- data/docs/NgrokAPI/Models/APIKey.html +1 -1
- data/docs/NgrokAPI/Models/AWSAuth.html +1 -1
- data/docs/NgrokAPI/Models/AWSCredentials.html +1 -1
- data/docs/NgrokAPI/Models/AWSRole.html +1 -1
- data/docs/NgrokAPI/Models/AbuseReport.html +1 -1
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +1 -1
- data/docs/NgrokAPI/Models/CertificateAuthority.html +1 -1
- data/docs/NgrokAPI/Models/Credential.html +1 -1
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +1 -1
- data/docs/NgrokAPI/Models/EndpointCompression.html +1 -1
- data/docs/NgrokAPI/Models/EndpointConfiguration.html +1 -1
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +1 -1
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +1 -1
- data/docs/NgrokAPI/Models/EndpointLogging.html +1 -1
- data/docs/NgrokAPI/Models/EndpointLoggingMutate.html +1 -1
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +1 -1
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuth.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOIDC.html +1 -1
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +1 -1
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +1 -1
- data/docs/NgrokAPI/Models/EndpointSAML.html +1 -1
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +1 -1
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +1 -1
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +1 -1
- data/docs/NgrokAPI/Models/EventDestination.html +1 -1
- data/docs/NgrokAPI/Models/EventSource.html +1 -1
- data/docs/NgrokAPI/Models/{ReservedDomainCertNSTarget.html → EventSourceList.html} +42 -42
- data/docs/NgrokAPI/Models/EventSourceReplace.html +1 -1
- data/docs/NgrokAPI/Models/EventStream.html +1 -1
- data/docs/NgrokAPI/Models/EventSubscription.html +1 -1
- data/docs/NgrokAPI/Models/EventTarget.html +1 -1
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +1 -1
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +1 -1
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +1 -1
- data/docs/NgrokAPI/Models/IPPolicy.html +1 -1
- data/docs/NgrokAPI/Models/IPPolicyRule.html +1 -1
- data/docs/NgrokAPI/Models/IPRestriction.html +1 -1
- data/docs/NgrokAPI/Models/IPWhitelistEntry.html +1 -1
- data/docs/NgrokAPI/Models/Listable.html +118 -50
- data/docs/NgrokAPI/Models/Ref.html +1 -1
- data/docs/NgrokAPI/Models/ReservedAddr.html +1 -1
- data/docs/NgrokAPI/Models/ReservedDomain.html +91 -17
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +12 -86
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +1 -1
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +1 -1
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +1 -1
- data/docs/NgrokAPI/Models/SSHCredential.html +1 -1
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +1 -1
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +1 -1
- data/docs/NgrokAPI/Models/TLSCertificate.html +1 -1
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +1 -1
- data/docs/NgrokAPI/Models/Tunnel.html +1 -1
- data/docs/NgrokAPI/Models/TunnelSession.html +1 -1
- data/docs/NgrokAPI/Models.html +3 -3
- data/docs/NgrokAPI/PagedIterator.html +14 -10
- data/docs/NgrokAPI/Services/APIKeysClient.html +227 -62
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +2 -5
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +206 -41
- data/docs/NgrokAPI/Services/CredentialsClient.html +213 -47
- data/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +281 -114
- data/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +221 -50
- data/docs/NgrokAPI/Services/EventSourcesClient.html +279 -33
- data/docs/NgrokAPI/Services/EventStreamsClient.html +218 -47
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +213 -42
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +207 -41
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +210 -42
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +215 -51
- data/docs/NgrokAPI/Services/IPWhitelistClient.html +206 -38
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +230 -63
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +308 -142
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +208 -40
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +213 -45
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +207 -40
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +209 -42
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +208 -43
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +260 -93
- data/docs/NgrokAPI/Services/TunnelsClient.html +174 -6
- data/docs/NgrokAPI/Services.html +1 -1
- data/docs/NgrokAPI.html +2 -2
- data/docs/README +94 -0
- data/docs/_index.html +8 -8
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +53 -26
- data/docs/index.html +53 -26
- data/docs/method_list.html +822 -630
- data/docs/top-level-namespace.html +1 -1
- data/lib/ngrokapi/client.rb +27 -8
- data/lib/ngrokapi/http_client.rb +5 -3
- data/lib/ngrokapi/models/{reserved_domain_cert_ns_target.rb → event_source_list.rb} +5 -5
- data/lib/ngrokapi/models/listable.rb +13 -2
- data/lib/ngrokapi/models/reserved_domain.rb +3 -1
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +1 -3
- data/lib/ngrokapi/paged_iterator.rb +4 -2
- data/lib/ngrokapi/services/api_keys_client.rb +36 -4
- data/lib/ngrokapi/services/certificate_authorities_client.rb +33 -0
- data/lib/ngrokapi/services/credentials_client.rb +35 -2
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +33 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +33 -0
- data/lib/ngrokapi/services/event_sources_client.rb +39 -0
- data/lib/ngrokapi/services/event_streams_client.rb +33 -0
- data/lib/ngrokapi/services/event_subscriptions_client.rb +33 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +34 -1
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +33 -0
- data/lib/ngrokapi/services/ip_restrictions_client.rb +33 -0
- data/lib/ngrokapi/services/ip_whitelist_client.rb +34 -1
- data/lib/ngrokapi/services/reserved_addrs_client.rb +33 -0
- data/lib/ngrokapi/services/reserved_domains_client.rb +33 -0
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +33 -0
- data/lib/ngrokapi/services/ssh_credentials_client.rb +33 -0
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +33 -0
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +33 -0
- data/lib/ngrokapi/services/tls_certificates_client.rb +33 -0
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +33 -0
- data/lib/ngrokapi/services/tunnels_client.rb +33 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/spec/ngrokapi/client_spec.rb +19 -0
- data/spec/ngrokapi/models/event_source_list_spec.rb +21 -0
- data/spec/ngrokapi/paged_iterator_spec.rb +2 -2
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +0 -2
- data/spec/ngrokapi/services/api_keys_client_spec.rb +0 -3
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +0 -3
- data/spec/ngrokapi/services/credentials_client_spec.rb +0 -3
- data/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +0 -3
- data/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +0 -3
- data/spec/ngrokapi/services/event_sources_client_spec.rb +33 -3
- data/spec/ngrokapi/services/event_streams_client_spec.rb +0 -3
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ip_whitelist_client_spec.rb +0 -3
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +0 -3
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +0 -3
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +0 -3
- data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +0 -1
- data/spec/spec_helper.rb +7 -0
- metadata +10 -7
- data/doc/.gitkeep +0 -0
- data/spec/ngrokapi/models/reserved_domain_cert_ns_target_spec.rb +0 -21
|
@@ -102,10 +102,7 @@
|
|
|
102
102
|
<h2>Overview</h2><div class="docstring">
|
|
103
103
|
<div class="discussion">
|
|
104
104
|
|
|
105
|
-
<p>An SSH Certificate Authority is a pair of an SSH Certificate and its private
|
|
106
|
-
|
|
107
|
-
<pre class="code ruby"><code class="ruby">key that can be used to sign other SSH host and user certificates.
|
|
108
|
-
</code></pre>
|
|
105
|
+
<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>
|
|
109
106
|
|
|
110
107
|
<p><a href="https://ngrok.com/docs/api#api-ssh-certificate-authorities">ngrok.com/docs/api#api-ssh-certificate-authorities</a></p>
|
|
111
108
|
|
|
@@ -374,6 +371,30 @@
|
|
|
374
371
|
<p>List all SSH Certificate Authorities on this account.</p>
|
|
375
372
|
</div></span>
|
|
376
373
|
|
|
374
|
+
</li>
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
<li class="public ">
|
|
378
|
+
<span class="summary_signature">
|
|
379
|
+
|
|
380
|
+
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
</span>
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
<span class="summary_desc"><div class='inline'>
|
|
395
|
+
<p>List all SSH Certificate Authorities on this account Throws an exception if API error.</p>
|
|
396
|
+
</div></span>
|
|
397
|
+
|
|
377
398
|
</li>
|
|
378
399
|
|
|
379
400
|
|
|
@@ -599,7 +620,7 @@
|
|
|
599
620
|
|
|
600
621
|
—
|
|
601
622
|
<div class='inline'>
|
|
602
|
-
<p>the type of private key to generate. one of
|
|
623
|
+
<p>the type of private key to generate. one of <code>rsa</code>, <code>ecdsa</code>, <code>ed25519</code></p>
|
|
603
624
|
</div>
|
|
604
625
|
|
|
605
626
|
</li>
|
|
@@ -635,7 +656,7 @@
|
|
|
635
656
|
|
|
636
657
|
—
|
|
637
658
|
<div class='inline'>
|
|
638
|
-
<p>the key size to use when creating an RSA key. one of
|
|
659
|
+
<p>the key size to use when creating an RSA key. one of <code>2048</code> or <code>4096</code></p>
|
|
639
660
|
</div>
|
|
640
661
|
|
|
641
662
|
</li>
|
|
@@ -1213,7 +1234,8 @@
|
|
|
1213
1234
|
150
|
|
1214
1235
|
151
|
|
1215
1236
|
152
|
|
1216
|
-
153
|
|
1237
|
+
153
|
|
1238
|
+
154</pre>
|
|
1217
1239
|
</td>
|
|
1218
1240
|
<td>
|
|
1219
1241
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 136</span>
|
|
@@ -1229,6 +1251,7 @@
|
|
|
1229
1251
|
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1230
1252
|
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient::PATH (constant)">PATH</a></span></span>
|
|
1231
1253
|
<span class='rparen'>)</span>
|
|
1254
|
+
|
|
1232
1255
|
<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>
|
|
1233
1256
|
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1234
1257
|
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
@@ -1239,6 +1262,151 @@
|
|
|
1239
1262
|
</td>
|
|
1240
1263
|
</tr>
|
|
1241
1264
|
</table>
|
|
1265
|
+
</div>
|
|
1266
|
+
|
|
1267
|
+
<div class="method_details ">
|
|
1268
|
+
<h3 class="signature " id="list!-instance_method">
|
|
1269
|
+
|
|
1270
|
+
#<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>
|
|
1271
|
+
|
|
1272
|
+
|
|
1273
|
+
|
|
1274
|
+
|
|
1275
|
+
|
|
1276
|
+
</h3><div class="docstring">
|
|
1277
|
+
<div class="discussion">
|
|
1278
|
+
|
|
1279
|
+
<p>List all SSH Certificate Authorities on this account Throws an exception if API error.</p>
|
|
1280
|
+
|
|
1281
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-certificate-authorities-list">ngrok.com/docs/api#api-ssh-certificate-authorities-list</a></p>
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
</div>
|
|
1285
|
+
</div>
|
|
1286
|
+
<div class="tags">
|
|
1287
|
+
<p class="tag_title">Parameters:</p>
|
|
1288
|
+
<ul class="param">
|
|
1289
|
+
|
|
1290
|
+
<li>
|
|
1291
|
+
|
|
1292
|
+
<span class='name'>before_id</span>
|
|
1293
|
+
|
|
1294
|
+
|
|
1295
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1296
|
+
|
|
1297
|
+
|
|
1298
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1299
|
+
|
|
1300
|
+
|
|
1301
|
+
</li>
|
|
1302
|
+
|
|
1303
|
+
<li>
|
|
1304
|
+
|
|
1305
|
+
<span class='name'>limit</span>
|
|
1306
|
+
|
|
1307
|
+
|
|
1308
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1309
|
+
|
|
1310
|
+
|
|
1311
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1312
|
+
|
|
1313
|
+
|
|
1314
|
+
</li>
|
|
1315
|
+
|
|
1316
|
+
<li>
|
|
1317
|
+
|
|
1318
|
+
<span class='name'>url</span>
|
|
1319
|
+
|
|
1320
|
+
|
|
1321
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1322
|
+
|
|
1323
|
+
|
|
1324
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1325
|
+
|
|
1326
|
+
|
|
1327
|
+
—
|
|
1328
|
+
<div class='inline'>
|
|
1329
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1330
|
+
</div>
|
|
1331
|
+
|
|
1332
|
+
</li>
|
|
1333
|
+
|
|
1334
|
+
</ul>
|
|
1335
|
+
|
|
1336
|
+
<p class="tag_title">Returns:</p>
|
|
1337
|
+
<ul class="return">
|
|
1338
|
+
|
|
1339
|
+
<li>
|
|
1340
|
+
|
|
1341
|
+
|
|
1342
|
+
<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>
|
|
1343
|
+
|
|
1344
|
+
|
|
1345
|
+
|
|
1346
|
+
—
|
|
1347
|
+
<div class='inline'>
|
|
1348
|
+
<p>result from the API request</p>
|
|
1349
|
+
</div>
|
|
1350
|
+
|
|
1351
|
+
</li>
|
|
1352
|
+
|
|
1353
|
+
</ul>
|
|
1354
|
+
|
|
1355
|
+
</div><table class="source_code">
|
|
1356
|
+
<tr>
|
|
1357
|
+
<td>
|
|
1358
|
+
<pre class="lines">
|
|
1359
|
+
|
|
1360
|
+
|
|
1361
|
+
166
|
|
1362
|
+
167
|
|
1363
|
+
168
|
|
1364
|
+
169
|
|
1365
|
+
170
|
|
1366
|
+
171
|
|
1367
|
+
172
|
|
1368
|
+
173
|
|
1369
|
+
174
|
|
1370
|
+
175
|
|
1371
|
+
176
|
|
1372
|
+
177
|
|
1373
|
+
178
|
|
1374
|
+
179
|
|
1375
|
+
180
|
|
1376
|
+
181
|
|
1377
|
+
182
|
|
1378
|
+
183
|
|
1379
|
+
184
|
|
1380
|
+
185
|
|
1381
|
+
186</pre>
|
|
1382
|
+
</td>
|
|
1383
|
+
<td>
|
|
1384
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 166</span>
|
|
1385
|
+
|
|
1386
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
|
|
1387
|
+
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1388
|
+
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1389
|
+
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1390
|
+
<span class='rparen'>)</span>
|
|
1391
|
+
<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>
|
|
1392
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1393
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1394
|
+
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1395
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1396
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient::PATH (constant)">PATH</a></span></span>
|
|
1397
|
+
<span class='rparen'>)</span>
|
|
1398
|
+
|
|
1399
|
+
<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>
|
|
1400
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1401
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1402
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1403
|
+
<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/SSHCertificateAuthority.html" title="NgrokAPI::Models::SSHCertificateAuthority (class)">SSHCertificateAuthority</a></span></span><span class='comma'>,</span>
|
|
1404
|
+
<span class='label'>danger:</span> <span class='kw'>true</span>
|
|
1405
|
+
<span class='rparen'>)</span>
|
|
1406
|
+
<span class='kw'>end</span></pre>
|
|
1407
|
+
</td>
|
|
1408
|
+
</tr>
|
|
1409
|
+
</table>
|
|
1242
1410
|
</div>
|
|
1243
1411
|
|
|
1244
1412
|
<div class="method_details ">
|
|
@@ -1340,24 +1508,24 @@
|
|
|
1340
1508
|
<pre class="lines">
|
|
1341
1509
|
|
|
1342
1510
|
|
|
1343
|
-
|
|
1344
|
-
|
|
1345
|
-
|
|
1346
|
-
|
|
1347
|
-
|
|
1348
|
-
|
|
1349
|
-
|
|
1350
|
-
|
|
1351
|
-
|
|
1352
|
-
|
|
1353
|
-
|
|
1354
|
-
|
|
1355
|
-
|
|
1356
|
-
|
|
1357
|
-
|
|
1511
|
+
197
|
|
1512
|
+
198
|
|
1513
|
+
199
|
|
1514
|
+
200
|
|
1515
|
+
201
|
|
1516
|
+
202
|
|
1517
|
+
203
|
|
1518
|
+
204
|
|
1519
|
+
205
|
|
1520
|
+
206
|
|
1521
|
+
207
|
|
1522
|
+
208
|
|
1523
|
+
209
|
|
1524
|
+
210
|
|
1525
|
+
211</pre>
|
|
1358
1526
|
</td>
|
|
1359
1527
|
<td>
|
|
1360
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line
|
|
1528
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 197</span>
|
|
1361
1529
|
|
|
1362
1530
|
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
|
|
1363
1531
|
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
@@ -1478,24 +1646,24 @@
|
|
|
1478
1646
|
<pre class="lines">
|
|
1479
1647
|
|
|
1480
1648
|
|
|
1481
|
-
|
|
1482
|
-
|
|
1483
|
-
|
|
1484
|
-
|
|
1485
|
-
|
|
1486
|
-
|
|
1487
|
-
|
|
1488
|
-
|
|
1489
|
-
|
|
1490
|
-
|
|
1491
|
-
|
|
1492
|
-
|
|
1493
|
-
|
|
1494
|
-
|
|
1495
|
-
|
|
1649
|
+
223
|
|
1650
|
+
224
|
|
1651
|
+
225
|
|
1652
|
+
226
|
|
1653
|
+
227
|
|
1654
|
+
228
|
|
1655
|
+
229
|
|
1656
|
+
230
|
|
1657
|
+
231
|
|
1658
|
+
232
|
|
1659
|
+
233
|
|
1660
|
+
234
|
|
1661
|
+
235
|
|
1662
|
+
236
|
|
1663
|
+
237</pre>
|
|
1496
1664
|
</td>
|
|
1497
1665
|
<td>
|
|
1498
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line
|
|
1666
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_certificate_authorities_client.rb', line 223</span>
|
|
1499
1667
|
|
|
1500
1668
|
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
|
|
1501
1669
|
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
@@ -1522,7 +1690,7 @@
|
|
|
1522
1690
|
</div>
|
|
1523
1691
|
|
|
1524
1692
|
<div id="footer">
|
|
1525
|
-
Generated on
|
|
1693
|
+
Generated on Tue Oct 19 15:48:26 2021 by
|
|
1526
1694
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1527
1695
|
0.9.26 (ruby-3.0.1).
|
|
1528
1696
|
</div>
|
|
@@ -102,10 +102,7 @@
|
|
|
102
102
|
<h2>Overview</h2><div class="docstring">
|
|
103
103
|
<div class="discussion">
|
|
104
104
|
|
|
105
|
-
<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels
|
|
106
|
-
|
|
107
|
-
<pre class="code ruby"><code class="ruby">via the ngrok SSH tunnel gateway.
|
|
108
|
-
</code></pre>
|
|
105
|
+
<p>SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.</p>
|
|
109
106
|
|
|
110
107
|
<p><a href="https://ngrok.com/docs/api#api-ssh-credentials">ngrok.com/docs/api#api-ssh-credentials</a></p>
|
|
111
108
|
|
|
@@ -374,6 +371,30 @@
|
|
|
374
371
|
<p>List all ssh credentials on this account.</p>
|
|
375
372
|
</div></span>
|
|
376
373
|
|
|
374
|
+
</li>
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
<li class="public ">
|
|
378
|
+
<span class="summary_signature">
|
|
379
|
+
|
|
380
|
+
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
</span>
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
<span class="summary_desc"><div class='inline'>
|
|
395
|
+
<p>List all ssh credentials on this account Throws an exception if API error.</p>
|
|
396
|
+
</div></span>
|
|
397
|
+
|
|
377
398
|
</li>
|
|
378
399
|
|
|
379
400
|
|
|
@@ -599,7 +620,7 @@
|
|
|
599
620
|
|
|
600
621
|
—
|
|
601
622
|
<div class='inline'>
|
|
602
|
-
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the
|
|
623
|
+
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
|
|
603
624
|
</div>
|
|
604
625
|
|
|
605
626
|
</li>
|
|
@@ -1189,7 +1210,8 @@
|
|
|
1189
1210
|
148
|
|
1190
1211
|
149
|
|
1191
1212
|
150
|
|
1192
|
-
151
|
|
1213
|
+
151
|
|
1214
|
+
152</pre>
|
|
1193
1215
|
</td>
|
|
1194
1216
|
<td>
|
|
1195
1217
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 134</span>
|
|
@@ -1205,6 +1227,7 @@
|
|
|
1205
1227
|
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1206
1228
|
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHCredentialsClient::PATH (constant)">PATH</a></span></span>
|
|
1207
1229
|
<span class='rparen'>)</span>
|
|
1230
|
+
|
|
1208
1231
|
<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>
|
|
1209
1232
|
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1210
1233
|
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
@@ -1215,6 +1238,151 @@
|
|
|
1215
1238
|
</td>
|
|
1216
1239
|
</tr>
|
|
1217
1240
|
</table>
|
|
1241
|
+
</div>
|
|
1242
|
+
|
|
1243
|
+
<div class="method_details ">
|
|
1244
|
+
<h3 class="signature " id="list!-instance_method">
|
|
1245
|
+
|
|
1246
|
+
#<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>
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
|
|
1250
|
+
|
|
1251
|
+
|
|
1252
|
+
</h3><div class="docstring">
|
|
1253
|
+
<div class="discussion">
|
|
1254
|
+
|
|
1255
|
+
<p>List all ssh credentials on this account Throws an exception if API error.</p>
|
|
1256
|
+
|
|
1257
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-credentials-list">ngrok.com/docs/api#api-ssh-credentials-list</a></p>
|
|
1258
|
+
|
|
1259
|
+
|
|
1260
|
+
</div>
|
|
1261
|
+
</div>
|
|
1262
|
+
<div class="tags">
|
|
1263
|
+
<p class="tag_title">Parameters:</p>
|
|
1264
|
+
<ul class="param">
|
|
1265
|
+
|
|
1266
|
+
<li>
|
|
1267
|
+
|
|
1268
|
+
<span class='name'>before_id</span>
|
|
1269
|
+
|
|
1270
|
+
|
|
1271
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1272
|
+
|
|
1273
|
+
|
|
1274
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1275
|
+
|
|
1276
|
+
|
|
1277
|
+
</li>
|
|
1278
|
+
|
|
1279
|
+
<li>
|
|
1280
|
+
|
|
1281
|
+
<span class='name'>limit</span>
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1285
|
+
|
|
1286
|
+
|
|
1287
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1288
|
+
|
|
1289
|
+
|
|
1290
|
+
</li>
|
|
1291
|
+
|
|
1292
|
+
<li>
|
|
1293
|
+
|
|
1294
|
+
<span class='name'>url</span>
|
|
1295
|
+
|
|
1296
|
+
|
|
1297
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1298
|
+
|
|
1299
|
+
|
|
1300
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1301
|
+
|
|
1302
|
+
|
|
1303
|
+
—
|
|
1304
|
+
<div class='inline'>
|
|
1305
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1306
|
+
</div>
|
|
1307
|
+
|
|
1308
|
+
</li>
|
|
1309
|
+
|
|
1310
|
+
</ul>
|
|
1311
|
+
|
|
1312
|
+
<p class="tag_title">Returns:</p>
|
|
1313
|
+
<ul class="return">
|
|
1314
|
+
|
|
1315
|
+
<li>
|
|
1316
|
+
|
|
1317
|
+
|
|
1318
|
+
<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>
|
|
1319
|
+
|
|
1320
|
+
|
|
1321
|
+
|
|
1322
|
+
—
|
|
1323
|
+
<div class='inline'>
|
|
1324
|
+
<p>result from the API request</p>
|
|
1325
|
+
</div>
|
|
1326
|
+
|
|
1327
|
+
</li>
|
|
1328
|
+
|
|
1329
|
+
</ul>
|
|
1330
|
+
|
|
1331
|
+
</div><table class="source_code">
|
|
1332
|
+
<tr>
|
|
1333
|
+
<td>
|
|
1334
|
+
<pre class="lines">
|
|
1335
|
+
|
|
1336
|
+
|
|
1337
|
+
164
|
|
1338
|
+
165
|
|
1339
|
+
166
|
|
1340
|
+
167
|
|
1341
|
+
168
|
|
1342
|
+
169
|
|
1343
|
+
170
|
|
1344
|
+
171
|
|
1345
|
+
172
|
|
1346
|
+
173
|
|
1347
|
+
174
|
|
1348
|
+
175
|
|
1349
|
+
176
|
|
1350
|
+
177
|
|
1351
|
+
178
|
|
1352
|
+
179
|
|
1353
|
+
180
|
|
1354
|
+
181
|
|
1355
|
+
182
|
|
1356
|
+
183
|
|
1357
|
+
184</pre>
|
|
1358
|
+
</td>
|
|
1359
|
+
<td>
|
|
1360
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 164</span>
|
|
1361
|
+
|
|
1362
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
|
|
1363
|
+
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1364
|
+
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1365
|
+
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1366
|
+
<span class='rparen'>)</span>
|
|
1367
|
+
<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>
|
|
1368
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1369
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1370
|
+
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1371
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1372
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHCredentialsClient::PATH (constant)">PATH</a></span></span>
|
|
1373
|
+
<span class='rparen'>)</span>
|
|
1374
|
+
|
|
1375
|
+
<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>
|
|
1376
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1377
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1378
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::SSHCredentialsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1379
|
+
<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/SSHCredential.html" title="NgrokAPI::Models::SSHCredential (class)">SSHCredential</a></span></span><span class='comma'>,</span>
|
|
1380
|
+
<span class='label'>danger:</span> <span class='kw'>true</span>
|
|
1381
|
+
<span class='rparen'>)</span>
|
|
1382
|
+
<span class='kw'>end</span></pre>
|
|
1383
|
+
</td>
|
|
1384
|
+
</tr>
|
|
1385
|
+
</table>
|
|
1218
1386
|
</div>
|
|
1219
1387
|
|
|
1220
1388
|
<div class="method_details ">
|
|
@@ -1302,7 +1470,7 @@
|
|
|
1302
1470
|
|
|
1303
1471
|
—
|
|
1304
1472
|
<div class='inline'>
|
|
1305
|
-
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the
|
|
1473
|
+
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
|
|
1306
1474
|
</div>
|
|
1307
1475
|
|
|
1308
1476
|
</li>
|
|
@@ -1334,26 +1502,26 @@
|
|
|
1334
1502
|
<pre class="lines">
|
|
1335
1503
|
|
|
1336
1504
|
|
|
1337
|
-
|
|
1338
|
-
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
|
|
1343
|
-
|
|
1344
|
-
|
|
1345
|
-
|
|
1346
|
-
|
|
1347
|
-
|
|
1348
|
-
|
|
1349
|
-
|
|
1350
|
-
|
|
1351
|
-
|
|
1352
|
-
|
|
1353
|
-
|
|
1505
|
+
196
|
|
1506
|
+
197
|
|
1507
|
+
198
|
|
1508
|
+
199
|
|
1509
|
+
200
|
|
1510
|
+
201
|
|
1511
|
+
202
|
|
1512
|
+
203
|
|
1513
|
+
204
|
|
1514
|
+
205
|
|
1515
|
+
206
|
|
1516
|
+
207
|
|
1517
|
+
208
|
|
1518
|
+
209
|
|
1519
|
+
210
|
|
1520
|
+
211
|
|
1521
|
+
212</pre>
|
|
1354
1522
|
</td>
|
|
1355
1523
|
<td>
|
|
1356
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line
|
|
1524
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 196</span>
|
|
1357
1525
|
|
|
1358
1526
|
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
|
|
1359
1527
|
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
@@ -1462,7 +1630,7 @@
|
|
|
1462
1630
|
|
|
1463
1631
|
—
|
|
1464
1632
|
<div class='inline'>
|
|
1465
|
-
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the
|
|
1633
|
+
<p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>'*'</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
|
|
1466
1634
|
</div>
|
|
1467
1635
|
|
|
1468
1636
|
</li>
|
|
@@ -1494,26 +1662,26 @@
|
|
|
1494
1662
|
<pre class="lines">
|
|
1495
1663
|
|
|
1496
1664
|
|
|
1497
|
-
|
|
1498
|
-
|
|
1499
|
-
|
|
1500
|
-
|
|
1501
|
-
|
|
1502
|
-
|
|
1503
|
-
|
|
1504
|
-
|
|
1505
|
-
|
|
1506
|
-
|
|
1507
|
-
|
|
1508
|
-
|
|
1509
|
-
|
|
1510
|
-
|
|
1511
|
-
|
|
1512
|
-
|
|
1513
|
-
|
|
1665
|
+
225
|
|
1666
|
+
226
|
|
1667
|
+
227
|
|
1668
|
+
228
|
|
1669
|
+
229
|
|
1670
|
+
230
|
|
1671
|
+
231
|
|
1672
|
+
232
|
|
1673
|
+
233
|
|
1674
|
+
234
|
|
1675
|
+
235
|
|
1676
|
+
236
|
|
1677
|
+
237
|
|
1678
|
+
238
|
|
1679
|
+
239
|
|
1680
|
+
240
|
|
1681
|
+
241</pre>
|
|
1514
1682
|
</td>
|
|
1515
1683
|
<td>
|
|
1516
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line
|
|
1684
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 225</span>
|
|
1517
1685
|
|
|
1518
1686
|
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
|
|
1519
1687
|
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
@@ -1542,7 +1710,7 @@
|
|
|
1542
1710
|
</div>
|
|
1543
1711
|
|
|
1544
1712
|
<div id="footer">
|
|
1545
|
-
Generated on
|
|
1713
|
+
Generated on Tue Oct 19 15:48:23 2021 by
|
|
1546
1714
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1547
1715
|
0.9.26 (ruby-3.0.1).
|
|
1548
1716
|
</div>
|