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