A Weighted Backend balances traffic among the referenced backends. Traffic
is assigned proportionally to each based on its weight. The percentage of
- traffic is calculated by dividing a backend's weight by the sum of all
+ traffic is calculated by dividing a backend's weight by the sum of all
weights.
See also https://ngrok.com/docs/api#api-weighted-backends
Abuse Reports allow you to submit take-down requests for URLs hosted by
- ngrok that violate ngrok's terms of service.
+ ngrok that violate ngrok's terms of service.
See also https://ngrok.com/docs/api#api-abuse-reports.
API Keys are used to authenticate to the ngrok
API. You may use the API itself
- to provision and manage API Keys but you'll need to provision your first API
+ to provision and manage API Keys but you'll need to provision your first
+ API
key from the API Keys page
on your
ngrok.com dashboard.
@@ -418,7 +419,7 @@ loadScripts(document, 'script');
Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
agent to connect the ngrok service as your account. They are installed with
- the ngrok authtoken command or by specifying it in the
+ the ngrok config add-authtoken command or by specifying it in the
ngrok.yml
configuration file with the authtoken property.
@@ -554,7 +555,7 @@ loadScripts(document, 'script');
Reserved Domains are hostnames that you can listen for traffic on. Domains
can be used to listen for http, https or tls traffic. You may use a domain
that you own by creating a CNAME record specified in the returned resource.
- This CNAME record points traffic for that domain to ngrok's edge servers.
+ This CNAME record points traffic for that domain to ngrok's edge servers.
See also https://ngrok.com/docs/api#api-reserved-domains.
diff --git a/docs/com/ngrok/NgrokApiClient.HttpMethod.html b/docs/com/ngrok/NgrokApiClient.HttpMethod.html
index cae905a..6f2f23b 100644
--- a/docs/com/ngrok/NgrokApiClient.HttpMethod.html
+++ b/docs/com/ngrok/NgrokApiClient.HttpMethod.html
@@ -1,11 +1,11 @@
-
-NgrokApiClient.HttpMethod (ngrok Java API client 0.4.0 API)
+
+NgrokApiClient.HttpMethod (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/NgrokApiClient.html b/docs/com/ngrok/NgrokApiClient.html
index 3e6f923..b4fc516 100644
--- a/docs/com/ngrok/NgrokApiClient.html
+++ b/docs/com/ngrok/NgrokApiClient.html
@@ -1,11 +1,11 @@
-
-NgrokApiClient (ngrok Java API client 0.4.0 API)
+
+NgrokApiClient (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/Version.html b/docs/com/ngrok/Version.html
index 14c9a64..edaadc3 100644
--- a/docs/com/ngrok/Version.html
+++ b/docs/com/ngrok/Version.html
@@ -1,11 +1,11 @@
-
-Version (ngrok Java API client 0.4.0 API)
+
+Version (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/class-use/DefaultNgrokApiClient.Builder.html b/docs/com/ngrok/class-use/DefaultNgrokApiClient.Builder.html
index b31a21c..3eaace6 100644
--- a/docs/com/ngrok/class-use/DefaultNgrokApiClient.Builder.html
+++ b/docs/com/ngrok/class-use/DefaultNgrokApiClient.Builder.html
@@ -1,11 +1,11 @@
-
-Uses of Class com.ngrok.DefaultNgrokApiClient.Builder (ngrok Java API client 0.4.0 API)
+
+Uses of Class com.ngrok.DefaultNgrokApiClient.Builder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/class-use/DefaultNgrokApiClient.html b/docs/com/ngrok/class-use/DefaultNgrokApiClient.html
index 61bd97c..f01612a 100644
--- a/docs/com/ngrok/class-use/DefaultNgrokApiClient.html
+++ b/docs/com/ngrok/class-use/DefaultNgrokApiClient.html
@@ -1,11 +1,11 @@
-
-Uses of Class com.ngrok.DefaultNgrokApiClient (ngrok Java API client 0.4.0 API)
+
+Uses of Class com.ngrok.DefaultNgrokApiClient (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/class-use/Ngrok.BackendsNamespace.html b/docs/com/ngrok/class-use/Ngrok.BackendsNamespace.html
index 4bab72b..23032b1 100644
--- a/docs/com/ngrok/class-use/Ngrok.BackendsNamespace.html
+++ b/docs/com/ngrok/class-use/Ngrok.BackendsNamespace.html
@@ -1,11 +1,11 @@
-
-Uses of Class com.ngrok.Ngrok.BackendsNamespace (ngrok Java API client 0.4.0 API)
+
+Uses of Class com.ngrok.Ngrok.BackendsNamespace (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/class-use/Ngrok.EdgeModulesNamespace.html b/docs/com/ngrok/class-use/Ngrok.EdgeModulesNamespace.html
index 1390838..8684904 100644
--- a/docs/com/ngrok/class-use/Ngrok.EdgeModulesNamespace.html
+++ b/docs/com/ngrok/class-use/Ngrok.EdgeModulesNamespace.html
@@ -1,11 +1,11 @@
-
-Uses of Class com.ngrok.Ngrok.EdgeModulesNamespace (ngrok Java API client 0.4.0 API)
+
+Uses of Class com.ngrok.Ngrok.EdgeModulesNamespace (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/class-use/Ngrok.EdgesNamespace.html b/docs/com/ngrok/class-use/Ngrok.EdgesNamespace.html
index b3924b1..ee13c2f 100644
--- a/docs/com/ngrok/class-use/Ngrok.EdgesNamespace.html
+++ b/docs/com/ngrok/class-use/Ngrok.EdgesNamespace.html
@@ -1,11 +1,11 @@
-
-Uses of Class com.ngrok.Ngrok.EdgesNamespace (ngrok Java API client 0.4.0 API)
+
+Uses of Class com.ngrok.Ngrok.EdgesNamespace (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/class-use/Ngrok.html b/docs/com/ngrok/class-use/Ngrok.html
index e0b508b..3f3a826 100644
--- a/docs/com/ngrok/class-use/Ngrok.html
+++ b/docs/com/ngrok/class-use/Ngrok.html
@@ -1,11 +1,11 @@
-
-Uses of Class com.ngrok.Ngrok (ngrok Java API client 0.4.0 API)
+
+Uses of Class com.ngrok.Ngrok (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/class-use/NgrokApiClient.HttpMethod.html b/docs/com/ngrok/class-use/NgrokApiClient.HttpMethod.html
index 9a12731..97f8437 100644
--- a/docs/com/ngrok/class-use/NgrokApiClient.HttpMethod.html
+++ b/docs/com/ngrok/class-use/NgrokApiClient.HttpMethod.html
@@ -1,11 +1,11 @@
-
-Uses of Enum com.ngrok.NgrokApiClient.HttpMethod (ngrok Java API client 0.4.0 API)
+
+Uses of Enum com.ngrok.NgrokApiClient.HttpMethod (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/class-use/NgrokApiClient.html b/docs/com/ngrok/class-use/NgrokApiClient.html
index 64908f4..0e0e12b 100644
--- a/docs/com/ngrok/class-use/NgrokApiClient.html
+++ b/docs/com/ngrok/class-use/NgrokApiClient.html
@@ -1,11 +1,11 @@
-
-Uses of Interface com.ngrok.NgrokApiClient (ngrok Java API client 0.4.0 API)
+
+Uses of Interface com.ngrok.NgrokApiClient (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/class-use/Version.html b/docs/com/ngrok/class-use/Version.html
index 4243adc..2942ef6 100644
--- a/docs/com/ngrok/class-use/Version.html
+++ b/docs/com/ngrok/class-use/Version.html
@@ -1,11 +1,11 @@
-
-Uses of Class com.ngrok.Version (ngrok Java API client 0.4.0 API)
+
+Uses of Class com.ngrok.Version (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/definitions/AbuseReport.html b/docs/com/ngrok/definitions/AbuseReport.html
index 12f666b..88bc982 100644
--- a/docs/com/ngrok/definitions/AbuseReport.html
+++ b/docs/com/ngrok/definitions/AbuseReport.html
@@ -1,11 +1,11 @@
-
-AbuseReport (ngrok Java API client 0.4.0 API)
+
+AbuseReport (ngrok Java API client 0.6.0 API)
-
+
@@ -247,7 +247,7 @@ loadScripts(document, 'script');
a list of URLs containing suspected abusive content
createdAt - timestamp when the tunnel credential was created, RFC 3339 format
description - human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
metadata - arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
-
token - the credential's authtoken that can be used to authenticate an ngrok agent. This value is only available one time, on the API response from credential creation, otherwise it is null.
-
acl - optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the bind rule. The bind rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule bind:example.ngrok.io. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of bind:*.example.com which will allow x.example.com, y.example.com, *.example.com, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions.
+
token - the credential's authtoken that can be used to authenticate an ngrok agent. This value is only available one time, on the API response from credential creation, otherwise it is null.
+
acl - optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the bind rule. The bind rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule bind:example.ngrok.io. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of bind:*.example.com which will allow x.example.com, y.example.com, *.example.com, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions.
the credential's authtoken that can be used to authenticate an ngrok agent.
+
the credential's authtoken that can be used to authenticate an ngrok agent.
This value is only available one time, on the API response from
credential creation, otherwise it is null.
@@ -291,11 +291,11 @@ loadScripts(document, 'script');
match multiple domains with a common suffix. For example, you may specify a rule
of bind:*.example.com which will allow x.example.com,
y.example.com, *.example.com, etc. A rule of
- '*' is equivalent to no acl at all and will explicitly permit all
- actions.
+ '*' is equivalent to no acl at all and will explicitly
+ permit all actions.
the OAuth app client ID. retrieve it from the identity provider's dashboard
+
the OAuth app client ID. retrieve it from the identity provider's dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -197,7 +197,7 @@ loadScripts(document, 'script');
the OAuth app client ID. retrieve it from the identity provider's dashboard
+
the OAuth app client ID. retrieve it from the identity provider's dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -214,9 +214,9 @@ loadScripts(document, 'script');
the OAuth app client secret. retrieve if from the identity provider's dashboard
- where you created your own OAuth app. optional, see all of the caveats in the
- docs for client_id.
+
the OAuth app client secret. retrieve if from the identity provider's
+ dashboard where you created your own OAuth app. optional, see all of the caveats
+ in the docs for client_id.
Parameters:
clientSecret - the value of the client_secret parameter as a String
the OAuth app client secret. retrieve if from the identity provider's dashboard
- where you created your own OAuth app. optional, see all of the caveats in the
- docs for client_id.
+
the OAuth app client secret. retrieve if from the identity provider's
+ dashboard where you created your own OAuth app. optional, see all of the caveats
+ in the docs for client_id.
Parameters:
clientSecret - the value of the client_secret parameter as a String, wrapped in an Optional
@@ -250,7 +250,7 @@ loadScripts(document, 'script');
client_secret to set scopes)
Parameters:
-
scopes - the value of the scopes parameter as a List<String>
+
scopes - the value of the scopes parameter as a List of String
Returns:
this builder instance
@@ -266,7 +266,7 @@ loadScripts(document, 'script');
client_secret to set scopes)
Parameters:
-
scopes - the value of the scopes parameter as a List<String>, wrapped in an Optional
+
scopes - the value of the scopes parameter as a List of String, wrapped in an Optional
Returns:
this builder instance
@@ -280,7 +280,7 @@ loadScripts(document, 'script');
allowed access to the endpoint
Parameters:
-
emailAddresses - the value of the email_addresses parameter as a List<String>
+
emailAddresses - the value of the email_addresses parameter as a List of String
Returns:
this builder instance
@@ -294,7 +294,7 @@ loadScripts(document, 'script');
allowed access to the endpoint
Parameters:
-
emailAddresses - the value of the email_addresses parameter as a List<String>, wrapped in an Optional
+
emailAddresses - the value of the email_addresses parameter as a List of String, wrapped in an Optional
Returns:
this builder instance
@@ -308,7 +308,7 @@ loadScripts(document, 'script');
allowed access to the endpoint
Parameters:
-
emailDomains - the value of the email_domains parameter as a List<String>
+
emailDomains - the value of the email_domains parameter as a List of String
Returns:
this builder instance
@@ -322,7 +322,7 @@ loadScripts(document, 'script');
allowed access to the endpoint
Parameters:
-
emailDomains - the value of the email_domains parameter as a List<String>, wrapped in an Optional
+
emailDomains - the value of the email_domains parameter as a List of String, wrapped in an Optional
the OAuth app client ID. retrieve it from the identity provider's dashboard
+
the OAuth app client ID. retrieve it from the identity provider's dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -200,9 +200,9 @@ loadScripts(document, 'script');
the OAuth app client secret. retrieve if from the identity provider's dashboard
- where you created your own OAuth app. optional, see all of the caveats in the
- docs for client_id.
+
the OAuth app client secret. retrieve if from the identity provider's
+ dashboard where you created your own OAuth app. optional, see all of the caveats
+ in the docs for client_id.
Returns:
the value of the property as a String wrapped in an Optional
@@ -219,7 +219,7 @@ loadScripts(document, 'script');
client_secret to set scopes)
the OAuth app client ID. retrieve it from the identity provider's dashboard
+
the OAuth app client ID. retrieve it from the identity provider's dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -217,7 +217,7 @@ loadScripts(document, 'script');
the OAuth app client ID. retrieve it from the identity provider's dashboard
+
the OAuth app client ID. retrieve it from the identity provider's dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -234,9 +234,9 @@ loadScripts(document, 'script');
the OAuth app client secret. retrieve if from the identity provider's dashboard
- where you created your own OAuth app. optional, see all of the caveats in the
- docs for client_id.
+
the OAuth app client secret. retrieve if from the identity provider's
+ dashboard where you created your own OAuth app. optional, see all of the caveats
+ in the docs for client_id.
Parameters:
clientSecret - the value of the client_secret parameter as a String
the OAuth app client secret. retrieve if from the identity provider's dashboard
- where you created your own OAuth app. optional, see all of the caveats in the
- docs for client_id.
+
the OAuth app client secret. retrieve if from the identity provider's
+ dashboard where you created your own OAuth app. optional, see all of the caveats
+ in the docs for client_id.
Parameters:
clientSecret - the value of the client_secret parameter as a String, wrapped in an Optional
@@ -270,7 +270,7 @@ loadScripts(document, 'script');
client_secret to set scopes)
Parameters:
-
scopes - the value of the scopes parameter as a List<String>
+
scopes - the value of the scopes parameter as a List of String
Returns:
this builder instance
@@ -286,7 +286,7 @@ loadScripts(document, 'script');
client_secret to set scopes)
Parameters:
-
scopes - the value of the scopes parameter as a List<String>, wrapped in an Optional
+
scopes - the value of the scopes parameter as a List of String, wrapped in an Optional
Returns:
this builder instance
@@ -300,7 +300,7 @@ loadScripts(document, 'script');
allowed access to the endpoint
Parameters:
-
emailAddresses - the value of the email_addresses parameter as a List<String>
+
emailAddresses - the value of the email_addresses parameter as a List of String
Returns:
this builder instance
@@ -314,7 +314,7 @@ loadScripts(document, 'script');
allowed access to the endpoint
Parameters:
-
emailAddresses - the value of the email_addresses parameter as a List<String>, wrapped in an Optional
+
emailAddresses - the value of the email_addresses parameter as a List of String, wrapped in an Optional
Returns:
this builder instance
@@ -328,7 +328,7 @@ loadScripts(document, 'script');
allowed access to the endpoint
Parameters:
-
emailDomains - the value of the email_domains parameter as a List<String>
+
emailDomains - the value of the email_domains parameter as a List of String
Returns:
this builder instance
@@ -342,7 +342,7 @@ loadScripts(document, 'script');
allowed access to the endpoint
Parameters:
-
emailDomains - the value of the email_domains parameter as a List<String>, wrapped in an Optional
+
emailDomains - the value of the email_domains parameter as a List of String, wrapped in an Optional
a list of github teams identifiers. users will be allowed access to the endpoint
- if they are a member of any of these teams. identifiers should be in the 'slug'
- format qualified with the org name, e.g. org-name/team-name
+ if they are a member of any of these teams. identifiers should be in the
+ 'slug' format qualified with the org name, e.g.
+ org-name/team-name
Parameters:
-
teams - the value of the teams parameter as a List<String>
+
teams - the value of the teams parameter as a List of String
a list of github teams identifiers. users will be allowed access to the endpoint
- if they are a member of any of these teams. identifiers should be in the 'slug'
- format qualified with the org name, e.g. org-name/team-name
+ if they are a member of any of these teams. identifiers should be in the
+ 'slug' format qualified with the org name, e.g.
+ org-name/team-name
Parameters:
-
teams - the value of the teams parameter as a List<String>, wrapped in an Optional
+
teams - the value of the teams parameter as a List of String, wrapped in an Optional
a list of github org identifiers. users who are members of any of the listed
- organizations will be allowed access. identifiers should be the organization's
- 'slug'
+ organizations will be allowed access. identifiers should be the
+ organization's 'slug'
Parameters:
-
organizations - the value of the organizations parameter as a List<String>
+
organizations - the value of the organizations parameter as a List of String
a list of github org identifiers. users who are members of any of the listed
- organizations will be allowed access. identifiers should be the organization's
- 'slug'
+ organizations will be allowed access. identifiers should be the
+ organization's 'slug'
Parameters:
-
organizations - the value of the organizations parameter as a List<String>, wrapped in an Optional
+
organizations - the value of the organizations parameter as a List of String, wrapped in an Optional
the OAuth app client ID. retrieve it from the identity provider's dashboard
+
the OAuth app client ID. retrieve it from the identity provider's dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -210,9 +210,9 @@ loadScripts(document, 'script');
the OAuth app client secret. retrieve if from the identity provider's dashboard
- where you created your own OAuth app. optional, see all of the caveats in the
- docs for client_id.
+
the OAuth app client secret. retrieve if from the identity provider's
+ dashboard where you created your own OAuth app. optional, see all of the caveats
+ in the docs for client_id.
Returns:
the value of the property as a String wrapped in an Optional
@@ -229,7 +229,7 @@ loadScripts(document, 'script');
client_secret to set scopes)
a list of github teams identifiers. users will be allowed access to the endpoint
- if they are a member of any of these teams. identifiers should be in the 'slug'
- format qualified with the org name, e.g. org-name/team-name
+ if they are a member of any of these teams. identifiers should be in the
+ 'slug' format qualified with the org name, e.g.
+ org-name/team-name
a list of github org identifiers. users who are members of any of the listed
- organizations will be allowed access. identifiers should be the organization's
- 'slug'
+ organizations will be allowed access. identifiers should be the
+ organization's 'slug'
the OAuth app client ID. retrieve it from the identity provider's dashboard
+
the OAuth app client ID. retrieve it from the identity provider's dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -197,7 +197,7 @@ loadScripts(document, 'script');
the OAuth app client ID. retrieve it from the identity provider's dashboard
+
the OAuth app client ID. retrieve it from the identity provider's dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -214,9 +214,9 @@ loadScripts(document, 'script');
the OAuth app client secret. retrieve if from the identity provider's dashboard
- where you created your own OAuth app. optional, see all of the caveats in the
- docs for client_id.
+
the OAuth app client secret. retrieve if from the identity provider's
+ dashboard where you created your own OAuth app. optional, see all of the caveats
+ in the docs for client_id.
Parameters:
clientSecret - the value of the client_secret parameter as a String
the OAuth app client secret. retrieve if from the identity provider's dashboard
- where you created your own OAuth app. optional, see all of the caveats in the
- docs for client_id.
+
the OAuth app client secret. retrieve if from the identity provider's
+ dashboard where you created your own OAuth app. optional, see all of the caveats
+ in the docs for client_id.
Parameters:
clientSecret - the value of the client_secret parameter as a String, wrapped in an Optional
@@ -250,7 +250,7 @@ loadScripts(document, 'script');
client_secret to set scopes)
Parameters:
-
scopes - the value of the scopes parameter as a List<String>
+
scopes - the value of the scopes parameter as a List of String
Returns:
this builder instance
@@ -266,7 +266,7 @@ loadScripts(document, 'script');
client_secret to set scopes)
Parameters:
-
scopes - the value of the scopes parameter as a List<String>, wrapped in an Optional
+
scopes - the value of the scopes parameter as a List of String, wrapped in an Optional
Returns:
this builder instance
@@ -280,7 +280,7 @@ loadScripts(document, 'script');
allowed access to the endpoint
Parameters:
-
emailAddresses - the value of the email_addresses parameter as a List<String>
+
emailAddresses - the value of the email_addresses parameter as a List of String
Returns:
this builder instance
@@ -294,7 +294,7 @@ loadScripts(document, 'script');
allowed access to the endpoint
Parameters:
-
emailAddresses - the value of the email_addresses parameter as a List<String>, wrapped in an Optional
+
emailAddresses - the value of the email_addresses parameter as a List of String, wrapped in an Optional
Returns:
this builder instance
@@ -308,7 +308,7 @@ loadScripts(document, 'script');
allowed access to the endpoint
Parameters:
-
emailDomains - the value of the email_domains parameter as a List<String>
+
emailDomains - the value of the email_domains parameter as a List of String
Returns:
this builder instance
@@ -322,7 +322,7 @@ loadScripts(document, 'script');
allowed access to the endpoint
Parameters:
-
emailDomains - the value of the email_domains parameter as a List<String>, wrapped in an Optional
+
emailDomains - the value of the email_domains parameter as a List of String, wrapped in an Optional
the OAuth app client ID. retrieve it from the identity provider's dashboard
+
the OAuth app client ID. retrieve it from the identity provider's dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -200,9 +200,9 @@ loadScripts(document, 'script');
the OAuth app client secret. retrieve if from the identity provider's dashboard
- where you created your own OAuth app. optional, see all of the caveats in the
- docs for client_id.
+
the OAuth app client secret. retrieve if from the identity provider's
+ dashboard where you created your own OAuth app. optional, see all of the caveats
+ in the docs for client_id.
Returns:
the value of the property as a String wrapped in an Optional
@@ -219,7 +219,7 @@ loadScripts(document, 'script');
client_secret to set scopes)
the OAuth app client ID. retrieve it from the identity provider's dashboard
+
the OAuth app client ID. retrieve it from the identity provider's dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -197,7 +197,7 @@ loadScripts(document, 'script');
the OAuth app client ID. retrieve it from the identity provider's dashboard
+
the OAuth app client ID. retrieve it from the identity provider's dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -214,9 +214,9 @@ loadScripts(document, 'script');
the OAuth app client secret. retrieve if from the identity provider's dashboard
- where you created your own OAuth app. optional, see all of the caveats in the
- docs for client_id.
+
the OAuth app client secret. retrieve if from the identity provider's
+ dashboard where you created your own OAuth app. optional, see all of the caveats
+ in the docs for client_id.
Parameters:
clientSecret - the value of the client_secret parameter as a String
the OAuth app client secret. retrieve if from the identity provider's dashboard
- where you created your own OAuth app. optional, see all of the caveats in the
- docs for client_id.
+
the OAuth app client secret. retrieve if from the identity provider's
+ dashboard where you created your own OAuth app. optional, see all of the caveats
+ in the docs for client_id.
Parameters:
clientSecret - the value of the client_secret parameter as a String, wrapped in an Optional
@@ -250,7 +250,7 @@ loadScripts(document, 'script');
client_secret to set scopes)
Parameters:
-
scopes - the value of the scopes parameter as a List<String>
+
scopes - the value of the scopes parameter as a List of String
Returns:
this builder instance
@@ -266,7 +266,7 @@ loadScripts(document, 'script');
client_secret to set scopes)
Parameters:
-
scopes - the value of the scopes parameter as a List<String>, wrapped in an Optional
+
scopes - the value of the scopes parameter as a List of String, wrapped in an Optional
Returns:
this builder instance
@@ -280,7 +280,7 @@ loadScripts(document, 'script');
allowed access to the endpoint
Parameters:
-
emailAddresses - the value of the email_addresses parameter as a List<String>
+
emailAddresses - the value of the email_addresses parameter as a List of String
Returns:
this builder instance
@@ -294,7 +294,7 @@ loadScripts(document, 'script');
allowed access to the endpoint
Parameters:
-
emailAddresses - the value of the email_addresses parameter as a List<String>, wrapped in an Optional
+
emailAddresses - the value of the email_addresses parameter as a List of String, wrapped in an Optional
Returns:
this builder instance
@@ -308,7 +308,7 @@ loadScripts(document, 'script');
allowed access to the endpoint
Parameters:
-
emailDomains - the value of the email_domains parameter as a List<String>
+
emailDomains - the value of the email_domains parameter as a List of String
Returns:
this builder instance
@@ -322,7 +322,7 @@ loadScripts(document, 'script');
allowed access to the endpoint
Parameters:
-
emailDomains - the value of the email_domains parameter as a List<String>, wrapped in an Optional
+
emailDomains - the value of the email_domains parameter as a List of String, wrapped in an Optional
the OAuth app client ID. retrieve it from the identity provider's dashboard
+
the OAuth app client ID. retrieve it from the identity provider's dashboard
where you created your own OAuth app. optional. if unspecified, ngrok will use
its own managed oauth application which has additional restrictions. see the
OAuth module docs for more details. if present, client_secret must be present as
@@ -200,9 +200,9 @@ loadScripts(document, 'script');
the OAuth app client secret. retrieve if from the identity provider's dashboard
- where you created your own OAuth app. optional, see all of the caveats in the
- docs for client_id.
+
the OAuth app client secret. retrieve if from the identity provider's
+ dashboard where you created your own OAuth app. optional, see all of the caveats
+ in the docs for client_id.
Returns:
the value of the property as a String wrapped in an Optional
@@ -219,7 +219,7 @@ loadScripts(document, 'script');
client_secret to set scopes)
enabled - true if the module will be applied to traffic, false to disable. default true if unspecified
optionsPassthrough - Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
-
cookiePrefix - the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
+
cookiePrefix - the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
inactivityTimeout - Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.
maximumDuration - Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
idpMetadata - The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.
forceAuthn - If true, indicates that whenever we redirect a user to the IdP for authentication that the IdP must prompt the user for authentication credentials even if the user already has a valid session with the IdP.
allowIdpInitiated - If true, the IdP may initiate a login directly (e.g. the user does not need to visit the endpoint first and then be redirected). The IdP should set the RelayState parameter to the target URL of the resource they want the user to be redirected to after the SAML login assertion has been processed.
authorizedGroups - If present, only users who are a member of one of the listed groups may access the target endpoint.
-
entityId - The SP Entity's unique ID. This always takes the form of a URL. In ngrok's implementation, this URL is the same as the metadata URL. This will need to be specified to the IdP as configuration.
-
assertionConsumerServiceUrl - The public URL of the SP's Assertion Consumer Service. This is where the IdP will redirect to during an authentication flow. This will need to be specified to the IdP as configuration.
-
singleLogoutUrl - The public URL of the SP's Single Logout Service. This is where the IdP will redirect to during a single logout flow. This will optionally need to be specified to the IdP as configuration.
-
requestSigningCertificatePem - PEM-encoded x.509 certificate of the key pair that is used to sign all SAML requests that the ngrok SP makes to the IdP. Many IdPs do not support request signing verification, but we highly recommend specifying this in the IdP's configuration if it is supported.
-
metadataUrl - A public URL where the SP's metadata is hosted. If an IdP supports dynamic configuration, this is the URL it can use to retrieve the SP metadata.
+
entityId - The SP Entity's unique ID. This always takes the form of a URL. In ngrok's implementation, this URL is the same as the metadata URL. This will need to be specified to the IdP as configuration.
+
assertionConsumerServiceUrl - The public URL of the SP's Assertion Consumer Service. This is where the IdP will redirect to during an authentication flow. This will need to be specified to the IdP as configuration.
+
singleLogoutUrl - The public URL of the SP's Single Logout Service. This is where the IdP will redirect to during a single logout flow. This will optionally need to be specified to the IdP as configuration.
+
requestSigningCertificatePem - PEM-encoded x.509 certificate of the key pair that is used to sign all SAML requests that the ngrok SP makes to the IdP. Many IdPs do not support request signing verification, but we highly recommend specifying this in the IdP's configuration if it is supported.
+
metadataUrl - A public URL where the SP's metadata is hosted. If an IdP supports dynamic configuration, this is the URL it can use to retrieve the SP metadata.
nameidFormat - Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects. If unspecified, a default value of urn:oasis:names:tc:SAML:2.0:nameid-format:persistent will be used. A subset of the allowed values enumerated by the SAML specification are supported.
The SP Entity's unique ID. This always takes the form of a URL. In ngrok's
- implementation, this URL is the same as the metadata URL. This will need to be
- specified to the IdP as configuration.
+
The SP Entity's unique ID. This always takes the form of a URL. In
+ ngrok's implementation, this URL is the same as the metadata URL. This will
+ need to be specified to the IdP as configuration.
The public URL of the SP's Assertion Consumer Service. This is where the IdP
+
The public URL of the SP's Assertion Consumer Service. This is where the IdP
will redirect to during an authentication flow. This will need to be specified
to the IdP as configuration.
The public URL of the SP's Single Logout Service. This is where the IdP will
+
The public URL of the SP's Single Logout Service. This is where the IdP will
redirect to during a single logout flow. This will optionally need to be
specified to the IdP as configuration.
PEM-encoded x.509 certificate of the key pair that is used to sign all SAML
requests that the ngrok SP makes to the IdP. Many IdPs do not support request
- signing verification, but we highly recommend specifying this in the IdP's
+ signing verification, but we highly recommend specifying this in the IdP's
configuration if it is supported.
description - human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.
metadata - arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
publicKey - the PEM-encoded public key of the SSH keypair that will be used to authenticate
-
acl - optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the bind rule. The bind rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule bind:example.ngrok.io. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of bind:*.example.com which will allow x.example.com, y.example.com, *.example.com, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions.
+
acl - optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the bind rule. The bind rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule bind:example.ngrok.io. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of bind:*.example.com which will allow x.example.com, y.example.com, *.example.com, etc. A rule of '*' is equivalent to no acl at all and will explicitly permit all actions.
@@ -289,11 +289,11 @@ loadScripts(document, 'script');
match multiple domains with a common suffix. For example, you may specify a rule
of bind:*.example.com which will allow x.example.com,
y.example.com, *.example.com, etc. A rule of
- '*' is equivalent to no acl at all and will explicitly permit all
- actions.
+ '*' is equivalent to no acl at all and will explicitly
+ permit all actions.
sshCertificateAuthorityId - the ssh certificate authority that is used to sign this ssh user certificate
principals - the list of principals included in the ssh user certificate. This is the list of usernames that the certificate holder may sign in as on a machine authorizing the signing certificate authority. Dangerously, if no principals are specified, this certificate may be used to log in as any user.
criticalOptions - A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec for additional details.
-
extensions - A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec for additional details.
+
extensions - A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec for additional details.
validAfter - the time when the ssh host certificate becomes valid, in RFC 3339 format.
validUntil - the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
certificate - the signed SSH certificate in OpenSSH Authorized Keys Format. this value should be placed in a -cert.pub certificate file on disk that should be referenced in your sshd_config configuration file with a HostCertificate directive
@@ -368,7 +368,7 @@ loadScripts(document, 'script');
this certificate may be used to log in as any user.
publicUrl - URL of the ephemeral tunnel's public endpoint
+
publicUrl - URL of the ephemeral tunnel's public endpoint
startedAt - timestamp when the tunnel was initiated in RFC 3339 format
metadata - user-supplied metadata for the tunnel defined in the ngrok configuration file. See the tunnel metadata configuration option In API version 0, this value was instead pulled from the top-level metadata configuration option.
proto - tunnel protocol for ephemeral tunnels. one of http, https, tcp or tls
Abuse Reports allow you to submit take-down requests for URLs hosted by
- ngrok that violate ngrok's terms of service.
+ ngrok that violate ngrok's terms of service.
See also https://ngrok.com/docs/api#api-abuse-reports.
API Keys are used to authenticate to the ngrok
API. You may use the API itself
- to provision and manage API Keys but you'll need to provision your first API
+ to provision and manage API Keys but you'll need to provision your first
+ API
key from the API Keys page
on your
ngrok.com dashboard.
diff --git a/docs/com/ngrok/services/CertificateAuthorities.CreateCallBuilder.html b/docs/com/ngrok/services/CertificateAuthorities.CreateCallBuilder.html
index 07163c8..a837f9c 100644
--- a/docs/com/ngrok/services/CertificateAuthorities.CreateCallBuilder.html
+++ b/docs/com/ngrok/services/CertificateAuthorities.CreateCallBuilder.html
@@ -1,11 +1,11 @@
-
-CertificateAuthorities.CreateCallBuilder (ngrok Java API client 0.4.0 API)
+
+CertificateAuthorities.CreateCallBuilder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/CertificateAuthorities.DeleteCallBuilder.html b/docs/com/ngrok/services/CertificateAuthorities.DeleteCallBuilder.html
index ea39903..fe811e7 100644
--- a/docs/com/ngrok/services/CertificateAuthorities.DeleteCallBuilder.html
+++ b/docs/com/ngrok/services/CertificateAuthorities.DeleteCallBuilder.html
@@ -1,11 +1,11 @@
-
-CertificateAuthorities.DeleteCallBuilder (ngrok Java API client 0.4.0 API)
+
+CertificateAuthorities.DeleteCallBuilder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/CertificateAuthorities.GetCallBuilder.html b/docs/com/ngrok/services/CertificateAuthorities.GetCallBuilder.html
index 3f0a48e..9e40e23 100644
--- a/docs/com/ngrok/services/CertificateAuthorities.GetCallBuilder.html
+++ b/docs/com/ngrok/services/CertificateAuthorities.GetCallBuilder.html
@@ -1,11 +1,11 @@
-
-CertificateAuthorities.GetCallBuilder (ngrok Java API client 0.4.0 API)
+
+CertificateAuthorities.GetCallBuilder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/CertificateAuthorities.ListCallBuilder.html b/docs/com/ngrok/services/CertificateAuthorities.ListCallBuilder.html
index 6030d7f..54b05cd 100644
--- a/docs/com/ngrok/services/CertificateAuthorities.ListCallBuilder.html
+++ b/docs/com/ngrok/services/CertificateAuthorities.ListCallBuilder.html
@@ -1,11 +1,11 @@
-
-CertificateAuthorities.ListCallBuilder (ngrok Java API client 0.4.0 API)
+
+CertificateAuthorities.ListCallBuilder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/CertificateAuthorities.UpdateCallBuilder.html b/docs/com/ngrok/services/CertificateAuthorities.UpdateCallBuilder.html
index 1135651..4cb8d43 100644
--- a/docs/com/ngrok/services/CertificateAuthorities.UpdateCallBuilder.html
+++ b/docs/com/ngrok/services/CertificateAuthorities.UpdateCallBuilder.html
@@ -1,11 +1,11 @@
-
-CertificateAuthorities.UpdateCallBuilder (ngrok Java API client 0.4.0 API)
+
+CertificateAuthorities.UpdateCallBuilder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/CertificateAuthorities.html b/docs/com/ngrok/services/CertificateAuthorities.html
index 991f148..16a3442 100644
--- a/docs/com/ngrok/services/CertificateAuthorities.html
+++ b/docs/com/ngrok/services/CertificateAuthorities.html
@@ -1,11 +1,11 @@
-
-CertificateAuthorities (ngrok Java API client 0.4.0 API)
+
+CertificateAuthorities (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/Credentials.CreateCallBuilder.html b/docs/com/ngrok/services/Credentials.CreateCallBuilder.html
index 278d4a8..9e2d05a 100644
--- a/docs/com/ngrok/services/Credentials.CreateCallBuilder.html
+++ b/docs/com/ngrok/services/Credentials.CreateCallBuilder.html
@@ -1,11 +1,11 @@
-
-Credentials.CreateCallBuilder (ngrok Java API client 0.4.0 API)
+
+Credentials.CreateCallBuilder (ngrok Java API client 0.6.0 API)
-
+
@@ -226,11 +226,11 @@ loadScripts(document, 'script');
match multiple domains with a common suffix. For example, you may specify a rule
of bind:*.example.com which will allow x.example.com,
y.example.com, *.example.com, etc. A rule of
- '*' is equivalent to no acl at all and will explicitly permit all
- actions.
+ '*' is equivalent to no acl at all and will explicitly
+ permit all actions.
Parameters:
-
acl - the value of the acl parameter as a List<String>
+
acl - the value of the acl parameter as a List of String
Returns:
the call builder instance
@@ -249,11 +249,11 @@ loadScripts(document, 'script');
match multiple domains with a common suffix. For example, you may specify a rule
of bind:*.example.com which will allow x.example.com,
y.example.com, *.example.com, etc. A rule of
- '*' is equivalent to no acl at all and will explicitly permit all
- actions.
+ '*' is equivalent to no acl at all and will explicitly
+ permit all actions.
diff --git a/docs/com/ngrok/services/Credentials.DeleteCallBuilder.html b/docs/com/ngrok/services/Credentials.DeleteCallBuilder.html
index ecd5cfe..f780834 100644
--- a/docs/com/ngrok/services/Credentials.DeleteCallBuilder.html
+++ b/docs/com/ngrok/services/Credentials.DeleteCallBuilder.html
@@ -1,11 +1,11 @@
-
-Credentials.DeleteCallBuilder (ngrok Java API client 0.4.0 API)
+
+Credentials.DeleteCallBuilder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/Credentials.GetCallBuilder.html b/docs/com/ngrok/services/Credentials.GetCallBuilder.html
index 2dcafd3..310ae09 100644
--- a/docs/com/ngrok/services/Credentials.GetCallBuilder.html
+++ b/docs/com/ngrok/services/Credentials.GetCallBuilder.html
@@ -1,11 +1,11 @@
-
-Credentials.GetCallBuilder (ngrok Java API client 0.4.0 API)
+
+Credentials.GetCallBuilder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/Credentials.ListCallBuilder.html b/docs/com/ngrok/services/Credentials.ListCallBuilder.html
index 26bed39..1c7598f 100644
--- a/docs/com/ngrok/services/Credentials.ListCallBuilder.html
+++ b/docs/com/ngrok/services/Credentials.ListCallBuilder.html
@@ -1,11 +1,11 @@
-
-Credentials.ListCallBuilder (ngrok Java API client 0.4.0 API)
+
+Credentials.ListCallBuilder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/Credentials.UpdateCallBuilder.html b/docs/com/ngrok/services/Credentials.UpdateCallBuilder.html
index e402d02..8de312c 100644
--- a/docs/com/ngrok/services/Credentials.UpdateCallBuilder.html
+++ b/docs/com/ngrok/services/Credentials.UpdateCallBuilder.html
@@ -1,11 +1,11 @@
-
-Credentials.UpdateCallBuilder (ngrok Java API client 0.4.0 API)
+
+Credentials.UpdateCallBuilder (ngrok Java API client 0.6.0 API)
-
+
@@ -226,11 +226,11 @@ loadScripts(document, 'script');
match multiple domains with a common suffix. For example, you may specify a rule
of bind:*.example.com which will allow x.example.com,
y.example.com, *.example.com, etc. A rule of
- '*' is equivalent to no acl at all and will explicitly permit all
- actions.
+ '*' is equivalent to no acl at all and will explicitly
+ permit all actions.
Parameters:
-
acl - the value of the acl parameter as a List<String>
+
acl - the value of the acl parameter as a List of String
Returns:
the call builder instance
@@ -249,11 +249,11 @@ loadScripts(document, 'script');
match multiple domains with a common suffix. For example, you may specify a rule
of bind:*.example.com which will allow x.example.com,
y.example.com, *.example.com, etc. A rule of
- '*' is equivalent to no acl at all and will explicitly permit all
- actions.
+ '*' is equivalent to no acl at all and will explicitly
+ permit all actions.
Reserved Domains are hostnames that you can listen for traffic on. Domains
can be used to listen for http, https or tls traffic. You may use a domain
that you own by creating a CNAME record specified in the returned resource.
- This CNAME record points traffic for that domain to ngrok's edge servers.
+ This CNAME record points traffic for that domain to ngrok's edge servers.
See also https://ngrok.com/docs/api#api-reserved-domains.
name - the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.
+
name - the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.
Returns:
a call builder for this API call
diff --git a/docs/com/ngrok/services/SshCertificateAuthorities.CreateCallBuilder.html b/docs/com/ngrok/services/SshCertificateAuthorities.CreateCallBuilder.html
index 6810c2f..b0212d0 100644
--- a/docs/com/ngrok/services/SshCertificateAuthorities.CreateCallBuilder.html
+++ b/docs/com/ngrok/services/SshCertificateAuthorities.CreateCallBuilder.html
@@ -1,11 +1,11 @@
-
-SshCertificateAuthorities.CreateCallBuilder (ngrok Java API client 0.4.0 API)
+
+SshCertificateAuthorities.CreateCallBuilder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/SshCertificateAuthorities.DeleteCallBuilder.html b/docs/com/ngrok/services/SshCertificateAuthorities.DeleteCallBuilder.html
index 1f23a9f..3d6466a 100644
--- a/docs/com/ngrok/services/SshCertificateAuthorities.DeleteCallBuilder.html
+++ b/docs/com/ngrok/services/SshCertificateAuthorities.DeleteCallBuilder.html
@@ -1,11 +1,11 @@
-
-SshCertificateAuthorities.DeleteCallBuilder (ngrok Java API client 0.4.0 API)
+
+SshCertificateAuthorities.DeleteCallBuilder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/SshCertificateAuthorities.GetCallBuilder.html b/docs/com/ngrok/services/SshCertificateAuthorities.GetCallBuilder.html
index 8d47d56..230374e 100644
--- a/docs/com/ngrok/services/SshCertificateAuthorities.GetCallBuilder.html
+++ b/docs/com/ngrok/services/SshCertificateAuthorities.GetCallBuilder.html
@@ -1,11 +1,11 @@
-
-SshCertificateAuthorities.GetCallBuilder (ngrok Java API client 0.4.0 API)
+
+SshCertificateAuthorities.GetCallBuilder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/SshCertificateAuthorities.ListCallBuilder.html b/docs/com/ngrok/services/SshCertificateAuthorities.ListCallBuilder.html
index 4c07adc..974ccef 100644
--- a/docs/com/ngrok/services/SshCertificateAuthorities.ListCallBuilder.html
+++ b/docs/com/ngrok/services/SshCertificateAuthorities.ListCallBuilder.html
@@ -1,11 +1,11 @@
-
-SshCertificateAuthorities.ListCallBuilder (ngrok Java API client 0.4.0 API)
+
+SshCertificateAuthorities.ListCallBuilder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/SshCertificateAuthorities.UpdateCallBuilder.html b/docs/com/ngrok/services/SshCertificateAuthorities.UpdateCallBuilder.html
index 5d3af15..a80b956 100644
--- a/docs/com/ngrok/services/SshCertificateAuthorities.UpdateCallBuilder.html
+++ b/docs/com/ngrok/services/SshCertificateAuthorities.UpdateCallBuilder.html
@@ -1,11 +1,11 @@
-
-SshCertificateAuthorities.UpdateCallBuilder (ngrok Java API client 0.4.0 API)
+
+SshCertificateAuthorities.UpdateCallBuilder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/SshCertificateAuthorities.html b/docs/com/ngrok/services/SshCertificateAuthorities.html
index 16eddf5..22fb4db 100644
--- a/docs/com/ngrok/services/SshCertificateAuthorities.html
+++ b/docs/com/ngrok/services/SshCertificateAuthorities.html
@@ -1,11 +1,11 @@
-
-SshCertificateAuthorities (ngrok Java API client 0.4.0 API)
+
+SshCertificateAuthorities (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/SshCredentials.CreateCallBuilder.html b/docs/com/ngrok/services/SshCredentials.CreateCallBuilder.html
index 3aa8dc0..7ab8e24 100644
--- a/docs/com/ngrok/services/SshCredentials.CreateCallBuilder.html
+++ b/docs/com/ngrok/services/SshCredentials.CreateCallBuilder.html
@@ -1,11 +1,11 @@
-
-SshCredentials.CreateCallBuilder (ngrok Java API client 0.4.0 API)
+
+SshCredentials.CreateCallBuilder (ngrok Java API client 0.6.0 API)
-
+
@@ -226,11 +226,11 @@ loadScripts(document, 'script');
match multiple domains with a common suffix. For example, you may specify a rule
of bind:*.example.com which will allow x.example.com,
y.example.com, *.example.com, etc. A rule of
- '*' is equivalent to no acl at all and will explicitly permit all
- actions.
+ '*' is equivalent to no acl at all and will explicitly
+ permit all actions.
Parameters:
-
acl - the value of the acl parameter as a List<String>
+
acl - the value of the acl parameter as a List of String
Returns:
the call builder instance
@@ -249,11 +249,11 @@ loadScripts(document, 'script');
match multiple domains with a common suffix. For example, you may specify a rule
of bind:*.example.com which will allow x.example.com,
y.example.com, *.example.com, etc. A rule of
- '*' is equivalent to no acl at all and will explicitly permit all
- actions.
+ '*' is equivalent to no acl at all and will explicitly
+ permit all actions.
diff --git a/docs/com/ngrok/services/SshCredentials.DeleteCallBuilder.html b/docs/com/ngrok/services/SshCredentials.DeleteCallBuilder.html
index 0b876ec..56bab00 100644
--- a/docs/com/ngrok/services/SshCredentials.DeleteCallBuilder.html
+++ b/docs/com/ngrok/services/SshCredentials.DeleteCallBuilder.html
@@ -1,11 +1,11 @@
-
-SshCredentials.DeleteCallBuilder (ngrok Java API client 0.4.0 API)
+
+SshCredentials.DeleteCallBuilder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/SshCredentials.GetCallBuilder.html b/docs/com/ngrok/services/SshCredentials.GetCallBuilder.html
index a31c96e..b9c8bf0 100644
--- a/docs/com/ngrok/services/SshCredentials.GetCallBuilder.html
+++ b/docs/com/ngrok/services/SshCredentials.GetCallBuilder.html
@@ -1,11 +1,11 @@
-
-SshCredentials.GetCallBuilder (ngrok Java API client 0.4.0 API)
+
+SshCredentials.GetCallBuilder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/SshCredentials.ListCallBuilder.html b/docs/com/ngrok/services/SshCredentials.ListCallBuilder.html
index 7283802..42a4f0b 100644
--- a/docs/com/ngrok/services/SshCredentials.ListCallBuilder.html
+++ b/docs/com/ngrok/services/SshCredentials.ListCallBuilder.html
@@ -1,11 +1,11 @@
-
-SshCredentials.ListCallBuilder (ngrok Java API client 0.4.0 API)
+
+SshCredentials.ListCallBuilder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/SshCredentials.UpdateCallBuilder.html b/docs/com/ngrok/services/SshCredentials.UpdateCallBuilder.html
index ffce0d1..59574f3 100644
--- a/docs/com/ngrok/services/SshCredentials.UpdateCallBuilder.html
+++ b/docs/com/ngrok/services/SshCredentials.UpdateCallBuilder.html
@@ -1,11 +1,11 @@
-
-SshCredentials.UpdateCallBuilder (ngrok Java API client 0.4.0 API)
+
+SshCredentials.UpdateCallBuilder (ngrok Java API client 0.6.0 API)
-
+
@@ -226,11 +226,11 @@ loadScripts(document, 'script');
match multiple domains with a common suffix. For example, you may specify a rule
of bind:*.example.com which will allow x.example.com,
y.example.com, *.example.com, etc. A rule of
- '*' is equivalent to no acl at all and will explicitly permit all
- actions.
+ '*' is equivalent to no acl at all and will explicitly
+ permit all actions.
Parameters:
-
acl - the value of the acl parameter as a List<String>
+
acl - the value of the acl parameter as a List of String
Returns:
the call builder instance
@@ -249,11 +249,11 @@ loadScripts(document, 'script');
match multiple domains with a common suffix. For example, you may specify a rule
of bind:*.example.com which will allow x.example.com,
y.example.com, *.example.com, etc. A rule of
- '*' is equivalent to no acl at all and will explicitly permit all
- actions.
+ '*' is equivalent to no acl at all and will explicitly
+ permit all actions.
Create a new ssh_credential from an uploaded public SSH key. This ssh credential
- can be used to start new tunnels via ngrok's SSH gateway.
+ can be used to start new tunnels via ngrok's SSH gateway.
See also https://ngrok.com/docs/api#api-ssh-credentials-create.
diff --git a/docs/com/ngrok/services/SshHostCertificates.CreateCallBuilder.html b/docs/com/ngrok/services/SshHostCertificates.CreateCallBuilder.html
index 6044583..b5479d4 100644
--- a/docs/com/ngrok/services/SshHostCertificates.CreateCallBuilder.html
+++ b/docs/com/ngrok/services/SshHostCertificates.CreateCallBuilder.html
@@ -1,11 +1,11 @@
-
-SshHostCertificates.CreateCallBuilder (ngrok Java API client 0.4.0 API)
+
+SshHostCertificates.CreateCallBuilder (ngrok Java API client 0.6.0 API)
-
+
@@ -185,7 +185,7 @@ loadScripts(document, 'script');
considered valid for all hosts.
Parameters:
-
principals - the value of the principals parameter as a List<String>
+
principals - the value of the principals parameter as a List of String
Returns:
the call builder instance
@@ -201,7 +201,7 @@ loadScripts(document, 'script');
considered valid for all hosts.
Parameters:
-
principals - the value of the principals parameter as an Optional of List<String>
+
principals - the value of the principals parameter as an Optional of List of String
Returns:
the call builder instance
diff --git a/docs/com/ngrok/services/SshHostCertificates.DeleteCallBuilder.html b/docs/com/ngrok/services/SshHostCertificates.DeleteCallBuilder.html
index f444a90..0fb26bb 100644
--- a/docs/com/ngrok/services/SshHostCertificates.DeleteCallBuilder.html
+++ b/docs/com/ngrok/services/SshHostCertificates.DeleteCallBuilder.html
@@ -1,11 +1,11 @@
-
-SshHostCertificates.DeleteCallBuilder (ngrok Java API client 0.4.0 API)
+
+SshHostCertificates.DeleteCallBuilder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/SshHostCertificates.GetCallBuilder.html b/docs/com/ngrok/services/SshHostCertificates.GetCallBuilder.html
index f2df5a2..0316de1 100644
--- a/docs/com/ngrok/services/SshHostCertificates.GetCallBuilder.html
+++ b/docs/com/ngrok/services/SshHostCertificates.GetCallBuilder.html
@@ -1,11 +1,11 @@
-
-SshHostCertificates.GetCallBuilder (ngrok Java API client 0.4.0 API)
+
+SshHostCertificates.GetCallBuilder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/SshHostCertificates.ListCallBuilder.html b/docs/com/ngrok/services/SshHostCertificates.ListCallBuilder.html
index 21b2392..cbfe876 100644
--- a/docs/com/ngrok/services/SshHostCertificates.ListCallBuilder.html
+++ b/docs/com/ngrok/services/SshHostCertificates.ListCallBuilder.html
@@ -1,11 +1,11 @@
-
-SshHostCertificates.ListCallBuilder (ngrok Java API client 0.4.0 API)
+
+SshHostCertificates.ListCallBuilder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/SshHostCertificates.UpdateCallBuilder.html b/docs/com/ngrok/services/SshHostCertificates.UpdateCallBuilder.html
index 3ca59a3..72c4d9f 100644
--- a/docs/com/ngrok/services/SshHostCertificates.UpdateCallBuilder.html
+++ b/docs/com/ngrok/services/SshHostCertificates.UpdateCallBuilder.html
@@ -1,11 +1,11 @@
-
-SshHostCertificates.UpdateCallBuilder (ngrok Java API client 0.4.0 API)
+
+SshHostCertificates.UpdateCallBuilder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/SshHostCertificates.html b/docs/com/ngrok/services/SshHostCertificates.html
index b919e95..34ee736 100644
--- a/docs/com/ngrok/services/SshHostCertificates.html
+++ b/docs/com/ngrok/services/SshHostCertificates.html
@@ -1,11 +1,11 @@
-
-SshHostCertificates (ngrok Java API client 0.4.0 API)
+
+SshHostCertificates (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/SshUserCertificates.CreateCallBuilder.html b/docs/com/ngrok/services/SshUserCertificates.CreateCallBuilder.html
index 740058e..3d8b5d6 100644
--- a/docs/com/ngrok/services/SshUserCertificates.CreateCallBuilder.html
+++ b/docs/com/ngrok/services/SshUserCertificates.CreateCallBuilder.html
@@ -1,11 +1,11 @@
-
-SshUserCertificates.CreateCallBuilder (ngrok Java API client 0.4.0 API)
+
+SshUserCertificates.CreateCallBuilder (ngrok Java API client 0.6.0 API)
-
+
@@ -205,7 +205,7 @@ loadScripts(document, 'script');
this certificate may be used to log in as any user.
Parameters:
-
principals - the value of the principals parameter as a List<String>
+
principals - the value of the principals parameter as a List of String
Returns:
the call builder instance
@@ -221,7 +221,7 @@ loadScripts(document, 'script');
this certificate may be used to log in as any user.
Parameters:
-
principals - the value of the principals parameter as an Optional of List<String>
+
principals - the value of the principals parameter as an Optional of List of String
A Weighted Backend balances traffic among the referenced backends. Traffic
is assigned proportionally to each based on its weight. The percentage of
- traffic is calculated by dividing a backend's weight by the sum of all
+ traffic is calculated by dividing a backend's weight by the sum of all
weights.
See also https://ngrok.com/docs/api#api-weighted-backends.
diff --git a/docs/com/ngrok/services/class-use/AbuseReports.CreateCallBuilder.html b/docs/com/ngrok/services/class-use/AbuseReports.CreateCallBuilder.html
index ae7e52e..e804569 100644
--- a/docs/com/ngrok/services/class-use/AbuseReports.CreateCallBuilder.html
+++ b/docs/com/ngrok/services/class-use/AbuseReports.CreateCallBuilder.html
@@ -1,11 +1,11 @@
-
-Uses of Class com.ngrok.services.AbuseReports.CreateCallBuilder (ngrok Java API client 0.4.0 API)
+
+Uses of Class com.ngrok.services.AbuseReports.CreateCallBuilder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/class-use/AbuseReports.GetCallBuilder.html b/docs/com/ngrok/services/class-use/AbuseReports.GetCallBuilder.html
index b4b2e4b..caf9f69 100644
--- a/docs/com/ngrok/services/class-use/AbuseReports.GetCallBuilder.html
+++ b/docs/com/ngrok/services/class-use/AbuseReports.GetCallBuilder.html
@@ -1,11 +1,11 @@
-
-Uses of Class com.ngrok.services.AbuseReports.GetCallBuilder (ngrok Java API client 0.4.0 API)
+
+Uses of Class com.ngrok.services.AbuseReports.GetCallBuilder (ngrok Java API client 0.6.0 API)
-
+
diff --git a/docs/com/ngrok/services/class-use/AbuseReports.html b/docs/com/ngrok/services/class-use/AbuseReports.html
index 3b779ef..77dd6e6 100644
--- a/docs/com/ngrok/services/class-use/AbuseReports.html
+++ b/docs/com/ngrok/services/class-use/AbuseReports.html
@@ -1,11 +1,11 @@
-
-Uses of Class com.ngrok.services.AbuseReports (ngrok Java API client 0.4.0 API)
+
+Uses of Class com.ngrok.services.AbuseReports (ngrok Java API client 0.6.0 API)
-
+
@@ -72,7 +72,7 @@ loadScripts(document, 'script');