@ngrok/ngrok-api 0.1.0 → 0.7.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.
- package/CHANGELOG.md +16 -0
- package/README.md +102 -31
- package/docs/CNAME +1 -0
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/client.Ngrok.html +772 -0
- package/docs/classes/services.APIKeys.html +354 -0
- package/docs/classes/services.AbuseReports.html +261 -0
- package/docs/classes/services.AgentIngresses.html +343 -0
- package/docs/classes/services.CertificateAuthorities.html +354 -0
- package/docs/classes/services.Credentials.html +353 -0
- package/docs/classes/services.EdgeRouteBackendModule.html +270 -0
- package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +270 -0
- package/docs/classes/services.EdgeRouteCompressionModule.html +270 -0
- package/docs/classes/services.EdgeRouteIPRestrictionModule.html +270 -0
- package/docs/classes/services.EdgeRouteOAuthModule.html +270 -0
- package/docs/classes/services.EdgeRouteOIDCModule.html +270 -0
- package/docs/classes/services.EdgeRouteRequestHeadersModule.html +270 -0
- package/docs/classes/services.EdgeRouteResponseHeadersModule.html +270 -0
- package/docs/classes/services.EdgeRouteSAMLModule.html +270 -0
- package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +270 -0
- package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +270 -0
- package/docs/classes/services.EdgesHTTPS.html +343 -0
- package/docs/classes/services.EdgesHTTPSRoutes.html +317 -0
- package/docs/classes/services.EdgesTCP.html +343 -0
- package/docs/classes/services.EdgesTLS.html +343 -0
- package/docs/classes/services.Endpoints.html +256 -0
- package/docs/classes/services.EventDestinations.html +343 -0
- package/docs/classes/services.EventSources.html +349 -0
- package/docs/classes/services.EventSubscriptions.html +343 -0
- package/docs/classes/services.FailoverBackends.html +353 -0
- package/docs/classes/services.HTTPResponseBackends.html +318 -0
- package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +270 -0
- package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +270 -0
- package/docs/classes/services.IPPolicies.html +353 -0
- package/docs/classes/services.IPPolicyRules.html +351 -0
- package/docs/classes/services.IPRestrictions.html +355 -0
- package/docs/classes/services.ReservedAddrs.html +352 -0
- package/docs/classes/services.ReservedDomains.html +417 -0
- package/docs/classes/services.SSHCertificateAuthorities.html +351 -0
- package/docs/classes/services.SSHCredentials.html +351 -0
- package/docs/classes/services.SSHHostCertificates.html +352 -0
- package/docs/classes/services.SSHUserCertificates.html +352 -0
- package/docs/classes/services.TCPEdgeBackendModule.html +270 -0
- package/docs/classes/services.TCPEdgeIPRestrictionModule.html +270 -0
- package/docs/classes/services.TLSCertificates.html +354 -0
- package/docs/classes/services.TLSEdgeBackendModule.html +270 -0
- package/docs/classes/services.TLSEdgeIPRestrictionModule.html +270 -0
- package/docs/classes/services.TLSEdgeMutualTLSModule.html +270 -0
- package/docs/classes/services.TLSEdgeTLSTerminationModule.html +270 -0
- package/docs/classes/services.TunnelGroupBackends.html +351 -0
- package/docs/classes/services.TunnelSessions.html +352 -0
- package/docs/classes/services.Tunnels.html +255 -0
- package/docs/classes/services.WeightedBackends.html +353 -0
- package/docs/index.html +103 -546
- package/docs/interfaces/client.NgrokConfig.html +179 -0
- package/docs/interfaces/{apikey.html → datatypes.APIKey.html} +41 -29
- package/docs/interfaces/{apikeycreate.html → datatypes.APIKeyCreate.html} +25 -13
- package/docs/interfaces/{apikeylist.html → datatypes.APIKeyList.html} +32 -20
- package/docs/interfaces/{apikeyupdate.html → datatypes.APIKeyUpdate.html} +28 -16
- package/docs/interfaces/{awsauth.html → datatypes.AWSAuth.html} +27 -15
- package/docs/interfaces/{awscredentials.html → datatypes.AWSCredentials.html} +31 -19
- package/docs/interfaces/{awsrole.html → datatypes.AWSRole.html} +25 -13
- package/docs/interfaces/{abusereport.html → datatypes.AbuseReport.html} +45 -33
- package/docs/interfaces/{abusereportcreate.html → datatypes.AbuseReportCreate.html} +25 -13
- package/docs/interfaces/{abusereporthostname.html → datatypes.AbuseReportHostname.html} +26 -14
- package/docs/interfaces/datatypes.AgentIngress.html +300 -0
- package/docs/interfaces/{ipwhitelistentrycreate.html → datatypes.AgentIngressCreate.html} +37 -25
- package/docs/interfaces/datatypes.AgentIngressList.html +205 -0
- package/docs/interfaces/{ipwhitelistentryupdate.html → datatypes.AgentIngressUpdate.html} +33 -21
- package/docs/interfaces/{certificateauthority.html → datatypes.CertificateAuthority.html} +73 -61
- package/docs/interfaces/{certificateauthoritycreate.html → datatypes.CertificateAuthorityCreate.html} +31 -19
- package/docs/interfaces/{certificateauthoritylist.html → datatypes.CertificateAuthorityList.html} +34 -22
- package/docs/interfaces/{certificateauthorityupdate.html → datatypes.CertificateAuthorityUpdate.html} +28 -16
- package/docs/interfaces/{credential.html → datatypes.Credential.html} +45 -33
- package/docs/interfaces/{credentialcreate.html → datatypes.CredentialCreate.html} +29 -17
- package/docs/interfaces/{credentiallist.html → datatypes.CredentialList.html} +32 -20
- package/docs/interfaces/{credentialupdate.html → datatypes.CredentialUpdate.html} +32 -20
- package/docs/interfaces/{endpointippolicyreplace.html → datatypes.EdgeBackendReplace.html} +29 -17
- package/docs/interfaces/{endpointbackendreplace.html → datatypes.EdgeIPRestrictionReplace.html} +29 -17
- package/docs/interfaces/{endpointresponseheadersreplace.html → datatypes.EdgeMutualTLSReplace.html} +29 -17
- package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +190 -0
- package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +190 -0
- package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +190 -0
- package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +190 -0
- package/docs/interfaces/{reserveddomaincertnstarget.html → datatypes.EdgeRouteItem.html} +36 -24
- package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +190 -0
- package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +190 -0
- package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +190 -0
- package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +190 -0
- package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +190 -0
- package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +190 -0
- package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +190 -0
- package/docs/interfaces/{endpointoauthreplace.html → datatypes.EdgeTLSTerminationAtEdgeReplace.html} +29 -17
- package/docs/interfaces/{endpointbasicauthreplace.html → datatypes.EdgeTLSTerminationReplace.html} +29 -17
- package/docs/interfaces/{empty.html → datatypes.Empty.html} +18 -7
- package/docs/interfaces/datatypes.Endpoint.html +395 -0
- package/docs/interfaces/{endpointbackend.html → datatypes.EndpointBackend.html} +27 -15
- package/docs/interfaces/{endpointlogging.html → datatypes.EndpointBackendMutate.html} +36 -24
- package/docs/interfaces/{endpointcircuitbreaker.html → datatypes.EndpointCircuitBreaker.html} +53 -41
- package/docs/interfaces/{endpointcompression.html → datatypes.EndpointCompression.html} +23 -11
- package/docs/interfaces/{endpointippolicy.html → datatypes.EndpointIPPolicy.html} +29 -17
- package/docs/interfaces/{endpointippolicymutate.html → datatypes.EndpointIPPolicyMutate.html} +29 -17
- package/docs/interfaces/datatypes.EndpointList.html +205 -0
- package/docs/interfaces/{endpointmutualtls.html → datatypes.EndpointMutualTLS.html} +29 -17
- package/docs/interfaces/{endpointmutualtlsmutate.html → datatypes.EndpointMutualTLSMutate.html} +29 -17
- package/docs/interfaces/{endpointoauth.html → datatypes.EndpointOAuth.html} +57 -45
- package/docs/interfaces/{endpointoauthfacebook.html → datatypes.EndpointOAuthFacebook.html} +48 -36
- package/docs/interfaces/{endpointoauthgithub.html → datatypes.EndpointOAuthGitHub.html} +55 -43
- package/docs/interfaces/{endpointoauthgoogle.html → datatypes.EndpointOAuthGoogle.html} +48 -36
- package/docs/interfaces/{endpointoauthmicrosoft.html → datatypes.EndpointOAuthMicrosoft.html} +48 -36
- package/docs/interfaces/{endpointoauthprovider.html → datatypes.EndpointOAuthProvider.html} +35 -23
- package/docs/interfaces/{endpointoidc.html → datatypes.EndpointOIDC.html} +65 -53
- package/docs/interfaces/{endpointrequestheaders.html → datatypes.EndpointRequestHeaders.html} +29 -17
- package/docs/interfaces/{endpointresponseheaders.html → datatypes.EndpointResponseHeaders.html} +29 -17
- package/docs/interfaces/{endpointsaml.html → datatypes.EndpointSAML.html} +121 -90
- package/docs/interfaces/{endpointsamlmutate.html → datatypes.EndpointSAMLMutate.html} +91 -60
- package/docs/interfaces/{endpointtlstermination.html → datatypes.EndpointTLSTermination.html} +37 -25
- package/docs/interfaces/{endpointloggingmutate.html → datatypes.EndpointTLSTerminationAtEdge.html} +33 -21
- package/docs/interfaces/{endpointwebhookvalidation.html → datatypes.EndpointWebhookValidation.html} +30 -18
- package/docs/interfaces/{staticbackendtls.html → datatypes.EndpointWebsocketTCPConverter.html} +27 -15
- package/docs/interfaces/{error.html → datatypes.Error.html} +37 -25
- package/docs/interfaces/{eventdestination.html → datatypes.EventDestination.html} +46 -34
- package/docs/interfaces/{eventdestinationcreate.html → datatypes.EventDestinationCreate.html} +34 -22
- package/docs/interfaces/{eventdestinationlist.html → datatypes.EventDestinationList.html} +34 -22
- package/docs/interfaces/{eventdestinationupdate.html → datatypes.EventDestinationUpdate.html} +37 -25
- package/docs/interfaces/{eventsource.html → datatypes.EventSource.html} +25 -13
- package/docs/interfaces/{eventsourcecreate.html → datatypes.EventSourceCreate.html} +28 -16
- package/docs/interfaces/{eventsourceitem.html → datatypes.EventSourceItem.html} +28 -16
- package/docs/interfaces/{eventsourcelist.html → datatypes.EventSourceList.html} +26 -14
- package/docs/interfaces/{eventsourcepaging.html → datatypes.EventSourcePaging.html} +25 -13
- package/docs/interfaces/{eventsourcereplace.html → datatypes.EventSourceReplace.html} +22 -10
- package/docs/interfaces/{eventsourceupdate.html → datatypes.EventSourceUpdate.html} +28 -16
- package/docs/interfaces/{eventsubscription.html → datatypes.EventSubscription.html} +45 -33
- package/docs/interfaces/{eventsubscriptioncreate.html → datatypes.EventSubscriptionCreate.html} +36 -24
- package/docs/interfaces/{eventsubscriptionlist.html → datatypes.EventSubscriptionList.html} +34 -22
- package/docs/interfaces/{eventsubscriptionupdate.html → datatypes.EventSubscriptionUpdate.html} +39 -27
- package/docs/interfaces/{eventtarget.html → datatypes.EventTarget.html} +33 -21
- package/docs/interfaces/{eventtargetcloudwatchlogs.html → datatypes.EventTargetCloudwatchLogs.html} +30 -18
- package/docs/interfaces/{eventtargetfirehose.html → datatypes.EventTargetFirehose.html} +30 -18
- package/docs/interfaces/{eventtargetkinesis.html → datatypes.EventTargetKinesis.html} +30 -18
- package/docs/interfaces/{staticbackend.html → datatypes.FailoverBackend.html} +52 -40
- package/docs/interfaces/{prioritybackendcreate.html → datatypes.FailoverBackendCreate.html} +31 -19
- package/docs/interfaces/{prioritybackendlist.html → datatypes.FailoverBackendList.html} +37 -25
- package/docs/interfaces/{prioritybackendupdate.html → datatypes.FailoverBackendUpdate.html} +34 -22
- package/docs/interfaces/datatypes.HTTPResponseBackend.html +295 -0
- package/docs/interfaces/{tunnelgroupbackend.html → datatypes.HTTPResponseBackendCreate.html} +53 -41
- package/docs/interfaces/{staticbackendlist.html → datatypes.HTTPResponseBackendList.html} +35 -38
- package/docs/interfaces/{tcpedge.html → datatypes.HTTPResponseBackendUpdate.html} +58 -65
- package/docs/interfaces/{eventstream.html → datatypes.HTTPSEdge.html} +78 -71
- package/docs/interfaces/{staticbackendupdate.html → datatypes.HTTPSEdgeCreate.html} +60 -48
- package/docs/interfaces/datatypes.HTTPSEdgeList.html +205 -0
- package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +509 -0
- package/docs/interfaces/{endpointconfigurationcreate.html → datatypes.HTTPSEdgeRouteCreate.html} +141 -110
- package/docs/interfaces/{endpointconfiguration.html → datatypes.HTTPSEdgeRouteUpdate.html} +138 -145
- package/docs/interfaces/{tlsedgeupdate.html → datatypes.HTTPSEdgeUpdate.html} +65 -43
- package/docs/interfaces/{ippolicy.html → datatypes.IPPolicy.html} +37 -44
- package/docs/interfaces/{ippolicycreate.html → datatypes.IPPolicyCreate.html} +25 -32
- package/docs/interfaces/{ippolicylist.html → datatypes.IPPolicyList.html} +34 -22
- package/docs/interfaces/{ippolicyrule.html → datatypes.IPPolicyRule.html} +65 -34
- package/docs/interfaces/{ippolicyrulecreate.html → datatypes.IPPolicyRuleCreate.html} +53 -22
- package/docs/interfaces/{ippolicyrulelist.html → datatypes.IPPolicyRuleList.html} +34 -22
- package/docs/interfaces/{ippolicyruleupdate.html → datatypes.IPPolicyRuleUpdate.html} +31 -19
- package/docs/interfaces/{ippolicyupdate.html → datatypes.IPPolicyUpdate.html} +28 -16
- package/docs/interfaces/{iprestriction.html → datatypes.IPRestriction.html} +50 -38
- package/docs/interfaces/{iprestrictioncreate.html → datatypes.IPRestrictionCreate.html} +38 -26
- package/docs/interfaces/{iprestrictionlist.html → datatypes.IPRestrictionList.html} +34 -22
- package/docs/interfaces/{iprestrictionupdate.html → datatypes.IPRestrictionUpdate.html} +37 -25
- package/docs/interfaces/{item.html → datatypes.Item.html} +22 -10
- package/docs/interfaces/{paging.html → datatypes.Paging.html} +28 -16
- package/docs/interfaces/{ref.html → datatypes.Ref.html} +25 -13
- package/docs/interfaces/{reservedaddr.html → datatypes.ReservedAddr.html} +43 -50
- package/docs/interfaces/{reservedaddrcreate.html → datatypes.ReservedAddrCreate.html} +28 -35
- package/docs/interfaces/{reservedaddrlist.html → datatypes.ReservedAddrList.html} +34 -22
- package/docs/interfaces/datatypes.ReservedAddrUpdate.html +200 -0
- package/docs/interfaces/{reserveddomain.html → datatypes.ReservedDomain.html} +82 -89
- package/docs/interfaces/{reserveddomaincertjob.html → datatypes.ReservedDomainCertJob.html} +40 -47
- package/docs/interfaces/{reserveddomaincertpolicy.html → datatypes.ReservedDomainCertPolicy.html} +28 -16
- package/docs/interfaces/{reserveddomaincertstatus.html → datatypes.ReservedDomainCertStatus.html} +31 -19
- package/docs/interfaces/{reserveddomaincreate.html → datatypes.ReservedDomainCreate.html} +45 -71
- package/docs/interfaces/{reserveddomainlist.html → datatypes.ReservedDomainList.html} +34 -22
- package/docs/interfaces/datatypes.ReservedDomainUpdate.html +238 -0
- package/docs/interfaces/{sshcertificateauthority.html → datatypes.SSHCertificateAuthority.html} +49 -37
- package/docs/interfaces/{sshcertificateauthoritycreate.html → datatypes.SSHCertificateAuthorityCreate.html} +45 -33
- package/docs/interfaces/{sshcertificateauthoritylist.html → datatypes.SSHCertificateAuthorityList.html} +34 -22
- package/docs/interfaces/{sshcertificateauthorityupdate.html → datatypes.SSHCertificateAuthorityUpdate.html} +28 -16
- package/docs/interfaces/{sshcredential.html → datatypes.SSHCredential.html} +47 -35
- package/docs/interfaces/{sshcredentialcreate.html → datatypes.SSHCredentialCreate.html} +35 -23
- package/docs/interfaces/{sshcredentiallist.html → datatypes.SSHCredentialList.html} +34 -22
- package/docs/interfaces/{sshcredentialupdate.html → datatypes.SSHCredentialUpdate.html} +32 -20
- package/docs/interfaces/{sshhostcertificate.html → datatypes.SSHHostCertificate.html} +76 -64
- package/docs/interfaces/{sshhostcertificatecreate.html → datatypes.SSHHostCertificateCreate.html} +53 -41
- package/docs/interfaces/{sshhostcertificatelist.html → datatypes.SSHHostCertificateList.html} +34 -22
- package/docs/interfaces/{sshhostcertificateupdate.html → datatypes.SSHHostCertificateUpdate.html} +28 -16
- package/docs/interfaces/{sshusercertificate.html → datatypes.SSHUserCertificate.html} +87 -75
- package/docs/interfaces/{sshusercertificatecreate.html → datatypes.SSHUserCertificateCreate.html} +64 -52
- package/docs/interfaces/{sshusercertificatelist.html → datatypes.SSHUserCertificateList.html} +34 -22
- package/docs/interfaces/{sshusercertificateupdate.html → datatypes.SSHUserCertificateUpdate.html} +28 -16
- package/docs/interfaces/{tlsedge.html → datatypes.TCPEdge.html} +69 -66
- package/docs/interfaces/{tlsedgecreate.html → datatypes.TCPEdgeCreate.html} +64 -42
- package/docs/interfaces/{endpointconfigurationlist.html → datatypes.TCPEdgeList.html} +40 -28
- package/docs/interfaces/{eventstreamupdate.html → datatypes.TCPEdgeUpdate.html} +60 -53
- package/docs/interfaces/{tlscertificate.html → datatypes.TLSCertificate.html} +134 -122
- package/docs/interfaces/{tlscertificatecreate.html → datatypes.TLSCertificateCreate.html} +39 -27
- package/docs/interfaces/{tlscertificatelist.html → datatypes.TLSCertificateList.html} +34 -22
- package/docs/interfaces/{tlscertificatesans.html → datatypes.TLSCertificateSANs.html} +28 -16
- package/docs/interfaces/{tlscertificateupdate.html → datatypes.TLSCertificateUpdate.html} +28 -16
- package/docs/interfaces/datatypes.TLSEdge.html +323 -0
- package/docs/interfaces/datatypes.TLSEdgeCreate.html +266 -0
- package/docs/interfaces/datatypes.TLSEdgeList.html +205 -0
- package/docs/interfaces/{reserveddomainupdate.html → datatypes.TLSEdgeUpdate.html} +83 -62
- package/docs/interfaces/datatypes.Tunnel.html +357 -0
- package/docs/interfaces/datatypes.TunnelGroupBackend.html +281 -0
- package/docs/interfaces/{tunnelgroupbackendcreate.html → datatypes.TunnelGroupBackendCreate.html} +28 -16
- package/docs/interfaces/{tunnelgroupbackendlist.html → datatypes.TunnelGroupBackendList.html} +32 -20
- package/docs/interfaces/{tunnelgroupbackendupdate.html → datatypes.TunnelGroupBackendUpdate.html} +31 -19
- package/docs/interfaces/{tunnellist.html → datatypes.TunnelList.html} +32 -20
- package/docs/interfaces/{tunnelsession.html → datatypes.TunnelSession.html} +57 -45
- package/docs/interfaces/{tunnelsessionlist.html → datatypes.TunnelSessionList.html} +34 -22
- package/docs/interfaces/{tunnelsessionsupdate.html → datatypes.TunnelSessionsUpdate.html} +22 -10
- package/docs/interfaces/{weightedbackend.html → datatypes.WeightedBackend.html} +56 -25
- package/docs/interfaces/{weightedbackendcreate.html → datatypes.WeightedBackendCreate.html} +28 -16
- package/docs/interfaces/{weightedbackendlist.html → datatypes.WeightedBackendList.html} +32 -20
- package/docs/interfaces/{weightedbackendupdate.html → datatypes.WeightedBackendUpdate.html} +31 -19
- package/docs/{interfaces/endpointbasicauth.html → modules/client.html} +38 -20
- package/docs/modules/datatypes.html +796 -0
- package/docs/modules/services.html +316 -0
- package/docs/modules.html +16 -690
- package/lib/client.d.ts +179 -0
- package/lib/client.d.ts.map +1 -0
- package/lib/client.js +126 -0
- package/lib/client.js.map +1 -0
- package/lib/{types.d.ts → datatypes.d.ts} +729 -660
- package/lib/datatypes.d.ts.map +1 -0
- package/lib/{types.js → datatypes.js} +1 -1
- package/lib/datatypes.js.map +1 -0
- package/lib/index.d.ts +2 -378
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +2 -2148
- package/lib/index.js.map +1 -1
- package/lib/services.d.ts +993 -0
- package/lib/services.d.ts.map +1 -0
- package/lib/services.js +3600 -0
- package/lib/services.js.map +1 -0
- package/lib/util.d.ts +5 -0
- package/lib/util.d.ts.map +1 -0
- package/lib/util.js +53 -0
- package/lib/util.js.map +1 -0
- package/package.json +2 -2
- package/src/client.ts +322 -0
- package/src/{types.ts → datatypes.ts} +760 -689
- package/src/index.ts +2 -1775
- package/src/services.ts +3380 -0
- package/src/util.ts +48 -0
- package/test/apikey.test.js +41 -30
- package/docs/classes/ngrok.html +0 -5028
- package/docs/interfaces/endpointbackendmutate.html +0 -119
- package/docs/interfaces/endpointcircuitbreakerreplace.html +0 -164
- package/docs/interfaces/endpointcompressionreplace.html +0 -164
- package/docs/interfaces/endpointconfigurationupdate.html +0 -421
- package/docs/interfaces/endpointloggingreplace.html +0 -164
- package/docs/interfaces/endpointmutualtlsreplace.html +0 -164
- package/docs/interfaces/endpointoidcreplace.html +0 -164
- package/docs/interfaces/endpointrequestheadersreplace.html +0 -164
- package/docs/interfaces/endpointsamlreplace.html +0 -164
- package/docs/interfaces/endpointtlsterminationreplace.html +0 -164
- package/docs/interfaces/endpointwebhookvalidationreplace.html +0 -164
- package/docs/interfaces/eventstreamcreate.html +0 -250
- package/docs/interfaces/eventstreamlist.html +0 -193
- package/docs/interfaces/eventtargetdebug.html +0 -119
- package/docs/interfaces/eventtargets3.html +0 -250
- package/docs/interfaces/ipwhitelistentry.html +0 -250
- package/docs/interfaces/ipwhitelistentrylist.html +0 -193
- package/docs/interfaces/prioritybackend.html +0 -231
- package/docs/interfaces/reservedaddrupdate.html +0 -207
- package/docs/interfaces/rootresponse.html +0 -164
- package/docs/interfaces/sentevent.html +0 -150
- package/docs/interfaces/staticbackendcreate.html +0 -212
- package/docs/interfaces/tcpedgecreate.html +0 -188
- package/docs/interfaces/tcpedgeupdate.html +0 -207
- package/docs/interfaces/tunnel.html +0 -269
- package/lib/types.d.ts.map +0 -1
- package/lib/types.js.map +0 -1
- package/test/endpointConfigurations.test.js +0 -63
|
@@ -0,0 +1,205 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html class="default no-js">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
6
|
+
<title>EndpointList | @ngrok/ngrok-api</title>
|
|
7
|
+
<meta name="description" content="Documentation for @ngrok/ngrok-api">
|
|
8
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
|
+
<link rel="stylesheet" href="../assets/css/main.css">
|
|
10
|
+
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
11
|
+
</head>
|
|
12
|
+
<body>
|
|
13
|
+
<header>
|
|
14
|
+
<div class="tsd-page-toolbar">
|
|
15
|
+
<div class="container">
|
|
16
|
+
<div class="table-wrap">
|
|
17
|
+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
18
|
+
<div class="field">
|
|
19
|
+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
20
|
+
<input id="tsd-search-field" type="text" />
|
|
21
|
+
</div>
|
|
22
|
+
<ul class="results">
|
|
23
|
+
<li class="state loading">Preparing search index...</li>
|
|
24
|
+
<li class="state failure">The search index is not available</li>
|
|
25
|
+
</ul>
|
|
26
|
+
<a href="../index.html" class="title">@ngrok/ngrok-api</a>
|
|
27
|
+
</div>
|
|
28
|
+
<div class="table-cell" id="tsd-widgets">
|
|
29
|
+
<div id="tsd-filter">
|
|
30
|
+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
31
|
+
<div class="tsd-filter-group">
|
|
32
|
+
<div class="tsd-select" id="tsd-filter-visibility">
|
|
33
|
+
<span class="tsd-select-label">All</span>
|
|
34
|
+
<ul class="tsd-select-list">
|
|
35
|
+
<li data-value="public">Public</li>
|
|
36
|
+
<li data-value="protected">Public/Protected</li>
|
|
37
|
+
<li data-value="private" class="selected">All</li>
|
|
38
|
+
</ul>
|
|
39
|
+
</div>
|
|
40
|
+
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
41
|
+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
42
|
+
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
43
|
+
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
44
|
+
</div>
|
|
45
|
+
</div>
|
|
46
|
+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
47
|
+
</div>
|
|
48
|
+
</div>
|
|
49
|
+
</div>
|
|
50
|
+
</div>
|
|
51
|
+
<div class="tsd-page-title">
|
|
52
|
+
<div class="container">
|
|
53
|
+
<ul class="tsd-breadcrumb">
|
|
54
|
+
<li>
|
|
55
|
+
<a href="../modules.html">@ngrok/ngrok-api</a>
|
|
56
|
+
</li>
|
|
57
|
+
<li>
|
|
58
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
59
|
+
</li>
|
|
60
|
+
<li>
|
|
61
|
+
<a href="datatypes.EndpointList.html">EndpointList</a>
|
|
62
|
+
</li>
|
|
63
|
+
</ul>
|
|
64
|
+
<h1>Interface EndpointList</h1>
|
|
65
|
+
</div>
|
|
66
|
+
</div>
|
|
67
|
+
</header>
|
|
68
|
+
<div class="container container-main">
|
|
69
|
+
<div class="row">
|
|
70
|
+
<div class="col-8 col-content">
|
|
71
|
+
<section class="tsd-panel tsd-hierarchy">
|
|
72
|
+
<h3>Hierarchy</h3>
|
|
73
|
+
<ul class="tsd-hierarchy">
|
|
74
|
+
<li>
|
|
75
|
+
<span class="target">EndpointList</span>
|
|
76
|
+
</li>
|
|
77
|
+
</ul>
|
|
78
|
+
</section>
|
|
79
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
80
|
+
<h2>Index</h2>
|
|
81
|
+
<section class="tsd-panel tsd-index-panel">
|
|
82
|
+
<div class="tsd-index-content">
|
|
83
|
+
<section class="tsd-index-section ">
|
|
84
|
+
<h3>Properties</h3>
|
|
85
|
+
<ul class="tsd-index-list">
|
|
86
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointList.html#endpoints" class="tsd-kind-icon">endpoints</a></li>
|
|
87
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a></li>
|
|
88
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointList.html#uri" class="tsd-kind-icon">uri</a></li>
|
|
89
|
+
</ul>
|
|
90
|
+
</section>
|
|
91
|
+
</div>
|
|
92
|
+
</section>
|
|
93
|
+
</section>
|
|
94
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
95
|
+
<h2>Properties</h2>
|
|
96
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
97
|
+
<a name="endpoints" class="tsd-anchor"></a>
|
|
98
|
+
<h3>endpoints</h3>
|
|
99
|
+
<div class="tsd-signature tsd-kind-icon">endpoints<span class="tsd-signature-symbol">:</span> <a href="datatypes.Endpoint.html" class="tsd-signature-type" data-tsd-kind="Interface">Endpoint</a><span class="tsd-signature-symbol">[]</span></div>
|
|
100
|
+
<aside class="tsd-sources">
|
|
101
|
+
<ul>
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1099">datatypes.ts:1099</a></li>
|
|
103
|
+
</ul>
|
|
104
|
+
</aside>
|
|
105
|
+
<div class="tsd-comment tsd-typography">
|
|
106
|
+
<div class="lead">
|
|
107
|
+
<p>the list of all active endpoints on this account</p>
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
</section>
|
|
111
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
112
|
+
<a name="nextPageUri" class="tsd-anchor"></a>
|
|
113
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> next<wbr>Page<wbr>Uri</h3>
|
|
114
|
+
<div class="tsd-signature tsd-kind-icon">next<wbr>Page<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
115
|
+
<aside class="tsd-sources">
|
|
116
|
+
<ul>
|
|
117
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1103">datatypes.ts:1103</a></li>
|
|
118
|
+
</ul>
|
|
119
|
+
</aside>
|
|
120
|
+
<div class="tsd-comment tsd-typography">
|
|
121
|
+
<div class="lead">
|
|
122
|
+
<p>URI of the next page, or null if there is no next page</p>
|
|
123
|
+
</div>
|
|
124
|
+
</div>
|
|
125
|
+
</section>
|
|
126
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
127
|
+
<a name="uri" class="tsd-anchor"></a>
|
|
128
|
+
<h3>uri</h3>
|
|
129
|
+
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
130
|
+
<aside class="tsd-sources">
|
|
131
|
+
<ul>
|
|
132
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1101">datatypes.ts:1101</a></li>
|
|
133
|
+
</ul>
|
|
134
|
+
</aside>
|
|
135
|
+
<div class="tsd-comment tsd-typography">
|
|
136
|
+
<div class="lead">
|
|
137
|
+
<p>URI of the endpoints list API resource</p>
|
|
138
|
+
</div>
|
|
139
|
+
</div>
|
|
140
|
+
</section>
|
|
141
|
+
</section>
|
|
142
|
+
</div>
|
|
143
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
144
|
+
<nav class="tsd-navigation primary">
|
|
145
|
+
<ul>
|
|
146
|
+
<li class=" ">
|
|
147
|
+
<a href="../modules.html">Modules</a>
|
|
148
|
+
</li>
|
|
149
|
+
<li class=" tsd-kind-module">
|
|
150
|
+
<a href="../modules/client.html">client</a>
|
|
151
|
+
</li>
|
|
152
|
+
<li class="current tsd-kind-module">
|
|
153
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
154
|
+
</li>
|
|
155
|
+
<li class=" tsd-kind-module">
|
|
156
|
+
<a href="../modules/services.html">services</a>
|
|
157
|
+
</li>
|
|
158
|
+
</ul>
|
|
159
|
+
</nav>
|
|
160
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
161
|
+
<ul class="before-current">
|
|
162
|
+
</ul>
|
|
163
|
+
<ul class="current">
|
|
164
|
+
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
165
|
+
<a href="datatypes.EndpointList.html" class="tsd-kind-icon">Endpoint<wbr>List</a>
|
|
166
|
+
<ul>
|
|
167
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
168
|
+
<a href="datatypes.EndpointList.html#endpoints" class="tsd-kind-icon">endpoints</a>
|
|
169
|
+
</li>
|
|
170
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
171
|
+
<a href="datatypes.EndpointList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a>
|
|
172
|
+
</li>
|
|
173
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
174
|
+
<a href="datatypes.EndpointList.html#uri" class="tsd-kind-icon">uri</a>
|
|
175
|
+
</li>
|
|
176
|
+
</ul>
|
|
177
|
+
</li>
|
|
178
|
+
</ul>
|
|
179
|
+
<ul class="after-current">
|
|
180
|
+
</ul>
|
|
181
|
+
</nav>
|
|
182
|
+
</div>
|
|
183
|
+
</div>
|
|
184
|
+
</div>
|
|
185
|
+
<footer class="with-border-bottom">
|
|
186
|
+
<div class="container">
|
|
187
|
+
<h2>Legend</h2>
|
|
188
|
+
<div class="tsd-legend-group">
|
|
189
|
+
<ul class="tsd-legend">
|
|
190
|
+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
191
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
192
|
+
</ul>
|
|
193
|
+
<ul class="tsd-legend">
|
|
194
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
195
|
+
</ul>
|
|
196
|
+
</div>
|
|
197
|
+
</div>
|
|
198
|
+
</footer>
|
|
199
|
+
<div class="container tsd-generator">
|
|
200
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
201
|
+
</div>
|
|
202
|
+
<div class="overlay"></div>
|
|
203
|
+
<script src="../assets/js/main.js"></script>
|
|
204
|
+
</body>
|
|
205
|
+
</html>
|
|
@@ -55,7 +55,10 @@
|
|
|
55
55
|
<a href="../modules.html">@ngrok/ngrok-api</a>
|
|
56
56
|
</li>
|
|
57
57
|
<li>
|
|
58
|
-
<a href="
|
|
58
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
59
|
+
</li>
|
|
60
|
+
<li>
|
|
61
|
+
<a href="datatypes.EndpointMutualTLS.html">EndpointMutualTLS</a>
|
|
59
62
|
</li>
|
|
60
63
|
</ul>
|
|
61
64
|
<h1>Interface EndpointMutualTLS</h1>
|
|
@@ -80,8 +83,8 @@
|
|
|
80
83
|
<section class="tsd-index-section ">
|
|
81
84
|
<h3>Properties</h3>
|
|
82
85
|
<ul class="tsd-index-list">
|
|
83
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="
|
|
84
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="
|
|
86
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointMutualTLS.html#certificateAuthorities" class="tsd-kind-icon">certificate<wbr>Authorities</a></li>
|
|
87
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointMutualTLS.html#enabled" class="tsd-kind-icon">enabled</a></li>
|
|
85
88
|
</ul>
|
|
86
89
|
</section>
|
|
87
90
|
</div>
|
|
@@ -90,12 +93,12 @@
|
|
|
90
93
|
<section class="tsd-panel-group tsd-member-group ">
|
|
91
94
|
<h2>Properties</h2>
|
|
92
95
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
93
|
-
<a name="
|
|
94
|
-
<h3>
|
|
95
|
-
<div class="tsd-signature tsd-kind-icon">
|
|
96
|
+
<a name="certificateAuthorities" class="tsd-anchor"></a>
|
|
97
|
+
<h3>certificate<wbr>Authorities</h3>
|
|
98
|
+
<div class="tsd-signature tsd-kind-icon">certificate<wbr>Authorities<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a><span class="tsd-signature-symbol">[]</span></div>
|
|
96
99
|
<aside class="tsd-sources">
|
|
97
100
|
<ul>
|
|
98
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L438">datatypes.ts:438</a></li>
|
|
99
102
|
</ul>
|
|
100
103
|
</aside>
|
|
101
104
|
<div class="tsd-comment tsd-typography">
|
|
@@ -110,12 +113,12 @@
|
|
|
110
113
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
111
114
|
<aside class="tsd-sources">
|
|
112
115
|
<ul>
|
|
113
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
116
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L436">datatypes.ts:436</a></li>
|
|
114
117
|
</ul>
|
|
115
118
|
</aside>
|
|
116
119
|
<div class="tsd-comment tsd-typography">
|
|
117
120
|
<div class="lead">
|
|
118
|
-
<p>true if the module will be applied to traffic, false to disable. default true if unspecified</p>
|
|
121
|
+
<p><code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</p>
|
|
119
122
|
</div>
|
|
120
123
|
</div>
|
|
121
124
|
</section>
|
|
@@ -125,7 +128,16 @@
|
|
|
125
128
|
<nav class="tsd-navigation primary">
|
|
126
129
|
<ul>
|
|
127
130
|
<li class=" ">
|
|
128
|
-
<a href="../modules.html">
|
|
131
|
+
<a href="../modules.html">Modules</a>
|
|
132
|
+
</li>
|
|
133
|
+
<li class=" tsd-kind-module">
|
|
134
|
+
<a href="../modules/client.html">client</a>
|
|
135
|
+
</li>
|
|
136
|
+
<li class="current tsd-kind-module">
|
|
137
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
138
|
+
</li>
|
|
139
|
+
<li class=" tsd-kind-module">
|
|
140
|
+
<a href="../modules/services.html">services</a>
|
|
129
141
|
</li>
|
|
130
142
|
</ul>
|
|
131
143
|
</nav>
|
|
@@ -133,14 +145,14 @@
|
|
|
133
145
|
<ul class="before-current">
|
|
134
146
|
</ul>
|
|
135
147
|
<ul class="current">
|
|
136
|
-
<li class="current tsd-kind-interface">
|
|
137
|
-
<a href="
|
|
148
|
+
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
149
|
+
<a href="datatypes.EndpointMutualTLS.html" class="tsd-kind-icon">Endpoint<wbr>MutualTLS</a>
|
|
138
150
|
<ul>
|
|
139
151
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
140
|
-
<a href="
|
|
152
|
+
<a href="datatypes.EndpointMutualTLS.html#certificateAuthorities" class="tsd-kind-icon">certificate<wbr>Authorities</a>
|
|
141
153
|
</li>
|
|
142
154
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
143
|
-
<a href="
|
|
155
|
+
<a href="datatypes.EndpointMutualTLS.html#enabled" class="tsd-kind-icon">enabled</a>
|
|
144
156
|
</li>
|
|
145
157
|
</ul>
|
|
146
158
|
</li>
|
|
@@ -156,11 +168,11 @@
|
|
|
156
168
|
<h2>Legend</h2>
|
|
157
169
|
<div class="tsd-legend-group">
|
|
158
170
|
<ul class="tsd-legend">
|
|
159
|
-
<li class="tsd-kind-
|
|
160
|
-
<li class="tsd-kind-property tsd-parent-kind-
|
|
171
|
+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
172
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
161
173
|
</ul>
|
|
162
174
|
<ul class="tsd-legend">
|
|
163
|
-
<li class="tsd-kind-
|
|
175
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
164
176
|
</ul>
|
|
165
177
|
</div>
|
|
166
178
|
</div>
|
package/docs/interfaces/{endpointmutualtlsmutate.html → datatypes.EndpointMutualTLSMutate.html}
RENAMED
|
@@ -55,7 +55,10 @@
|
|
|
55
55
|
<a href="../modules.html">@ngrok/ngrok-api</a>
|
|
56
56
|
</li>
|
|
57
57
|
<li>
|
|
58
|
-
<a href="
|
|
58
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
59
|
+
</li>
|
|
60
|
+
<li>
|
|
61
|
+
<a href="datatypes.EndpointMutualTLSMutate.html">EndpointMutualTLSMutate</a>
|
|
59
62
|
</li>
|
|
60
63
|
</ul>
|
|
61
64
|
<h1>Interface EndpointMutualTLSMutate</h1>
|
|
@@ -80,8 +83,8 @@
|
|
|
80
83
|
<section class="tsd-index-section ">
|
|
81
84
|
<h3>Properties</h3>
|
|
82
85
|
<ul class="tsd-index-list">
|
|
83
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="
|
|
84
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="
|
|
86
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointMutualTLSMutate.html#certificateAuthorityIds" class="tsd-kind-icon">certificate<wbr>Authority<wbr>Ids</a></li>
|
|
87
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointMutualTLSMutate.html#enabled" class="tsd-kind-icon">enabled</a></li>
|
|
85
88
|
</ul>
|
|
86
89
|
</section>
|
|
87
90
|
</div>
|
|
@@ -90,12 +93,12 @@
|
|
|
90
93
|
<section class="tsd-panel-group tsd-member-group ">
|
|
91
94
|
<h2>Properties</h2>
|
|
92
95
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
93
|
-
<a name="
|
|
94
|
-
<h3>
|
|
95
|
-
<div class="tsd-signature tsd-kind-icon">
|
|
96
|
+
<a name="certificateAuthorityIds" class="tsd-anchor"></a>
|
|
97
|
+
<h3>certificate<wbr>Authority<wbr>Ids</h3>
|
|
98
|
+
<div class="tsd-signature tsd-kind-icon">certificate<wbr>Authority<wbr>Ids<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
96
99
|
<aside class="tsd-sources">
|
|
97
100
|
<ul>
|
|
98
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L445">datatypes.ts:445</a></li>
|
|
99
102
|
</ul>
|
|
100
103
|
</aside>
|
|
101
104
|
<div class="tsd-comment tsd-typography">
|
|
@@ -110,12 +113,12 @@
|
|
|
110
113
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
111
114
|
<aside class="tsd-sources">
|
|
112
115
|
<ul>
|
|
113
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
116
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L443">datatypes.ts:443</a></li>
|
|
114
117
|
</ul>
|
|
115
118
|
</aside>
|
|
116
119
|
<div class="tsd-comment tsd-typography">
|
|
117
120
|
<div class="lead">
|
|
118
|
-
<p>true if the module will be applied to traffic, false to disable. default true if unspecified</p>
|
|
121
|
+
<p><code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</p>
|
|
119
122
|
</div>
|
|
120
123
|
</div>
|
|
121
124
|
</section>
|
|
@@ -125,7 +128,16 @@
|
|
|
125
128
|
<nav class="tsd-navigation primary">
|
|
126
129
|
<ul>
|
|
127
130
|
<li class=" ">
|
|
128
|
-
<a href="../modules.html">
|
|
131
|
+
<a href="../modules.html">Modules</a>
|
|
132
|
+
</li>
|
|
133
|
+
<li class=" tsd-kind-module">
|
|
134
|
+
<a href="../modules/client.html">client</a>
|
|
135
|
+
</li>
|
|
136
|
+
<li class="current tsd-kind-module">
|
|
137
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
138
|
+
</li>
|
|
139
|
+
<li class=" tsd-kind-module">
|
|
140
|
+
<a href="../modules/services.html">services</a>
|
|
129
141
|
</li>
|
|
130
142
|
</ul>
|
|
131
143
|
</nav>
|
|
@@ -133,14 +145,14 @@
|
|
|
133
145
|
<ul class="before-current">
|
|
134
146
|
</ul>
|
|
135
147
|
<ul class="current">
|
|
136
|
-
<li class="current tsd-kind-interface">
|
|
137
|
-
<a href="
|
|
148
|
+
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
149
|
+
<a href="datatypes.EndpointMutualTLSMutate.html" class="tsd-kind-icon">Endpoint<wbr>MutualTLSMutate</a>
|
|
138
150
|
<ul>
|
|
139
151
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
140
|
-
<a href="
|
|
152
|
+
<a href="datatypes.EndpointMutualTLSMutate.html#certificateAuthorityIds" class="tsd-kind-icon">certificate<wbr>Authority<wbr>Ids</a>
|
|
141
153
|
</li>
|
|
142
154
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
143
|
-
<a href="
|
|
155
|
+
<a href="datatypes.EndpointMutualTLSMutate.html#enabled" class="tsd-kind-icon">enabled</a>
|
|
144
156
|
</li>
|
|
145
157
|
</ul>
|
|
146
158
|
</li>
|
|
@@ -156,11 +168,11 @@
|
|
|
156
168
|
<h2>Legend</h2>
|
|
157
169
|
<div class="tsd-legend-group">
|
|
158
170
|
<ul class="tsd-legend">
|
|
159
|
-
<li class="tsd-kind-
|
|
160
|
-
<li class="tsd-kind-property tsd-parent-kind-
|
|
171
|
+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
172
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
161
173
|
</ul>
|
|
162
174
|
<ul class="tsd-legend">
|
|
163
|
-
<li class="tsd-kind-
|
|
175
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
164
176
|
</ul>
|
|
165
177
|
</div>
|
|
166
178
|
</div>
|