Search.setIndex({docnames:["abuse_reports","api_keys","certificate_authorities","client","credentials","datatypes","endpoint_circuit_breaker_module","endpoint_compression_module","endpoint_configurations","endpoint_ip_policy_module","endpoint_logging_module","endpoint_mutual_tls_module","endpoint_o_auth_module","endpoint_oidc_module","endpoint_request_headers_module","endpoint_response_headers_module","endpoint_saml_module","endpoint_tls_termination_module","endpoint_webhook_validation_module","errors","event_destinations","event_sources","event_streams","event_subscriptions","index","ip_policies","ip_policy_rules","ip_restrictions","ip_whitelist","reserved_addrs","reserved_domains","ssh_certificate_authorities","ssh_credentials","ssh_host_certificates","ssh_user_certificates","tls_certificates","tunnel_sessions","tunnels"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.viewcode":1,sphinx:56},filenames:["abuse_reports.rst","api_keys.rst","certificate_authorities.rst","client.rst","credentials.rst","datatypes.rst","endpoint_circuit_breaker_module.rst","endpoint_compression_module.rst","endpoint_configurations.rst","endpoint_ip_policy_module.rst","endpoint_logging_module.rst","endpoint_mutual_tls_module.rst","endpoint_o_auth_module.rst","endpoint_oidc_module.rst","endpoint_request_headers_module.rst","endpoint_response_headers_module.rst","endpoint_saml_module.rst","endpoint_tls_termination_module.rst","endpoint_webhook_validation_module.rst","errors.rst","event_destinations.rst","event_sources.rst","event_streams.rst","event_subscriptions.rst","index.rst","ip_policies.rst","ip_policy_rules.rst","ip_restrictions.rst","ip_whitelist.rst","reserved_addrs.rst","reserved_domains.rst","ssh_certificate_authorities.rst","ssh_credentials.rst","ssh_host_certificates.rst","ssh_user_certificates.rst","tls_certificates.rst","tunnel_sessions.rst","tunnels.rst"],objects:{"":{ngrok:[19,0,0,"-"]},"ngrok.Client":{abuse_reports:[3,2,1,""],api_keys:[3,2,1,""],certificate_authorities:[3,2,1,""],credentials:[3,2,1,""],endpoint_configurations:[3,2,1,""],event_destinations:[3,2,1,""],event_sources:[3,2,1,""],event_streams:[3,2,1,""],event_subscriptions:[3,2,1,""],ip_policies:[3,2,1,""],ip_policy_rules:[3,2,1,""],ip_restrictions:[3,2,1,""],ip_whitelist:[3,2,1,""],pointcfg_module:[3,2,1,""],reserved_addrs:[3,2,1,""],reserved_domains:[3,2,1,""],ssh_certificate_authorities:[3,2,1,""],ssh_credentials:[3,2,1,""],ssh_host_certificates:[3,2,1,""],ssh_user_certificates:[3,2,1,""],tls_certificates:[3,2,1,""],tunnel_sessions:[3,2,1,""],tunnels:[3,2,1,""]},"ngrok.Error":{operation_id:[19,2,1,""]},"ngrok.datatypes":{APIKey:[5,1,1,""],APIKeyList:[5,1,1,""],AWSAuth:[5,1,1,""],AWSCredentials:[5,1,1,""],AWSRole:[5,1,1,""],AbuseReport:[5,1,1,""],AbuseReportHostname:[5,1,1,""],CertificateAuthority:[5,1,1,""],CertificateAuthorityList:[5,1,1,""],Credential:[5,1,1,""],CredentialList:[5,1,1,""],EndpointCircuitBreaker:[5,1,1,""],EndpointCompression:[5,1,1,""],EndpointConfiguration:[5,1,1,""],EndpointConfigurationList:[5,1,1,""],EndpointIPPolicy:[5,1,1,""],EndpointIPPolicyMutate:[5,1,1,""],EndpointLogging:[5,1,1,""],EndpointLoggingMutate:[5,1,1,""],EndpointMutualTLS:[5,1,1,""],EndpointMutualTLSMutate:[5,1,1,""],EndpointOAuth:[5,1,1,""],EndpointOAuthFacebook:[5,1,1,""],EndpointOAuthGitHub:[5,1,1,""],EndpointOAuthGoogle:[5,1,1,""],EndpointOAuthMicrosoft:[5,1,1,""],EndpointOAuthProvider:[5,1,1,""],EndpointOIDC:[5,1,1,""],EndpointRequestHeaders:[5,1,1,""],EndpointResponseHeaders:[5,1,1,""],EndpointSAML:[5,1,1,""],EndpointSAMLMutate:[5,1,1,""],EndpointTLSTermination:[5,1,1,""],EndpointWebhookValidation:[5,1,1,""],EventDestination:[5,1,1,""],EventDestinationList:[5,1,1,""],EventSource:[5,1,1,""],EventSourceList:[5,1,1,""],EventSourceReplace:[5,1,1,""],EventStream:[5,1,1,""],EventStreamList:[5,1,1,""],EventSubscription:[5,1,1,""],EventSubscriptionList:[5,1,1,""],EventTarget:[5,1,1,""],EventTargetCloudwatchLogs:[5,1,1,""],EventTargetFirehose:[5,1,1,""],EventTargetKinesis:[5,1,1,""],IPPolicy:[5,1,1,""],IPPolicyList:[5,1,1,""],IPPolicyRule:[5,1,1,""],IPPolicyRuleList:[5,1,1,""],IPRestriction:[5,1,1,""],IPRestrictionList:[5,1,1,""],IPWhitelistEntry:[5,1,1,""],IPWhitelistEntryList:[5,1,1,""],Ref:[5,1,1,""],ReservedAddr:[5,1,1,""],ReservedAddrList:[5,1,1,""],ReservedDomain:[5,1,1,""],ReservedDomainCertJob:[5,1,1,""],ReservedDomainCertNSTarget:[5,1,1,""],ReservedDomainCertPolicy:[5,1,1,""],ReservedDomainCertStatus:[5,1,1,""],ReservedDomainList:[5,1,1,""],SSHCertificateAuthority:[5,1,1,""],SSHCertificateAuthorityList:[5,1,1,""],SSHCredential:[5,1,1,""],SSHCredentialList:[5,1,1,""],SSHHostCertificate:[5,1,1,""],SSHHostCertificateList:[5,1,1,""],SSHUserCertificate:[5,1,1,""],SSHUserCertificateList:[5,1,1,""],TLSCertificate:[5,1,1,""],TLSCertificateList:[5,1,1,""],TLSCertificateSANs:[5,1,1,""],Tunnel:[5,1,1,""],TunnelList:[5,1,1,""],TunnelSession:[5,1,1,""],TunnelSessionList:[5,1,1,""]},"ngrok.datatypes.APIKey":{"delete":[5,2,1,""],created_at:[5,2,1,""],description:[5,2,1,""],id:[5,2,1,""],metadata:[5,2,1,""],token:[5,2,1,""],update:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.APIKeyList":{keys:[5,2,1,""],next_page_uri:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.AWSAuth":{creds:[5,2,1,""],role:[5,2,1,""]},"ngrok.datatypes.AWSCredentials":{aws_access_key_id:[5,2,1,""],aws_secret_access_key:[5,2,1,""]},"ngrok.datatypes.AWSRole":{role_arn:[5,2,1,""]},"ngrok.datatypes.AbuseReport":{created_at:[5,2,1,""],hostnames:[5,2,1,""],id:[5,2,1,""],metadata:[5,2,1,""],status:[5,2,1,""],uri:[5,2,1,""],urls:[5,2,1,""]},"ngrok.datatypes.AbuseReportHostname":{hostname:[5,2,1,""],status:[5,2,1,""]},"ngrok.datatypes.CertificateAuthority":{"delete":[5,2,1,""],ca_pem:[5,2,1,""],created_at:[5,2,1,""],description:[5,2,1,""],extended_key_usages:[5,2,1,""],id:[5,2,1,""],key_usages:[5,2,1,""],metadata:[5,2,1,""],not_after:[5,2,1,""],not_before:[5,2,1,""],subject_common_name:[5,2,1,""],update:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.CertificateAuthorityList":{certificate_authorities:[5,2,1,""],next_page_uri:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.Credential":{"delete":[5,2,1,""],acl:[5,2,1,""],created_at:[5,2,1,""],description:[5,2,1,""],id:[5,2,1,""],metadata:[5,2,1,""],token:[5,2,1,""],update:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.CredentialList":{credentials:[5,2,1,""],next_page_uri:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.EndpointCircuitBreaker":{enabled:[5,2,1,""],error_threshold_percentage:[5,2,1,""],num_buckets:[5,2,1,""],rolling_window:[5,2,1,""],tripped_duration:[5,2,1,""],volume_threshold:[5,2,1,""]},"ngrok.datatypes.EndpointCompression":{enabled:[5,2,1,""]},"ngrok.datatypes.EndpointConfiguration":{"delete":[5,2,1,""],circuit_breaker:[5,2,1,""],compression:[5,2,1,""],created_at:[5,2,1,""],description:[5,2,1,""],id:[5,2,1,""],ip_policy:[5,2,1,""],logging:[5,2,1,""],metadata:[5,2,1,""],mutual_tls:[5,2,1,""],oauth:[5,2,1,""],oidc:[5,2,1,""],request_headers:[5,2,1,""],response_headers:[5,2,1,""],saml:[5,2,1,""],tls_termination:[5,2,1,""],type:[5,2,1,""],update:[5,2,1,""],uri:[5,2,1,""],webhook_validation:[5,2,1,""]},"ngrok.datatypes.EndpointConfigurationList":{endpoint_configurations:[5,2,1,""],next_page_uri:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.EndpointIPPolicy":{enabled:[5,2,1,""],ip_policies:[5,2,1,""]},"ngrok.datatypes.EndpointIPPolicyMutate":{enabled:[5,2,1,""],ip_policy_ids:[5,2,1,""]},"ngrok.datatypes.EndpointLogging":{enabled:[5,2,1,""],event_streams:[5,2,1,""]},"ngrok.datatypes.EndpointLoggingMutate":{enabled:[5,2,1,""],event_stream_ids:[5,2,1,""]},"ngrok.datatypes.EndpointMutualTLS":{certificate_authorities:[5,2,1,""],enabled:[5,2,1,""]},"ngrok.datatypes.EndpointMutualTLSMutate":{certificate_authority_ids:[5,2,1,""],enabled:[5,2,1,""]},"ngrok.datatypes.EndpointOAuth":{auth_check_interval:[5,2,1,""],cookie_prefix:[5,2,1,""],enabled:[5,2,1,""],inactivity_timeout:[5,2,1,""],maximum_duration:[5,2,1,""],options_passthrough:[5,2,1,""],provider:[5,2,1,""]},"ngrok.datatypes.EndpointOAuthFacebook":{client_id:[5,2,1,""],client_secret:[5,2,1,""],email_addresses:[5,2,1,""],email_domains:[5,2,1,""],scopes:[5,2,1,""]},"ngrok.datatypes.EndpointOAuthGitHub":{client_id:[5,2,1,""],client_secret:[5,2,1,""],email_addresses:[5,2,1,""],email_domains:[5,2,1,""],organizations:[5,2,1,""],scopes:[5,2,1,""],teams:[5,2,1,""]},"ngrok.datatypes.EndpointOAuthGoogle":{client_id:[5,2,1,""],client_secret:[5,2,1,""],email_addresses:[5,2,1,""],email_domains:[5,2,1,""],scopes:[5,2,1,""]},"ngrok.datatypes.EndpointOAuthMicrosoft":{client_id:[5,2,1,""],client_secret:[5,2,1,""],email_addresses:[5,2,1,""],email_domains:[5,2,1,""],scopes:[5,2,1,""]},"ngrok.datatypes.EndpointOAuthProvider":{facebook:[5,2,1,""],github:[5,2,1,""],google:[5,2,1,""],microsoft:[5,2,1,""]},"ngrok.datatypes.EndpointOIDC":{client_id:[5,2,1,""],client_secret:[5,2,1,""],cookie_prefix:[5,2,1,""],enabled:[5,2,1,""],inactivity_timeout:[5,2,1,""],issuer:[5,2,1,""],maximum_duration:[5,2,1,""],options_passthrough:[5,2,1,""],scopes:[5,2,1,""]},"ngrok.datatypes.EndpointRequestHeaders":{add:[5,2,1,""],enabled:[5,2,1,""],remove:[5,2,1,""]},"ngrok.datatypes.EndpointResponseHeaders":{add:[5,2,1,""],enabled:[5,2,1,""],remove:[5,2,1,""]},"ngrok.datatypes.EndpointSAML":{allow_idp_initiated:[5,2,1,""],assertion_consumer_service_url:[5,2,1,""],authorized_groups:[5,2,1,""],cookie_prefix:[5,2,1,""],enabled:[5,2,1,""],entity_id:[5,2,1,""],force_authn:[5,2,1,""],idp_metadata:[5,2,1,""],inactivity_timeout:[5,2,1,""],maximum_duration:[5,2,1,""],metadata_url:[5,2,1,""],nameid_format:[5,2,1,""],options_passthrough:[5,2,1,""],request_signing_certificate_pem:[5,2,1,""],single_logout_url:[5,2,1,""]},"ngrok.datatypes.EndpointSAMLMutate":{allow_idp_initiated:[5,2,1,""],authorized_groups:[5,2,1,""],cookie_prefix:[5,2,1,""],enabled:[5,2,1,""],force_authn:[5,2,1,""],idp_metadata:[5,2,1,""],inactivity_timeout:[5,2,1,""],maximum_duration:[5,2,1,""],nameid_format:[5,2,1,""],options_passthrough:[5,2,1,""]},"ngrok.datatypes.EndpointTLSTermination":{enabled:[5,2,1,""],min_version:[5,2,1,""],terminate_at:[5,2,1,""]},"ngrok.datatypes.EndpointWebhookValidation":{enabled:[5,2,1,""],provider:[5,2,1,""],secret:[5,2,1,""]},"ngrok.datatypes.EventDestination":{"delete":[5,2,1,""],created_at:[5,2,1,""],description:[5,2,1,""],format:[5,2,1,""],id:[5,2,1,""],metadata:[5,2,1,""],target:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.EventDestinationList":{event_destinations:[5,2,1,""],next_page_uri:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.EventSource":{type:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.EventSourceList":{sources:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.EventSourceReplace":{type:[5,2,1,""]},"ngrok.datatypes.EventStream":{"delete":[5,2,1,""],created_at:[5,2,1,""],description:[5,2,1,""],destination_ids:[5,2,1,""],event_type:[5,2,1,""],fields:[5,2,1,""],id:[5,2,1,""],metadata:[5,2,1,""],sampling_rate:[5,2,1,""],update:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.EventStreamList":{event_streams:[5,2,1,""],next_page_uri:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.EventSubscription":{"delete":[5,2,1,""],created_at:[5,2,1,""],description:[5,2,1,""],destinations:[5,2,1,""],id:[5,2,1,""],metadata:[5,2,1,""],sources:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.EventSubscriptionList":{event_subscriptions:[5,2,1,""],next_page_uri:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.EventTarget":{cloudwatch_logs:[5,2,1,""],firehose:[5,2,1,""],kinesis:[5,2,1,""]},"ngrok.datatypes.EventTargetCloudwatchLogs":{auth:[5,2,1,""],log_group_arn:[5,2,1,""]},"ngrok.datatypes.EventTargetFirehose":{auth:[5,2,1,""],delivery_stream_arn:[5,2,1,""]},"ngrok.datatypes.EventTargetKinesis":{auth:[5,2,1,""],stream_arn:[5,2,1,""]},"ngrok.datatypes.IPPolicy":{"delete":[5,2,1,""],action:[5,2,1,""],created_at:[5,2,1,""],description:[5,2,1,""],id:[5,2,1,""],metadata:[5,2,1,""],update:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.IPPolicyList":{ip_policies:[5,2,1,""],next_page_uri:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.IPPolicyRule":{"delete":[5,2,1,""],cidr:[5,2,1,""],created_at:[5,2,1,""],description:[5,2,1,""],id:[5,2,1,""],ip_policy:[5,2,1,""],metadata:[5,2,1,""],update:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.IPPolicyRuleList":{ip_policy_rules:[5,2,1,""],next_page_uri:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.IPRestriction":{"delete":[5,2,1,""],created_at:[5,2,1,""],description:[5,2,1,""],enforced:[5,2,1,""],id:[5,2,1,""],ip_policies:[5,2,1,""],metadata:[5,2,1,""],type:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.IPRestrictionList":{ip_restrictions:[5,2,1,""],next_page_uri:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.IPWhitelistEntry":{"delete":[5,2,1,""],created_at:[5,2,1,""],description:[5,2,1,""],id:[5,2,1,""],ip_net:[5,2,1,""],metadata:[5,2,1,""],update:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.IPWhitelistEntryList":{next_page_uri:[5,2,1,""],uri:[5,2,1,""],whitelist:[5,2,1,""]},"ngrok.datatypes.Ref":{id:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.ReservedAddr":{"delete":[5,2,1,""],addr:[5,2,1,""],created_at:[5,2,1,""],description:[5,2,1,""],endpoint_configuration:[5,2,1,""],id:[5,2,1,""],metadata:[5,2,1,""],region:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.ReservedAddrList":{next_page_uri:[5,2,1,""],reserved_addrs:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.ReservedDomain":{"delete":[5,2,1,""],certificate:[5,2,1,""],certificate_management_policy:[5,2,1,""],certificate_management_status:[5,2,1,""],cname_target:[5,2,1,""],created_at:[5,2,1,""],description:[5,2,1,""],domain:[5,2,1,""],http_endpoint_configuration:[5,2,1,""],https_endpoint_configuration:[5,2,1,""],id:[5,2,1,""],metadata:[5,2,1,""],region:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.ReservedDomainCertJob":{error_code:[5,2,1,""],msg:[5,2,1,""],ns_targets:[5,2,1,""],retries_at:[5,2,1,""],started_at:[5,2,1,""]},"ngrok.datatypes.ReservedDomainCertNSTarget":{nameservers:[5,2,1,""],zone:[5,2,1,""]},"ngrok.datatypes.ReservedDomainCertPolicy":{authority:[5,2,1,""],private_key_type:[5,2,1,""]},"ngrok.datatypes.ReservedDomainCertStatus":{provisioning_job:[5,2,1,""],renews_at:[5,2,1,""]},"ngrok.datatypes.ReservedDomainList":{next_page_uri:[5,2,1,""],reserved_domains:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.SSHCertificateAuthority":{"delete":[5,2,1,""],created_at:[5,2,1,""],description:[5,2,1,""],id:[5,2,1,""],key_type:[5,2,1,""],metadata:[5,2,1,""],public_key:[5,2,1,""],update:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.SSHCertificateAuthorityList":{next_page_uri:[5,2,1,""],ssh_certificate_authorities:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.SSHCredential":{"delete":[5,2,1,""],acl:[5,2,1,""],created_at:[5,2,1,""],description:[5,2,1,""],id:[5,2,1,""],metadata:[5,2,1,""],public_key:[5,2,1,""],update:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.SSHCredentialList":{next_page_uri:[5,2,1,""],ssh_credentials:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.SSHHostCertificate":{"delete":[5,2,1,""],certificate:[5,2,1,""],created_at:[5,2,1,""],description:[5,2,1,""],id:[5,2,1,""],key_type:[5,2,1,""],metadata:[5,2,1,""],principals:[5,2,1,""],public_key:[5,2,1,""],ssh_certificate_authority_id:[5,2,1,""],update:[5,2,1,""],uri:[5,2,1,""],valid_after:[5,2,1,""],valid_until:[5,2,1,""]},"ngrok.datatypes.SSHHostCertificateList":{next_page_uri:[5,2,1,""],ssh_host_certificates:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.SSHUserCertificate":{"delete":[5,2,1,""],certificate:[5,2,1,""],created_at:[5,2,1,""],critical_options:[5,2,1,""],description:[5,2,1,""],extensions:[5,2,1,""],id:[5,2,1,""],key_type:[5,2,1,""],metadata:[5,2,1,""],principals:[5,2,1,""],public_key:[5,2,1,""],ssh_certificate_authority_id:[5,2,1,""],update:[5,2,1,""],uri:[5,2,1,""],valid_after:[5,2,1,""],valid_until:[5,2,1,""]},"ngrok.datatypes.SSHUserCertificateList":{next_page_uri:[5,2,1,""],ssh_user_certificates:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.TLSCertificate":{"delete":[5,2,1,""],certificate_pem:[5,2,1,""],created_at:[5,2,1,""],description:[5,2,1,""],extended_key_usages:[5,2,1,""],id:[5,2,1,""],issued_at:[5,2,1,""],issuer_common_name:[5,2,1,""],key_usages:[5,2,1,""],metadata:[5,2,1,""],not_after:[5,2,1,""],not_before:[5,2,1,""],private_key_type:[5,2,1,""],serial_number:[5,2,1,""],subject_alternative_names:[5,2,1,""],subject_common_name:[5,2,1,""],subject_country:[5,2,1,""],subject_locality:[5,2,1,""],subject_organization:[5,2,1,""],subject_organizational_unit:[5,2,1,""],subject_province:[5,2,1,""],update:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.TLSCertificateList":{next_page_uri:[5,2,1,""],tls_certificates:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.TLSCertificateSANs":{dns_names:[5,2,1,""],ips:[5,2,1,""]},"ngrok.datatypes.Tunnel":{id:[5,2,1,""],metadata:[5,2,1,""],proto:[5,2,1,""],public_url:[5,2,1,""],region:[5,2,1,""],started_at:[5,2,1,""],tunnel_session:[5,2,1,""]},"ngrok.datatypes.TunnelList":{next_page_uri:[5,2,1,""],tunnels:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.TunnelSession":{agent_version:[5,2,1,""],credential:[5,2,1,""],id:[5,2,1,""],ip:[5,2,1,""],metadata:[5,2,1,""],os:[5,2,1,""],region:[5,2,1,""],started_at:[5,2,1,""],transport:[5,2,1,""],uri:[5,2,1,""]},"ngrok.datatypes.TunnelSessionList":{next_page_uri:[5,2,1,""],tunnel_sessions:[5,2,1,""],uri:[5,2,1,""]},"ngrok.services":{APIKeysClient:[1,1,1,""],AbuseReportsClient:[0,1,1,""],CertificateAuthoritiesClient:[2,1,1,""],CredentialsClient:[4,1,1,""],EndpointCircuitBreakerModuleClient:[6,1,1,""],EndpointCompressionModuleClient:[7,1,1,""],EndpointConfigurationsClient:[8,1,1,""],EndpointIPPolicyModuleClient:[9,1,1,""],EndpointLoggingModuleClient:[10,1,1,""],EndpointMutualTLSModuleClient:[11,1,1,""],EndpointOAuthModuleClient:[12,1,1,""],EndpointOIDCModuleClient:[13,1,1,""],EndpointRequestHeadersModuleClient:[14,1,1,""],EndpointResponseHeadersModuleClient:[15,1,1,""],EndpointSAMLModuleClient:[16,1,1,""],EndpointTLSTerminationModuleClient:[17,1,1,""],EndpointWebhookValidationModuleClient:[18,1,1,""],EventDestinationsClient:[20,1,1,""],EventSourcesClient:[21,1,1,""],EventStreamsClient:[22,1,1,""],EventSubscriptionsClient:[23,1,1,""],IPPoliciesClient:[25,1,1,""],IPPolicyRulesClient:[26,1,1,""],IPRestrictionsClient:[27,1,1,""],IPWhitelistClient:[28,1,1,""],ReservedAddrsClient:[29,1,1,""],ReservedDomainsClient:[30,1,1,""],SSHCertificateAuthoritiesClient:[31,1,1,""],SSHCredentialsClient:[32,1,1,""],SSHHostCertificatesClient:[33,1,1,""],SSHUserCertificatesClient:[34,1,1,""],TLSCertificatesClient:[35,1,1,""],TunnelSessionsClient:[36,1,1,""],TunnelsClient:[37,1,1,""]},"ngrok.services.APIKeysClient":{"delete":[1,2,1,""],create:[1,2,1,""],get:[1,2,1,""],list:[1,2,1,""],update:[1,2,1,""]},"ngrok.services.AbuseReportsClient":{create:[0,2,1,""],get:[0,2,1,""]},"ngrok.services.CertificateAuthoritiesClient":{"delete":[2,2,1,""],create:[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"ngrok.services.CredentialsClient":{"delete":[4,2,1,""],create:[4,2,1,""],get:[4,2,1,""],list:[4,2,1,""],update:[4,2,1,""]},"ngrok.services.EndpointCircuitBreakerModuleClient":{"delete":[6,2,1,""],get:[6,2,1,""],replace:[6,2,1,""]},"ngrok.services.EndpointCompressionModuleClient":{"delete":[7,2,1,""],get:[7,2,1,""],replace:[7,2,1,""]},"ngrok.services.EndpointConfigurationsClient":{"delete":[8,2,1,""],create:[8,2,1,""],get:[8,2,1,""],list:[8,2,1,""],update:[8,2,1,""]},"ngrok.services.EndpointIPPolicyModuleClient":{"delete":[9,2,1,""],get:[9,2,1,""],replace:[9,2,1,""]},"ngrok.services.EndpointLoggingModuleClient":{"delete":[10,2,1,""],get:[10,2,1,""],replace:[10,2,1,""]},"ngrok.services.EndpointMutualTLSModuleClient":{"delete":[11,2,1,""],get:[11,2,1,""],replace:[11,2,1,""]},"ngrok.services.EndpointOAuthModuleClient":{"delete":[12,2,1,""],get:[12,2,1,""],replace:[12,2,1,""]},"ngrok.services.EndpointOIDCModuleClient":{"delete":[13,2,1,""],get:[13,2,1,""],replace:[13,2,1,""]},"ngrok.services.EndpointRequestHeadersModuleClient":{"delete":[14,2,1,""],get:[14,2,1,""],replace:[14,2,1,""]},"ngrok.services.EndpointResponseHeadersModuleClient":{"delete":[15,2,1,""],get:[15,2,1,""],replace:[15,2,1,""]},"ngrok.services.EndpointSAMLModuleClient":{"delete":[16,2,1,""],get:[16,2,1,""],replace:[16,2,1,""]},"ngrok.services.EndpointTLSTerminationModuleClient":{"delete":[17,2,1,""],get:[17,2,1,""],replace:[17,2,1,""]},"ngrok.services.EndpointWebhookValidationModuleClient":{"delete":[18,2,1,""],get:[18,2,1,""],replace:[18,2,1,""]},"ngrok.services.EventDestinationsClient":{"delete":[20,2,1,""],create:[20,2,1,""],get:[20,2,1,""],list:[20,2,1,""],update:[20,2,1,""]},"ngrok.services.EventSourcesClient":{"delete":[21,2,1,""],create:[21,2,1,""],get:[21,2,1,""],list:[21,2,1,""],update:[21,2,1,""]},"ngrok.services.EventStreamsClient":{"delete":[22,2,1,""],create:[22,2,1,""],get:[22,2,1,""],list:[22,2,1,""],update:[22,2,1,""]},"ngrok.services.EventSubscriptionsClient":{"delete":[23,2,1,""],create:[23,2,1,""],get:[23,2,1,""],list:[23,2,1,""],update:[23,2,1,""]},"ngrok.services.IPPoliciesClient":{"delete":[25,2,1,""],create:[25,2,1,""],get:[25,2,1,""],list:[25,2,1,""],update:[25,2,1,""]},"ngrok.services.IPPolicyRulesClient":{"delete":[26,2,1,""],create:[26,2,1,""],get:[26,2,1,""],list:[26,2,1,""],update:[26,2,1,""]},"ngrok.services.IPRestrictionsClient":{"delete":[27,2,1,""],create:[27,2,1,""],get:[27,2,1,""],list:[27,2,1,""],update:[27,2,1,""]},"ngrok.services.IPWhitelistClient":{"delete":[28,2,1,""],create:[28,2,1,""],get:[28,2,1,""],list:[28,2,1,""],update:[28,2,1,""]},"ngrok.services.ReservedAddrsClient":{"delete":[29,2,1,""],create:[29,2,1,""],delete_endpoint_config:[29,2,1,""],get:[29,2,1,""],list:[29,2,1,""],update:[29,2,1,""]},"ngrok.services.ReservedDomainsClient":{"delete":[30,2,1,""],create:[30,2,1,""],delete_certificate:[30,2,1,""],delete_certificate_management_policy:[30,2,1,""],delete_http_endpoint_config:[30,2,1,""],delete_https_endpoint_config:[30,2,1,""],get:[30,2,1,""],list:[30,2,1,""],update:[30,2,1,""]},"ngrok.services.SSHCertificateAuthoritiesClient":{"delete":[31,2,1,""],create:[31,2,1,""],get:[31,2,1,""],list:[31,2,1,""],update:[31,2,1,""]},"ngrok.services.SSHCredentialsClient":{"delete":[32,2,1,""],create:[32,2,1,""],get:[32,2,1,""],list:[32,2,1,""],update:[32,2,1,""]},"ngrok.services.SSHHostCertificatesClient":{"delete":[33,2,1,""],create:[33,2,1,""],get:[33,2,1,""],list:[33,2,1,""],update:[33,2,1,""]},"ngrok.services.SSHUserCertificatesClient":{"delete":[34,2,1,""],create:[34,2,1,""],get:[34,2,1,""],list:[34,2,1,""],update:[34,2,1,""]},"ngrok.services.TLSCertificatesClient":{"delete":[35,2,1,""],create:[35,2,1,""],get:[35,2,1,""],list:[35,2,1,""],update:[35,2,1,""]},"ngrok.services.TunnelSessionsClient":{get:[36,2,1,""],list:[36,2,1,""],restart:[36,2,1,""],stop:[36,2,1,""],update:[36,2,1,""]},"ngrok.services.TunnelsClient":{list:[37,2,1,""]},ngrok:{Client:[3,1,1,""],Error:[19,3,1,""],NotFoundError:[19,3,1,""],datatypes:[5,0,0,"-"],services:[37,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","exception","Python exception"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:exception"},terms:{"100":[5,22],"128":5,"2048":31,"255":[1,2,4,5,8,20,22,23,25,26,27,28,31,32,33,34,35],"3339":[5,33,34],"404":19,"4096":[0,1,2,4,5,8,20,22,23,25,26,27,28,29,30,31,32,33,34,35],"509":5,"abstract":24,"break":36,"byte":[0,1,2,4,5,8,20,22,25,26,27,28,29,30,31,32,33,34,35],"catch":19,"char":[5,23],"class":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],"default":[5,29,30,33,34],"export":5,"float":[5,22],"import":[3,24],"int":[5,19,31],"long":5,"new":[0,1,2,4,8,20,22,25,26,27,28,29,30,31,32,33,34,35,36],"null":[5,8,20,30],"public":[3,5,27,32,33,34],"return":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],"throw":20,"true":[5,27],"try":[19,24],AWS:5,CAs:5,DNS:5,For:[4,5,32],IDs:[5,22,23],IPs:[3,5,25,26,27,28],One:5,SNS:5,TLS:[2,3,5,8,24,30],That:24,The:[1,3,4,5,19,20,21,22,24,28,32,33,34,36],Then:3,There:8,These:[5,34],Use:[3,28],__iter__:24,abil:[5,34],abl:5,about:[0,2,4,5,8,19,20,22,25,26,27,28,31,32,33,34,35],abus:[3,5,24],abuse_report:[0,3],abusereport:[0,5],abusereporthostnam:5,abusereportscli:[0,3],accept:[5,20],access:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],account:[0,1,2,3,4,5,8,20,22,23,25,26,27,28,29,30,31,32,33,34,35,36,37],acl:[4,5,32],action:[3,4,5,19,24,25,32],add:[5,21],addit:[5,19,21,24,34],addr:[5,29],address:[3,4,5,8,24,28,32,33,34],advertis:5,after:[5,24,36],against:[5,19],agent:[3,4,5,27,36,37],agent_vers:5,all:[1,2,3,4,5,8,19,20,22,24,25,26,27,28,29,30,31,32,33,34,35,36,37],allow:[0,3,4,5,19,24,25,27,32,33,36],allow_idp_initi:5,along:[3,33],alreadi:[5,36],also:[3,5,25,35],altern:5,alwai:5,amazon:5,amount:[5,36],ani:[5,8,19,24,25,34,36],anoth:25,anyth:[20,22],api:[0,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,25,26,27,28,29,30,31,32,33,34,35,36,37],api_kei:[1,3],apikei:[1,5],apikeylist:[1,5],apikeyscli:[1,3],app:[5,30],appli:[3,5,8,20,22,25,27],applic:[5,24],arbitrari:[0,1,2,4,5,8,19,20,22,23,25,26,27,28,29,30,31,32,33,34,35],arn:5,arrai:5,ask:5,aspect:[3,27],assert:[3,5,33],assertion_consumer_service_url:5,assign:[3,5,19,29],associ:[20,22,25],assum:5,attach:[2,3,5,8,21,25,26,27,29,30,35],attribut:[1,2,4,20,22,25,26,27,28,29,30,32,35],audienc:5,auth:[5,12],auth_check_interv:5,authent:[1,3,4,5,32,33,34],author:[0,3,4,5,24,33,34],authorized_group:5,authorizinig:[5,34],authtoken:[3,4,5],autom:[3,35],automat:[3,5,30,35],avail:[0,4,5,22,36],awai:24,awar:36,aws_access_key_id:5,aws_secret_access_kei:5,awsauth:5,awscredenti:5,awsrol:5,ban:5,base:5,base_url:3,bearer:5,becaus:[5,19],becom:[5,33,34],been:[2,3,5,8,36],befor:[5,36],before_id:[1,2,4,8,20,22,23,25,26,27,28,29,30,31,32,33,34,35,36,37],behalf:5,being:5,belong:5,best:19,between:5,bind:[4,5,32],blob:[5,34],block:19,bool:[5,27],both:[5,26],breaker:[5,8,24],bucket:5,bundl:[5,35],ca_pem:[2,5],cach:5,call:[4,5,24,33,34,36],caller:[4,5,19,32,36],can:[1,3,4,5,8,24,25,27,29,30,31,32,34,35,36],cannot:[3,29],captur:[5,22],caus:36,caveat:5,cert:5,certfic:[2,31,33,34],certif:[3,5,24,30],certificate_author:[2,3,5],certificate_authority_id:5,certificate_id:30,certificate_management_polici:[5,30],certificate_management_statu:5,certificate_pem:[5,35],certificateauthor:[2,5],certificateauthoritiescli:[2,3],certificateauthoritylist:[2,5],certifici:5,certkei:[5,34],chain:[5,35],check:[5,19,36],choos:5,chosen:[3,5,29],cidr:[3,5,24,25,26,27,28],circuit:[5,8,24],circuit_break:[5,8],circumst:36,client:[0,1,2,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],client_id:5,client_secret:5,cloudwatch:5,cloudwatch_log:[5,20],cname:[3,5,30],cname_target:5,code:[5,19,24,36],collect:[5,22],com:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,20,21,22,23,25,26,27,28,29,30,31,32,33,34,35,36,37],command:[3,4,5,34,36],common:[4,5,19,32],commun:[5,28],compat:36,complet:[5,8,36],compress:[5,8,24],concaten:5,condit:[5,19],config:[20,22,29,30],config_metadata:5,configur:[3,4,5,24,25,29,30,36],connect:[3,4,5,25,27,30,33,34,36],consid:[5,33],construct:[0,1,2,3,4,6,7,8,9,10,11,12,13,14,15,16,17,18,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],consult:[19,24],consum:5,contact:0,contain:[0,5,20,23,30],content:[0,5],control:[3,25],cooki:5,cookie_prefix:5,cor:5,correct:5,correspond:[3,33],could:[19,36],countri:5,cr_1kyyuneyn6xhhlqymblrj5nxkoz:24,creat:[0,1,2,3,4,5,8,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35],created_at:5,creation:5,cred:[3,5,24],credenti:[3,5,24],credentiallist:[4,5],credentialscli:[3,4],critic:[5,34],critical_opt:[5,34],current:[5,20,27,33,34,36,37],curv:31,custom:[5,23],danger:[5,33,34],dashboard:[1,3,5,24,25,27],data:[0,1,2,4,5,8,20,22,25,26,27,28,29,30,31,32,33,34,35],datacent:[5,29,30],datatyp:24,defin:[0,1,2,3,4,5,8,20,22,25,26,27,28,29,30,31,32,33,34,35],definit:5,delet:[1,2,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35],delete_certif:30,delete_certificate_management_polici:30,delete_endpoint_config:29,delete_http_endpoint_config:30,delete_https_endpoint_config:30,deliv:5,deliveri:5,delivery_stream_arn:5,deni:[3,5,19,25,34],deposit:5,deprec:[3,28],describ:5,descript:[1,2,4,5,8,20,22,23,25,26,27,28,29,30,31,32,33,34,35],destin:[5,22,23,24],destination_id:[5,22,23],detach:[29,30],detail:[0,1,2,4,5,8,19,20,21,22,24,25,26,27,28,29,30,31,32,33,34,35,36],determin:[5,22],direct:5,directli:[0,1,2,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],disabl:[5,30,36],disallow:5,discoveri:5,disk:5,distinguish:19,dns:5,dns_error:5,dns_name:5,doc:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,20,21,22,23,25,26,27,28,29,30,31,32,33,34,35,36,37],document:19,doe:[5,30],domain:[3,4,5,8,24,32,35],done:36,down:[0,3],download:5,dump:24,durat:5,dure:5,dynam:5,each:[3,5,8,22,36],easier:19,ecdsa:[5,31],ed25519:[5,31],edg:[3,5,30],either:5,ellipt:31,elliptic_curv:31,els:19,email:5,email_address:5,email_domain:5,enabl:[3,5,35],encapsul:[3,5,8,19,20],encod:[5,32,35],endpoint:[3,5,6,7,9,10,11,12,13,14,15,16,17,18,20,22,24,25,27,28,29,30,36,37],endpoint_circuit_breaker_modul:6,endpoint_compression_modul:7,endpoint_configur:[3,5,8],endpoint_configuration_id:29,endpoint_ip_policy_modul:9,endpoint_logging_modul:10,endpoint_mutual_tls_modul:11,endpoint_o_auth_modul:12,endpoint_oidc_modul:13,endpoint_request_headers_modul:14,endpoint_response_headers_modul:15,endpoint_saml_modul:16,endpoint_tls_termination_modul:17,endpoint_webhook_validation_modul:18,endpointcircuitbreak:[5,6,8],endpointcircuitbreakermodulecli:6,endpointcompress:[5,7,8],endpointcompressionmodulecli:7,endpointconfigur:[5,8],endpointconfigurationlist:[5,8],endpointconfigurationscli:[3,8],endpointippolici:[5,9],endpointippolicymodulecli:9,endpointippolicymut:[5,8,9],endpointlog:[5,10],endpointloggingmodulecli:10,endpointloggingmut:[5,8,10],endpointmutualtl:[5,11],endpointmutualtlsmodulecli:11,endpointmutualtlsmut:[5,8,11],endpointoauth:[5,8,12],endpointoauthfacebook:5,endpointoauthgithub:5,endpointoauthgoogl:5,endpointoauthmicrosoft:5,endpointoauthmodulecli:12,endpointoauthprovid:5,endpointoidc:[5,8,13],endpointoidcmodulecli:13,endpointrequesthead:[5,8,14],endpointrequestheadersmodulecli:14,endpointresponsehead:[5,8,15],endpointresponseheadersmodulecli:15,endpointsaml:[5,16],endpointsamlmodulecli:16,endpointsamlmut:[5,8,16],endpointtlstermin:[5,8,17],endpointtlsterminationmodulecli:17,endpointwebhookvalid:[5,8,18],endpointwebhookvalidationmodulecli:18,enforc:[3,5,27],ensur:19,entiti:5,entity_id:5,entitydescriptor:5,entri:[3,5,26,28],enumer:5,equival:[4,5,32],err_ngrok_1410:19,error:[5,20],error_cod:[5,19,24],error_threshold_percentag:5,etc:[4,5,32],evalu:5,even:5,event:[5,24],event_destin:[3,5,20],event_sourc:[3,21],event_stream:[3,5,22],event_stream_id:5,event_subscript:[3,5,23],event_typ:[5,22],eventdestin:[5,20],eventdestinationlist:[5,20],eventdestinationscli:[3,20],eventsourc:[5,21],eventsourcelist:[5,21],eventsourcereplac:[5,23],eventsourcescli:[3,21],eventstream:[5,22],eventstreamlist:[5,22],eventstreamscli:[3,22],eventsubscript:[5,23],eventsubscriptionlist:[5,23],eventsubscriptionscli:[3,23],eventtarget:[5,20],eventtargetcloudwatchlog:5,eventtargetfirehos:5,eventtargetkinesi:5,exactli:[5,20],exampl:[4,5,30,32],exceed:5,except:[5,24],exclus:30,exec:36,exist:8,exit:36,expect:5,explain:19,explicitli:[4,5,32],expos:[3,37],extend:5,extended_key_usag:5,extens:[5,34],face:[3,27],facebook:5,fail:[5,8,19,24,36],fals:[5,27],fetch:24,field:[5,19,22],file:[3,4,5],firehos:[5,20],first:[1,3,5,19,24,35],flow:5,follow:[5,20,34,36],forc:[5,34],force_authn:5,form:5,format:[5,20,33,34],forward:[5,34],four:[5,27],from:[1,3,5,22,24,32],full:[5,30],futur:[4,33],gatewai:[3,32],gener:[1,4,31],geograph:[5,29,30],get:[0,1,2,4,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,25,26,27,28,29,30,31,32,33,34,35,36],giraff:24,github:[5,34],gitlab:5,given:[5,21],googl:5,group:[3,5,8,25],guarante:[5,19],handl:[3,8,29,30],handshak:5,happen:19,has:[2,3,5,20,25,27,36],have:[3,4,5,8,22,23,32,35],header:[5,8,24],health:5,help:5,helper:24,highli:5,holder:[5,34],host:[0,3,5,24,31,34],hostcertif:5,hostnam:[3,5,29,30,33],hour:34,how:[3,5,8,20],howev:8,http:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],http_endpoint_configur:5,http_endpoint_configuration_id:30,http_request_complet:[5,22],http_status_cod:[19,24],https_endpoint_configur:5,https_endpoint_configuration_id:30,human:[1,2,4,5,8,19,20,22,23,25,26,27,28,29,30,31,32,33,34,35],ident:5,identifi:[0,1,2,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,20,21,22,23,25,26,27,28,29,30,31,32,33,34,35,36],idp:5,idp_metadata:5,ignor:5,implement:[5,24],inact:5,inactivity_timeout:5,inbound:[29,30],includ:[2,3,4,5,19,32,33,34,36],indic:[5,19],industri:5,inform:[2,4,5,8,20,22,23,24,25,26,27,28,31,32,33,34,35],ingress:[3,27],init:[3,27],initi:5,initiati:5,inject:5,instal:[3,4],instanc:[3,36],instead:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,20,21,22,23,25,26,27,28,29,30,31,32,33,34,35,36,37],instruct:36,integ:5,integr:36,intend:[5,23],intercom:5,internal_error:5,interpret:[5,34],introspect:19,invalid:[5,19,33,34],invok:[19,24],ip_net:[5,28],ip_polici:[3,5,8,19,24,25],ip_policy_id:[5,24,26,27],ip_policy_rul:[3,5,24,26],ip_restrict:[3,5,27],ip_whitelist:[3,28],ippolici:[5,25],ippoliciescli:[3,25],ippolicylist:[5,25],ippolicyrul:[5,26],ippolicyrulelist:[5,26],ippolicyrulescli:[3,26],iprestrict:[5,27],iprestrictionlist:[5,27],iprestrictionscli:[3,27],ips:5,ipv4:[3,5,26],ipv6:[3,5,26],ipwhitelistcli:[3,28],ipwhitelistentri:[5,28],ipwhitelistentrylist:[5,28],isn:5,issu:[5,27,33,34,36],issued_at:5,issuer:5,issuer_common_nam:5,its:[3,5,31,33],itself:[1,3,24,36],job:5,json:[5,20,24],kei:[2,3,5,24,31,32,33,34,35],key_siz:31,key_typ:5,key_usag:5,keypair:[5,32],kind:19,kinesi:[5,20],latest:36,lead:[4,5,32],leaf:[5,35],least:[5,22,23,36],leav:[5,20],letsencrypt:5,level:5,librari:[3,24],like:[5,20,22,24,30],limit:[1,2,4,5,8,20,22,23,25,26,27,28,29,30,31,32,33,34,35,36,37],link:35,list:[0,1,2,3,4,5,8,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],listen:[3,29,30],local:5,locat:5,log:[3,5,8,24,27,34],log_group_arn:5,login:5,logout:5,longer:5,low:5,machin:[2,4,5,8,20,22,23,25,26,27,28,29,30,31,32,33,34,35],mai:[1,3,4,5,19,30,32,34,35],major:36,make:[3,5,19,26,27,36],manag:[1,3,5,30],mani:5,manual:36,map:[5,34],master:[5,34],match:[3,4,5,32,35],max:[0,1,2,4,5,8,20,22,23,25,26,27,28,29,30,31,32,33,34,35],maximum:5,maximum_dur:5,member:5,messag:[5,19,24],metadata:[0,1,2,4,5,8,20,22,23,24,25,26,27,28,29,30,31,32,33,34,35],metadata_url:5,method:19,metric:5,microsoft:5,min_vers:5,minimum:5,modifi:8,modul:[2,3,5,8,24,25],more:[3,5,22,34,36],most:5,msg:5,mtl:[2,3],multipl:[4,5,32],must:[3,4,5,20,34,36],mutual:[2,3,5,8,24,30],mutual_tl:[5,8],nake:19,name:[5,30],nameid:5,nameid_format:5,nameserv:5,necessari:[5,24],need:[1,3,4,5,24],network:[5,19,28],never:36,next:5,next_page_uri:5,ngrok:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,25,26,27,28,29,30,31,32,33,34,35,36,37],none:[1,2,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,20,22,23,25,26,27,28,29,30,31,32,33,34,35,36,37],not_aft:5,not_befor:5,notabl:36,notat:[5,26,28],notfounderror:19,ns_target:5,num_bucket:5,number:[5,34],oasi:5,oauth:[5,8,24],object:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],offici:24,oidc:[5,8,24],one:[3,5,8,20,22,23,24,31,33,36],onli:[0,2,3,4,5,8,20,27,32,34],onlin:[5,24,36,37],open:[4,5,32,34],openid:5,openssh:[5,33,34],oper:[5,8,19,36],operation_id:19,operationid:19,option:[0,1,2,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],options_passthrough:5,org:5,organ:5,organiz:5,other:[2,3,5,19,31],otherwis:5,our:[0,19],out:5,output:[5,20],own:[1,3,5,30],packag:24,page:[1,3,5],pair:[3,5,31,35],paramet:[0,1,2,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,25,26,27,28,29,30,31,32,33,34,35,36,37],pars:5,partially_process:5,pass:5,pem:[2,5,32,35],pend:5,percentag:[5,22],period:5,perman:5,permiss:[5,34],permit:[4,5,32,34],persist:5,pip:24,place:[3,5,27],platform:36,pleas:36,point:[3,5,19,30],pointcfg_modul:3,polici:[3,5,8,24,27,30],port:[3,5,29,34],portabl:[5,34],portion:5,predefin:[5,34],prefer:5,prefix:5,present:[2,3,5,34],preserv:22,presnt:5,princip:[5,33,34],print:[3,24],privat:[2,3,5,31,33,35],private_key_pem:35,private_key_typ:[5,31],process:[5,36],prompt:5,prop:5,properti:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],proto:5,protocol:[5,22,34],provid:[3,5,37],provinc:5,provis:[1,3,5,35],provisioning_job:5,pty:[5,34],pub:5,public_kei:[5,32,33,34],public_url:5,pull:5,purpos:[5,25,34],python:24,qualifi:5,rais:19,rang:[3,5,22,25,26,28],raw:[2,5],readabl:[1,2,4,5,8,19,20,22,23,25,26,27,28,29,30,31,32,33,34,35],reauthent:5,recent:5,recheck:5,recommend:5,reconnect:36,record:[3,5,30],redirect:5,ref:5,refer:[5,20],referenc:[5,8,20,25],refresh:5,region:[5,29,30],relat:5,relayst:5,reli:5,remain:25,remov:[3,5,20,21,28],renew:5,renews_at:5,replac:[6,7,8,9,10,11,12,13,14,15,16,17,18],report:[3,5,24],repres:[3,5,22,36],request:[0,3,5,8,19,24,27,36],request_head:[5,8],request_signing_certificate_pem:5,requir:[5,22,23],reserv:[3,5,8,24],reserved_addr:[3,5,29],reserved_domain:[3,5,30],reservedaddr:[5,29],reservedaddrlist:[5,29],reservedaddrscli:[3,29],reserveddomain:[5,30],reserveddomaincertjob:5,reserveddomaincertnstarget:5,reserveddomaincertpolici:[5,30],reserveddomaincertstatu:5,reserveddomainlist:[5,30],reserveddomainscli:[3,30],resourc:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,20,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36],respons:[0,4,5,8,19,24],response_head:[5,8],resrtrict:5,rest:[5,20],restart:36,restrict:[3,4,5,24,25,28,32],retain:5,retri:[5,19],retries_at:5,retriev:5,reusabl:[3,8,25],revers:[3,36,37],review:0,revok:5,rfc:[5,33,34],robustli:19,role:5,role_arn:5,roll:5,rolling_window:5,root:3,rsa:[5,31],rule:[3,4,5,24,25,32],run:[3,5,36,37],runtimeerror:19,safe:5,same:5,saml:[5,8,24],sampling_r:[5,22],san:5,save:4,scope:5,second:[5,36],secret:5,section:24,secur:4,see:[5,34,35],send:[5,20],sendgrid:5,sent:5,separ:19,sequenc:[0,4,5,22,23,27,32,33,34],serial:[5,20],serial_numb:5,serv:[5,33],server:[3,5,19,30,33,34],server_nam:24,servic:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,20,21,22,23,25,26,27,28,29,30,31,32,33,34,35,36,37],session:[3,4,5,24,25,37],set:[5,27],shopifi:5,should:[5,22,23,36],sign:[2,3,5,31,33,34],simpl:19,singl:[5,24],single_logout_url:5,size:31,slack:5,slug:5,some:[19,24,36],someth:19,sourc:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],spec:[5,34],specif:[3,5,19,22,24,27],specifi:[3,4,5,8,26,30,32,33,34],ssh:[3,5,24,36,37],ssh_certificate_author:[3,5,31],ssh_certificate_authority_id:[5,33,34],ssh_credenti:[3,5,32],ssh_host_certif:[3,5,33],ssh_user_certif:[3,5,34],sshcertificateauthor:[5,31],sshcertificateauthoritiescli:[3,31],sshcertificateauthoritylist:[5,31],sshcredenti:[5,32],sshcredentiallist:[5,32],sshcredentialscli:[3,32],sshd_config:5,sshhostcertif:[5,33],sshhostcertificatelist:[5,33],sshhostcertificatescli:[3,33],sshusercertif:[5,34],sshusercertificatelist:[5,34],sshusercertificatescli:[3,34],start:[3,4,5,25,27,32,36],started_at:5,state:5,statist:5,statu:[0,5,19,24,36],status:5,still:[5,8,20,36],stop:36,str:[0,1,2,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,25,26,27,28,29,30,31,32,33,34,35,36,37],stream:[5,20,23,24],stream_arn:5,string:[5,19],stripe:5,subclass:19,subdomain:[5,30],subject:5,subject_alternative_nam:5,subject_common_nam:5,subject_countri:5,subject_loc:5,subject_organ:5,subject_organizational_unit:5,subject_provinc:5,submit:[0,3],subnet:24,subscript:[5,21,24],subscription_id:21,subset:5,successfulli:36,suffix:[4,5,32],suppli:[5,23],support:[5,22,25,26,27,36],suspect:[0,5],system:[0,5,19],take:[0,3,5,19],taken:5,target:[5,20,30],tcp:[3,5,8,29],tcp_connection_clos:[5,22],team:[0,5],temporari:5,term:[0,3,5],termin:[3,5,8,24,34,35],terminate_at:5,thei:[3,4,5,8,25,29,35],them:5,thi:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37],threshold:5,through:5,thrown:19,thu:[2,3],time:[4,5,32,33,34,36],timestamp:5,tls:[3,5,11,17,30,35],tls_certif:[3,5,35],tls_termin:[5,8],tlscertif:[5,35],tlscertificatelist:[5,35],tlscertificatesan:5,tlscertificatescli:[3,35],togeth:5,token:[4,5,32],top:5,trace:19,traffic:[3,5,8,24,25,27,28,29,30,33,35],transpar:24,transport:5,treat:25,trigger:[5,21,23],trip:5,tripped_dur:5,trust:[3,33,34],tunabl:5,tune:5,tunnel:[3,5,24,25,28,32],tunnel_sess:[3,5,36],tunnellist:[5,37],tunnelscli:[3,37],tunnelsess:[5,36],tunnelsessionlist:[5,36],tunnelsessionscli:[3,36],twilio:5,two:[5,34],type:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,25,26,27,28,29,30,31,32,33,34,35,36,37],unban:5,undefin:19,underli:5,understand:[5,34],unexpect:19,uniqu:[5,8,19,20,21,22,23],unit:5,unspecifi:[4,5,32,33,34],until:[3,20,22,25,35],unus:[3,35],updat:[1,2,4,5,8,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36],upload:[2,5,30,32,35],upstream:5,uri:5,url:[0,3,5],urn:5,use:[1,3,4,5,8,19,30,31,32],used:[1,2,3,4,5,22,23,25,27,29,30,31,32,33,34,35],user:[0,1,2,3,4,5,8,20,22,24,25,26,27,28,29,30,31,32,33,35],usernam:[5,34],uses:[1,5],using:[5,36],valid:[2,3,5,8,19,22,24,33,34],valid_aft:[5,33,34],valid_befor:[5,33,34],valid_until:[5,33,34],valu:[5,8,20,22,25,27,33,34],verif:5,verifi:[2,3],version:[5,36],via:[3,8,25,32],violat:[0,3],visit:5,volum:5,volume_threshold:5,wai:8,wait:[5,36],want:[5,22],warn:[5,27],webhook:[5,8,24],webhook_valid:[5,8],well:[5,24],what:[1,4,5,8,27,29,30,32],when:[3,5,8,19,20,24,31,33,34,36],whenev:5,where:[5,20],whether:5,which:[0,3,4,5,21,22,23,24,27,32,35,36],whitelist:[3,5,24],who:[3,4,5,32,33],why:[5,19],wildcard:[4,5,32],window:[5,36],wish:36,without:24,work:24,would:[4,5,20,22,32],x11:[5,34],x509:[2,3,35],xml:5,year:33,yet:36,yml:[3,4],you:[0,1,3,4,5,19,20,22,24,25,30,32,35,36],your:[1,3,4,5,20,24,27,28,32,36],yourself:4,zero:25,zone:5},titles:["Abuse Reports","API Keys","Certificate Authorities","Client","Tunnel Credentials","Datatypes","Circuit Breaker Module","Compression Module","Endpoint Configurations","IP Policy Module","Logging Module","Mutual TLS Module","OAuth Module","OIDC Module","Request Headers Module","Response Headers Module","SAML Module","TLS Termination Module","Webhook Validation Module","Errors","Event Destinations","Event Sources","Event Streams","Event Subscriptions","ngrok-api","IP Policies","IP Policy Rules","IP Restrictions","IP Whitelist","Reserved Addresses","Reserved Domains","SSH Certificate Authorities","SSH Credentials","SSH Host Certificates","SSH User Certificates","TLS Certificates","Tunnel Sessions","Tunnels"],titleterms:{"class":19,TLS:[11,17,35],abus:0,address:29,api:[1,24],author:[2,31],automat:24,breaker:6,certif:[2,31,33,34,35],circuit:6,client:3,compress:7,configur:8,credenti:[4,32],datatyp:5,destin:20,domain:30,endpoint:8,error:[19,24],event:[20,21,22,23],exampl:24,except:19,get:24,handl:[19,24],header:[14,15],host:33,instal:24,instanc:24,kei:1,log:10,method:24,modul:[6,7,9,10,11,12,13,14,15,16,17,18],mutual:11,ngrok:24,oauth:12,oidc:13,page:24,polici:[9,25,26],quickstart:24,refer:24,report:0,request:14,reserv:[29,30],respons:15,restrict:27,rule:26,saml:16,servic:24,session:36,sourc:21,ssh:[31,32,33,34],start:24,stream:22,subscript:23,termin:17,tunnel:[4,36,37],user:34,valid:18,webhook:18,whitelist:28}})