@ngrok/ngrok-api 0.2.0 → 0.3.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/docs/CNAME +1 -0
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/client.Ngrok.html +37 -43
- package/docs/classes/services.APIKeys.html +9 -9
- package/docs/classes/services.AbuseReports.html +6 -6
- package/docs/classes/{services.IPWhitelist.html → services.AgentIngresses.html} +61 -69
- package/docs/classes/services.CertificateAuthorities.html +9 -9
- package/docs/classes/services.Credentials.html +9 -9
- package/docs/classes/services.EndpointCircuitBreakerModule.html +7 -7
- package/docs/classes/services.EndpointCompressionModule.html +7 -7
- package/docs/classes/services.EndpointConfigurations.html +9 -9
- package/docs/classes/services.EndpointIPPolicyModule.html +7 -7
- package/docs/classes/services.EndpointLoggingModule.html +7 -7
- package/docs/classes/services.EndpointMutualTLSModule.html +7 -7
- package/docs/classes/services.EndpointOAuthModule.html +7 -7
- package/docs/classes/services.EndpointOIDCModule.html +7 -7
- package/docs/classes/services.EndpointRequestHeadersModule.html +7 -7
- package/docs/classes/services.EndpointResponseHeadersModule.html +7 -7
- package/docs/classes/services.EndpointSAMLModule.html +7 -7
- package/docs/classes/services.EndpointTLSTerminationModule.html +7 -7
- package/docs/classes/services.EndpointWebhookValidationModule.html +7 -7
- package/docs/classes/services.EventDestinations.html +9 -9
- package/docs/classes/services.EventSources.html +9 -9
- package/docs/classes/services.EventStreams.html +9 -9
- package/docs/classes/services.EventSubscriptions.html +9 -9
- package/docs/classes/services.IPPolicies.html +9 -9
- package/docs/classes/services.IPPolicyRules.html +9 -9
- package/docs/classes/services.IPRestrictions.html +9 -9
- package/docs/classes/services.ReservedAddrs.html +10 -10
- package/docs/classes/services.ReservedDomains.html +13 -13
- package/docs/classes/services.SSHCertificateAuthorities.html +9 -9
- package/docs/classes/services.SSHCredentials.html +9 -9
- package/docs/classes/services.SSHHostCertificates.html +9 -9
- package/docs/classes/services.SSHUserCertificates.html +9 -9
- package/docs/classes/services.TLSCertificates.html +9 -9
- package/docs/classes/services.TunnelSessions.html +9 -9
- package/docs/classes/services.Tunnels.html +5 -5
- package/docs/interfaces/client.NgrokConfig.html +2 -2
- package/docs/interfaces/datatypes.APIKey.html +6 -6
- package/docs/interfaces/datatypes.APIKeyCreate.html +2 -2
- package/docs/interfaces/datatypes.APIKeyList.html +3 -3
- package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
- package/docs/interfaces/datatypes.AWSAuth.html +2 -2
- package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
- package/docs/interfaces/datatypes.AWSRole.html +1 -1
- package/docs/interfaces/datatypes.AbuseReport.html +7 -7
- package/docs/interfaces/datatypes.AbuseReportCreate.html +2 -2
- package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
- package/docs/interfaces/{datatypes.IPWhitelistEntry.html → datatypes.AgentIngress.html} +73 -35
- package/docs/interfaces/{datatypes.IPWhitelistEntryCreate.html → datatypes.AgentIngressCreate.html} +20 -20
- package/docs/interfaces/{datatypes.IPWhitelistEntryList.html → datatypes.AgentIngressList.html} +26 -26
- package/docs/interfaces/{datatypes.IPWhitelistEntryUpdate.html → datatypes.AgentIngressUpdate.html} +16 -16
- package/docs/interfaces/datatypes.CertificateAuthority.html +11 -11
- package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.Credential.html +7 -7
- package/docs/interfaces/datatypes.CredentialCreate.html +3 -3
- package/docs/interfaces/datatypes.CredentialList.html +3 -3
- package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
- package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
- package/docs/interfaces/datatypes.EndpointCircuitBreakerReplace.html +2 -2
- package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
- package/docs/interfaces/datatypes.EndpointCompressionReplace.html +2 -2
- package/docs/interfaces/datatypes.EndpointConfiguration.html +18 -18
- package/docs/interfaces/datatypes.EndpointConfigurationCreate.html +15 -15
- package/docs/interfaces/datatypes.EndpointConfigurationList.html +3 -3
- package/docs/interfaces/datatypes.EndpointConfigurationUpdate.html +15 -15
- package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
- package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointIPPolicyReplace.html +2 -2
- package/docs/interfaces/datatypes.EndpointLogging.html +2 -2
- package/docs/interfaces/datatypes.EndpointLoggingMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointLoggingReplace.html +2 -2
- package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
- package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointMutualTLSReplace.html +2 -2
- package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
- package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
- package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthProvider.html +4 -4
- package/docs/interfaces/datatypes.EndpointOAuthReplace.html +2 -2
- package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
- package/docs/interfaces/datatypes.EndpointOIDCReplace.html +2 -2
- package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointRequestHeadersReplace.html +2 -2
- package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointResponseHeadersReplace.html +2 -2
- package/docs/interfaces/datatypes.EndpointSAML.html +33 -14
- package/docs/interfaces/datatypes.EndpointSAMLMutate.html +28 -9
- package/docs/interfaces/datatypes.EndpointSAMLReplace.html +2 -2
- package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
- package/docs/interfaces/datatypes.EndpointTLSTerminationReplace.html +2 -2
- package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
- package/docs/interfaces/datatypes.EndpointWebhookValidationReplace.html +2 -2
- package/docs/interfaces/datatypes.Error.html +4 -4
- package/docs/interfaces/datatypes.EventDestination.html +7 -7
- package/docs/interfaces/datatypes.EventDestinationCreate.html +4 -4
- package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
- package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
- package/docs/interfaces/datatypes.EventSource.html +2 -2
- package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
- package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
- package/docs/interfaces/datatypes.EventSourceList.html +2 -2
- package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
- package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
- package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
- package/docs/interfaces/datatypes.EventStream.html +9 -9
- package/docs/interfaces/datatypes.EventStreamCreate.html +6 -6
- package/docs/interfaces/datatypes.EventStreamList.html +3 -3
- package/docs/interfaces/datatypes.EventStreamUpdate.html +6 -6
- package/docs/interfaces/datatypes.EventSubscription.html +7 -7
- package/docs/interfaces/datatypes.EventSubscriptionCreate.html +4 -4
- package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
- package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
- package/docs/interfaces/datatypes.EventTarget.html +3 -3
- package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
- package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
- package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
- package/docs/interfaces/datatypes.IPPolicy.html +6 -6
- package/docs/interfaces/datatypes.IPPolicyCreate.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRule.html +7 -7
- package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +4 -4
- package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
- package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
- package/docs/interfaces/datatypes.IPRestriction.html +8 -8
- package/docs/interfaces/datatypes.IPRestrictionCreate.html +5 -5
- package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
- package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
- package/docs/interfaces/datatypes.Item.html +1 -1
- package/docs/interfaces/datatypes.Paging.html +2 -2
- package/docs/interfaces/datatypes.Ref.html +2 -2
- package/docs/interfaces/datatypes.ReservedAddr.html +8 -8
- package/docs/interfaces/datatypes.ReservedAddrCreate.html +5 -5
- package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrUpdate.html +4 -4
- package/docs/interfaces/datatypes.ReservedDomain.html +32 -13
- package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -23
- package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCreate.html +8 -8
- package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainUpdate.html +7 -7
- package/docs/interfaces/datatypes.SSHCertificateAuthority.html +7 -7
- package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +5 -5
- package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHCredential.html +7 -7
- package/docs/interfaces/datatypes.SSHCredentialCreate.html +4 -4
- package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
- package/docs/interfaces/datatypes.SSHCredentialUpdate.html +4 -4
- package/docs/interfaces/datatypes.SSHHostCertificate.html +12 -12
- package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +7 -7
- package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificate.html +14 -14
- package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +9 -9
- package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.TLSCertificate.html +21 -21
- package/docs/interfaces/datatypes.TLSCertificateCreate.html +4 -4
- package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
- package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
- package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.Tunnel.html +7 -7
- package/docs/interfaces/datatypes.TunnelList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSession.html +10 -10
- package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
- package/docs/modules/datatypes.html +16 -20
- package/docs/modules/services.html +4 -4
- package/lib/client.d.ts +1 -5
- package/lib/client.d.ts.map +1 -1
- package/lib/client.js +3 -4
- package/lib/client.js.map +1 -1
- package/lib/datatypes.d.ts +49 -47
- package/lib/datatypes.d.ts.map +1 -1
- package/lib/services.d.ts +27 -31
- package/lib/services.d.ts.map +1 -1
- package/lib/services.js +155 -159
- package/lib/services.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +3 -7
- package/src/datatypes.ts +53 -52
- package/src/services.ts +98 -102
- package/docs/interfaces/datatypes.ReservedDomainCertNSTarget.html +0 -186
|
@@ -102,7 +102,7 @@
|
|
|
102
102
|
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
103
103
|
<aside class="tsd-sources">
|
|
104
104
|
<ul>
|
|
105
|
-
<li>Defined in datatypes.ts:
|
|
105
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L128">datatypes.ts:128</a></li>
|
|
106
106
|
</ul>
|
|
107
107
|
</aside>
|
|
108
108
|
<div class="tsd-comment tsd-typography">
|
|
@@ -117,7 +117,7 @@
|
|
|
117
117
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
118
118
|
<aside class="tsd-sources">
|
|
119
119
|
<ul>
|
|
120
|
-
<li>Defined in datatypes.ts:
|
|
120
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L124">datatypes.ts:124</a></li>
|
|
121
121
|
</ul>
|
|
122
122
|
</aside>
|
|
123
123
|
<div class="tsd-comment tsd-typography">
|
|
@@ -132,7 +132,7 @@
|
|
|
132
132
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
133
133
|
<aside class="tsd-sources">
|
|
134
134
|
<ul>
|
|
135
|
-
<li>Defined in datatypes.ts:
|
|
135
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L120">datatypes.ts:120</a></li>
|
|
136
136
|
</ul>
|
|
137
137
|
</aside>
|
|
138
138
|
<div class="tsd-comment tsd-typography">
|
|
@@ -147,7 +147,7 @@
|
|
|
147
147
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
148
148
|
<aside class="tsd-sources">
|
|
149
149
|
<ul>
|
|
150
|
-
<li>Defined in datatypes.ts:
|
|
150
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L126">datatypes.ts:126</a></li>
|
|
151
151
|
</ul>
|
|
152
152
|
</aside>
|
|
153
153
|
<div class="tsd-comment tsd-typography">
|
|
@@ -162,7 +162,7 @@
|
|
|
162
162
|
<div class="tsd-signature tsd-kind-icon">token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
163
163
|
<aside class="tsd-sources">
|
|
164
164
|
<ul>
|
|
165
|
-
<li>Defined in datatypes.ts:
|
|
165
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L130">datatypes.ts:130</a></li>
|
|
166
166
|
</ul>
|
|
167
167
|
</aside>
|
|
168
168
|
<div class="tsd-comment tsd-typography">
|
|
@@ -177,7 +177,7 @@
|
|
|
177
177
|
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
178
178
|
<aside class="tsd-sources">
|
|
179
179
|
<ul>
|
|
180
|
-
<li>Defined in datatypes.ts:
|
|
180
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L122">datatypes.ts:122</a></li>
|
|
181
181
|
</ul>
|
|
182
182
|
</aside>
|
|
183
183
|
<div class="tsd-comment tsd-typography">
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
99
99
|
<aside class="tsd-sources">
|
|
100
100
|
<ul>
|
|
101
|
-
<li>Defined in datatypes.ts:
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L105">datatypes.ts:105</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
<div class="tsd-comment tsd-typography">
|
|
@@ -113,7 +113,7 @@
|
|
|
113
113
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
114
114
|
<aside class="tsd-sources">
|
|
115
115
|
<ul>
|
|
116
|
-
<li>Defined in datatypes.ts:
|
|
116
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L107">datatypes.ts:107</a></li>
|
|
117
117
|
</ul>
|
|
118
118
|
</aside>
|
|
119
119
|
<div class="tsd-comment tsd-typography">
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">keys<span class="tsd-signature-symbol">:</span> <a href="datatypes.APIKey.html" class="tsd-signature-type" data-tsd-kind="Interface">APIKey</a><span class="tsd-signature-symbol">[]</span></div>
|
|
100
100
|
<aside class="tsd-sources">
|
|
101
101
|
<ul>
|
|
102
|
-
<li>Defined in datatypes.ts:
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L135">datatypes.ts:135</a></li>
|
|
103
103
|
</ul>
|
|
104
104
|
</aside>
|
|
105
105
|
<div class="tsd-comment tsd-typography">
|
|
@@ -114,7 +114,7 @@
|
|
|
114
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
115
|
<aside class="tsd-sources">
|
|
116
116
|
<ul>
|
|
117
|
-
<li>Defined in datatypes.ts:
|
|
117
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L139">datatypes.ts:139</a></li>
|
|
118
118
|
</ul>
|
|
119
119
|
</aside>
|
|
120
120
|
<div class="tsd-comment tsd-typography">
|
|
@@ -129,7 +129,7 @@
|
|
|
129
129
|
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
130
130
|
<aside class="tsd-sources">
|
|
131
131
|
<ul>
|
|
132
|
-
<li>Defined in datatypes.ts:
|
|
132
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L137">datatypes.ts:137</a></li>
|
|
133
133
|
</ul>
|
|
134
134
|
</aside>
|
|
135
135
|
<div class="tsd-comment tsd-typography">
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
100
100
|
<aside class="tsd-sources">
|
|
101
101
|
<ul>
|
|
102
|
-
<li>Defined in datatypes.ts:
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L113">datatypes.ts:113</a></li>
|
|
103
103
|
</ul>
|
|
104
104
|
</aside>
|
|
105
105
|
<div class="tsd-comment tsd-typography">
|
|
@@ -114,7 +114,7 @@
|
|
|
114
114
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
115
115
|
<aside class="tsd-sources">
|
|
116
116
|
<ul>
|
|
117
|
-
<li>Defined in datatypes.ts:
|
|
117
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L111">datatypes.ts:111</a></li>
|
|
118
118
|
</ul>
|
|
119
119
|
</aside>
|
|
120
120
|
</section>
|
|
@@ -124,7 +124,7 @@
|
|
|
124
124
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
125
125
|
<aside class="tsd-sources">
|
|
126
126
|
<ul>
|
|
127
|
-
<li>Defined in datatypes.ts:
|
|
127
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L115">datatypes.ts:115</a></li>
|
|
128
128
|
</ul>
|
|
129
129
|
</aside>
|
|
130
130
|
<div class="tsd-comment tsd-typography">
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">creds<span class="tsd-signature-symbol">:</span> <a href="datatypes.AWSCredentials.html" class="tsd-signature-type" data-tsd-kind="Interface">AWSCredentials</a></div>
|
|
99
99
|
<aside class="tsd-sources">
|
|
100
100
|
<ul>
|
|
101
|
-
<li>Defined in datatypes.ts:
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L754">datatypes.ts:754</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
<div class="tsd-comment tsd-typography">
|
|
@@ -113,7 +113,7 @@
|
|
|
113
113
|
<div class="tsd-signature tsd-kind-icon">role<span class="tsd-signature-symbol">:</span> <a href="datatypes.AWSRole.html" class="tsd-signature-type" data-tsd-kind="Interface">AWSRole</a></div>
|
|
114
114
|
<aside class="tsd-sources">
|
|
115
115
|
<ul>
|
|
116
|
-
<li>Defined in datatypes.ts:
|
|
116
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L752">datatypes.ts:752</a></li>
|
|
117
117
|
</ul>
|
|
118
118
|
</aside>
|
|
119
119
|
<div class="tsd-comment tsd-typography">
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">aws<wbr>Access<wbr>Key<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
99
99
|
<aside class="tsd-sources">
|
|
100
100
|
<ul>
|
|
101
|
-
<li>Defined in datatypes.ts:
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L764">datatypes.ts:764</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
<div class="tsd-comment tsd-typography">
|
|
@@ -113,7 +113,7 @@
|
|
|
113
113
|
<div class="tsd-signature tsd-kind-icon">aws<wbr>Secret<wbr>Access<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
114
114
|
<aside class="tsd-sources">
|
|
115
115
|
<ul>
|
|
116
|
-
<li>Defined in datatypes.ts:
|
|
116
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L766">datatypes.ts:766</a></li>
|
|
117
117
|
</ul>
|
|
118
118
|
</aside>
|
|
119
119
|
<div class="tsd-comment tsd-typography">
|
|
@@ -97,7 +97,7 @@
|
|
|
97
97
|
<div class="tsd-signature tsd-kind-icon">role<wbr>Arn<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
98
98
|
<aside class="tsd-sources">
|
|
99
99
|
<ul>
|
|
100
|
-
<li>Defined in datatypes.ts:
|
|
100
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L759">datatypes.ts:759</a></li>
|
|
101
101
|
</ul>
|
|
102
102
|
</aside>
|
|
103
103
|
<div class="tsd-comment tsd-typography">
|
|
@@ -103,7 +103,7 @@
|
|
|
103
103
|
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
104
104
|
<aside class="tsd-sources">
|
|
105
105
|
<ul>
|
|
106
|
-
<li>Defined in datatypes.ts:33</li>
|
|
106
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L33">datatypes.ts:33</a></li>
|
|
107
107
|
</ul>
|
|
108
108
|
</aside>
|
|
109
109
|
<div class="tsd-comment tsd-typography">
|
|
@@ -118,7 +118,7 @@
|
|
|
118
118
|
<div class="tsd-signature tsd-kind-icon">hostnames<span class="tsd-signature-symbol">:</span> <a href="datatypes.AbuseReportHostname.html" class="tsd-signature-type" data-tsd-kind="Interface">AbuseReportHostname</a><span class="tsd-signature-symbol">[]</span></div>
|
|
119
119
|
<aside class="tsd-sources">
|
|
120
120
|
<ul>
|
|
121
|
-
<li>Defined in datatypes.ts:41</li>
|
|
121
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L41">datatypes.ts:41</a></li>
|
|
122
122
|
</ul>
|
|
123
123
|
</aside>
|
|
124
124
|
<div class="tsd-comment tsd-typography">
|
|
@@ -133,7 +133,7 @@
|
|
|
133
133
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
134
134
|
<aside class="tsd-sources">
|
|
135
135
|
<ul>
|
|
136
|
-
<li>Defined in datatypes.ts:29</li>
|
|
136
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L29">datatypes.ts:29</a></li>
|
|
137
137
|
</ul>
|
|
138
138
|
</aside>
|
|
139
139
|
<div class="tsd-comment tsd-typography">
|
|
@@ -148,7 +148,7 @@
|
|
|
148
148
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
149
149
|
<aside class="tsd-sources">
|
|
150
150
|
<ul>
|
|
151
|
-
<li>Defined in datatypes.ts:37</li>
|
|
151
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L37">datatypes.ts:37</a></li>
|
|
152
152
|
</ul>
|
|
153
153
|
</aside>
|
|
154
154
|
<div class="tsd-comment tsd-typography">
|
|
@@ -163,7 +163,7 @@
|
|
|
163
163
|
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
164
164
|
<aside class="tsd-sources">
|
|
165
165
|
<ul>
|
|
166
|
-
<li>Defined in datatypes.ts:39</li>
|
|
166
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L39">datatypes.ts:39</a></li>
|
|
167
167
|
</ul>
|
|
168
168
|
</aside>
|
|
169
169
|
<div class="tsd-comment tsd-typography">
|
|
@@ -178,7 +178,7 @@
|
|
|
178
178
|
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
179
179
|
<aside class="tsd-sources">
|
|
180
180
|
<ul>
|
|
181
|
-
<li>Defined in datatypes.ts:31</li>
|
|
181
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L31">datatypes.ts:31</a></li>
|
|
182
182
|
</ul>
|
|
183
183
|
</aside>
|
|
184
184
|
<div class="tsd-comment tsd-typography">
|
|
@@ -193,7 +193,7 @@
|
|
|
193
193
|
<div class="tsd-signature tsd-kind-icon">urls<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
194
194
|
<aside class="tsd-sources">
|
|
195
195
|
<ul>
|
|
196
|
-
<li>Defined in datatypes.ts:35</li>
|
|
196
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L35">datatypes.ts:35</a></li>
|
|
197
197
|
</ul>
|
|
198
198
|
</aside>
|
|
199
199
|
<div class="tsd-comment tsd-typography">
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
99
99
|
<aside class="tsd-sources">
|
|
100
100
|
<ul>
|
|
101
|
-
<li>Defined in datatypes.ts:55</li>
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L55">datatypes.ts:55</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
<div class="tsd-comment tsd-typography">
|
|
@@ -113,7 +113,7 @@
|
|
|
113
113
|
<div class="tsd-signature tsd-kind-icon">urls<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
114
114
|
<aside class="tsd-sources">
|
|
115
115
|
<ul>
|
|
116
|
-
<li>Defined in datatypes.ts:53</li>
|
|
116
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L53">datatypes.ts:53</a></li>
|
|
117
117
|
</ul>
|
|
118
118
|
</aside>
|
|
119
119
|
<div class="tsd-comment tsd-typography">
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">hostname<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
99
99
|
<aside class="tsd-sources">
|
|
100
100
|
<ul>
|
|
101
|
-
<li>Defined in datatypes.ts:46</li>
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L46">datatypes.ts:46</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
<div class="tsd-comment tsd-typography">
|
|
@@ -113,7 +113,7 @@
|
|
|
113
113
|
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
114
114
|
<aside class="tsd-sources">
|
|
115
115
|
<ul>
|
|
116
|
-
<li>Defined in datatypes.ts:48</li>
|
|
116
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L48">datatypes.ts:48</a></li>
|
|
117
117
|
</ul>
|
|
118
118
|
</aside>
|
|
119
119
|
<div class="tsd-comment tsd-typography">
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8">
|
|
5
5
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
6
|
-
<title>
|
|
6
|
+
<title>AgentIngress | @ngrok/ngrok-api</title>
|
|
7
7
|
<meta name="description" content="Documentation for @ngrok/ngrok-api">
|
|
8
8
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
9
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
@@ -58,10 +58,10 @@
|
|
|
58
58
|
<a href="../modules/datatypes.html">datatypes</a>
|
|
59
59
|
</li>
|
|
60
60
|
<li>
|
|
61
|
-
<a href="datatypes.
|
|
61
|
+
<a href="datatypes.AgentIngress.html">AgentIngress</a>
|
|
62
62
|
</li>
|
|
63
63
|
</ul>
|
|
64
|
-
<h1>Interface
|
|
64
|
+
<h1>Interface AgentIngress</h1>
|
|
65
65
|
</div>
|
|
66
66
|
</div>
|
|
67
67
|
</header>
|
|
@@ -72,7 +72,7 @@
|
|
|
72
72
|
<h3>Hierarchy</h3>
|
|
73
73
|
<ul class="tsd-hierarchy">
|
|
74
74
|
<li>
|
|
75
|
-
<span class="target">
|
|
75
|
+
<span class="target">AgentIngress</span>
|
|
76
76
|
</li>
|
|
77
77
|
</ul>
|
|
78
78
|
</section>
|
|
@@ -83,12 +83,14 @@
|
|
|
83
83
|
<section class="tsd-index-section ">
|
|
84
84
|
<h3>Properties</h3>
|
|
85
85
|
<ul class="tsd-index-list">
|
|
86
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
87
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
88
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
89
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
90
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
91
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
86
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngress.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
|
|
87
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngress.html#description" class="tsd-kind-icon">description</a></li>
|
|
88
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngress.html#domain" class="tsd-kind-icon">domain</a></li>
|
|
89
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngress.html#id" class="tsd-kind-icon">id</a></li>
|
|
90
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngress.html#metadata" class="tsd-kind-icon">metadata</a></li>
|
|
91
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngress.html#nsTargets" class="tsd-kind-icon">ns<wbr>Targets</a></li>
|
|
92
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngress.html#regionDomains" class="tsd-kind-icon">region<wbr>Domains</a></li>
|
|
93
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngress.html#uri" class="tsd-kind-icon">uri</a></li>
|
|
92
94
|
</ul>
|
|
93
95
|
</section>
|
|
94
96
|
</div>
|
|
@@ -102,12 +104,12 @@
|
|
|
102
104
|
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
103
105
|
<aside class="tsd-sources">
|
|
104
106
|
<ul>
|
|
105
|
-
<li>Defined in datatypes.ts:
|
|
107
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L91">datatypes.ts:91</a></li>
|
|
106
108
|
</ul>
|
|
107
109
|
</aside>
|
|
108
110
|
<div class="tsd-comment tsd-typography">
|
|
109
111
|
<div class="lead">
|
|
110
|
-
<p>timestamp when the
|
|
112
|
+
<p>timestamp when the Agent Ingress was created, RFC 3339 format</p>
|
|
111
113
|
</div>
|
|
112
114
|
</div>
|
|
113
115
|
</section>
|
|
@@ -117,42 +119,42 @@
|
|
|
117
119
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
118
120
|
<aside class="tsd-sources">
|
|
119
121
|
<ul>
|
|
120
|
-
<li>Defined in datatypes.ts:
|
|
122
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L81">datatypes.ts:81</a></li>
|
|
121
123
|
</ul>
|
|
122
124
|
</aside>
|
|
123
125
|
<div class="tsd-comment tsd-typography">
|
|
124
126
|
<div class="lead">
|
|
125
|
-
<p>human-readable description of the
|
|
127
|
+
<p>human-readable description of the use of this Agent Ingress. optional, max 255 bytes.</p>
|
|
126
128
|
</div>
|
|
127
129
|
</div>
|
|
128
130
|
</section>
|
|
129
131
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
130
|
-
<a name="
|
|
131
|
-
<h3>
|
|
132
|
-
<div class="tsd-signature tsd-kind-icon">
|
|
132
|
+
<a name="domain" class="tsd-anchor"></a>
|
|
133
|
+
<h3>domain</h3>
|
|
134
|
+
<div class="tsd-signature tsd-kind-icon">domain<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
133
135
|
<aside class="tsd-sources">
|
|
134
136
|
<ul>
|
|
135
|
-
<li>Defined in datatypes.ts:
|
|
137
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L85">datatypes.ts:85</a></li>
|
|
136
138
|
</ul>
|
|
137
139
|
</aside>
|
|
138
140
|
<div class="tsd-comment tsd-typography">
|
|
139
141
|
<div class="lead">
|
|
140
|
-
<p>
|
|
142
|
+
<p>the domain that you own to be used as the base domain name to generate regional agent ingress domains.</p>
|
|
141
143
|
</div>
|
|
142
144
|
</div>
|
|
143
145
|
</section>
|
|
144
146
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
145
|
-
<a name="
|
|
146
|
-
<h3>
|
|
147
|
-
<div class="tsd-signature tsd-kind-icon">
|
|
147
|
+
<a name="id" class="tsd-anchor"></a>
|
|
148
|
+
<h3>id</h3>
|
|
149
|
+
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
148
150
|
<aside class="tsd-sources">
|
|
149
151
|
<ul>
|
|
150
|
-
<li>Defined in datatypes.ts:
|
|
152
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L77">datatypes.ts:77</a></li>
|
|
151
153
|
</ul>
|
|
152
154
|
</aside>
|
|
153
155
|
<div class="tsd-comment tsd-typography">
|
|
154
156
|
<div class="lead">
|
|
155
|
-
<p>
|
|
157
|
+
<p>unique Agent Ingress resource identifier</p>
|
|
156
158
|
</div>
|
|
157
159
|
</div>
|
|
158
160
|
</section>
|
|
@@ -162,12 +164,42 @@
|
|
|
162
164
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
163
165
|
<aside class="tsd-sources">
|
|
164
166
|
<ul>
|
|
165
|
-
<li>Defined in datatypes.ts:
|
|
167
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L83">datatypes.ts:83</a></li>
|
|
168
|
+
</ul>
|
|
169
|
+
</aside>
|
|
170
|
+
<div class="tsd-comment tsd-typography">
|
|
171
|
+
<div class="lead">
|
|
172
|
+
<p>arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes</p>
|
|
173
|
+
</div>
|
|
174
|
+
</div>
|
|
175
|
+
</section>
|
|
176
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
177
|
+
<a name="nsTargets" class="tsd-anchor"></a>
|
|
178
|
+
<h3>ns<wbr>Targets</h3>
|
|
179
|
+
<div class="tsd-signature tsd-kind-icon">ns<wbr>Targets<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
180
|
+
<aside class="tsd-sources">
|
|
181
|
+
<ul>
|
|
182
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L87">datatypes.ts:87</a></li>
|
|
166
183
|
</ul>
|
|
167
184
|
</aside>
|
|
168
185
|
<div class="tsd-comment tsd-typography">
|
|
169
186
|
<div class="lead">
|
|
170
|
-
<p>
|
|
187
|
+
<p>a list of target values to use as the values of NS records for the domain property these values will delegate control over the domain to ngrok</p>
|
|
188
|
+
</div>
|
|
189
|
+
</div>
|
|
190
|
+
</section>
|
|
191
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
192
|
+
<a name="regionDomains" class="tsd-anchor"></a>
|
|
193
|
+
<h3>region<wbr>Domains</h3>
|
|
194
|
+
<div class="tsd-signature tsd-kind-icon">region<wbr>Domains<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
195
|
+
<aside class="tsd-sources">
|
|
196
|
+
<ul>
|
|
197
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L89">datatypes.ts:89</a></li>
|
|
198
|
+
</ul>
|
|
199
|
+
</aside>
|
|
200
|
+
<div class="tsd-comment tsd-typography">
|
|
201
|
+
<div class="lead">
|
|
202
|
+
<p>a list of regional agent ingress domains that are subdomains of the value of domain this value may increase over time as ngrok adds more regions</p>
|
|
171
203
|
</div>
|
|
172
204
|
</div>
|
|
173
205
|
</section>
|
|
@@ -177,12 +209,12 @@
|
|
|
177
209
|
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
178
210
|
<aside class="tsd-sources">
|
|
179
211
|
<ul>
|
|
180
|
-
<li>Defined in datatypes.ts:
|
|
212
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L79">datatypes.ts:79</a></li>
|
|
181
213
|
</ul>
|
|
182
214
|
</aside>
|
|
183
215
|
<div class="tsd-comment tsd-typography">
|
|
184
216
|
<div class="lead">
|
|
185
|
-
<p>URI
|
|
217
|
+
<p>URI to the API resource of this Agent ingress</p>
|
|
186
218
|
</div>
|
|
187
219
|
</div>
|
|
188
220
|
</section>
|
|
@@ -210,25 +242,31 @@
|
|
|
210
242
|
</ul>
|
|
211
243
|
<ul class="current">
|
|
212
244
|
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
213
|
-
<a href="datatypes.
|
|
245
|
+
<a href="datatypes.AgentIngress.html" class="tsd-kind-icon">Agent<wbr>Ingress</a>
|
|
214
246
|
<ul>
|
|
215
247
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
216
|
-
<a href="datatypes.
|
|
248
|
+
<a href="datatypes.AgentIngress.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
|
|
249
|
+
</li>
|
|
250
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
251
|
+
<a href="datatypes.AgentIngress.html#description" class="tsd-kind-icon">description</a>
|
|
252
|
+
</li>
|
|
253
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
254
|
+
<a href="datatypes.AgentIngress.html#domain" class="tsd-kind-icon">domain</a>
|
|
217
255
|
</li>
|
|
218
256
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
219
|
-
<a href="datatypes.
|
|
257
|
+
<a href="datatypes.AgentIngress.html#id" class="tsd-kind-icon">id</a>
|
|
220
258
|
</li>
|
|
221
259
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
222
|
-
<a href="datatypes.
|
|
260
|
+
<a href="datatypes.AgentIngress.html#metadata" class="tsd-kind-icon">metadata</a>
|
|
223
261
|
</li>
|
|
224
262
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
225
|
-
<a href="datatypes.
|
|
263
|
+
<a href="datatypes.AgentIngress.html#nsTargets" class="tsd-kind-icon">ns<wbr>Targets</a>
|
|
226
264
|
</li>
|
|
227
265
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
228
|
-
<a href="datatypes.
|
|
266
|
+
<a href="datatypes.AgentIngress.html#regionDomains" class="tsd-kind-icon">region<wbr>Domains</a>
|
|
229
267
|
</li>
|
|
230
268
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
231
|
-
<a href="datatypes.
|
|
269
|
+
<a href="datatypes.AgentIngress.html#uri" class="tsd-kind-icon">uri</a>
|
|
232
270
|
</li>
|
|
233
271
|
</ul>
|
|
234
272
|
</li>
|
package/docs/interfaces/{datatypes.IPWhitelistEntryCreate.html → datatypes.AgentIngressCreate.html}
RENAMED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8">
|
|
5
5
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
6
|
-
<title>
|
|
6
|
+
<title>AgentIngressCreate | @ngrok/ngrok-api</title>
|
|
7
7
|
<meta name="description" content="Documentation for @ngrok/ngrok-api">
|
|
8
8
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
9
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
@@ -58,10 +58,10 @@
|
|
|
58
58
|
<a href="../modules/datatypes.html">datatypes</a>
|
|
59
59
|
</li>
|
|
60
60
|
<li>
|
|
61
|
-
<a href="datatypes.
|
|
61
|
+
<a href="datatypes.AgentIngressCreate.html">AgentIngressCreate</a>
|
|
62
62
|
</li>
|
|
63
63
|
</ul>
|
|
64
|
-
<h1>Interface
|
|
64
|
+
<h1>Interface AgentIngressCreate</h1>
|
|
65
65
|
</div>
|
|
66
66
|
</div>
|
|
67
67
|
</header>
|
|
@@ -72,7 +72,7 @@
|
|
|
72
72
|
<h3>Hierarchy</h3>
|
|
73
73
|
<ul class="tsd-hierarchy">
|
|
74
74
|
<li>
|
|
75
|
-
<span class="target">
|
|
75
|
+
<span class="target">AgentIngressCreate</span>
|
|
76
76
|
</li>
|
|
77
77
|
</ul>
|
|
78
78
|
</section>
|
|
@@ -83,9 +83,9 @@
|
|
|
83
83
|
<section class="tsd-index-section ">
|
|
84
84
|
<h3>Properties</h3>
|
|
85
85
|
<ul class="tsd-index-list">
|
|
86
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
87
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
88
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.
|
|
86
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngressCreate.html#description" class="tsd-kind-icon">description</a></li>
|
|
87
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngressCreate.html#domain" class="tsd-kind-icon">domain</a></li>
|
|
88
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngressCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
|
|
89
89
|
</ul>
|
|
90
90
|
</section>
|
|
91
91
|
</div>
|
|
@@ -99,27 +99,27 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
100
100
|
<aside class="tsd-sources">
|
|
101
101
|
<ul>
|
|
102
|
-
<li>Defined in datatypes.ts:
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L60">datatypes.ts:60</a></li>
|
|
103
103
|
</ul>
|
|
104
104
|
</aside>
|
|
105
105
|
<div class="tsd-comment tsd-typography">
|
|
106
106
|
<div class="lead">
|
|
107
|
-
<p>human-readable description of the
|
|
107
|
+
<p>human-readable description of the use of this Agent Ingress. optional, max 255 bytes.</p>
|
|
108
108
|
</div>
|
|
109
109
|
</div>
|
|
110
110
|
</section>
|
|
111
111
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
112
|
-
<a name="
|
|
113
|
-
<h3>
|
|
114
|
-
<div class="tsd-signature tsd-kind-icon">
|
|
112
|
+
<a name="domain" class="tsd-anchor"></a>
|
|
113
|
+
<h3>domain</h3>
|
|
114
|
+
<div class="tsd-signature tsd-kind-icon">domain<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
115
115
|
<aside class="tsd-sources">
|
|
116
116
|
<ul>
|
|
117
|
-
<li>Defined in datatypes.ts:
|
|
117
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L64">datatypes.ts:64</a></li>
|
|
118
118
|
</ul>
|
|
119
119
|
</aside>
|
|
120
120
|
<div class="tsd-comment tsd-typography">
|
|
121
121
|
<div class="lead">
|
|
122
|
-
<p>
|
|
122
|
+
<p>the domain that you own to be used as the base domain name to generate regional agent ingress domains.</p>
|
|
123
123
|
</div>
|
|
124
124
|
</div>
|
|
125
125
|
</section>
|
|
@@ -129,12 +129,12 @@
|
|
|
129
129
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
130
130
|
<aside class="tsd-sources">
|
|
131
131
|
<ul>
|
|
132
|
-
<li>Defined in datatypes.ts:
|
|
132
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L62">datatypes.ts:62</a></li>
|
|
133
133
|
</ul>
|
|
134
134
|
</aside>
|
|
135
135
|
<div class="tsd-comment tsd-typography">
|
|
136
136
|
<div class="lead">
|
|
137
|
-
<p>arbitrary user-defined machine-readable data of this
|
|
137
|
+
<p>arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes</p>
|
|
138
138
|
</div>
|
|
139
139
|
</div>
|
|
140
140
|
</section>
|
|
@@ -162,16 +162,16 @@
|
|
|
162
162
|
</ul>
|
|
163
163
|
<ul class="current">
|
|
164
164
|
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
165
|
-
<a href="datatypes.
|
|
165
|
+
<a href="datatypes.AgentIngressCreate.html" class="tsd-kind-icon">Agent<wbr>Ingress<wbr>Create</a>
|
|
166
166
|
<ul>
|
|
167
167
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
168
|
-
<a href="datatypes.
|
|
168
|
+
<a href="datatypes.AgentIngressCreate.html#description" class="tsd-kind-icon">description</a>
|
|
169
169
|
</li>
|
|
170
170
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
171
|
-
<a href="datatypes.
|
|
171
|
+
<a href="datatypes.AgentIngressCreate.html#domain" class="tsd-kind-icon">domain</a>
|
|
172
172
|
</li>
|
|
173
173
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
174
|
-
<a href="datatypes.
|
|
174
|
+
<a href="datatypes.AgentIngressCreate.html#metadata" class="tsd-kind-icon">metadata</a>
|
|
175
175
|
</li>
|
|
176
176
|
</ul>
|
|
177
177
|
</li>
|