ngrok-api 0.9.0 → 0.16.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/.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,1680 @@
|
|
|
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::SSHHostCertificatesClient
|
|
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::SSHHostCertificatesClient";
|
|
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 (S)</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">SSHHostCertificatesClient</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::SSHHostCertificatesClient
|
|
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::SSHHostCertificatesClient</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/ssh_host_certificates_client.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.</p>
|
|
106
|
+
|
|
107
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-host-certificates">ngrok.com/docs/api#api-ssh-host-certificates</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="PATH-constant" class="">PATH =
|
|
125
|
+
<div class="docstring">
|
|
126
|
+
<div class="discussion">
|
|
127
|
+
|
|
128
|
+
<p>The API path for the requests</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'>/ssh_host_certificates</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
139
|
+
|
|
140
|
+
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
|
|
141
|
+
<div class="docstring">
|
|
142
|
+
<div class="discussion">
|
|
143
|
+
|
|
144
|
+
<p>The List Property from the resulting API for list calls</p>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
</div>
|
|
148
|
+
</div>
|
|
149
|
+
<div class="tags">
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
</div>
|
|
153
|
+
</dt>
|
|
154
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ssh_host_certificates</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="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(ssh_certificate_authority_id:, public_key:, principals: [], valid_after: "", valid_until: "", description: "", metadata: "") ⇒ NgrokAPI::Models::SSHHostCertificate </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>Create a new SSH Host Certificate.</p>
|
|
226
|
+
</div></span>
|
|
227
|
+
|
|
228
|
+
</li>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<li class="public ">
|
|
232
|
+
<span class="summary_signature">
|
|
233
|
+
|
|
234
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: "") ⇒ NgrokAPI::Models::Empty </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>Delete an SSH Host Certificate.</p>
|
|
250
|
+
</div></span>
|
|
251
|
+
|
|
252
|
+
</li>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
<li class="public ">
|
|
256
|
+
<span class="summary_signature">
|
|
257
|
+
|
|
258
|
+
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
</span>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
<span class="summary_desc"><div class='inline'>
|
|
273
|
+
<p>Delete an SSH Host Certificate Throws an exception if API error.</p>
|
|
274
|
+
</div></span>
|
|
275
|
+
|
|
276
|
+
</li>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
<li class="public ">
|
|
280
|
+
<span class="summary_signature">
|
|
281
|
+
|
|
282
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::SSHHostCertificate </a>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
</span>
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
<span class="summary_desc"><div class='inline'>
|
|
297
|
+
<p>Get detailed information about an SSH Host Certficate.</p>
|
|
298
|
+
</div></span>
|
|
299
|
+
|
|
300
|
+
</li>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
<li class="public ">
|
|
304
|
+
<span class="summary_signature">
|
|
305
|
+
|
|
306
|
+
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ NgrokAPI::Models::SSHHostCertificate </a>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
</span>
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
<span class="summary_desc"><div class='inline'>
|
|
321
|
+
<p>Get detailed information about an SSH Host Certficate Throws an exception if API error.</p>
|
|
322
|
+
</div></span>
|
|
323
|
+
|
|
324
|
+
</li>
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
<li class="public ">
|
|
328
|
+
<span class="summary_signature">
|
|
329
|
+
|
|
330
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒ SSHHostCertificatesClient </a>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
</span>
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
<span class="note title constructor">constructor</span>
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
<span class="summary_desc"><div class='inline'>
|
|
347
|
+
<p>A new instance of SSHHostCertificatesClient.</p>
|
|
348
|
+
</div></span>
|
|
349
|
+
|
|
350
|
+
</li>
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
<li class="public ">
|
|
354
|
+
<span class="summary_signature">
|
|
355
|
+
|
|
356
|
+
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
</span>
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
<span class="summary_desc"><div class='inline'>
|
|
371
|
+
<p>List all SSH Host Certificates issued on this account.</p>
|
|
372
|
+
</div></span>
|
|
373
|
+
|
|
374
|
+
</li>
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
<li class="public ">
|
|
378
|
+
<span class="summary_signature">
|
|
379
|
+
|
|
380
|
+
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
</span>
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
<span class="summary_desc"><div class='inline'>
|
|
395
|
+
<p>List all SSH Host Certificates issued on this account Throws an exception if API error.</p>
|
|
396
|
+
</div></span>
|
|
397
|
+
|
|
398
|
+
</li>
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
<li class="public ">
|
|
402
|
+
<span class="summary_signature">
|
|
403
|
+
|
|
404
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::SSHHostCertificate </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>Update an SSH Host Certificate.</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: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::SSHHostCertificate </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>Update an SSH Host Certificate Throws an exception if API error.</p>
|
|
444
|
+
</div></span>
|
|
445
|
+
|
|
446
|
+
</li>
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
</ul>
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
<div id="constructor_details" class="method_details_list">
|
|
453
|
+
<h2>Constructor Details</h2>
|
|
454
|
+
|
|
455
|
+
<div class="method_details first">
|
|
456
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
457
|
+
|
|
458
|
+
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::SSHHostCertificatesClient (class)">SSHHostCertificatesClient</a></span></tt>
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
</h3><div class="docstring">
|
|
465
|
+
<div class="discussion">
|
|
466
|
+
|
|
467
|
+
<p>Returns a new instance of SSHHostCertificatesClient.</p>
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
</div>
|
|
471
|
+
</div>
|
|
472
|
+
<div class="tags">
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
</div><table class="source_code">
|
|
476
|
+
<tr>
|
|
477
|
+
<td>
|
|
478
|
+
<pre class="lines">
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
19
|
|
482
|
+
20
|
|
483
|
+
21</pre>
|
|
484
|
+
</td>
|
|
485
|
+
<td>
|
|
486
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 19</span>
|
|
487
|
+
|
|
488
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
|
|
489
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
490
|
+
<span class='kw'>end</span></pre>
|
|
491
|
+
</td>
|
|
492
|
+
</tr>
|
|
493
|
+
</table>
|
|
494
|
+
</div>
|
|
495
|
+
|
|
496
|
+
</div>
|
|
497
|
+
|
|
498
|
+
<div id="instance_attr_details" class="attr_details">
|
|
499
|
+
<h2>Instance Attribute Details</h2>
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
<span id=""></span>
|
|
503
|
+
<div class="method_details first">
|
|
504
|
+
<h3 class="signature first" id="client-instance_method">
|
|
505
|
+
|
|
506
|
+
#<strong>client</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
</h3><div class="docstring">
|
|
513
|
+
<div class="discussion">
|
|
514
|
+
|
|
515
|
+
<p>Returns the value of attribute client.</p>
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
</div>
|
|
519
|
+
</div>
|
|
520
|
+
<div class="tags">
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
</div><table class="source_code">
|
|
524
|
+
<tr>
|
|
525
|
+
<td>
|
|
526
|
+
<pre class="lines">
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
17
|
|
530
|
+
18
|
|
531
|
+
19</pre>
|
|
532
|
+
</td>
|
|
533
|
+
<td>
|
|
534
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 17</span>
|
|
535
|
+
|
|
536
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
537
|
+
<span class='ivar'>@client</span>
|
|
538
|
+
<span class='kw'>end</span></pre>
|
|
539
|
+
</td>
|
|
540
|
+
</tr>
|
|
541
|
+
</table>
|
|
542
|
+
</div>
|
|
543
|
+
|
|
544
|
+
</div>
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
<div id="instance_method_details" class="method_details_list">
|
|
548
|
+
<h2>Instance Method Details</h2>
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
<div class="method_details first">
|
|
552
|
+
<h3 class="signature first" id="create-instance_method">
|
|
553
|
+
|
|
554
|
+
#<strong>create</strong>(ssh_certificate_authority_id:, public_key:, principals: [], valid_after: "", valid_until: "", description: "", metadata: "") ⇒ <tt><span class='object_link'><a href="../Models/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">NgrokAPI::Models::SSHHostCertificate</a></span></tt>
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
</h3><div class="docstring">
|
|
561
|
+
<div class="discussion">
|
|
562
|
+
|
|
563
|
+
<p>Create a new SSH Host Certificate</p>
|
|
564
|
+
|
|
565
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-host-certificates-create">ngrok.com/docs/api#api-ssh-host-certificates-create</a></p>
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
</div>
|
|
569
|
+
</div>
|
|
570
|
+
<div class="tags">
|
|
571
|
+
<p class="tag_title">Parameters:</p>
|
|
572
|
+
<ul class="param">
|
|
573
|
+
|
|
574
|
+
<li>
|
|
575
|
+
|
|
576
|
+
<span class='name'>ssh_certificate_authority_id</span>
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
—
|
|
584
|
+
<div class='inline'>
|
|
585
|
+
<p>the ssh certificate authority that is used to sign this ssh host certificate</p>
|
|
586
|
+
</div>
|
|
587
|
+
|
|
588
|
+
</li>
|
|
589
|
+
|
|
590
|
+
<li>
|
|
591
|
+
|
|
592
|
+
<span class='name'>public_key</span>
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
—
|
|
600
|
+
<div class='inline'>
|
|
601
|
+
<p>a public key in OpenSSH Authorized Keys format that this certificate signs</p>
|
|
602
|
+
</div>
|
|
603
|
+
|
|
604
|
+
</li>
|
|
605
|
+
|
|
606
|
+
<li>
|
|
607
|
+
|
|
608
|
+
<span class='name'>principals</span>
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
<em class="default">(defaults to: <tt>[]</tt>)</em>
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
—
|
|
618
|
+
<div class='inline'>
|
|
619
|
+
<p>the list of principals included in the ssh host certificate. This is the list of hostnames and/or IP addresses that are authorized to serve SSH traffic with this certificate. Dangerously, if no principals are specified, this certificate is considered valid for all hosts.</p>
|
|
620
|
+
</div>
|
|
621
|
+
|
|
622
|
+
</li>
|
|
623
|
+
|
|
624
|
+
<li>
|
|
625
|
+
|
|
626
|
+
<span class='name'>valid_after</span>
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
<span class='type'>(<tt>datetime (RFC3339 string)</tt>)</span>
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
—
|
|
636
|
+
<div class='inline'>
|
|
637
|
+
<p>The time when the host certificate becomes valid, in RFC 3339 format. Defaults to the current time if unspecified.</p>
|
|
638
|
+
</div>
|
|
639
|
+
|
|
640
|
+
</li>
|
|
641
|
+
|
|
642
|
+
<li>
|
|
643
|
+
|
|
644
|
+
<span class='name'>valid_until</span>
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
<span class='type'>(<tt>datetime (RFC3339 string)</tt>)</span>
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
—
|
|
654
|
+
<div class='inline'>
|
|
655
|
+
<p>The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of one year in the future will be used. The OpenSSH certificates RFC calls this <code>valid_before</code>.</p>
|
|
656
|
+
</div>
|
|
657
|
+
|
|
658
|
+
</li>
|
|
659
|
+
|
|
660
|
+
<li>
|
|
661
|
+
|
|
662
|
+
<span class='name'>description</span>
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
—
|
|
672
|
+
<div class='inline'>
|
|
673
|
+
<p>human-readable description of this SSH Host Certificate. optional, max 255 bytes.</p>
|
|
674
|
+
</div>
|
|
675
|
+
|
|
676
|
+
</li>
|
|
677
|
+
|
|
678
|
+
<li>
|
|
679
|
+
|
|
680
|
+
<span class='name'>metadata</span>
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
—
|
|
690
|
+
<div class='inline'>
|
|
691
|
+
<p>arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.</p>
|
|
692
|
+
</div>
|
|
693
|
+
|
|
694
|
+
</li>
|
|
695
|
+
|
|
696
|
+
</ul>
|
|
697
|
+
|
|
698
|
+
<p class="tag_title">Returns:</p>
|
|
699
|
+
<ul class="return">
|
|
700
|
+
|
|
701
|
+
<li>
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">NgrokAPI::Models::SSHHostCertificate</a></span></tt>)</span>
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
—
|
|
709
|
+
<div class='inline'>
|
|
710
|
+
<p>result from the API request</p>
|
|
711
|
+
</div>
|
|
712
|
+
|
|
713
|
+
</li>
|
|
714
|
+
|
|
715
|
+
</ul>
|
|
716
|
+
|
|
717
|
+
</div><table class="source_code">
|
|
718
|
+
<tr>
|
|
719
|
+
<td>
|
|
720
|
+
<pre class="lines">
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
36
|
|
724
|
+
37
|
|
725
|
+
38
|
|
726
|
+
39
|
|
727
|
+
40
|
|
728
|
+
41
|
|
729
|
+
42
|
|
730
|
+
43
|
|
731
|
+
44
|
|
732
|
+
45
|
|
733
|
+
46
|
|
734
|
+
47
|
|
735
|
+
48
|
|
736
|
+
49
|
|
737
|
+
50</pre>
|
|
738
|
+
</td>
|
|
739
|
+
<td>
|
|
740
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 36</span>
|
|
741
|
+
|
|
742
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>ssh_certificate_authority_id:</span><span class='comma'>,</span> <span class='label'>public_key:</span><span class='comma'>,</span> <span class='label'>principals:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>valid_after:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>valid_until:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
743
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ssh_host_certificates</span><span class='tstring_end'>'</span></span>
|
|
744
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
745
|
+
<span class='rbrace'>}</span>
|
|
746
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
747
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ssh_certificate_authority_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ssh_certificate_authority_id'>ssh_certificate_authority_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_ssh_certificate_authority_id'>ssh_certificate_authority_id</span>
|
|
748
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:public_key</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_public_key'>public_key</span> <span class='kw'>if</span> <span class='id identifier rubyid_public_key'>public_key</span>
|
|
749
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:principals</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_principals'>principals</span> <span class='kw'>if</span> <span class='id identifier rubyid_principals'>principals</span>
|
|
750
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:valid_after</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_valid_after'>valid_after</span> <span class='kw'>if</span> <span class='id identifier rubyid_valid_after'>valid_after</span>
|
|
751
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:valid_until</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_valid_until'>valid_until</span> <span class='kw'>if</span> <span class='id identifier rubyid_valid_until'>valid_until</span>
|
|
752
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
|
753
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
|
754
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
755
|
+
<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/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">SSHHostCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/SSHHostCertificate.html#initialize-instance_method" title="NgrokAPI::Models::SSHHostCertificate#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>
|
|
756
|
+
<span class='kw'>end</span></pre>
|
|
757
|
+
</td>
|
|
758
|
+
</tr>
|
|
759
|
+
</table>
|
|
760
|
+
</div>
|
|
761
|
+
|
|
762
|
+
<div class="method_details ">
|
|
763
|
+
<h3 class="signature " id="delete-instance_method">
|
|
764
|
+
|
|
765
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
</h3><div class="docstring">
|
|
772
|
+
<div class="discussion">
|
|
773
|
+
|
|
774
|
+
<p>Delete an SSH Host Certificate</p>
|
|
775
|
+
|
|
776
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-host-certificates-delete">ngrok.com/docs/api#api-ssh-host-certificates-delete</a></p>
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
</div>
|
|
780
|
+
</div>
|
|
781
|
+
<div class="tags">
|
|
782
|
+
<p class="tag_title">Parameters:</p>
|
|
783
|
+
<ul class="param">
|
|
784
|
+
|
|
785
|
+
<li>
|
|
786
|
+
|
|
787
|
+
<span class='name'>id</span>
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
—
|
|
797
|
+
<div class='inline'>
|
|
798
|
+
<p>a resource identifier</p>
|
|
799
|
+
</div>
|
|
800
|
+
|
|
801
|
+
</li>
|
|
802
|
+
|
|
803
|
+
</ul>
|
|
804
|
+
|
|
805
|
+
<p class="tag_title">Returns:</p>
|
|
806
|
+
<ul class="return">
|
|
807
|
+
|
|
808
|
+
<li>
|
|
809
|
+
|
|
810
|
+
|
|
811
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
—
|
|
816
|
+
<div class='inline'>
|
|
817
|
+
<p>result from the API request</p>
|
|
818
|
+
</div>
|
|
819
|
+
|
|
820
|
+
</li>
|
|
821
|
+
|
|
822
|
+
</ul>
|
|
823
|
+
|
|
824
|
+
</div><table class="source_code">
|
|
825
|
+
<tr>
|
|
826
|
+
<td>
|
|
827
|
+
<pre class="lines">
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
59
|
|
831
|
+
60
|
|
832
|
+
61
|
|
833
|
+
62
|
|
834
|
+
63
|
|
835
|
+
64
|
|
836
|
+
65</pre>
|
|
837
|
+
</td>
|
|
838
|
+
<td>
|
|
839
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 59</span>
|
|
840
|
+
|
|
841
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</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>
|
|
842
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ssh_host_certificates/%{id}</span><span class='tstring_end'>'</span></span>
|
|
843
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
844
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
845
|
+
<span class='rbrace'>}</span>
|
|
846
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='rparen'>)</span>
|
|
847
|
+
<span class='kw'>end</span></pre>
|
|
848
|
+
</td>
|
|
849
|
+
</tr>
|
|
850
|
+
</table>
|
|
851
|
+
</div>
|
|
852
|
+
|
|
853
|
+
<div class="method_details ">
|
|
854
|
+
<h3 class="signature " id="delete!-instance_method">
|
|
855
|
+
|
|
856
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
</h3><div class="docstring">
|
|
863
|
+
<div class="discussion">
|
|
864
|
+
|
|
865
|
+
<p>Delete an SSH Host Certificate Throws an exception if API error.</p>
|
|
866
|
+
|
|
867
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-host-certificates-delete">ngrok.com/docs/api#api-ssh-host-certificates-delete</a></p>
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
</div>
|
|
871
|
+
</div>
|
|
872
|
+
<div class="tags">
|
|
873
|
+
<p class="tag_title">Parameters:</p>
|
|
874
|
+
<ul class="param">
|
|
875
|
+
|
|
876
|
+
<li>
|
|
877
|
+
|
|
878
|
+
<span class='name'>id</span>
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
—
|
|
888
|
+
<div class='inline'>
|
|
889
|
+
<p>a resource identifier</p>
|
|
890
|
+
</div>
|
|
891
|
+
|
|
892
|
+
</li>
|
|
893
|
+
|
|
894
|
+
</ul>
|
|
895
|
+
|
|
896
|
+
<p class="tag_title">Returns:</p>
|
|
897
|
+
<ul class="return">
|
|
898
|
+
|
|
899
|
+
<li>
|
|
900
|
+
|
|
901
|
+
|
|
902
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
—
|
|
907
|
+
<div class='inline'>
|
|
908
|
+
<p>result from the API request</p>
|
|
909
|
+
</div>
|
|
910
|
+
|
|
911
|
+
</li>
|
|
912
|
+
|
|
913
|
+
</ul>
|
|
914
|
+
|
|
915
|
+
</div><table class="source_code">
|
|
916
|
+
<tr>
|
|
917
|
+
<td>
|
|
918
|
+
<pre class="lines">
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
75
|
|
922
|
+
76
|
|
923
|
+
77
|
|
924
|
+
78
|
|
925
|
+
79
|
|
926
|
+
80
|
|
927
|
+
81</pre>
|
|
928
|
+
</td>
|
|
929
|
+
<td>
|
|
930
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 75</span>
|
|
931
|
+
|
|
932
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</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>
|
|
933
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ssh_host_certificates/%{id}</span><span class='tstring_end'>'</span></span>
|
|
934
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
935
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
936
|
+
<span class='rbrace'>}</span>
|
|
937
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
938
|
+
<span class='kw'>end</span></pre>
|
|
939
|
+
</td>
|
|
940
|
+
</tr>
|
|
941
|
+
</table>
|
|
942
|
+
</div>
|
|
943
|
+
|
|
944
|
+
<div class="method_details ">
|
|
945
|
+
<h3 class="signature " id="get-instance_method">
|
|
946
|
+
|
|
947
|
+
#<strong>get</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">NgrokAPI::Models::SSHHostCertificate</a></span></tt>
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
|
|
952
|
+
|
|
953
|
+
</h3><div class="docstring">
|
|
954
|
+
<div class="discussion">
|
|
955
|
+
|
|
956
|
+
<p>Get detailed information about an SSH Host Certficate</p>
|
|
957
|
+
|
|
958
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-host-certificates-get">ngrok.com/docs/api#api-ssh-host-certificates-get</a></p>
|
|
959
|
+
|
|
960
|
+
|
|
961
|
+
</div>
|
|
962
|
+
</div>
|
|
963
|
+
<div class="tags">
|
|
964
|
+
<p class="tag_title">Parameters:</p>
|
|
965
|
+
<ul class="param">
|
|
966
|
+
|
|
967
|
+
<li>
|
|
968
|
+
|
|
969
|
+
<span class='name'>id</span>
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
973
|
+
|
|
974
|
+
|
|
975
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
—
|
|
979
|
+
<div class='inline'>
|
|
980
|
+
<p>a resource identifier</p>
|
|
981
|
+
</div>
|
|
982
|
+
|
|
983
|
+
</li>
|
|
984
|
+
|
|
985
|
+
</ul>
|
|
986
|
+
|
|
987
|
+
<p class="tag_title">Returns:</p>
|
|
988
|
+
<ul class="return">
|
|
989
|
+
|
|
990
|
+
<li>
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">NgrokAPI::Models::SSHHostCertificate</a></span></tt>)</span>
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
|
|
997
|
+
—
|
|
998
|
+
<div class='inline'>
|
|
999
|
+
<p>result from the API request</p>
|
|
1000
|
+
</div>
|
|
1001
|
+
|
|
1002
|
+
</li>
|
|
1003
|
+
|
|
1004
|
+
</ul>
|
|
1005
|
+
|
|
1006
|
+
</div><table class="source_code">
|
|
1007
|
+
<tr>
|
|
1008
|
+
<td>
|
|
1009
|
+
<pre class="lines">
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
90
|
|
1013
|
+
91
|
|
1014
|
+
92
|
|
1015
|
+
93
|
|
1016
|
+
94
|
|
1017
|
+
95
|
|
1018
|
+
96
|
|
1019
|
+
97
|
|
1020
|
+
98</pre>
|
|
1021
|
+
</td>
|
|
1022
|
+
<td>
|
|
1023
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 90</span>
|
|
1024
|
+
|
|
1025
|
+
<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>
|
|
1026
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ssh_host_certificates/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1027
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1028
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1029
|
+
<span class='rbrace'>}</span>
|
|
1030
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1031
|
+
<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>
|
|
1032
|
+
<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/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">SSHHostCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/SSHHostCertificate.html#initialize-instance_method" title="NgrokAPI::Models::SSHHostCertificate#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>
|
|
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="get!-instance_method">
|
|
1041
|
+
|
|
1042
|
+
#<strong>get!</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">NgrokAPI::Models::SSHHostCertificate</a></span></tt>
|
|
1043
|
+
|
|
1044
|
+
|
|
1045
|
+
|
|
1046
|
+
|
|
1047
|
+
|
|
1048
|
+
</h3><div class="docstring">
|
|
1049
|
+
<div class="discussion">
|
|
1050
|
+
|
|
1051
|
+
<p>Get detailed information about an SSH Host Certficate Throws an exception if API error.</p>
|
|
1052
|
+
|
|
1053
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-host-certificates-get">ngrok.com/docs/api#api-ssh-host-certificates-get</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><span class='object_link'><a href="../Models/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">NgrokAPI::Models::SSHHostCertificate</a></span></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
|
+
108
|
|
1108
|
+
109
|
|
1109
|
+
110
|
|
1110
|
+
111
|
|
1111
|
+
112
|
|
1112
|
+
113
|
|
1113
|
+
114
|
|
1114
|
+
115
|
|
1115
|
+
116</pre>
|
|
1116
|
+
</td>
|
|
1117
|
+
<td>
|
|
1118
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 108</span>
|
|
1119
|
+
|
|
1120
|
+
<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>
|
|
1121
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ssh_host_certificates/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1122
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1123
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1124
|
+
<span class='rbrace'>}</span>
|
|
1125
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1126
|
+
<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>
|
|
1127
|
+
<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/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">SSHHostCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/SSHHostCertificate.html#initialize-instance_method" title="NgrokAPI::Models::SSHHostCertificate#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>
|
|
1128
|
+
<span class='kw'>end</span></pre>
|
|
1129
|
+
</td>
|
|
1130
|
+
</tr>
|
|
1131
|
+
</table>
|
|
1132
|
+
</div>
|
|
1133
|
+
|
|
1134
|
+
<div class="method_details ">
|
|
1135
|
+
<h3 class="signature " id="list-instance_method">
|
|
1136
|
+
|
|
1137
|
+
#<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>
|
|
1138
|
+
|
|
1139
|
+
|
|
1140
|
+
|
|
1141
|
+
|
|
1142
|
+
|
|
1143
|
+
</h3><div class="docstring">
|
|
1144
|
+
<div class="discussion">
|
|
1145
|
+
|
|
1146
|
+
<p>List all SSH Host Certificates issued on this account</p>
|
|
1147
|
+
|
|
1148
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-host-certificates-list">ngrok.com/docs/api#api-ssh-host-certificates-list</a></p>
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
</div>
|
|
1152
|
+
</div>
|
|
1153
|
+
<div class="tags">
|
|
1154
|
+
<p class="tag_title">Parameters:</p>
|
|
1155
|
+
<ul class="param">
|
|
1156
|
+
|
|
1157
|
+
<li>
|
|
1158
|
+
|
|
1159
|
+
<span class='name'>before_id</span>
|
|
1160
|
+
|
|
1161
|
+
|
|
1162
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1163
|
+
|
|
1164
|
+
|
|
1165
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
</li>
|
|
1169
|
+
|
|
1170
|
+
<li>
|
|
1171
|
+
|
|
1172
|
+
<span class='name'>limit</span>
|
|
1173
|
+
|
|
1174
|
+
|
|
1175
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1176
|
+
|
|
1177
|
+
|
|
1178
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
</li>
|
|
1182
|
+
|
|
1183
|
+
<li>
|
|
1184
|
+
|
|
1185
|
+
<span class='name'>url</span>
|
|
1186
|
+
|
|
1187
|
+
|
|
1188
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1189
|
+
|
|
1190
|
+
|
|
1191
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1192
|
+
|
|
1193
|
+
|
|
1194
|
+
—
|
|
1195
|
+
<div class='inline'>
|
|
1196
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1197
|
+
</div>
|
|
1198
|
+
|
|
1199
|
+
</li>
|
|
1200
|
+
|
|
1201
|
+
</ul>
|
|
1202
|
+
|
|
1203
|
+
<p class="tag_title">Returns:</p>
|
|
1204
|
+
<ul class="return">
|
|
1205
|
+
|
|
1206
|
+
<li>
|
|
1207
|
+
|
|
1208
|
+
|
|
1209
|
+
<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>
|
|
1210
|
+
|
|
1211
|
+
|
|
1212
|
+
|
|
1213
|
+
—
|
|
1214
|
+
<div class='inline'>
|
|
1215
|
+
<p>result from the API request</p>
|
|
1216
|
+
</div>
|
|
1217
|
+
|
|
1218
|
+
</li>
|
|
1219
|
+
|
|
1220
|
+
</ul>
|
|
1221
|
+
|
|
1222
|
+
</div><table class="source_code">
|
|
1223
|
+
<tr>
|
|
1224
|
+
<td>
|
|
1225
|
+
<pre class="lines">
|
|
1226
|
+
|
|
1227
|
+
|
|
1228
|
+
127
|
|
1229
|
+
128
|
|
1230
|
+
129
|
|
1231
|
+
130
|
|
1232
|
+
131
|
|
1233
|
+
132
|
|
1234
|
+
133
|
|
1235
|
+
134
|
|
1236
|
+
135
|
|
1237
|
+
136
|
|
1238
|
+
137
|
|
1239
|
+
138
|
|
1240
|
+
139
|
|
1241
|
+
140
|
|
1242
|
+
141
|
|
1243
|
+
142</pre>
|
|
1244
|
+
</td>
|
|
1245
|
+
<td>
|
|
1246
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 127</span>
|
|
1247
|
+
|
|
1248
|
+
<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>
|
|
1249
|
+
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1250
|
+
<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>
|
|
1251
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1252
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1253
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1254
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHHostCertificatesClient::PATH (constant)">PATH</a></span></span>
|
|
1255
|
+
<span class='rparen'>)</span>
|
|
1256
|
+
|
|
1257
|
+
<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>
|
|
1258
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1259
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1260
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::SSHHostCertificatesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1261
|
+
<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/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">SSHHostCertificate</a></span></span>
|
|
1262
|
+
<span class='rparen'>)</span>
|
|
1263
|
+
<span class='kw'>end</span></pre>
|
|
1264
|
+
</td>
|
|
1265
|
+
</tr>
|
|
1266
|
+
</table>
|
|
1267
|
+
</div>
|
|
1268
|
+
|
|
1269
|
+
<div class="method_details ">
|
|
1270
|
+
<h3 class="signature " id="list!-instance_method">
|
|
1271
|
+
|
|
1272
|
+
#<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>
|
|
1273
|
+
|
|
1274
|
+
|
|
1275
|
+
|
|
1276
|
+
|
|
1277
|
+
|
|
1278
|
+
</h3><div class="docstring">
|
|
1279
|
+
<div class="discussion">
|
|
1280
|
+
|
|
1281
|
+
<p>List all SSH Host Certificates issued on this account Throws an exception if API error.</p>
|
|
1282
|
+
|
|
1283
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-host-certificates-list">ngrok.com/docs/api#api-ssh-host-certificates-list</a></p>
|
|
1284
|
+
|
|
1285
|
+
|
|
1286
|
+
</div>
|
|
1287
|
+
</div>
|
|
1288
|
+
<div class="tags">
|
|
1289
|
+
<p class="tag_title">Parameters:</p>
|
|
1290
|
+
<ul class="param">
|
|
1291
|
+
|
|
1292
|
+
<li>
|
|
1293
|
+
|
|
1294
|
+
<span class='name'>before_id</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
|
+
</li>
|
|
1304
|
+
|
|
1305
|
+
<li>
|
|
1306
|
+
|
|
1307
|
+
<span class='name'>limit</span>
|
|
1308
|
+
|
|
1309
|
+
|
|
1310
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1311
|
+
|
|
1312
|
+
|
|
1313
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
</li>
|
|
1317
|
+
|
|
1318
|
+
<li>
|
|
1319
|
+
|
|
1320
|
+
<span class='name'>url</span>
|
|
1321
|
+
|
|
1322
|
+
|
|
1323
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1324
|
+
|
|
1325
|
+
|
|
1326
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1327
|
+
|
|
1328
|
+
|
|
1329
|
+
—
|
|
1330
|
+
<div class='inline'>
|
|
1331
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1332
|
+
</div>
|
|
1333
|
+
|
|
1334
|
+
</li>
|
|
1335
|
+
|
|
1336
|
+
</ul>
|
|
1337
|
+
|
|
1338
|
+
<p class="tag_title">Returns:</p>
|
|
1339
|
+
<ul class="return">
|
|
1340
|
+
|
|
1341
|
+
<li>
|
|
1342
|
+
|
|
1343
|
+
|
|
1344
|
+
<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>
|
|
1345
|
+
|
|
1346
|
+
|
|
1347
|
+
|
|
1348
|
+
—
|
|
1349
|
+
<div class='inline'>
|
|
1350
|
+
<p>result from the API request</p>
|
|
1351
|
+
</div>
|
|
1352
|
+
|
|
1353
|
+
</li>
|
|
1354
|
+
|
|
1355
|
+
</ul>
|
|
1356
|
+
|
|
1357
|
+
</div><table class="source_code">
|
|
1358
|
+
<tr>
|
|
1359
|
+
<td>
|
|
1360
|
+
<pre class="lines">
|
|
1361
|
+
|
|
1362
|
+
|
|
1363
|
+
154
|
|
1364
|
+
155
|
|
1365
|
+
156
|
|
1366
|
+
157
|
|
1367
|
+
158
|
|
1368
|
+
159
|
|
1369
|
+
160
|
|
1370
|
+
161
|
|
1371
|
+
162
|
|
1372
|
+
163
|
|
1373
|
+
164
|
|
1374
|
+
165
|
|
1375
|
+
166
|
|
1376
|
+
167
|
|
1377
|
+
168
|
|
1378
|
+
169
|
|
1379
|
+
170
|
|
1380
|
+
171</pre>
|
|
1381
|
+
</td>
|
|
1382
|
+
<td>
|
|
1383
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 154</span>
|
|
1384
|
+
|
|
1385
|
+
<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>
|
|
1386
|
+
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1387
|
+
<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>
|
|
1388
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1389
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1390
|
+
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1391
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1392
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SSHHostCertificatesClient::PATH (constant)">PATH</a></span></span>
|
|
1393
|
+
<span class='rparen'>)</span>
|
|
1394
|
+
|
|
1395
|
+
<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>
|
|
1396
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1397
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1398
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::SSHHostCertificatesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1399
|
+
<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/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">SSHHostCertificate</a></span></span><span class='comma'>,</span>
|
|
1400
|
+
<span class='label'>danger:</span> <span class='kw'>true</span>
|
|
1401
|
+
<span class='rparen'>)</span>
|
|
1402
|
+
<span class='kw'>end</span></pre>
|
|
1403
|
+
</td>
|
|
1404
|
+
</tr>
|
|
1405
|
+
</table>
|
|
1406
|
+
</div>
|
|
1407
|
+
|
|
1408
|
+
<div class="method_details ">
|
|
1409
|
+
<h3 class="signature " id="update-instance_method">
|
|
1410
|
+
|
|
1411
|
+
#<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ <tt><span class='object_link'><a href="../Models/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">NgrokAPI::Models::SSHHostCertificate</a></span></tt>
|
|
1412
|
+
|
|
1413
|
+
|
|
1414
|
+
|
|
1415
|
+
|
|
1416
|
+
|
|
1417
|
+
</h3><div class="docstring">
|
|
1418
|
+
<div class="discussion">
|
|
1419
|
+
|
|
1420
|
+
<p>Update an SSH Host Certificate</p>
|
|
1421
|
+
|
|
1422
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-host-certificates-update">ngrok.com/docs/api#api-ssh-host-certificates-update</a></p>
|
|
1423
|
+
|
|
1424
|
+
|
|
1425
|
+
</div>
|
|
1426
|
+
</div>
|
|
1427
|
+
<div class="tags">
|
|
1428
|
+
<p class="tag_title">Parameters:</p>
|
|
1429
|
+
<ul class="param">
|
|
1430
|
+
|
|
1431
|
+
<li>
|
|
1432
|
+
|
|
1433
|
+
<span class='name'>id</span>
|
|
1434
|
+
|
|
1435
|
+
|
|
1436
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1437
|
+
|
|
1438
|
+
|
|
1439
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1440
|
+
|
|
1441
|
+
|
|
1442
|
+
</li>
|
|
1443
|
+
|
|
1444
|
+
<li>
|
|
1445
|
+
|
|
1446
|
+
<span class='name'>description</span>
|
|
1447
|
+
|
|
1448
|
+
|
|
1449
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1450
|
+
|
|
1451
|
+
|
|
1452
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1453
|
+
|
|
1454
|
+
|
|
1455
|
+
—
|
|
1456
|
+
<div class='inline'>
|
|
1457
|
+
<p>human-readable description of this SSH Host Certificate. optional, max 255 bytes.</p>
|
|
1458
|
+
</div>
|
|
1459
|
+
|
|
1460
|
+
</li>
|
|
1461
|
+
|
|
1462
|
+
<li>
|
|
1463
|
+
|
|
1464
|
+
<span class='name'>metadata</span>
|
|
1465
|
+
|
|
1466
|
+
|
|
1467
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1468
|
+
|
|
1469
|
+
|
|
1470
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1471
|
+
|
|
1472
|
+
|
|
1473
|
+
—
|
|
1474
|
+
<div class='inline'>
|
|
1475
|
+
<p>arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.</p>
|
|
1476
|
+
</div>
|
|
1477
|
+
|
|
1478
|
+
</li>
|
|
1479
|
+
|
|
1480
|
+
</ul>
|
|
1481
|
+
|
|
1482
|
+
<p class="tag_title">Returns:</p>
|
|
1483
|
+
<ul class="return">
|
|
1484
|
+
|
|
1485
|
+
<li>
|
|
1486
|
+
|
|
1487
|
+
|
|
1488
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">NgrokAPI::Models::SSHHostCertificate</a></span></tt>)</span>
|
|
1489
|
+
|
|
1490
|
+
|
|
1491
|
+
|
|
1492
|
+
—
|
|
1493
|
+
<div class='inline'>
|
|
1494
|
+
<p>result from the API request</p>
|
|
1495
|
+
</div>
|
|
1496
|
+
|
|
1497
|
+
</li>
|
|
1498
|
+
|
|
1499
|
+
</ul>
|
|
1500
|
+
|
|
1501
|
+
</div><table class="source_code">
|
|
1502
|
+
<tr>
|
|
1503
|
+
<td>
|
|
1504
|
+
<pre class="lines">
|
|
1505
|
+
|
|
1506
|
+
|
|
1507
|
+
182
|
|
1508
|
+
183
|
|
1509
|
+
184
|
|
1510
|
+
185
|
|
1511
|
+
186
|
|
1512
|
+
187
|
|
1513
|
+
188
|
|
1514
|
+
189
|
|
1515
|
+
190
|
|
1516
|
+
191
|
|
1517
|
+
192</pre>
|
|
1518
|
+
</td>
|
|
1519
|
+
<td>
|
|
1520
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 182</span>
|
|
1521
|
+
|
|
1522
|
+
<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'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1523
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ssh_host_certificates/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1524
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1525
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1526
|
+
<span class='rbrace'>}</span>
|
|
1527
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1528
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
|
1529
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
|
1530
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
1531
|
+
<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/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">SSHHostCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/SSHHostCertificate.html#initialize-instance_method" title="NgrokAPI::Models::SSHHostCertificate#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>
|
|
1532
|
+
<span class='kw'>end</span></pre>
|
|
1533
|
+
</td>
|
|
1534
|
+
</tr>
|
|
1535
|
+
</table>
|
|
1536
|
+
</div>
|
|
1537
|
+
|
|
1538
|
+
<div class="method_details ">
|
|
1539
|
+
<h3 class="signature " id="update!-instance_method">
|
|
1540
|
+
|
|
1541
|
+
#<strong>update!</strong>(id: "", description: nil, metadata: nil) ⇒ <tt><span class='object_link'><a href="../Models/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">NgrokAPI::Models::SSHHostCertificate</a></span></tt>
|
|
1542
|
+
|
|
1543
|
+
|
|
1544
|
+
|
|
1545
|
+
|
|
1546
|
+
|
|
1547
|
+
</h3><div class="docstring">
|
|
1548
|
+
<div class="discussion">
|
|
1549
|
+
|
|
1550
|
+
<p>Update an SSH Host Certificate Throws an exception if API error.</p>
|
|
1551
|
+
|
|
1552
|
+
<p><a href="https://ngrok.com/docs/api#api-ssh-host-certificates-update">ngrok.com/docs/api#api-ssh-host-certificates-update</a></p>
|
|
1553
|
+
|
|
1554
|
+
|
|
1555
|
+
</div>
|
|
1556
|
+
</div>
|
|
1557
|
+
<div class="tags">
|
|
1558
|
+
<p class="tag_title">Parameters:</p>
|
|
1559
|
+
<ul class="param">
|
|
1560
|
+
|
|
1561
|
+
<li>
|
|
1562
|
+
|
|
1563
|
+
<span class='name'>id</span>
|
|
1564
|
+
|
|
1565
|
+
|
|
1566
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1567
|
+
|
|
1568
|
+
|
|
1569
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1570
|
+
|
|
1571
|
+
|
|
1572
|
+
</li>
|
|
1573
|
+
|
|
1574
|
+
<li>
|
|
1575
|
+
|
|
1576
|
+
<span class='name'>description</span>
|
|
1577
|
+
|
|
1578
|
+
|
|
1579
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1580
|
+
|
|
1581
|
+
|
|
1582
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1583
|
+
|
|
1584
|
+
|
|
1585
|
+
—
|
|
1586
|
+
<div class='inline'>
|
|
1587
|
+
<p>human-readable description of this SSH Host Certificate. optional, max 255 bytes.</p>
|
|
1588
|
+
</div>
|
|
1589
|
+
|
|
1590
|
+
</li>
|
|
1591
|
+
|
|
1592
|
+
<li>
|
|
1593
|
+
|
|
1594
|
+
<span class='name'>metadata</span>
|
|
1595
|
+
|
|
1596
|
+
|
|
1597
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1598
|
+
|
|
1599
|
+
|
|
1600
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1601
|
+
|
|
1602
|
+
|
|
1603
|
+
—
|
|
1604
|
+
<div class='inline'>
|
|
1605
|
+
<p>arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.</p>
|
|
1606
|
+
</div>
|
|
1607
|
+
|
|
1608
|
+
</li>
|
|
1609
|
+
|
|
1610
|
+
</ul>
|
|
1611
|
+
|
|
1612
|
+
<p class="tag_title">Returns:</p>
|
|
1613
|
+
<ul class="return">
|
|
1614
|
+
|
|
1615
|
+
<li>
|
|
1616
|
+
|
|
1617
|
+
|
|
1618
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">NgrokAPI::Models::SSHHostCertificate</a></span></tt>)</span>
|
|
1619
|
+
|
|
1620
|
+
|
|
1621
|
+
|
|
1622
|
+
—
|
|
1623
|
+
<div class='inline'>
|
|
1624
|
+
<p>result from the API request</p>
|
|
1625
|
+
</div>
|
|
1626
|
+
|
|
1627
|
+
</li>
|
|
1628
|
+
|
|
1629
|
+
</ul>
|
|
1630
|
+
|
|
1631
|
+
</div><table class="source_code">
|
|
1632
|
+
<tr>
|
|
1633
|
+
<td>
|
|
1634
|
+
<pre class="lines">
|
|
1635
|
+
|
|
1636
|
+
|
|
1637
|
+
204
|
|
1638
|
+
205
|
|
1639
|
+
206
|
|
1640
|
+
207
|
|
1641
|
+
208
|
|
1642
|
+
209
|
|
1643
|
+
210
|
|
1644
|
+
211
|
|
1645
|
+
212
|
|
1646
|
+
213
|
|
1647
|
+
214</pre>
|
|
1648
|
+
</td>
|
|
1649
|
+
<td>
|
|
1650
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ssh_host_certificates_client.rb', line 204</span>
|
|
1651
|
+
|
|
1652
|
+
<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'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1653
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ssh_host_certificates/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1654
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1655
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1656
|
+
<span class='rbrace'>}</span>
|
|
1657
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1658
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
|
1659
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
|
1660
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
1661
|
+
<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/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">SSHHostCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/SSHHostCertificate.html#initialize-instance_method" title="NgrokAPI::Models::SSHHostCertificate#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>
|
|
1662
|
+
<span class='kw'>end</span></pre>
|
|
1663
|
+
</td>
|
|
1664
|
+
</tr>
|
|
1665
|
+
</table>
|
|
1666
|
+
</div>
|
|
1667
|
+
|
|
1668
|
+
</div>
|
|
1669
|
+
|
|
1670
|
+
</div>
|
|
1671
|
+
|
|
1672
|
+
<div id="footer">
|
|
1673
|
+
Generated on Thu Dec 2 18:48:56 2021 by
|
|
1674
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1675
|
+
0.9.27 (ruby-3.0.1).
|
|
1676
|
+
</div>
|
|
1677
|
+
|
|
1678
|
+
</div>
|
|
1679
|
+
</body>
|
|
1680
|
+
</html>
|