p
Helpers for creating new DefaultNgrokApiClient instances.
Creates a new default ngrok API client.
Creates a new default ngrok API client. -
API key used to access the ngrok API
an optional HTTP client to use to make requests
an optional API base URI
a new API client
Creates a new default Armeria WebClient.
Creates a new default Armeria WebClient. -
a HTTP client
Helpers for creating new DefaultNgrokApiClient instances.
Creates a new default ngrok API client.
Creates a new default ngrok API client. +
API key used to access the ngrok API
an optional HTTP client to use to make requests
an optional API base URI
a new API client
Creates a new default Armeria WebClient.
Creates a new default Armeria WebClient. +
a HTTP client
Default implementation of NgrokApiClient based on the Armeria HTTP client.
Sends a request to the ngrok API.
Sends a request to the ngrok API. -
the return type for the API response (must have an implicit io.circe.Decoder and scala.reflect.ClassTag)
the HTTP method to use
the endpoint (under the base URI) to send the request to
any query parameters to send along with the request (parameters with an empty - value will not be sent)
JSON request body, if any
an execution context
a future encapsulating the response type
Sends a GET request directly to the specified URI.
Sends a GET request directly to the specified URI. -
the return type for the API response (must have an implicit io.circe.Decoder and scala.reflect.ClassTag)
a URI to send the request to
an execution context
a future encapsulating the response type
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Default implementation of NgrokApiClient based on the Armeria HTTP client.
Sends a request to the ngrok API.
Sends a request to the ngrok API. +
the return type for the API response (must have an implicit io.circe.Decoder and scala.reflect.ClassTag)
the HTTP method to use
the endpoint (under the base URI) to send the request to
any query parameters to send along with the request (parameters with an empty + value will not be sent)
JSON request body, if any
an execution context
a future encapsulating the response type
Sends a GET request directly to the specified URI.
Sends a GET request directly to the specified URI. +
the return type for the API response (must have an implicit io.circe.Decoder and scala.reflect.ClassTag)
a URI to send the request to
an execution context
a future encapsulating the response type
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Factory for Ngrok instances.
Creates a new ngrok API instance using the default API client.
Creates a new ngrok API instance using the default API client.
The API key is pulled from the environment variable NGROK_API_KEY.
-
an ngrok API instance
Creates a new ngrok API instance using the default API client.
Creates a new ngrok API instance using the default API client. -
API key used to access the ngrok API
an ngrok API instance
Creates a new ngrok API instance.
Creates a new ngrok API instance. -
an instance of NgrokApiClient
Factory for Ngrok instances.
Creates a new ngrok API instance using the default API client.
Creates a new ngrok API instance using the default API client.
The API key is pulled from the environment variable NGROK_API_KEY.
+
an ngrok API instance
Creates a new ngrok API instance using the default API client.
Creates a new ngrok API instance using the default API client. +
API key used to access the ngrok API
an ngrok API instance
Creates a new ngrok API instance.
Creates a new ngrok API instance. +
an instance of NgrokApiClient
A namespace object for Backends.
A Failover backend defines failover behavior within a list of referenced +
A namespace object for Backends.
A Failover backend defines failover behavior within a list of referenced backends.
A Failover backend defines failover behavior within a list of referenced backends. Traffic is sent to the first backend in the list. If that backend is offline or no connection can be established, ngrok attempts to connect to the next backend in the list until one is successful.
a service client
Creates a service client for services.HttpResponseBackends.
Creates a service client for services.HttpResponseBackends.
See also https://ngrok.com/docs/api#api-http-response-backends -
a service client
A Tunnel Group Backend balances traffic among all online tunnels that match +
a service client
Creates a service client for services.HttpResponseBackends.
Creates a service client for services.HttpResponseBackends.
See also https://ngrok.com/docs/api#api-http-response-backends +
a service client
A Tunnel Group Backend balances traffic among all online tunnels that match a label selector.
A Tunnel Group Backend balances traffic among all online tunnels that match a label selector.
See also https://ngrok.com/docs/api#api-tunnel-group-backends -
a service client
A Weighted Backend balances traffic among the referenced backends.
A Weighted Backend balances traffic among the referenced backends. Traffic +
a service client
A Weighted Backend balances traffic among the referenced backends.
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.
a service client
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
a service client
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A namespace object for EdgeModules.
Creates a service client for services.HttpsEdgeMutualTlsModule.
Creates a service client for services.HttpsEdgeMutualTlsModule.
See also https://ngrok.com/docs/api#api-https-edge-mutual-tls-module +
A namespace object for EdgeModules.
Creates a service client for services.HttpsEdgeMutualTlsModule.
Creates a service client for services.HttpsEdgeMutualTlsModule.
See also https://ngrok.com/docs/api#api-https-edge-mutual-tls-module
a service client
Creates a service client for services.EdgeRouteBackendModule.
Creates a service client for services.EdgeRouteBackendModule.
See also https://ngrok.com/docs/api#api-edge-route-backend-module
a service client
Creates a service client for services.EdgeRouteCircuitBreakerModule.
Creates a service client for services.EdgeRouteCircuitBreakerModule.
See also https://ngrok.com/docs/api#api-edge-route-circuit-breaker-module
a service client
Creates a service client for services.EdgeRouteCompressionModule.
Creates a service client for services.EdgeRouteCompressionModule.
See also https://ngrok.com/docs/api#api-edge-route-compression-module @@ -12,10 +12,12 @@
a service client
Creates a service client for services.EdgeRouteWebhookVerificationModule.
Creates a service client for services.EdgeRouteWebhookVerificationModule.
See also https://ngrok.com/docs/api#api-edge-route-webhook-verification-module
a service client
Creates a service client for services.EdgeRouteWebsocketTcpConverterModule.
Creates a service client for services.EdgeRouteWebsocketTcpConverterModule.
See also https://ngrok.com/docs/api#api-edge-route-websocket-tcp-converter-module
a service client
Creates a service client for services.HttpsEdgeTlsTerminationModule.
Creates a service client for services.HttpsEdgeTlsTerminationModule.
See also https://ngrok.com/docs/api#api-https-edge-tls-termination-module -
a service client
Creates a service client for services.TcpEdgeBackendModule.
Creates a service client for services.TcpEdgeBackendModule.
See also https://ngrok.com/docs/api#api-tcp-edge-backend-module +
a service client
Creates a service client for services.TcpEdgeBackendModule.
Creates a service client for services.TcpEdgeBackendModule.
See also https://ngrok.com/docs/api#api-tcp-edge-backend-module
a service client
Creates a service client for services.TcpEdgeIpRestrictionModule.
Creates a service client for services.TcpEdgeIpRestrictionModule.
See also https://ngrok.com/docs/api#api-tcp-edge-ip-restriction-module
a service client
Creates a service client for services.TlsEdgeBackendModule.
Creates a service client for services.TlsEdgeBackendModule.
See also https://ngrok.com/docs/api#api-tls-edge-backend-module
a service client
Creates a service client for services.TlsEdgeIpRestrictionModule.
Creates a service client for services.TlsEdgeIpRestrictionModule.
See also https://ngrok.com/docs/api#api-tls-edge-ip-restriction-module
a service client
Creates a service client for services.TlsEdgeMutualTlsModule.
Creates a service client for services.TlsEdgeMutualTlsModule.
See also https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module
a service client
Creates a service client for services.TlsEdgeTlsTerminationModule.
Creates a service client for services.TlsEdgeTlsTerminationModule.
See also https://ngrok.com/docs/api#api-tls-edge-tls-termination-module -
a service client
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
a service client
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A namespace object for Edges.
Creates a service client for services.EdgesHttps.
Creates a service client for services.EdgesHttps.
See also https://ngrok.com/docs/api#api-edges-https +
A namespace object for Edges.
Creates a service client for services.EdgesHttps.
Creates a service client for services.EdgesHttps.
a service client
Creates a service client for services.EdgesHttpsRoutes.
Creates a service client for services.EdgesHttpsRoutes.
See also https://ngrok.com/docs/api#api-edges-https-routes -
a service client
Creates a service client for services.EdgesTcp.
Creates a service client for services.EdgesTcp.
See also https://ngrok.com/docs/api#api-edges-tcp +
a service client
Creates a service client for services.EdgesTcp.
Creates a service client for services.EdgesTcp.
a service client
Creates a service client for services.EdgesTls.
Creates a service client for services.EdgesTls.
See also https://ngrok.com/docs/api#api-edges-tls -
a service client
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
a service client
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Main entry point for the ngrok API.
A namespace object for Backends.
A namespace object for EdgeModules.
A namespace object for Edges.
Abuse Reports allow you to submit take-down requests for URLs hosted by - ngrok that violate ngrok's terms of service.
Abuse Reports allow you to submit take-down requests for URLs hosted by - ngrok that violate ngrok's terms of service.
See also https://ngrok.com/docs/api#api-abuse-reports. +
Main entry point for the ngrok API.
A namespace object for Backends.
A namespace object for EdgeModules.
A namespace object for Edges.
Abuse Reports allow you to submit take-down requests for URLs hosted by + ngrok that violate ngrok's terms of service.
Abuse Reports allow you to submit take-down requests for URLs hosted by + ngrok that violate ngrok's terms of service.
a service client
Creates a service client for AgentIngresses.
Creates a service client for AgentIngresses.
a service client
API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">ngrok API.
API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">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.
See also https://ngrok.com/docs/api#api-api-keys. @@ -19,9 +20,9 @@ to verify that the TLS certificate presented by a client has been signed by this CA. Certificate Authorities are used only for mTLS validation only and thus a private key is not included in the resource.
See also https://ngrok.com/docs/api#api-certificate-authorities. -
a service client
Tunnel Credentials are ngrok agent authtokens.
Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok +
a service client
Tunnel Credentials are ngrok agent authtokens.
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.
a service client
Creates a namespace object for EdgeModules.
Creates a namespace object for EdgeModules. @@ -30,10 +31,10 @@ which define what tunnel or edge is used to serve a hostport.
Endpoints provides an API for querying the endpoint objects which define what tunnel or edge is used to serve a hostport. Only active endpoints associated with a tunnel or backend are returned.
See also https://ngrok.com/docs/api#api-endpoints. -
a service client
Creates a service client for EventDestinations.
Creates a service client for EventDestinations.
See also https://ngrok.com/docs/api#api-event-destinations. +
a service client
Creates a service client for EventDestinations.
Creates a service client for EventDestinations.
a service client
Creates a service client for EventSources.
Creates a service client for EventSources.
a service client
Creates a service client for EventSubscriptions.
Creates a service client for EventSubscriptions.
See also https://ngrok.com/docs/api#api-event-subscriptions. -
a service client
IP Policies are reusable groups of CIDR ranges with an allow or
+
a service client
IP Policies are reusable groups of CIDR ranges with an allow or
deny
action.
IP Policies are reusable groups of CIDR ranges with an allow or
deny
@@ -50,13 +51,13 @@
restrictions can be used to enforce the source IPs that can make API
requests, log in to the dashboard, start ngrok agents, and connect to your
public-facing endpoints.
See also https://ngrok.com/docs/api#api-ip-restrictions. -
a service client
Reserved Addresses are TCP addresses that can be used to listen for traffic.
Reserved Addresses are TCP addresses that can be used to listen for traffic. +
a service client
Reserved Addresses are TCP addresses that can be used to listen for traffic.
Reserved Addresses are TCP addresses that can be used to listen for traffic. TCP address hostnames and ports are assigned by ngrok, they cannot be chosen.
a service client
Reserved Domains are hostnames that you can listen for traffic on.
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.
See also https://ngrok.com/docs/api#api-reserved-domains. + This CNAME record points traffic for that domain to ngrok's edge servers.
a service client
An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.
An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.
See also https://ngrok.com/docs/api#api-ssh-certificate-authorities. @@ -85,4 +86,6 @@
a service client
Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.
Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.
See also https://ngrok.com/docs/api#api-tunnels. -
a service client
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
a service client
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Helpful constants and enums for making API requests.
Helpful constants and enums for making API requests.
HTTP DELETE
Helpful constants and enums for making API requests.
Helpful constants and enums for making API requests.
HTTP DELETE
Helpful constants and enums for making API requests.
Helpful constants and enums for making API requests.
HTTP GET
Helpful constants and enums for making API requests.
Helpful constants and enums for making API requests.
HTTP GET
Helpful constants and enums for making API requests.
Helpful constants and enums for making API requests.
HTTP PATCH
Helpful constants and enums for making API requests.
Helpful constants and enums for making API requests.
HTTP PATCH
Helpful constants and enums for making API requests.
Helpful constants and enums for making API requests.
HTTP POST
Helpful constants and enums for making API requests.
Helpful constants and enums for making API requests.
HTTP POST
Helpful constants and enums for making API requests.
Helpful constants and enums for making API requests.
HTTP PUT
Helpful constants and enums for making API requests.
Helpful constants and enums for making API requests.
HTTP PUT
HTTP DELETE
HTTP GET
HTTP PATCH
HTTP POST
HTTP PUT
HTTP DELETE
HTTP GET
HTTP PATCH
HTTP POST
HTTP PUT
HTTP request methods.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
HTTP request methods.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Helpful constants and enums for making API requests.
HTTP request methods.
The default base URI for the public ngrok API server.
Helpful constants and enums for making API requests.
HTTP request methods.
The default base URI for the public ngrok API server.
API client interface.
Concrete implementations can be written and passed to Ngrok on construction +
API client interface.
Concrete implementations can be written and passed to Ngrok on construction in order to make HTTP requests or test business logic. -
Sends a request to the ngrok API.
Sends a request to the ngrok API. -
the return type for the API response (must have an implicit io.circe.Decoder and scala.reflect.ClassTag)
the HTTP method to use
the endpoint (under the base URI) to send the request to
any query parameters to send along with the request (parameters with an empty - value will not be sent)
JSON request body, if any
an execution context
a future encapsulating the response type
Sends a GET request directly to the specified URI.
Sends a GET request directly to the specified URI. -
the return type for the API response (must have an implicit io.circe.Decoder and scala.reflect.ClassTag)
a URI to send the request to
an execution context
a future encapsulating the response type
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Sends a request to the ngrok API.
Sends a request to the ngrok API. +
the return type for the API response (must have an implicit io.circe.Decoder and scala.reflect.ClassTag)
the HTTP method to use
the endpoint (under the base URI) to send the request to
any query parameters to send along with the request (parameters with an empty + value will not be sent)
JSON request body, if any
an execution context
a future encapsulating the response type
Sends a GET request directly to the specified URI.
Sends a GET request directly to the specified URI. +
the return type for the API response (must have an implicit io.circe.Decoder and scala.reflect.ClassTag)
a URI to send the request to
an execution context
a future encapsulating the response type
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Client version information.
The ngrok API version in use.
This API client's version string
Client version information.
The ngrok API version in use.
This API client's version string
A class encapsulating the AbuseReport resource. -
ID of the abuse report
URI of the abuse report API resource
timestamp that the abuse report record was created in RFC 3339 format
a list of URLs containing suspected abusive content
arbitrary user-defined data about this abuse report. Optional, max 4096 bytes.
Indicates whether ngrok has processed the abuse report. one of PENDING, PROCESSED, or PARTIALLY_PROCESSED
an array of hostname statuses related to the report
create a new AbuseReport.
create a new AbuseReport.
ID of the abuse report
URI of the abuse report API resource
timestamp that the abuse report record was created in RFC 3339 format
a list of URLs containing suspected abusive content
arbitrary user-defined data about this abuse report. Optional, max 4096 bytes.
Indicates whether ngrok has processed the abuse report. one of PENDING, PROCESSED, or PARTIALLY_PROCESSED
an array of hostname statuses related to the report
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the AbuseReport resource. +
ID of the abuse report
URI of the abuse report API resource
timestamp that the abuse report record was created in RFC 3339 format
a list of URLs containing suspected abusive content
arbitrary user-defined data about this abuse report. Optional, max 4096 bytes.
Indicates whether ngrok has processed the abuse report. one of PENDING, PROCESSED, or PARTIALLY_PROCESSED
an array of hostname statuses related to the report
create a new AbuseReport.
create a new AbuseReport.
ID of the abuse report
URI of the abuse report API resource
timestamp that the abuse report record was created in RFC 3339 format
a list of URLs containing suspected abusive content
arbitrary user-defined data about this abuse report. Optional, max 4096 bytes.
Indicates whether ngrok has processed the abuse report. one of PENDING, PROCESSED, or PARTIALLY_PROCESSED
an array of hostname statuses related to the report
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the AbuseReportHostname resource. -
the hostname ngrok has parsed out of one of the reported URLs in this abuse report
indicates what action ngrok has taken against the hostname. one of PENDING, BANNED, UNBANNED, or IGNORE
create a new AbuseReportHostname.
create a new AbuseReportHostname.
the hostname ngrok has parsed out of one of the reported URLs in this abuse report
indicates what action ngrok has taken against the hostname. one of PENDING, BANNED, UNBANNED, or IGNORE
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the AbuseReportHostname resource. +
the hostname ngrok has parsed out of one of the reported URLs in this abuse report
indicates what action ngrok has taken against the hostname. one of PENDING, BANNED, UNBANNED, or IGNORE
create a new AbuseReportHostname.
create a new AbuseReportHostname.
the hostname ngrok has parsed out of one of the reported URLs in this abuse report
indicates what action ngrok has taken against the hostname. one of PENDING, BANNED, UNBANNED, or IGNORE
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the AgentIngress resource. -
unique Agent Ingress resource identifier
URI to the API resource of this Agent ingress
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
the domain that you own to be used as the base domain name to generate regional agent ingress domains.
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
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
timestamp when the Agent Ingress was created, RFC 3339 format
create a new AgentIngress.
create a new AgentIngress.
unique Agent Ingress resource identifier
URI to the API resource of this Agent ingress
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
the domain that you own to be used as the base domain name to generate regional agent ingress domains.
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
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
timestamp when the Agent Ingress was created, RFC 3339 format
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the AgentIngress resource. +
unique Agent Ingress resource identifier
URI to the API resource of this Agent ingress
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
the domain that you own to be used as the base domain name to generate regional agent ingress domains.
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
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
timestamp when the Agent Ingress was created, RFC 3339 format
create a new AgentIngress.
create a new AgentIngress.
unique Agent Ingress resource identifier
URI to the API resource of this Agent ingress
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
the domain that you own to be used as the base domain name to generate regional agent ingress domains.
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
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
timestamp when the Agent Ingress was created, RFC 3339 format
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the AgentIngressList resource. -
the list of Agent Ingresses owned by this account
URI of the Agent Ingress list API resource
URI of the next page, or null if there is no next page
create a new AgentIngressList.
create a new AgentIngressList.
the list of Agent Ingresses owned by this account
URI of the Agent Ingress list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the AgentIngressList resource. +
the list of Agent Ingresses owned by this account
URI of the Agent Ingress list API resource
URI of the next page, or null if there is no next page
create a new AgentIngressList.
create a new AgentIngressList.
the list of Agent Ingresses owned by this account
URI of the Agent Ingress list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the ApiKey resource. -
unique API key resource identifier
URI to the API resource of this API key
human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
arbitrary user-defined data of this API key. optional, max 4096 bytes
timestamp when the api key was created, RFC 3339 format
the bearer token that can be placed into the Authorization header to authenticate request to the ngrok API. This value is only available one time, on the API response from key creation. Otherwise it is null.
create a new ApiKey.
create a new ApiKey.
unique API key resource identifier
URI to the API resource of this API key
human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
arbitrary user-defined data of this API key. optional, max 4096 bytes
timestamp when the api key was created, RFC 3339 format
the bearer token that can be placed into the Authorization header to authenticate request to the ngrok API. This value is only available one time, on the API response from key creation. Otherwise it is null.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the ApiKey resource. +
unique API key resource identifier
URI to the API resource of this API key
human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
arbitrary user-defined data of this API key. optional, max 4096 bytes
timestamp when the api key was created, RFC 3339 format
the bearer token that can be placed into the Authorization header to authenticate request to the ngrok API. This value is only available one time, on the API response from key creation. Otherwise it is null.
create a new ApiKey.
create a new ApiKey.
unique API key resource identifier
URI to the API resource of this API key
human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
arbitrary user-defined data of this API key. optional, max 4096 bytes
timestamp when the api key was created, RFC 3339 format
the bearer token that can be placed into the Authorization header to authenticate request to the ngrok API. This value is only available one time, on the API response from key creation. Otherwise it is null.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the ApiKeyList resource. -
the list of API keys for this account
URI of the API keys list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the ApiKeyList resource. +
the list of API keys for this account
URI of the API keys list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the AwsAuth resource. -
A role for ngrok to assume on your behalf to deposit events into your AWS account.
Credentials to your AWS account if you prefer ngrok to sign in with long-term access keys.
create a new AwsAuth.
create a new AwsAuth.
A role for ngrok to assume on your behalf to deposit events into your AWS account.
Credentials to your AWS account if you prefer ngrok to sign in with long-term access keys.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the AwsAuth resource. +
A role for ngrok to assume on your behalf to deposit events into your AWS account.
Credentials to your AWS account if you prefer ngrok to sign in with long-term access keys.
create a new AwsAuth.
create a new AwsAuth.
A role for ngrok to assume on your behalf to deposit events into your AWS account.
Credentials to your AWS account if you prefer ngrok to sign in with long-term access keys.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the AwsCredentials resource. -
The ID portion of an AWS access key.
The secret portion of an AWS access key.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the AwsCredentials resource. +
The ID portion of an AWS access key.
The secret portion of an AWS access key.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the AwsRole resource. -
An ARN that specifies the role that ngrok should use to deliver to the configured target.
create a new AwsRole.
create a new AwsRole.
An ARN that specifies the role that ngrok should use to deliver to the configured target.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the AwsRole resource. +
An ARN that specifies the role that ngrok should use to deliver to the configured target.
create a new AwsRole.
create a new AwsRole.
An ARN that specifies the role that ngrok should use to deliver to the configured target.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the CertificateAuthority resource. -
unique identifier for this Certificate Authority
URI of the Certificate Authority API resource
timestamp when the Certificate Authority was created, RFC 3339 format
human-readable description of this Certificate Authority. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.
raw PEM of the Certificate Authority
subject common name of the Certificate Authority
timestamp when this Certificate Authority becomes valid, RFC 3339 format
timestamp when this Certificate Authority becomes invalid, RFC 3339 format
set of actions the private key of this Certificate Authority can be used for
extended set of actions the private key of this Certificate Authority can be used for
create a new CertificateAuthority.
create a new CertificateAuthority.
unique identifier for this Certificate Authority
URI of the Certificate Authority API resource
timestamp when the Certificate Authority was created, RFC 3339 format
human-readable description of this Certificate Authority. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.
raw PEM of the Certificate Authority
subject common name of the Certificate Authority
timestamp when this Certificate Authority becomes valid, RFC 3339 format
timestamp when this Certificate Authority becomes invalid, RFC 3339 format
set of actions the private key of this Certificate Authority can be used for
extended set of actions the private key of this Certificate Authority can be used for
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the CertificateAuthority resource. +
unique identifier for this Certificate Authority
URI of the Certificate Authority API resource
timestamp when the Certificate Authority was created, RFC 3339 format
human-readable description of this Certificate Authority. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.
raw PEM of the Certificate Authority
subject common name of the Certificate Authority
timestamp when this Certificate Authority becomes valid, RFC 3339 format
timestamp when this Certificate Authority becomes invalid, RFC 3339 format
set of actions the private key of this Certificate Authority can be used for
extended set of actions the private key of this Certificate Authority can be used for
create a new CertificateAuthority.
create a new CertificateAuthority.
unique identifier for this Certificate Authority
URI of the Certificate Authority API resource
timestamp when the Certificate Authority was created, RFC 3339 format
human-readable description of this Certificate Authority. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.
raw PEM of the Certificate Authority
subject common name of the Certificate Authority
timestamp when this Certificate Authority becomes valid, RFC 3339 format
timestamp when this Certificate Authority becomes invalid, RFC 3339 format
set of actions the private key of this Certificate Authority can be used for
extended set of actions the private key of this Certificate Authority can be used for
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the CertificateAuthorityList resource. -
the list of all certificate authorities on this account
URI of the certificates authorities list API resource
URI of the next page, or null if there is no next page
create a new CertificateAuthorityList.
create a new CertificateAuthorityList.
the list of all certificate authorities on this account
URI of the certificates authorities list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
Fetches the URI of the next page. -
a URI
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the CertificateAuthorityList resource. +
the list of all certificate authorities on this account
URI of the certificates authorities list API resource
URI of the next page, or null if there is no next page
create a new CertificateAuthorityList.
create a new CertificateAuthorityList.
the list of all certificate authorities on this account
URI of the certificates authorities list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
Fetches the URI of the next page. +
a URI
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the Credential resource. -
unique tunnel credential resource identifier
URI of the tunnel credential API resource
timestamp when the tunnel credential was created, RFC 3339 format
human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
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.
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.
create a new Credential.
create a new Credential.
unique tunnel credential resource identifier
URI of the tunnel credential API resource
timestamp when the tunnel credential was created, RFC 3339 format
human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
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.
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.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the Credential resource. +
unique tunnel credential resource identifier
URI of the tunnel credential API resource
timestamp when the tunnel credential was created, RFC 3339 format
human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
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.
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.
create a new Credential.
create a new Credential.
unique tunnel credential resource identifier
URI of the tunnel credential API resource
timestamp when the tunnel credential was created, RFC 3339 format
human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
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.
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.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the CredentialList resource. -
the list of all tunnel credentials on this account
URI of the tunnel credential list API resource
URI of the next page, or null if there is no next page
create a new CredentialList.
create a new CredentialList.
the list of all tunnel credentials on this account
URI of the tunnel credential list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the CredentialList resource. +
the list of all tunnel credentials on this account
URI of the tunnel credential list API resource
URI of the next page, or null if there is no next page
create a new CredentialList.
create a new CredentialList.
the list of all tunnel credentials on this account
URI of the tunnel credential list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the Endpoint resource. -
unique endpoint resource identifier
identifier of the region this endpoint belongs to
timestamp when the endpoint was created in RFC 3339 format
timestamp when the endpoint was updated in RFC 3339 format
URL of the hostport served by this endpoint
protocol served by this endpoint. one of http, https, tcp, or tls
hostport served by this endpoint (hostname:port)
user-supplied metadata of the associated tunnel or edge object
the domain reserved for this endpoint
the address reserved for this endpoint
the tunnel serving requests to this endpoint, if this is an ephemeral endpoint
the edge serving requests to this endpoint, if this is an edge endpoint
create a new Endpoint.
create a new Endpoint.
unique endpoint resource identifier
identifier of the region this endpoint belongs to
timestamp when the endpoint was created in RFC 3339 format
timestamp when the endpoint was updated in RFC 3339 format
URL of the hostport served by this endpoint
protocol served by this endpoint. one of http, https, tcp, or tls
hostport served by this endpoint (hostname:port)
user-supplied metadata of the associated tunnel or edge object
the domain reserved for this endpoint
the address reserved for this endpoint
the tunnel serving requests to this endpoint, if this is an ephemeral endpoint
the edge serving requests to this endpoint, if this is an edge endpoint
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the Endpoint resource. +
unique endpoint resource identifier
identifier of the region this endpoint belongs to
timestamp when the endpoint was created in RFC 3339 format
timestamp when the endpoint was updated in RFC 3339 format
URL of the hostport served by this endpoint
protocol served by this endpoint. one of http, https, tcp, or tls
hostport served by this endpoint (hostname:port)
user-supplied metadata of the associated tunnel or edge object
the domain reserved for this endpoint
the address reserved for this endpoint
the tunnel serving requests to this endpoint, if this is an ephemeral endpoint
the edge serving requests to this endpoint, if this is an edge endpoint
create a new Endpoint.
create a new Endpoint.
unique endpoint resource identifier
identifier of the region this endpoint belongs to
timestamp when the endpoint was created in RFC 3339 format
timestamp when the endpoint was updated in RFC 3339 format
URL of the hostport served by this endpoint
protocol served by this endpoint. one of http, https, tcp, or tls
hostport served by this endpoint (hostname:port)
user-supplied metadata of the associated tunnel or edge object
the domain reserved for this endpoint
the address reserved for this endpoint
the tunnel serving requests to this endpoint, if this is an ephemeral endpoint
the edge serving requests to this endpoint, if this is an edge endpoint
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointBackend resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
backend to be used to back this endpoint
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointBackend resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
backend to be used to back this endpoint
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointBackendMutate resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
backend to be used to back this endpoint
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointBackendMutate resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
backend to be used to back this endpoint
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointCircuitBreaker resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health
Integer number of seconds in the statistical rolling window that metrics are retained for.
Integer number of buckets into which metrics are retained. Max 128.
Integer number of requests in a rolling window that will trip the circuit. Helpful if traffic volume is low.
Error threshold percentage should be between 0 - 1.0, not 0-100.0
create a new EndpointCircuitBreaker.
create a new EndpointCircuitBreaker.
true if the module will be applied to traffic, false to disable. default true if unspecified
Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health
Integer number of seconds in the statistical rolling window that metrics are retained for.
Integer number of buckets into which metrics are retained. Max 128.
Integer number of requests in a rolling window that will trip the circuit. Helpful if traffic volume is low.
Error threshold percentage should be between 0 - 1.0, not 0-100.0
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointCircuitBreaker resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health
Integer number of seconds in the statistical rolling window that metrics are retained for.
Integer number of buckets into which metrics are retained. Max 128.
Integer number of requests in a rolling window that will trip the circuit. Helpful if traffic volume is low.
Error threshold percentage should be between 0 - 1.0, not 0-100.0
create a new EndpointCircuitBreaker.
create a new EndpointCircuitBreaker.
true if the module will be applied to traffic, false to disable. default true if unspecified
Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health
Integer number of seconds in the statistical rolling window that metrics are retained for.
Integer number of buckets into which metrics are retained. Max 128.
Integer number of requests in a rolling window that will trip the circuit. Helpful if traffic volume is low.
Error threshold percentage should be between 0 - 1.0, not 0-100.0
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointCompression resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointCompression resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointIpPolicy resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
the value of the ip_policies parameter as a scala.List of Ref
create a new EndpointIpPolicy.
create a new EndpointIpPolicy.
true if the module will be applied to traffic, false to disable. default true if unspecified
the value of the ip_policies parameter as a scala.List of Ref
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointIpPolicy resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
the value of the ip_policies parameter as a scala.List of Ref
create a new EndpointIpPolicy.
create a new EndpointIpPolicy.
true if the module will be applied to traffic, false to disable. default true if unspecified
the value of the ip_policies parameter as a scala.List of Ref
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointIpPolicyMutate resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
list of all IP policies that will be used to check if a source IP is allowed access to the endpoint
create a new EndpointIpPolicyMutate.
create a new EndpointIpPolicyMutate.
true if the module will be applied to traffic, false to disable. default true if unspecified
list of all IP policies that will be used to check if a source IP is allowed access to the endpoint
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointIpPolicyMutate resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
list of all IP policies that will be used to check if a source IP is allowed access to the endpoint
create a new EndpointIpPolicyMutate.
create a new EndpointIpPolicyMutate.
true if the module will be applied to traffic, false to disable. default true if unspecified
list of all IP policies that will be used to check if a source IP is allowed access to the endpoint
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointList resource. -
the list of all active endpoints on this account
URI of the endpoints list API resource
URI of the next page, or null if there is no next page
create a new EndpointList.
create a new EndpointList.
the list of all active endpoints on this account
URI of the endpoints list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointList resource. +
the list of all active endpoints on this account
URI of the endpoints list API resource
URI of the next page, or null if there is no next page
create a new EndpointList.
create a new EndpointList.
the list of all active endpoints on this account
URI of the endpoints list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointMutualTls resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
PEM-encoded CA certificates that will be used to validate. Multiple CAs may be provided by concatenating them together.
create a new EndpointMutualTls.
create a new EndpointMutualTls.
true if the module will be applied to traffic, false to disable. default true if unspecified
PEM-encoded CA certificates that will be used to validate. Multiple CAs may be provided by concatenating them together.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointMutualTls resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
PEM-encoded CA certificates that will be used to validate. Multiple CAs may be provided by concatenating them together.
create a new EndpointMutualTls.
create a new EndpointMutualTls.
true if the module will be applied to traffic, false to disable. default true if unspecified
PEM-encoded CA certificates that will be used to validate. Multiple CAs may be provided by concatenating them together.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointMutualTlsMutate resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
list of certificate authorities that will be used to validate the TLS client certificate presented by the initiator of the TLS connection
create a new EndpointMutualTlsMutate.
create a new EndpointMutualTlsMutate.
true if the module will be applied to traffic, false to disable. default true if unspecified
list of certificate authorities that will be used to validate the TLS client certificate presented by the initiator of the TLS connection
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointMutualTlsMutate resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
list of certificate authorities that will be used to validate the TLS client certificate presented by the initiator of the TLS connection
create a new EndpointMutualTlsMutate.
create a new EndpointMutualTlsMutate.
true if the module will be applied to traffic, false to disable. default true if unspecified
list of certificate authorities that will be used to validate the TLS client certificate presented by the initiator of the TLS connection
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointOAuth resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
an object which defines the identity provider to use for authentication and configuration for who may access the endpoint
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
Integer number of seconds after which ngrok guarantees it will refresh user state from the identity provider and recheck whether the user is still authorized to access the endpoint. This is the preferred tunable to use to enforce a minimum amount of time after which a revoked user will no longer be able to access the resource.
create a new EndpointOAuth.
create a new EndpointOAuth.
true if the module will be applied to traffic, false to disable. default true if unspecified
an object which defines the identity provider to use for authentication and configuration for who may access the endpoint
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
Integer number of seconds after which ngrok guarantees it will refresh user state from the identity provider and recheck whether the user is still authorized to access the endpoint. This is the preferred tunable to use to enforce a minimum amount of time after which a revoked user will no longer be able to access the resource.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointOAuth resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
an object which defines the identity provider to use for authentication and configuration for who may access the endpoint
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
Integer number of seconds after which ngrok guarantees it will refresh user state from the identity provider and recheck whether the user is still authorized to access the endpoint. This is the preferred tunable to use to enforce a minimum amount of time after which a revoked user will no longer be able to access the resource.
create a new EndpointOAuth.
create a new EndpointOAuth.
true if the module will be applied to traffic, false to disable. default true if unspecified
an object which defines the identity provider to use for authentication and configuration for who may access the endpoint
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
Integer number of seconds after which ngrok guarantees it will refresh user state from the identity provider and recheck whether the user is still authorized to access the endpoint. This is the preferred tunable to use to enforce a minimum amount of time after which a revoked user will no longer be able to access the resource.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointOAuthFacebook resource. -
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
create a new EndpointOAuthFacebook.
create a new EndpointOAuthFacebook.
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointOAuthFacebook resource. +
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
create a new EndpointOAuthFacebook.
create a new EndpointOAuthFacebook.
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointOAuthGitHub resource. -
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
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
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'
create a new EndpointOAuthGitHub.
create a new EndpointOAuthGitHub.
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
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
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'
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointOAuthGitHub resource. +
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
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
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'
create a new EndpointOAuthGitHub.
create a new EndpointOAuthGitHub.
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
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
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'
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointOAuthGoogle resource. -
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
create a new EndpointOAuthGoogle.
create a new EndpointOAuthGoogle.
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointOAuthGoogle resource. +
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
create a new EndpointOAuthGoogle.
create a new EndpointOAuthGoogle.
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointOAuthMicrosoft resource. -
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
create a new EndpointOAuthMicrosoft.
create a new EndpointOAuthMicrosoft.
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointOAuthMicrosoft resource. +
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
create a new EndpointOAuthMicrosoft.
create a new EndpointOAuthMicrosoft.
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointOAuthProvider resource. -
configuration for using github as the identity provider
configuration for using facebook as the identity provider
configuration for using microsoft as the identity provider
configuration for using google as the identity provider
create a new EndpointOAuthProvider.
create a new EndpointOAuthProvider.
configuration for using github as the identity provider
configuration for using facebook as the identity provider
configuration for using microsoft as the identity provider
configuration for using google as the identity provider
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointOAuthProvider resource. +
configuration for using github as the identity provider
configuration for using facebook as the identity provider
configuration for using microsoft as the identity provider
configuration for using google as the identity provider
create a new EndpointOAuthProvider.
create a new EndpointOAuthProvider.
configuration for using github as the identity provider
configuration for using facebook as the identity provider
configuration for using microsoft as the identity provider
configuration for using google as the identity provider
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointOidc resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
URL of the OIDC "OpenID provider". This is the base URL used for discovery.
The OIDC app's client ID and OIDC audience.
The OIDC app's client secret.
The set of scopes to request from the OIDC identity provider.
create a new EndpointOidc.
create a new EndpointOidc.
true if the module will be applied to traffic, false to disable. default true if unspecified
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
URL of the OIDC "OpenID provider". This is the base URL used for discovery.
The OIDC app's client ID and OIDC audience.
The OIDC app's client secret.
The set of scopes to request from the OIDC identity provider.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointOidc resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
URL of the OIDC "OpenID provider". This is the base URL used for discovery.
The OIDC app's client ID and OIDC audience.
The OIDC app's client secret.
The set of scopes to request from the OIDC identity provider.
create a new EndpointOidc.
create a new EndpointOidc.
true if the module will be applied to traffic, false to disable. default true if unspecified
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
URL of the OIDC "OpenID provider". This is the base URL used for discovery.
The OIDC app's client ID and OIDC audience.
The OIDC app's client secret.
The set of scopes to request from the OIDC identity provider.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointRequestHeaders resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
a map of header key to header value that will be injected into the HTTP Request before being sent to the upstream application server
a list of header names that will be removed from the HTTP Request before being sent to the upstream application server
create a new EndpointRequestHeaders.
create a new EndpointRequestHeaders.
true if the module will be applied to traffic, false to disable. default true if unspecified
a map of header key to header value that will be injected into the HTTP Request before being sent to the upstream application server
a list of header names that will be removed from the HTTP Request before being sent to the upstream application server
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointRequestHeaders resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
a map of header key to header value that will be injected into the HTTP Request before being sent to the upstream application server
a list of header names that will be removed from the HTTP Request before being sent to the upstream application server
create a new EndpointRequestHeaders.
create a new EndpointRequestHeaders.
true if the module will be applied to traffic, false to disable. default true if unspecified
a map of header key to header value that will be injected into the HTTP Request before being sent to the upstream application server
a list of header names that will be removed from the HTTP Request before being sent to the upstream application server
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointResponseHeaders resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
a map of header key to header value that will be injected into the HTTP Response returned to the HTTP client
a list of header names that will be removed from the HTTP Response returned to the HTTP client
create a new EndpointResponseHeaders.
create a new EndpointResponseHeaders.
true if the module will be applied to traffic, false to disable. default true if unspecified
a map of header key to header value that will be injected into the HTTP Response returned to the HTTP client
a list of header names that will be removed from the HTTP Response returned to the HTTP client
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointResponseHeaders resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
a map of header key to header value that will be injected into the HTTP Response returned to the HTTP client
a list of header names that will be removed from the HTTP Response returned to the HTTP client
create a new EndpointResponseHeaders.
create a new EndpointResponseHeaders.
true if the module will be applied to traffic, false to disable. default true if unspecified
a map of header key to header value that will be injected into the HTTP Response returned to the HTTP client
a list of header names that will be removed from the HTTP Response returned to the HTTP client
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointSaml resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.
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.
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.
If present, only users who are a member of one of the listed groups may access the target endpoint.
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 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 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 configuration if it is supported.
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.
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.
create a new EndpointSaml.
create a new EndpointSaml.
true if the module will be applied to traffic, false to disable. default true if unspecified
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.
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.
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.
If present, only users who are a member of one of the listed groups may access the target endpoint.
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 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 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 configuration if it is supported.
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.
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.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointSaml resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.
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.
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.
If present, only users who are a member of one of the listed groups may access the target endpoint.
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 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 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 configuration if it is supported.
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.
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.
create a new EndpointSaml.
create a new EndpointSaml.
true if the module will be applied to traffic, false to disable. default true if unspecified
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.
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.
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.
If present, only users who are a member of one of the listed groups may access the target endpoint.
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 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 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 configuration if it is supported.
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.
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.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointSamlMutate resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.
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.
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.
If present, only users who are a member of one of the listed groups may access the target endpoint.
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.
create a new EndpointSamlMutate.
create a new EndpointSamlMutate.
true if the module will be applied to traffic, false to disable. default true if unspecified
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.
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.
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.
If present, only users who are a member of one of the listed groups may access the target endpoint.
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.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointSamlMutate resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.
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.
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.
If present, only users who are a member of one of the listed groups may access the target endpoint.
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.
create a new EndpointSamlMutate.
create a new EndpointSamlMutate.
true if the module will be applied to traffic, false to disable. default true if unspecified
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.
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.
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.
If present, only users who are a member of one of the listed groups may access the target endpoint.
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.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointTlsTermination resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
edge if the ngrok edge should terminate TLS traffic, upstream if TLS traffic should be passed through to the upstream ngrok agent / application server for termination. if upstream is chosen, most other modules will be disallowed because they rely on the ngrok edge being able to access the underlying traffic.
The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if terminate_at is set to upstream.
create a new EndpointTlsTermination.
create a new EndpointTlsTermination.
true if the module will be applied to traffic, false to disable. default true if unspecified
edge if the ngrok edge should terminate TLS traffic, upstream if TLS traffic should be passed through to the upstream ngrok agent / application server for termination. if upstream is chosen, most other modules will be disallowed because they rely on the ngrok edge being able to access the underlying traffic.
The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if terminate_at is set to upstream.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointTlsTermination resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
edge if the ngrok edge should terminate TLS traffic, upstream if TLS traffic should be passed through to the upstream ngrok agent / application server for termination. if upstream is chosen, most other modules will be disallowed because they rely on the ngrok edge being able to access the underlying traffic.
The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if terminate_at is set to upstream.
create a new EndpointTlsTermination.
create a new EndpointTlsTermination.
true if the module will be applied to traffic, false to disable. default true if unspecified
edge if the ngrok edge should terminate TLS traffic, upstream if TLS traffic should be passed through to the upstream ngrok agent / application server for termination. if upstream is chosen, most other modules will be disallowed because they rely on the ngrok edge being able to access the underlying traffic.
The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if terminate_at is set to upstream.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointTlsTerminationAtEdge resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if terminate_at is set to upstream.
create a new EndpointTlsTerminationAtEdge.
create a new EndpointTlsTerminationAtEdge.
true if the module will be applied to traffic, false to disable. default true if unspecified
The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if terminate_at is set to upstream.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointTlsTerminationAtEdge resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if terminate_at is set to upstream.
create a new EndpointTlsTerminationAtEdge.
create a new EndpointTlsTerminationAtEdge.
true if the module will be applied to traffic, false to disable. default true if unspecified
The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if terminate_at is set to upstream.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointWebhookValidation resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers: SLACK, SNS, STRIPE, GITHUB, TWILIO, SHOPIFY, GITLAB, INTERCOM, SENDGRID, XERO, PAGERDUTY.
a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret
create a new EndpointWebhookValidation.
create a new EndpointWebhookValidation.
true if the module will be applied to traffic, false to disable. default true if unspecified
a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers: SLACK, SNS, STRIPE, GITHUB, TWILIO, SHOPIFY, GITLAB, INTERCOM, SENDGRID, XERO, PAGERDUTY.
a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointWebhookValidation resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers: SLACK, SNS, STRIPE, GITHUB, TWILIO, SHOPIFY, GITLAB, INTERCOM, SENDGRID, XERO, PAGERDUTY.
a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret
create a new EndpointWebhookValidation.
create a new EndpointWebhookValidation.
true if the module will be applied to traffic, false to disable. default true if unspecified
a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers: SLACK, SNS, STRIPE, GITHUB, TWILIO, SHOPIFY, GITLAB, INTERCOM, SENDGRID, XERO, PAGERDUTY.
a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointWebsocketTcpConverter resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EndpointWebsocketTcpConverter resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EventDestination resource. -
Unique identifier for this Event Destination.
Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
Timestamp when the Event Destination was created, RFC 3339 format.
Human-readable description of the Event Destination. Optional, max 255 bytes.
The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
URI of the Event Destination API resource.
create a new EventDestination.
create a new EventDestination.
Unique identifier for this Event Destination.
Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
Timestamp when the Event Destination was created, RFC 3339 format.
Human-readable description of the Event Destination. Optional, max 255 bytes.
The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
URI of the Event Destination API resource.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EventDestination resource. +
Unique identifier for this Event Destination.
Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
Timestamp when the Event Destination was created, RFC 3339 format.
Human-readable description of the Event Destination. Optional, max 255 bytes.
The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
URI of the Event Destination API resource.
create a new EventDestination.
create a new EventDestination.
Unique identifier for this Event Destination.
Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
Timestamp when the Event Destination was created, RFC 3339 format.
Human-readable description of the Event Destination. Optional, max 255 bytes.
The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
URI of the Event Destination API resource.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EventDestinationList resource. -
The list of all Event Destinations on this account.
URI of the Event Destinations list API resource.
URI of the next page, or null if there is no next page.
create a new EventDestinationList.
create a new EventDestinationList.
The list of all Event Destinations on this account.
URI of the Event Destinations list API resource.
URI of the next page, or null if there is no next page.
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EventDestinationList resource. +
The list of all Event Destinations on this account.
URI of the Event Destinations list API resource.
URI of the next page, or null if there is no next page.
create a new EventDestinationList.
create a new EventDestinationList.
The list of all Event Destinations on this account.
URI of the Event Destinations list API resource.
URI of the next page, or null if there is no next page.
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EventSource resource. -
URI of the Event Source API resource.
create a new EventSource.
create a new EventSource.
URI of the Event Source API resource.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EventSource resource. +
URI of the Event Source API resource.
create a new EventSource.
create a new EventSource.
URI of the Event Source API resource.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EventSourceList resource. -
The list of all Event Sources for an Event Subscription
URI of the next page, or null if there is no next page.
create a new EventSourceList.
create a new EventSourceList.
The list of all Event Sources for an Event Subscription
URI of the next page, or null if there is no next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EventSourceList resource. +
The list of all Event Sources for an Event Subscription
URI of the next page, or null if there is no next page.
create a new EventSourceList.
create a new EventSourceList.
The list of all Event Sources for an Event Subscription
URI of the next page, or null if there is no next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EventSourceReplace resource. -
create a new EventSourceReplace.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EventSourceReplace resource. +
create a new EventSourceReplace.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EventSubscription resource. -
Unique identifier for this Event Subscription.
URI of the Event Subscription API resource.
When the Event Subscription was created (RFC 3339 format).
Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
Sources containing the types for which this event subscription will trigger
Destinations to which these events will be sent
create a new EventSubscription.
create a new EventSubscription.
Unique identifier for this Event Subscription.
URI of the Event Subscription API resource.
When the Event Subscription was created (RFC 3339 format).
Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
Sources containing the types for which this event subscription will trigger
Destinations to which these events will be sent
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EventSubscription resource. +
Unique identifier for this Event Subscription.
URI of the Event Subscription API resource.
When the Event Subscription was created (RFC 3339 format).
Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
Sources containing the types for which this event subscription will trigger
Destinations to which these events will be sent
create a new EventSubscription.
create a new EventSubscription.
Unique identifier for this Event Subscription.
URI of the Event Subscription API resource.
When the Event Subscription was created (RFC 3339 format).
Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
Sources containing the types for which this event subscription will trigger
Destinations to which these events will be sent
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EventSubscriptionList resource. -
The list of all Event Subscriptions on this account.
URI of the Event Subscriptions list API resource.
URI of next page, or null if there is no next page.
create a new EventSubscriptionList.
create a new EventSubscriptionList.
The list of all Event Subscriptions on this account.
URI of the Event Subscriptions list API resource.
URI of next page, or null if there is no next page.
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EventSubscriptionList resource. +
The list of all Event Subscriptions on this account.
URI of the Event Subscriptions list API resource.
URI of next page, or null if there is no next page.
create a new EventSubscriptionList.
create a new EventSubscriptionList.
The list of all Event Subscriptions on this account.
URI of the Event Subscriptions list API resource.
URI of next page, or null if there is no next page.
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EventTarget resource. -
Configuration used to send events to Amazon Kinesis Data Firehose.
Configuration used to send events to Amazon Kinesis.
Configuration used to send events to Amazon CloudWatch Logs.
create a new EventTarget.
create a new EventTarget.
Configuration used to send events to Amazon Kinesis Data Firehose.
Configuration used to send events to Amazon Kinesis.
Configuration used to send events to Amazon CloudWatch Logs.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EventTarget resource. +
Configuration used to send events to Amazon Kinesis Data Firehose.
Configuration used to send events to Amazon Kinesis.
Configuration used to send events to Amazon CloudWatch Logs.
create a new EventTarget.
create a new EventTarget.
Configuration used to send events to Amazon Kinesis Data Firehose.
Configuration used to send events to Amazon Kinesis.
Configuration used to send events to Amazon CloudWatch Logs.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EventTargetCloudwatchLogs resource. -
Configuration for how to authenticate into your AWS account. Exactly one of role or creds should be configured.
An Amazon Resource Name specifying the CloudWatch Logs group to deposit events into.
create a new EventTargetCloudwatchLogs.
create a new EventTargetCloudwatchLogs.
Configuration for how to authenticate into your AWS account. Exactly one of role or creds should be configured.
An Amazon Resource Name specifying the CloudWatch Logs group to deposit events into.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EventTargetCloudwatchLogs resource. +
Configuration for how to authenticate into your AWS account. Exactly one of role or creds should be configured.
An Amazon Resource Name specifying the CloudWatch Logs group to deposit events into.
create a new EventTargetCloudwatchLogs.
create a new EventTargetCloudwatchLogs.
Configuration for how to authenticate into your AWS account. Exactly one of role or creds should be configured.
An Amazon Resource Name specifying the CloudWatch Logs group to deposit events into.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EventTargetFirehose resource. -
Configuration for how to authenticate into your AWS account. Exactly one of role or creds should be configured.
An Amazon Resource Name specifying the Firehose delivery stream to deposit events into.
create a new EventTargetFirehose.
create a new EventTargetFirehose.
Configuration for how to authenticate into your AWS account. Exactly one of role or creds should be configured.
An Amazon Resource Name specifying the Firehose delivery stream to deposit events into.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EventTargetFirehose resource. +
Configuration for how to authenticate into your AWS account. Exactly one of role or creds should be configured.
An Amazon Resource Name specifying the Firehose delivery stream to deposit events into.
create a new EventTargetFirehose.
create a new EventTargetFirehose.
Configuration for how to authenticate into your AWS account. Exactly one of role or creds should be configured.
An Amazon Resource Name specifying the Firehose delivery stream to deposit events into.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EventTargetKinesis resource. -
Configuration for how to authenticate into your AWS account. Exactly one of role or creds should be configured.
An Amazon Resource Name specifying the Kinesis stream to deposit events into.
create a new EventTargetKinesis.
create a new EventTargetKinesis.
Configuration for how to authenticate into your AWS account. Exactly one of role or creds should be configured.
An Amazon Resource Name specifying the Kinesis stream to deposit events into.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the EventTargetKinesis resource. +
Configuration for how to authenticate into your AWS account. Exactly one of role or creds should be configured.
An Amazon Resource Name specifying the Kinesis stream to deposit events into.
create a new EventTargetKinesis.
create a new EventTargetKinesis.
Configuration for how to authenticate into your AWS account. Exactly one of role or creds should be configured.
An Amazon Resource Name specifying the Kinesis stream to deposit events into.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the FailoverBackend resource. -
unique identifier for this Failover backend
URI of the FailoverBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
the ids of the child backends in order
create a new FailoverBackend.
create a new FailoverBackend.
unique identifier for this Failover backend
URI of the FailoverBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
the ids of the child backends in order
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the FailoverBackend resource. +
unique identifier for this Failover backend
URI of the FailoverBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
the ids of the child backends in order
create a new FailoverBackend.
create a new FailoverBackend.
unique identifier for this Failover backend
URI of the FailoverBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
the ids of the child backends in order
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the FailoverBackendList resource. -
the list of all Failover backends on this account
URI of the Failover backends list API resource
URI of the next page, or null if there is no next page
create a new FailoverBackendList.
create a new FailoverBackendList.
the list of all Failover backends on this account
URI of the Failover backends list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the FailoverBackendList resource. +
the list of all Failover backends on this account
URI of the Failover backends list API resource
URI of the next page, or null if there is no next page
create a new FailoverBackendList.
create a new FailoverBackendList.
the list of all Failover backends on this account
URI of the Failover backends list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the HttpResponseBackend resource. -
the value of the id parameter as a scala.Predef.String
URI of the HTTPResponseBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
body to return as fixed content
headers to return
status code to return
create a new HttpResponseBackend.
create a new HttpResponseBackend.
the value of the id parameter as a scala.Predef.String
URI of the HTTPResponseBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
body to return as fixed content
headers to return
status code to return
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the HttpResponseBackend resource. +
the value of the id parameter as a scala.Predef.String
URI of the HTTPResponseBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
body to return as fixed content
headers to return
status code to return
create a new HttpResponseBackend.
create a new HttpResponseBackend.
the value of the id parameter as a scala.Predef.String
URI of the HTTPResponseBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
body to return as fixed content
headers to return
status code to return
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the HttpResponseBackendList resource. -
the value of the backends parameter as a scala.List of HttpResponseBackend
the value of the uri parameter as a java.net.URI
the value of the next_page_uri parameter as a java.net.URI
create a new HttpResponseBackendList.
create a new HttpResponseBackendList.
the value of the backends parameter as a scala.List of HttpResponseBackend
the value of the uri parameter as a java.net.URI
the value of the next_page_uri parameter as a java.net.URI
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the HttpResponseBackendList resource. +
the value of the backends parameter as a scala.List of HttpResponseBackend
the value of the uri parameter as a java.net.URI
the value of the next_page_uri parameter as a java.net.URI
create a new HttpResponseBackendList.
create a new HttpResponseBackendList.
the value of the backends parameter as a scala.List of HttpResponseBackend
the value of the uri parameter as a java.net.URI
the value of the next_page_uri parameter as a java.net.URI
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the HttpsEdge resource. -
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes.
timestamp when the edge configuration was created, RFC 3339 format
URI of the edge API resource
hostports served by this edge
edge modules
the value of the tls_termination parameter as a EndpointTlsTermination
routes
create a new HttpsEdge.
create a new HttpsEdge.
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes.
timestamp when the edge configuration was created, RFC 3339 format
URI of the edge API resource
hostports served by this edge
edge modules
the value of the tls_termination parameter as a EndpointTlsTermination
routes
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the HttpsEdge resource. +
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes.
timestamp when the edge configuration was created, RFC 3339 format
URI of the edge API resource
hostports served by this edge
edge modules
the value of the tls_termination parameter as a EndpointTlsTermination
routes
create a new HttpsEdge.
create a new HttpsEdge.
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes.
timestamp when the edge configuration was created, RFC 3339 format
URI of the edge API resource
hostports served by this edge
edge modules
the value of the tls_termination parameter as a EndpointTlsTermination
routes
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the HttpsEdgeList resource. -
the list of all HTTPS Edges on this account
URI of the HTTPS Edge list API resource
URI of the next page, or null if there is no next page
create a new HttpsEdgeList.
create a new HttpsEdgeList.
the list of all HTTPS Edges on this account
URI of the HTTPS Edge list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the HttpsEdgeList resource. +
the list of all HTTPS Edges on this account
URI of the HTTPS Edge list API resource
URI of the next page, or null if there is no next page
create a new HttpsEdgeList.
create a new HttpsEdgeList.
the list of all HTTPS Edges on this account
URI of the HTTPS Edge list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the HttpsEdgeRoute resource. -
unique identifier of this edge
unique identifier of this edge route
timestamp when the edge configuration was created, RFC 3339 format
Type of match to use for this route. Valid values are "exact_path" and "path_prefix".
URI of the edge API resource
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
backend module configuration or null
ip restriction module configuration or null
circuit breaker module configuration or null
compression module configuration or null
request headers module configuration or null
response headers module configuration or null
webhook verification module configuration or null
oauth module configuration or null
saml module configuration or null
oidc module configuration or null
websocket to tcp adapter configuration or null
create a new HttpsEdgeRoute.
create a new HttpsEdgeRoute.
unique identifier of this edge
unique identifier of this edge route
timestamp when the edge configuration was created, RFC 3339 format
Type of match to use for this route. Valid values are "exact_path" and "path_prefix".
URI of the edge API resource
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
backend module configuration or null
ip restriction module configuration or null
circuit breaker module configuration or null
compression module configuration or null
request headers module configuration or null
response headers module configuration or null
webhook verification module configuration or null
oauth module configuration or null
saml module configuration or null
oidc module configuration or null
websocket to tcp adapter configuration or null
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the HttpsEdgeRoute resource. +
unique identifier of this edge
unique identifier of this edge route
timestamp when the edge configuration was created, RFC 3339 format
Type of match to use for this route. Valid values are "exact_path" and "path_prefix".
URI of the edge API resource
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
backend module configuration or null
ip restriction module configuration or null
circuit breaker module configuration or null
compression module configuration or null
request headers module configuration or null
response headers module configuration or null
webhook verification module configuration or null
oauth module configuration or null
saml module configuration or null
oidc module configuration or null
websocket to tcp adapter configuration or null
create a new HttpsEdgeRoute.
create a new HttpsEdgeRoute.
unique identifier of this edge
unique identifier of this edge route
timestamp when the edge configuration was created, RFC 3339 format
Type of match to use for this route. Valid values are "exact_path" and "path_prefix".
URI of the edge API resource
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
backend module configuration or null
ip restriction module configuration or null
circuit breaker module configuration or null
compression module configuration or null
request headers module configuration or null
response headers module configuration or null
webhook verification module configuration or null
oauth module configuration or null
saml module configuration or null
oidc module configuration or null
websocket to tcp adapter configuration or null
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the IpPolicy resource. -
unique identifier for this IP policy
URI of the IP Policy API resource
timestamp when the IP policy was created, RFC 3339 format
human-readable description of the source IPs of this IP policy. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.
create a new IpPolicy.
create a new IpPolicy.
unique identifier for this IP policy
URI of the IP Policy API resource
timestamp when the IP policy was created, RFC 3339 format
human-readable description of the source IPs of this IP policy. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the IpPolicy resource. +
unique identifier for this IP policy
URI of the IP Policy API resource
timestamp when the IP policy was created, RFC 3339 format
human-readable description of the source IPs of this IP policy. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.
create a new IpPolicy.
create a new IpPolicy.
unique identifier for this IP policy
URI of the IP Policy API resource
timestamp when the IP policy was created, RFC 3339 format
human-readable description of the source IPs of this IP policy. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the IpPolicyList resource. -
the list of all IP policies on this account
URI of the IP policy list API resource
URI of the next page, or null if there is no next page
create a new IpPolicyList.
create a new IpPolicyList.
the list of all IP policies on this account
URI of the IP policy list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the IpPolicyList resource. +
the list of all IP policies on this account
URI of the IP policy list API resource
URI of the next page, or null if there is no next page
create a new IpPolicyList.
create a new IpPolicyList.
the list of all IP policies on this account
URI of the IP policy list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the IpPolicyRule resource. -
unique identifier for this IP policy rule
URI of the IP policy rule API resource
timestamp when the IP policy rule was created, RFC 3339 format
human-readable description of the source IPs of this IP rule. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.
an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
object describing the IP policy this IP Policy Rule belongs to
the action to apply to the policy rule, either allow or deny
create a new IpPolicyRule.
create a new IpPolicyRule.
unique identifier for this IP policy rule
URI of the IP policy rule API resource
timestamp when the IP policy rule was created, RFC 3339 format
human-readable description of the source IPs of this IP rule. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.
an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
object describing the IP policy this IP Policy Rule belongs to
the action to apply to the policy rule, either allow or deny
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the IpPolicyRule resource. +
unique identifier for this IP policy rule
URI of the IP policy rule API resource
timestamp when the IP policy rule was created, RFC 3339 format
human-readable description of the source IPs of this IP rule. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.
an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
object describing the IP policy this IP Policy Rule belongs to
the action to apply to the policy rule, either allow or deny
create a new IpPolicyRule.
create a new IpPolicyRule.
unique identifier for this IP policy rule
URI of the IP policy rule API resource
timestamp when the IP policy rule was created, RFC 3339 format
human-readable description of the source IPs of this IP rule. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.
an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
object describing the IP policy this IP Policy Rule belongs to
the action to apply to the policy rule, either allow or deny
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the IpPolicyRuleList resource. -
the list of all IP policy rules on this account
URI of the IP policy rule list API resource
URI of the next page, or null if there is no next page
create a new IpPolicyRuleList.
create a new IpPolicyRuleList.
the list of all IP policy rules on this account
URI of the IP policy rule list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the IpPolicyRuleList resource. +
the list of all IP policy rules on this account
URI of the IP policy rule list API resource
URI of the next page, or null if there is no next page
create a new IpPolicyRuleList.
create a new IpPolicyRuleList.
the list of all IP policy rules on this account
URI of the IP policy rule list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the IpRestriction resource. -
unique identifier for this IP restriction
URI of the IP restriction API resource
timestamp when the IP restriction was created, RFC 3339 format
human-readable description of this IP restriction. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
true if the IP restriction will be enforced. if false, only warnings will be issued
the set of IP policies that are used to enforce the restriction
create a new IpRestriction.
create a new IpRestriction.
unique identifier for this IP restriction
URI of the IP restriction API resource
timestamp when the IP restriction was created, RFC 3339 format
human-readable description of this IP restriction. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
true if the IP restriction will be enforced. if false, only warnings will be issued
the set of IP policies that are used to enforce the restriction
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the IpRestriction resource. +
unique identifier for this IP restriction
URI of the IP restriction API resource
timestamp when the IP restriction was created, RFC 3339 format
human-readable description of this IP restriction. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
true if the IP restriction will be enforced. if false, only warnings will be issued
the set of IP policies that are used to enforce the restriction
create a new IpRestriction.
create a new IpRestriction.
unique identifier for this IP restriction
URI of the IP restriction API resource
timestamp when the IP restriction was created, RFC 3339 format
human-readable description of this IP restriction. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
true if the IP restriction will be enforced. if false, only warnings will be issued
the set of IP policies that are used to enforce the restriction
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the IpRestrictionList resource. -
the list of all IP restrictions on this account
URI of the IP restrictions list API resource
URI of the next page, or null if there is no next page
create a new IpRestrictionList.
create a new IpRestrictionList.
the list of all IP restrictions on this account
URI of the IP restrictions list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the IpRestrictionList resource. +
the list of all IP restrictions on this account
URI of the IP restrictions list API resource
URI of the next page, or null if there is no next page
create a new IpRestrictionList.
create a new IpRestrictionList.
the list of all IP restrictions on this account
URI of the IP restrictions list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Creates a new ngrok API error.
Creates a new ngrok API error. -
HTTP status returned from the server
a new NgrokApiError
Creates a new ngrok API error.
Creates a new ngrok API error. -
HTTP status returned from the server
response body returned from server, if any
exception cause
a new NgrokApiError
Creates a new ngrok API error.
Creates a new ngrok API error. +
HTTP status returned from the server
a new NgrokApiError
Creates a new ngrok API error.
Creates a new ngrok API error. +
HTTP status returned from the server
response body returned from server, if any
exception cause
a new NgrokApiError
Representation of an API error from ngrok. -
descriptive error message.
HTTP status returned from the server
ngrok-specific error code, if any
key-value map of error details
exception cause, if any
creates a new ngrok API error.
creates a new ngrok API error.
descriptive error message.
HTTP status returned from the server
ngrok-specific error code, if any
key-value map of error details
exception cause, if any
Checks if this error object contains one of the provided codes.
Checks if this error object contains one of the provided codes. -
error codes to check
whether or not one of the codes matches what is in this error object
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Representation of an API error from ngrok. +
descriptive error message.
HTTP status returned from the server
ngrok-specific error code, if any
key-value map of error details
exception cause, if any
creates a new ngrok API error.
creates a new ngrok API error.
descriptive error message.
HTTP status returned from the server
ngrok-specific error code, if any
key-value map of error details
exception cause, if any
Checks if this error object contains one of the provided codes.
Checks if this error object contains one of the provided codes. +
error codes to check
whether or not one of the codes matches what is in this error object
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Wrapper class that holds a single page of a Pageable response. -
underlying page type
creates a new page.
creates a new page.
the API client used to fetch the page
the page itself
Fetches the next page of responses, if any.
Fetches the next page of responses, if any. -
an execution context
a future encapsulating a possible next page
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Wrapper class that holds a single page of a Pageable response. +
underlying page type
creates a new page.
creates a new page.
the API client used to fetch the page
the page itself
Fetches the next page of responses, if any.
Fetches the next page of responses, if any. +
an execution context
a future encapsulating a possible next page
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Trait indicating a resource type that can have more than one page of responses.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Trait indicating a resource type that can have more than one page of responses.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the Ref resource. -
a resource identifier
a uri for locating a resource
create a new Ref.
create a new Ref.
a resource identifier
a uri for locating a resource
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the Ref resource. +
a resource identifier
a uri for locating a resource
create a new Ref.
create a new Ref.
a resource identifier
a uri for locating a resource
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the ReservedAddr resource. -
unique reserved address resource identifier
URI of the reserved address API resource
timestamp when the reserved address was created, RFC 3339 format
human-readable description of what this reserved address will be used for
arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
hostname:port of the reserved address that was assigned at creation time
reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
create a new ReservedAddr.
create a new ReservedAddr.
unique reserved address resource identifier
URI of the reserved address API resource
timestamp when the reserved address was created, RFC 3339 format
human-readable description of what this reserved address will be used for
arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
hostname:port of the reserved address that was assigned at creation time
reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the ReservedAddr resource. +
unique reserved address resource identifier
URI of the reserved address API resource
timestamp when the reserved address was created, RFC 3339 format
human-readable description of what this reserved address will be used for
arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
hostname:port of the reserved address that was assigned at creation time
reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
create a new ReservedAddr.
create a new ReservedAddr.
unique reserved address resource identifier
URI of the reserved address API resource
timestamp when the reserved address was created, RFC 3339 format
human-readable description of what this reserved address will be used for
arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
hostname:port of the reserved address that was assigned at creation time
reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the ReservedAddrList resource. -
the list of all reserved addresses on this account
URI of the reserved address list API resource
URI of the next page, or null if there is no next page
create a new ReservedAddrList.
create a new ReservedAddrList.
the list of all reserved addresses on this account
URI of the reserved address list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the ReservedAddrList resource. +
the list of all reserved addresses on this account
URI of the reserved address list API resource
URI of the next page, or null if there is no next page
create a new ReservedAddrList.
create a new ReservedAddrList.
the list of all reserved addresses on this account
URI of the reserved address list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the ReservedDomain resource. -
unique reserved domain resource identifier
URI of the reserved domain API resource
timestamp when the reserved domain was created, RFC 3339 format
human-readable description of what this reserved domain will be used for
arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
hostname of the reserved domain
reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io
object referencing the TLS certificate used for connections to this domain. This can be either a user-uploaded certificate, the most recently issued automatic one, or null otherwise.
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
status of the automatic certificate management for this domain, or null if automatic management is disabled
DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.
create a new ReservedDomain.
create a new ReservedDomain.
unique reserved domain resource identifier
URI of the reserved domain API resource
timestamp when the reserved domain was created, RFC 3339 format
human-readable description of what this reserved domain will be used for
arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
hostname of the reserved domain
reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io
object referencing the TLS certificate used for connections to this domain. This can be either a user-uploaded certificate, the most recently issued automatic one, or null otherwise.
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
status of the automatic certificate management for this domain, or null if automatic management is disabled
DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the ReservedDomain resource. +
unique reserved domain resource identifier
URI of the reserved domain API resource
timestamp when the reserved domain was created, RFC 3339 format
human-readable description of what this reserved domain will be used for
arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
hostname of the reserved domain
reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io
object referencing the TLS certificate used for connections to this domain. This can be either a user-uploaded certificate, the most recently issued automatic one, or null otherwise.
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
status of the automatic certificate management for this domain, or null if automatic management is disabled
DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.
create a new ReservedDomain.
create a new ReservedDomain.
unique reserved domain resource identifier
URI of the reserved domain API resource
timestamp when the reserved domain was created, RFC 3339 format
human-readable description of what this reserved domain will be used for
arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
hostname of the reserved domain
reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io
object referencing the TLS certificate used for connections to this domain. This can be either a user-uploaded certificate, the most recently issued automatic one, or null otherwise.
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
status of the automatic certificate management for this domain, or null if automatic management is disabled
DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the ReservedDomainCertJob resource. -
if present, an error code indicating why provisioning is failing. It may be either a temporary condition (INTERNAL_ERROR), or a permanent one the user must correct (DNS_ERROR).
a message describing the current status or error
timestamp when the provisioning job started, RFC 3339 format
timestamp when the provisioning job will be retried
create a new ReservedDomainCertJob.
create a new ReservedDomainCertJob.
if present, an error code indicating why provisioning is failing. It may be either a temporary condition (INTERNAL_ERROR), or a permanent one the user must correct (DNS_ERROR).
a message describing the current status or error
timestamp when the provisioning job started, RFC 3339 format
timestamp when the provisioning job will be retried
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the ReservedDomainCertJob resource. +
if present, an error code indicating why provisioning is failing. It may be either a temporary condition (INTERNAL_ERROR), or a permanent one the user must correct (DNS_ERROR).
a message describing the current status or error
timestamp when the provisioning job started, RFC 3339 format
timestamp when the provisioning job will be retried
create a new ReservedDomainCertJob.
create a new ReservedDomainCertJob.
if present, an error code indicating why provisioning is failing. It may be either a temporary condition (INTERNAL_ERROR), or a permanent one the user must correct (DNS_ERROR).
a message describing the current status or error
timestamp when the provisioning job started, RFC 3339 format
timestamp when the provisioning job will be retried
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the ReservedDomainCertPolicy resource. -
certificate authority to request certificates from. The only supported value is letsencrypt.
type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.
create a new ReservedDomainCertPolicy.
create a new ReservedDomainCertPolicy.
certificate authority to request certificates from. The only supported value is letsencrypt.
type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the ReservedDomainCertPolicy resource. +
certificate authority to request certificates from. The only supported value is letsencrypt.
type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.
create a new ReservedDomainCertPolicy.
create a new ReservedDomainCertPolicy.
certificate authority to request certificates from. The only supported value is letsencrypt.
type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the ReservedDomainCertStatus resource. -
timestamp when the next renewal will be requested, RFC 3339 format
status of the certificate provisioning job, or null if the certificiate isn't being provisioned or renewed
create a new ReservedDomainCertStatus.
create a new ReservedDomainCertStatus.
timestamp when the next renewal will be requested, RFC 3339 format
status of the certificate provisioning job, or null if the certificiate isn't being provisioned or renewed
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the ReservedDomainCertStatus resource. +
timestamp when the next renewal will be requested, RFC 3339 format
status of the certificate provisioning job, or null if the certificiate isn't being provisioned or renewed
create a new ReservedDomainCertStatus.
create a new ReservedDomainCertStatus.
timestamp when the next renewal will be requested, RFC 3339 format
status of the certificate provisioning job, or null if the certificiate isn't being provisioned or renewed
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the ReservedDomainList resource. -
the list of all reserved domains on this account
URI of the reserved domain list API resource
URI of the next page, or null if there is no next page
create a new ReservedDomainList.
create a new ReservedDomainList.
the list of all reserved domains on this account
URI of the reserved domain list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the ReservedDomainList resource. +
the list of all reserved domains on this account
URI of the reserved domain list API resource
URI of the next page, or null if there is no next page
create a new ReservedDomainList.
create a new ReservedDomainList.
the list of all reserved domains on this account
URI of the reserved domain list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the SshCertificateAuthority resource. -
unique identifier for this SSH Certificate Authority
URI of the SSH Certificate Authority API resource
timestamp when the SSH Certificate Authority API resource was created, RFC 3339 format
human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
raw public key for this SSH Certificate Authority
the type of private key for this SSH Certificate Authority
create a new SshCertificateAuthority.
create a new SshCertificateAuthority.
unique identifier for this SSH Certificate Authority
URI of the SSH Certificate Authority API resource
timestamp when the SSH Certificate Authority API resource was created, RFC 3339 format
human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
raw public key for this SSH Certificate Authority
the type of private key for this SSH Certificate Authority
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the SshCertificateAuthority resource. +
unique identifier for this SSH Certificate Authority
URI of the SSH Certificate Authority API resource
timestamp when the SSH Certificate Authority API resource was created, RFC 3339 format
human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
raw public key for this SSH Certificate Authority
the type of private key for this SSH Certificate Authority
create a new SshCertificateAuthority.
create a new SshCertificateAuthority.
unique identifier for this SSH Certificate Authority
URI of the SSH Certificate Authority API resource
timestamp when the SSH Certificate Authority API resource was created, RFC 3339 format
human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
raw public key for this SSH Certificate Authority
the type of private key for this SSH Certificate Authority
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the SshCertificateAuthorityList resource. -
the list of all certificate authorities on this account
URI of the certificates authorities list API resource
URI of the next page, or null if there is no next page
create a new SshCertificateAuthorityList.
create a new SshCertificateAuthorityList.
the list of all certificate authorities on this account
URI of the certificates authorities list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
Fetches the URI of the next page. -
a URI
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the SshCertificateAuthorityList resource. +
the list of all certificate authorities on this account
URI of the certificates authorities list API resource
URI of the next page, or null if there is no next page
create a new SshCertificateAuthorityList.
create a new SshCertificateAuthorityList.
the list of all certificate authorities on this account
URI of the certificates authorities list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
Fetches the URI of the next page. +
a URI
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the SshCredential resource. -
unique ssh credential resource identifier
URI of the ssh credential API resource
timestamp when the ssh credential was created, RFC 3339 format
human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.
arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
the PEM-encoded public key of the SSH keypair that will be used to authenticate
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.
create a new SshCredential.
create a new SshCredential.
unique ssh credential resource identifier
URI of the ssh credential API resource
timestamp when the ssh credential was created, RFC 3339 format
human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.
arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
the PEM-encoded public key of the SSH keypair that will be used to authenticate
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.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the SshCredential resource. +
unique ssh credential resource identifier
URI of the ssh credential API resource
timestamp when the ssh credential was created, RFC 3339 format
human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.
arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
the PEM-encoded public key of the SSH keypair that will be used to authenticate
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.
create a new SshCredential.
create a new SshCredential.
unique ssh credential resource identifier
URI of the ssh credential API resource
timestamp when the ssh credential was created, RFC 3339 format
human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.
arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
the PEM-encoded public key of the SSH keypair that will be used to authenticate
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.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the SshCredentialList resource. -
the list of all ssh credentials on this account
URI of the ssh credential list API resource
URI of the next page, or null if there is no next page
create a new SshCredentialList.
create a new SshCredentialList.
the list of all ssh credentials on this account
URI of the ssh credential list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the SshCredentialList resource. +
the list of all ssh credentials on this account
URI of the ssh credential list API resource
URI of the next page, or null if there is no next page
create a new SshCredentialList.
create a new SshCredentialList.
the list of all ssh credentials on this account
URI of the ssh credential list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the SshHostCertificate resource. -
unique identifier for this SSH Host Certificate
URI of the SSH Host Certificate API resource
timestamp when the SSH Host Certificate API resource was created, RFC 3339 format
human-readable description of this SSH Host Certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.
a public key in OpenSSH Authorized Keys format that this certificate signs
the key type of the public_key, one of rsa, ecdsa or ed25519
the ssh certificate authority that is used to sign this ssh host certificate
the list of principals included in the ssh host certificate. This is the list of hostnames and/or IP addresses that are authorized to serve SSH traffic with this certificate. Dangerously, if no principals are specified, this certificate is considered valid for all hosts.
the time when the ssh host certificate becomes valid, in RFC 3339 format.
the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
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
create a new SshHostCertificate.
create a new SshHostCertificate.
unique identifier for this SSH Host Certificate
URI of the SSH Host Certificate API resource
timestamp when the SSH Host Certificate API resource was created, RFC 3339 format
human-readable description of this SSH Host Certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.
a public key in OpenSSH Authorized Keys format that this certificate signs
the key type of the public_key, one of rsa, ecdsa or ed25519
the ssh certificate authority that is used to sign this ssh host certificate
the list of principals included in the ssh host certificate. This is the list of hostnames and/or IP addresses that are authorized to serve SSH traffic with this certificate. Dangerously, if no principals are specified, this certificate is considered valid for all hosts.
the time when the ssh host certificate becomes valid, in RFC 3339 format.
the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
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
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the SshHostCertificate resource. +
unique identifier for this SSH Host Certificate
URI of the SSH Host Certificate API resource
timestamp when the SSH Host Certificate API resource was created, RFC 3339 format
human-readable description of this SSH Host Certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.
a public key in OpenSSH Authorized Keys format that this certificate signs
the key type of the public_key, one of rsa, ecdsa or ed25519
the ssh certificate authority that is used to sign this ssh host certificate
the list of principals included in the ssh host certificate. This is the list of hostnames and/or IP addresses that are authorized to serve SSH traffic with this certificate. Dangerously, if no principals are specified, this certificate is considered valid for all hosts.
the time when the ssh host certificate becomes valid, in RFC 3339 format.
the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
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
create a new SshHostCertificate.
create a new SshHostCertificate.
unique identifier for this SSH Host Certificate
URI of the SSH Host Certificate API resource
timestamp when the SSH Host Certificate API resource was created, RFC 3339 format
human-readable description of this SSH Host Certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.
a public key in OpenSSH Authorized Keys format that this certificate signs
the key type of the public_key, one of rsa, ecdsa or ed25519
the ssh certificate authority that is used to sign this ssh host certificate
the list of principals included in the ssh host certificate. This is the list of hostnames and/or IP addresses that are authorized to serve SSH traffic with this certificate. Dangerously, if no principals are specified, this certificate is considered valid for all hosts.
the time when the ssh host certificate becomes valid, in RFC 3339 format.
the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
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
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the SshHostCertificateList resource. -
the list of all ssh host certificates on this account
URI of the ssh host certificates list API resource
URI of the next page, or null if there is no next page
create a new SshHostCertificateList.
create a new SshHostCertificateList.
the list of all ssh host certificates on this account
URI of the ssh host certificates list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the SshHostCertificateList resource. +
the list of all ssh host certificates on this account
URI of the ssh host certificates list API resource
URI of the next page, or null if there is no next page
create a new SshHostCertificateList.
create a new SshHostCertificateList.
the list of all ssh host certificates on this account
URI of the ssh host certificates list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the SshUserCertificate resource. -
unique identifier for this SSH User Certificate
URI of the SSH User Certificate API resource
timestamp when the SSH User Certificate API resource was created, RFC 3339 format
human-readable description of this SSH User Certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
a public key in OpenSSH Authorized Keys format that this certificate signs
the key type of the public_key, one of rsa, ecdsa or ed25519
the ssh certificate authority that is used to sign this ssh user certificate
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.
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.
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.
the time when the ssh host certificate becomes valid, in RFC 3339 format.
the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
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
create a new SshUserCertificate.
create a new SshUserCertificate.
unique identifier for this SSH User Certificate
URI of the SSH User Certificate API resource
timestamp when the SSH User Certificate API resource was created, RFC 3339 format
human-readable description of this SSH User Certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
a public key in OpenSSH Authorized Keys format that this certificate signs
the key type of the public_key, one of rsa, ecdsa or ed25519
the ssh certificate authority that is used to sign this ssh user certificate
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.
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.
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.
the time when the ssh host certificate becomes valid, in RFC 3339 format.
the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
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
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the SshUserCertificate resource. +
unique identifier for this SSH User Certificate
URI of the SSH User Certificate API resource
timestamp when the SSH User Certificate API resource was created, RFC 3339 format
human-readable description of this SSH User Certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
a public key in OpenSSH Authorized Keys format that this certificate signs
the key type of the public_key, one of rsa, ecdsa or ed25519
the ssh certificate authority that is used to sign this ssh user certificate
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.
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.
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.
the time when the ssh host certificate becomes valid, in RFC 3339 format.
the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
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
create a new SshUserCertificate.
create a new SshUserCertificate.
unique identifier for this SSH User Certificate
URI of the SSH User Certificate API resource
timestamp when the SSH User Certificate API resource was created, RFC 3339 format
human-readable description of this SSH User Certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
a public key in OpenSSH Authorized Keys format that this certificate signs
the key type of the public_key, one of rsa, ecdsa or ed25519
the ssh certificate authority that is used to sign this ssh user certificate
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.
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.
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.
the time when the ssh host certificate becomes valid, in RFC 3339 format.
the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
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
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the SshUserCertificateList resource. -
the list of all ssh user certificates on this account
URI of the ssh user certificates list API resource
URI of the next page, or null if there is no next page
create a new SshUserCertificateList.
create a new SshUserCertificateList.
the list of all ssh user certificates on this account
URI of the ssh user certificates list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the SshUserCertificateList resource. +
the list of all ssh user certificates on this account
URI of the ssh user certificates list API resource
URI of the next page, or null if there is no next page
create a new SshUserCertificateList.
create a new SshUserCertificateList.
the list of all ssh user certificates on this account
URI of the ssh user certificates list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TcpEdge resource. -
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
timestamp when the edge was created, RFC 3339 format
URI of the edge API resource
hostports served by this edge
edge modules
the value of the ip_restriction parameter as a EndpointIpPolicy
create a new TcpEdge.
create a new TcpEdge.
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
timestamp when the edge was created, RFC 3339 format
URI of the edge API resource
hostports served by this edge
edge modules
the value of the ip_restriction parameter as a EndpointIpPolicy
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TcpEdge resource. +
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
timestamp when the edge was created, RFC 3339 format
URI of the edge API resource
hostports served by this edge
edge modules
the value of the ip_restriction parameter as a EndpointIpPolicy
create a new TcpEdge.
create a new TcpEdge.
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
timestamp when the edge was created, RFC 3339 format
URI of the edge API resource
hostports served by this edge
edge modules
the value of the ip_restriction parameter as a EndpointIpPolicy
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TcpEdgeList resource. -
the list of all TCP Edges on this account
URI of the TCP Edge list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TcpEdgeList resource. +
the list of all TCP Edges on this account
URI of the TCP Edge list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TlsCertificate resource. -
unique identifier for this TLS certificate
URI of the TLS certificate API resource
timestamp when the TLS certificate was created, RFC 3339 format
human-readable description of this TLS certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.
chain of PEM-encoded certificates, leaf first. See Certificate Bundles.
subject common name from the leaf of this TLS certificate
subject alternative names (SANs) from the leaf of this TLS certificate
timestamp (in RFC 3339 format) when this TLS certificate was issued automatically, or null if this certificate was user-uploaded
timestamp when this TLS certificate becomes valid, RFC 3339 format
timestamp when this TLS certificate becomes invalid, RFC 3339 format
set of actions the private key of this TLS certificate can be used for
extended set of actions the private key of this TLS certificate can be used for
type of the private key of this TLS certificate. One of rsa, ecdsa, or ed25519.
issuer common name from the leaf of this TLS certificate
serial number of the leaf of this TLS certificate
subject organization from the leaf of this TLS certificate
subject organizational unit from the leaf of this TLS certificate
subject locality from the leaf of this TLS certificate
subject province from the leaf of this TLS certificate
subject country from the leaf of this TLS certificate
create a new TlsCertificate.
create a new TlsCertificate.
unique identifier for this TLS certificate
URI of the TLS certificate API resource
timestamp when the TLS certificate was created, RFC 3339 format
human-readable description of this TLS certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.
chain of PEM-encoded certificates, leaf first. See Certificate Bundles.
subject common name from the leaf of this TLS certificate
subject alternative names (SANs) from the leaf of this TLS certificate
timestamp (in RFC 3339 format) when this TLS certificate was issued automatically, or null if this certificate was user-uploaded
timestamp when this TLS certificate becomes valid, RFC 3339 format
timestamp when this TLS certificate becomes invalid, RFC 3339 format
set of actions the private key of this TLS certificate can be used for
extended set of actions the private key of this TLS certificate can be used for
type of the private key of this TLS certificate. One of rsa, ecdsa, or ed25519.
issuer common name from the leaf of this TLS certificate
serial number of the leaf of this TLS certificate
subject organization from the leaf of this TLS certificate
subject organizational unit from the leaf of this TLS certificate
subject locality from the leaf of this TLS certificate
subject province from the leaf of this TLS certificate
subject country from the leaf of this TLS certificate
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TlsCertificate resource. +
unique identifier for this TLS certificate
URI of the TLS certificate API resource
timestamp when the TLS certificate was created, RFC 3339 format
human-readable description of this TLS certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.
chain of PEM-encoded certificates, leaf first. See Certificate Bundles.
subject common name from the leaf of this TLS certificate
subject alternative names (SANs) from the leaf of this TLS certificate
timestamp (in RFC 3339 format) when this TLS certificate was issued automatically, or null if this certificate was user-uploaded
timestamp when this TLS certificate becomes valid, RFC 3339 format
timestamp when this TLS certificate becomes invalid, RFC 3339 format
set of actions the private key of this TLS certificate can be used for
extended set of actions the private key of this TLS certificate can be used for
type of the private key of this TLS certificate. One of rsa, ecdsa, or ed25519.
issuer common name from the leaf of this TLS certificate
serial number of the leaf of this TLS certificate
subject organization from the leaf of this TLS certificate
subject organizational unit from the leaf of this TLS certificate
subject locality from the leaf of this TLS certificate
subject province from the leaf of this TLS certificate
subject country from the leaf of this TLS certificate
create a new TlsCertificate.
create a new TlsCertificate.
unique identifier for this TLS certificate
URI of the TLS certificate API resource
timestamp when the TLS certificate was created, RFC 3339 format
human-readable description of this TLS certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.
chain of PEM-encoded certificates, leaf first. See Certificate Bundles.
subject common name from the leaf of this TLS certificate
subject alternative names (SANs) from the leaf of this TLS certificate
timestamp (in RFC 3339 format) when this TLS certificate was issued automatically, or null if this certificate was user-uploaded
timestamp when this TLS certificate becomes valid, RFC 3339 format
timestamp when this TLS certificate becomes invalid, RFC 3339 format
set of actions the private key of this TLS certificate can be used for
extended set of actions the private key of this TLS certificate can be used for
type of the private key of this TLS certificate. One of rsa, ecdsa, or ed25519.
issuer common name from the leaf of this TLS certificate
serial number of the leaf of this TLS certificate
subject organization from the leaf of this TLS certificate
subject organizational unit from the leaf of this TLS certificate
subject locality from the leaf of this TLS certificate
subject province from the leaf of this TLS certificate
subject country from the leaf of this TLS certificate
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TlsCertificateList resource. -
the list of all TLS certificates on this account
URI of the TLS certificates list API resource
URI of the next page, or null if there is no next page
create a new TlsCertificateList.
create a new TlsCertificateList.
the list of all TLS certificates on this account
URI of the TLS certificates list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TlsCertificateList resource. +
the list of all TLS certificates on this account
URI of the TLS certificates list API resource
URI of the next page, or null if there is no next page
create a new TlsCertificateList.
create a new TlsCertificateList.
the list of all TLS certificates on this account
URI of the TLS certificates list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TlsCertificateSaNs resource. -
set of additional domains (including wildcards) this TLS certificate is valid for
set of IP addresses this TLS certificate is also valid for
create a new TlsCertificateSaNs.
create a new TlsCertificateSaNs.
set of additional domains (including wildcards) this TLS certificate is valid for
set of IP addresses this TLS certificate is also valid for
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TlsCertificateSaNs resource. +
set of additional domains (including wildcards) this TLS certificate is valid for
set of IP addresses this TLS certificate is also valid for
create a new TlsCertificateSaNs.
create a new TlsCertificateSaNs.
set of additional domains (including wildcards) this TLS certificate is valid for
set of IP addresses this TLS certificate is also valid for
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TlsEdge resource. -
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
timestamp when the edge configuration was created, RFC 3339 format
URI of the edge API resource
hostports served by this edge
edge modules
the value of the ip_restriction parameter as a EndpointIpPolicy
the value of the mutual_tls parameter as a EndpointMutualTls
the value of the tls_termination parameter as a EndpointTlsTermination
create a new TlsEdge.
create a new TlsEdge.
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
timestamp when the edge configuration was created, RFC 3339 format
URI of the edge API resource
hostports served by this edge
edge modules
the value of the ip_restriction parameter as a EndpointIpPolicy
the value of the mutual_tls parameter as a EndpointMutualTls
the value of the tls_termination parameter as a EndpointTlsTermination
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TlsEdge resource. +
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
timestamp when the edge configuration was created, RFC 3339 format
URI of the edge API resource
hostports served by this edge
edge modules
the value of the ip_restriction parameter as a EndpointIpPolicy
the value of the mutual_tls parameter as a EndpointMutualTls
the value of the tls_termination parameter as a EndpointTlsTermination
create a new TlsEdge.
create a new TlsEdge.
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
timestamp when the edge configuration was created, RFC 3339 format
URI of the edge API resource
hostports served by this edge
edge modules
the value of the ip_restriction parameter as a EndpointIpPolicy
the value of the mutual_tls parameter as a EndpointMutualTls
the value of the tls_termination parameter as a EndpointTlsTermination
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TlsEdgeList resource. -
the list of all TLS Edges on this account
URI of the TLS Edge list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TlsEdgeList resource. +
the list of all TLS Edges on this account
URI of the TLS Edge list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the Tunnel resource. -
unique tunnel resource identifier
URL of the ephemeral tunnel's public endpoint
timestamp when the tunnel was initiated in RFC 3339 format
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.
tunnel protocol for ephemeral tunnels. one of http, https, tcp or tls
identifier of tune region where the tunnel is running
reference object pointing to the tunnel session on which this tunnel was started
the ephemeral endpoint this tunnel is associated with, if this is an agent-initiated tunnel
the labels the tunnel group backends will match against, if this is a backend tunnel
tunnel group backends served by this backend tunnel
upstream address the ngrok agent forwards traffic over this tunnel to. this may be expressed as a URL or a network address.
create a new Tunnel.
create a new Tunnel.
unique tunnel resource identifier
URL of the ephemeral tunnel's public endpoint
timestamp when the tunnel was initiated in RFC 3339 format
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.
tunnel protocol for ephemeral tunnels. one of http, https, tcp or tls
identifier of tune region where the tunnel is running
reference object pointing to the tunnel session on which this tunnel was started
the ephemeral endpoint this tunnel is associated with, if this is an agent-initiated tunnel
the labels the tunnel group backends will match against, if this is a backend tunnel
tunnel group backends served by this backend tunnel
upstream address the ngrok agent forwards traffic over this tunnel to. this may be expressed as a URL or a network address.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the Tunnel resource. +
unique tunnel resource identifier
URL of the ephemeral tunnel's public endpoint
timestamp when the tunnel was initiated in RFC 3339 format
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.
tunnel protocol for ephemeral tunnels. one of http, https, tcp or tls
identifier of tune region where the tunnel is running
reference object pointing to the tunnel session on which this tunnel was started
the ephemeral endpoint this tunnel is associated with, if this is an agent-initiated tunnel
the labels the tunnel group backends will match against, if this is a backend tunnel
tunnel group backends served by this backend tunnel
upstream address the ngrok agent forwards traffic over this tunnel to. this may be expressed as a URL or a network address.
create a new Tunnel.
create a new Tunnel.
unique tunnel resource identifier
URL of the ephemeral tunnel's public endpoint
timestamp when the tunnel was initiated in RFC 3339 format
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.
tunnel protocol for ephemeral tunnels. one of http, https, tcp or tls
identifier of tune region where the tunnel is running
reference object pointing to the tunnel session on which this tunnel was started
the ephemeral endpoint this tunnel is associated with, if this is an agent-initiated tunnel
the labels the tunnel group backends will match against, if this is a backend tunnel
tunnel group backends served by this backend tunnel
upstream address the ngrok agent forwards traffic over this tunnel to. this may be expressed as a URL or a network address.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TunnelGroupBackend resource. -
unique identifier for this TunnelGroup backend
URI of the TunnelGroupBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
labels to watch for tunnels on, e.g. app->foo, dc->bar
tunnels matching this backend
create a new TunnelGroupBackend.
create a new TunnelGroupBackend.
unique identifier for this TunnelGroup backend
URI of the TunnelGroupBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
labels to watch for tunnels on, e.g. app->foo, dc->bar
tunnels matching this backend
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TunnelGroupBackend resource. +
unique identifier for this TunnelGroup backend
URI of the TunnelGroupBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
labels to watch for tunnels on, e.g. app->foo, dc->bar
tunnels matching this backend
create a new TunnelGroupBackend.
create a new TunnelGroupBackend.
unique identifier for this TunnelGroup backend
URI of the TunnelGroupBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
labels to watch for tunnels on, e.g. app->foo, dc->bar
tunnels matching this backend
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TunnelGroupBackendList resource. -
the list of all TunnelGroup backends on this account
URI of the TunnelGroup backends list API resource
URI of the next page, or null if there is no next page
create a new TunnelGroupBackendList.
create a new TunnelGroupBackendList.
the list of all TunnelGroup backends on this account
URI of the TunnelGroup backends list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TunnelGroupBackendList resource. +
the list of all TunnelGroup backends on this account
URI of the TunnelGroup backends list API resource
URI of the next page, or null if there is no next page
create a new TunnelGroupBackendList.
create a new TunnelGroupBackendList.
the list of all TunnelGroup backends on this account
URI of the TunnelGroup backends list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TunnelList resource. -
the list of all online tunnels on this account
URI of the tunnels list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TunnelList resource. +
the list of all online tunnels on this account
URI of the tunnels list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TunnelSession resource. -
version of the ngrok agent that started this ngrok tunnel session
reference to the tunnel credential or ssh credential used by the ngrok agent to start this tunnel session
unique tunnel session resource identifier
source ip address of the tunnel session
arbitrary user-defined data specified in the metadata property in the ngrok configuration file. See the metadata configuration option
operating system of the host the ngrok agent is running on
the ngrok region identifier in which this tunnel session was started
time when the tunnel session first connected to the ngrok servers
the transport protocol used to start the tunnel session. Either ngrok/v2 or ssh
URI to the API resource of the tunnel session
create a new TunnelSession.
create a new TunnelSession.
version of the ngrok agent that started this ngrok tunnel session
reference to the tunnel credential or ssh credential used by the ngrok agent to start this tunnel session
unique tunnel session resource identifier
source ip address of the tunnel session
arbitrary user-defined data specified in the metadata property in the ngrok configuration file. See the metadata configuration option
operating system of the host the ngrok agent is running on
the ngrok region identifier in which this tunnel session was started
time when the tunnel session first connected to the ngrok servers
the transport protocol used to start the tunnel session. Either ngrok/v2 or ssh
URI to the API resource of the tunnel session
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TunnelSession resource. +
version of the ngrok agent that started this ngrok tunnel session
reference to the tunnel credential or ssh credential used by the ngrok agent to start this tunnel session
unique tunnel session resource identifier
source ip address of the tunnel session
arbitrary user-defined data specified in the metadata property in the ngrok configuration file. See the metadata configuration option
operating system of the host the ngrok agent is running on
the ngrok region identifier in which this tunnel session was started
time when the tunnel session first connected to the ngrok servers
the transport protocol used to start the tunnel session. Either ngrok/v2 or ssh
URI to the API resource of the tunnel session
create a new TunnelSession.
create a new TunnelSession.
version of the ngrok agent that started this ngrok tunnel session
reference to the tunnel credential or ssh credential used by the ngrok agent to start this tunnel session
unique tunnel session resource identifier
source ip address of the tunnel session
arbitrary user-defined data specified in the metadata property in the ngrok configuration file. See the metadata configuration option
operating system of the host the ngrok agent is running on
the ngrok region identifier in which this tunnel session was started
time when the tunnel session first connected to the ngrok servers
the transport protocol used to start the tunnel session. Either ngrok/v2 or ssh
URI to the API resource of the tunnel session
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TunnelSessionList resource. -
list of all tunnel sessions on this account
URI to the API resource of the tunnel session list
URI of the next page, or null if there is no next page
create a new TunnelSessionList.
create a new TunnelSessionList.
list of all tunnel sessions on this account
URI to the API resource of the tunnel session list
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the TunnelSessionList resource. +
list of all tunnel sessions on this account
URI to the API resource of the tunnel session list
URI of the next page, or null if there is no next page
create a new TunnelSessionList.
create a new TunnelSessionList.
list of all tunnel sessions on this account
URI to the API resource of the tunnel session list
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the WeightedBackend resource. -
unique identifier for this Weighted backend
URI of the WeightedBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
the ids of the child backends to their weights [0-10000]
create a new WeightedBackend.
create a new WeightedBackend.
unique identifier for this Weighted backend
URI of the WeightedBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
the ids of the child backends to their weights [0-10000]
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the WeightedBackend resource. +
unique identifier for this Weighted backend
URI of the WeightedBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
the ids of the child backends to their weights [0-10000]
create a new WeightedBackend.
create a new WeightedBackend.
unique identifier for this Weighted backend
URI of the WeightedBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
the ids of the child backends to their weights [0-10000]
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the WeightedBackendList resource. -
the list of all Weighted backends on this account
URI of the Weighted backends list API resource
URI of the next page, or null if there is no next page
create a new WeightedBackendList.
create a new WeightedBackendList.
the list of all Weighted backends on this account
URI of the Weighted backends list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the WeightedBackendList resource. +
the list of all Weighted backends on this account
URI of the Weighted backends list API resource
URI of the next page, or null if there is no next page
create a new WeightedBackendList.
create a new WeightedBackendList.
the list of all Weighted backends on this account
URI of the Weighted backends list API resource
URI of the next page, or null if there is no next page
Fetches the URI of the next page.
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A class encapsulating the AbuseReport resource.
A class encapsulating the AbuseReport resource. -
ID of the abuse report
URI of the abuse report API resource
timestamp that the abuse report record was created in RFC 3339 format
a list of URLs containing suspected abusive content
arbitrary user-defined data about this abuse report. Optional, max 4096 bytes.
Indicates whether ngrok has processed the abuse report. one of PENDING, PROCESSED, or PARTIALLY_PROCESSED
an array of hostname statuses related to the report
A class encapsulating the AbuseReportHostname resource.
A class encapsulating the AbuseReportHostname resource. -
the hostname ngrok has parsed out of one of the reported URLs in this abuse report
indicates what action ngrok has taken against the hostname. one of PENDING, BANNED, UNBANNED, or IGNORE
A class encapsulating the AgentIngress resource.
A class encapsulating the AgentIngress resource. -
unique Agent Ingress resource identifier
URI to the API resource of this Agent ingress
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
the domain that you own to be used as the base domain name to generate regional agent ingress domains.
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
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
timestamp when the Agent Ingress was created, RFC 3339 format
A class encapsulating the AgentIngressList resource.
A class encapsulating the AgentIngressList resource. -
the list of Agent Ingresses owned by this account
URI of the Agent Ingress list API resource
URI of the next page, or null if there is no next page
A class encapsulating the ApiKey resource.
A class encapsulating the ApiKey resource. -
unique API key resource identifier
URI to the API resource of this API key
human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
arbitrary user-defined data of this API key. optional, max 4096 bytes
timestamp when the api key was created, RFC 3339 format
the bearer token that can be placed into the Authorization header to authenticate request to the ngrok API. This value is only available one time, on the API response from key creation. Otherwise it is null.
A class encapsulating the ApiKeyList resource.
A class encapsulating the ApiKeyList resource. -
the list of API keys for this account
URI of the API keys list API resource
URI of the next page, or null if there is no next page
A class encapsulating the AwsAuth resource.
A class encapsulating the AwsAuth resource. -
A role for ngrok to assume on your behalf to deposit events into your AWS account.
Credentials to your AWS account if you prefer ngrok to sign in with long-term access keys.
A class encapsulating the AwsCredentials resource.
A class encapsulating the AwsCredentials resource. -
The ID portion of an AWS access key.
The secret portion of an AWS access key.
A class encapsulating the AwsRole resource.
A class encapsulating the AwsRole resource. -
An ARN that specifies the role that ngrok should use to deliver to the configured target.
A class encapsulating the CertificateAuthority resource.
A class encapsulating the CertificateAuthority resource. -
unique identifier for this Certificate Authority
URI of the Certificate Authority API resource
timestamp when the Certificate Authority was created, RFC 3339 format
human-readable description of this Certificate Authority. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.
raw PEM of the Certificate Authority
subject common name of the Certificate Authority
timestamp when this Certificate Authority becomes valid, RFC 3339 format
timestamp when this Certificate Authority becomes invalid, RFC 3339 format
set of actions the private key of this Certificate Authority can be used for
extended set of actions the private key of this Certificate Authority can be used for
A class encapsulating the CertificateAuthorityList resource.
A class encapsulating the CertificateAuthorityList resource. -
the list of all certificate authorities on this account
URI of the certificates authorities list API resource
URI of the next page, or null if there is no next page
A class encapsulating the Credential resource.
A class encapsulating the Credential resource. -
unique tunnel credential resource identifier
URI of the tunnel credential API resource
timestamp when the tunnel credential was created, RFC 3339 format
human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
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.
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.
A class encapsulating the CredentialList resource.
A class encapsulating the CredentialList resource. -
the list of all tunnel credentials on this account
URI of the tunnel credential list API resource
URI of the next page, or null if there is no next page
A class encapsulating the Endpoint resource.
A class encapsulating the Endpoint resource. -
unique endpoint resource identifier
identifier of the region this endpoint belongs to
timestamp when the endpoint was created in RFC 3339 format
timestamp when the endpoint was updated in RFC 3339 format
URL of the hostport served by this endpoint
protocol served by this endpoint. one of http, https, tcp, or tls
hostport served by this endpoint (hostname:port)
user-supplied metadata of the associated tunnel or edge object
the domain reserved for this endpoint
the address reserved for this endpoint
the tunnel serving requests to this endpoint, if this is an ephemeral endpoint
the edge serving requests to this endpoint, if this is an edge endpoint
A class encapsulating the EndpointBackend resource.
A class encapsulating the EndpointBackend resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
backend to be used to back this endpoint
A class encapsulating the EndpointBackendMutate resource.
A class encapsulating the EndpointBackendMutate resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
backend to be used to back this endpoint
A class encapsulating the EndpointCircuitBreaker resource.
A class encapsulating the EndpointCircuitBreaker resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health
Integer number of seconds in the statistical rolling window that metrics are retained for.
Integer number of buckets into which metrics are retained. Max 128.
Integer number of requests in a rolling window that will trip the circuit. Helpful if traffic volume is low.
Error threshold percentage should be between 0 - 1.0, not 0-100.0
A class encapsulating the EndpointCompression resource.
A class encapsulating the EndpointCompression resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
A class encapsulating the EndpointIpPolicy resource.
A class encapsulating the EndpointIpPolicy resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
the value of the ip_policies parameter as a scala.List of Ref
A class encapsulating the EndpointIpPolicyMutate resource.
A class encapsulating the EndpointIpPolicyMutate resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
list of all IP policies that will be used to check if a source IP is allowed access to the endpoint
A class encapsulating the EndpointList resource.
A class encapsulating the EndpointList resource. -
the list of all active endpoints on this account
URI of the endpoints list API resource
URI of the next page, or null if there is no next page
A class encapsulating the EndpointMutualTls resource.
A class encapsulating the EndpointMutualTls resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
PEM-encoded CA certificates that will be used to validate. Multiple CAs may be provided by concatenating them together.
A class encapsulating the EndpointMutualTlsMutate resource.
A class encapsulating the EndpointMutualTlsMutate resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
list of certificate authorities that will be used to validate the TLS client certificate presented by the initiator of the TLS connection
A class encapsulating the EndpointOAuth resource.
A class encapsulating the EndpointOAuth resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
an object which defines the identity provider to use for authentication and configuration for who may access the endpoint
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
Integer number of seconds after which ngrok guarantees it will refresh user state from the identity provider and recheck whether the user is still authorized to access the endpoint. This is the preferred tunable to use to enforce a minimum amount of time after which a revoked user will no longer be able to access the resource.
A class encapsulating the EndpointOAuthFacebook resource.
A class encapsulating the EndpointOAuthFacebook resource. -
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
A class encapsulating the EndpointOAuthGitHub resource.
A class encapsulating the EndpointOAuthGitHub resource. -
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
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
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'
A class encapsulating the EndpointOAuthGoogle resource.
A class encapsulating the EndpointOAuthGoogle resource. -
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
A class encapsulating the EndpointOAuthMicrosoft resource.
A class encapsulating the EndpointOAuthMicrosoft resource. -
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
A class encapsulating the EndpointOAuthProvider resource.
A class encapsulating the EndpointOAuthProvider resource. -
configuration for using github as the identity provider
configuration for using facebook as the identity provider
configuration for using microsoft as the identity provider
configuration for using google as the identity provider
A class encapsulating the EndpointOidc resource.
A class encapsulating the EndpointOidc resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
URL of the OIDC "OpenID provider". This is the base URL used for discovery.
The OIDC app's client ID and OIDC audience.
The OIDC app's client secret.
The set of scopes to request from the OIDC identity provider.
A class encapsulating the EndpointRequestHeaders resource.
A class encapsulating the EndpointRequestHeaders resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
a map of header key to header value that will be injected into the HTTP Request before being sent to the upstream application server
a list of header names that will be removed from the HTTP Request before being sent to the upstream application server
A class encapsulating the EndpointResponseHeaders resource.
A class encapsulating the EndpointResponseHeaders resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
a map of header key to header value that will be injected into the HTTP Response returned to the HTTP client
a list of header names that will be removed from the HTTP Response returned to the HTTP client
A class encapsulating the EndpointSaml resource.
A class encapsulating the EndpointSaml resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.
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.
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.
If present, only users who are a member of one of the listed groups may access the target endpoint.
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 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 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 configuration if it is supported.
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.
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.
A class encapsulating the EndpointSamlMutate resource.
A class encapsulating the EndpointSamlMutate resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.
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.
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.
If present, only users who are a member of one of the listed groups may access the target endpoint.
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.
A class encapsulating the EndpointTlsTermination resource.
A class encapsulating the EndpointTlsTermination resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
edge if the ngrok edge should terminate TLS traffic, upstream if TLS traffic should be passed through to the upstream ngrok agent / application server for termination. if upstream is chosen, most other modules will be disallowed because they rely on the ngrok edge being able to access the underlying traffic.
The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if terminate_at is set to upstream.
A class encapsulating the EndpointTlsTerminationAtEdge resource.
A class encapsulating the EndpointTlsTerminationAtEdge resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if terminate_at is set to upstream.
A class encapsulating the EndpointWebhookValidation resource.
A class encapsulating the EndpointWebhookValidation resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers: SLACK, SNS, STRIPE, GITHUB, TWILIO, SHOPIFY, GITLAB, INTERCOM, SENDGRID, XERO, PAGERDUTY.
a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret
A class encapsulating the EndpointWebsocketTcpConverter resource.
A class encapsulating the EndpointWebsocketTcpConverter resource. -
true if the module will be applied to traffic, false to disable. default true if unspecified
A class encapsulating the EventDestination resource.
A class encapsulating the EventDestination resource. -
Unique identifier for this Event Destination.
Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
Timestamp when the Event Destination was created, RFC 3339 format.
Human-readable description of the Event Destination. Optional, max 255 bytes.
The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
URI of the Event Destination API resource.
A class encapsulating the EventDestinationList resource.
A class encapsulating the EventDestinationList resource. -
The list of all Event Destinations on this account.
URI of the Event Destinations list API resource.
URI of the next page, or null if there is no next page.
A class encapsulating the EventSource resource.
A class encapsulating the EventSource resource. -
URI of the Event Source API resource.
A class encapsulating the EventSourceList resource.
A class encapsulating the EventSourceList resource. -
The list of all Event Sources for an Event Subscription
URI of the next page, or null if there is no next page.
A class encapsulating the EventSourceReplace resource.
A class encapsulating the EventSubscription resource.
A class encapsulating the EventSubscription resource. -
Unique identifier for this Event Subscription.
URI of the Event Subscription API resource.
When the Event Subscription was created (RFC 3339 format).
Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
Sources containing the types for which this event subscription will trigger
Destinations to which these events will be sent
A class encapsulating the EventSubscriptionList resource.
A class encapsulating the EventSubscriptionList resource. -
The list of all Event Subscriptions on this account.
URI of the Event Subscriptions list API resource.
URI of next page, or null if there is no next page.
A class encapsulating the EventTarget resource.
A class encapsulating the EventTarget resource. -
Configuration used to send events to Amazon Kinesis Data Firehose.
Configuration used to send events to Amazon Kinesis.
Configuration used to send events to Amazon CloudWatch Logs.
A class encapsulating the EventTargetCloudwatchLogs resource.
A class encapsulating the EventTargetCloudwatchLogs resource. -
Configuration for how to authenticate into your AWS account. Exactly one of role or creds should be configured.
An Amazon Resource Name specifying the CloudWatch Logs group to deposit events into.
A class encapsulating the EventTargetFirehose resource.
A class encapsulating the EventTargetFirehose resource. -
Configuration for how to authenticate into your AWS account. Exactly one of role or creds should be configured.
An Amazon Resource Name specifying the Firehose delivery stream to deposit events into.
A class encapsulating the EventTargetKinesis resource.
A class encapsulating the EventTargetKinesis resource. -
Configuration for how to authenticate into your AWS account. Exactly one of role or creds should be configured.
An Amazon Resource Name specifying the Kinesis stream to deposit events into.
A class encapsulating the FailoverBackend resource.
A class encapsulating the FailoverBackend resource. -
unique identifier for this Failover backend
URI of the FailoverBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
the ids of the child backends in order
A class encapsulating the FailoverBackendList resource.
A class encapsulating the FailoverBackendList resource. -
the list of all Failover backends on this account
URI of the Failover backends list API resource
URI of the next page, or null if there is no next page
A class encapsulating the HttpResponseBackend resource.
A class encapsulating the HttpResponseBackend resource. -
the value of the id parameter as a scala.Predef.String
URI of the HTTPResponseBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
body to return as fixed content
headers to return
status code to return
A class encapsulating the HttpResponseBackendList resource.
A class encapsulating the HttpResponseBackendList resource. -
the value of the backends parameter as a scala.List of HttpResponseBackend
the value of the uri parameter as a java.net.URI
the value of the next_page_uri parameter as a java.net.URI
A class encapsulating the HttpsEdge resource.
A class encapsulating the HttpsEdge resource. -
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes.
timestamp when the edge configuration was created, RFC 3339 format
URI of the edge API resource
hostports served by this edge
edge modules
the value of the tls_termination parameter as a EndpointTlsTermination
routes
A class encapsulating the HttpsEdgeList resource.
A class encapsulating the HttpsEdgeList resource. -
the list of all HTTPS Edges on this account
URI of the HTTPS Edge list API resource
URI of the next page, or null if there is no next page
A class encapsulating the HttpsEdgeRoute resource.
A class encapsulating the HttpsEdgeRoute resource. -
unique identifier of this edge
unique identifier of this edge route
timestamp when the edge configuration was created, RFC 3339 format
Type of match to use for this route. Valid values are "exact_path" and "path_prefix".
URI of the edge API resource
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
backend module configuration or null
ip restriction module configuration or null
circuit breaker module configuration or null
compression module configuration or null
request headers module configuration or null
response headers module configuration or null
webhook verification module configuration or null
oauth module configuration or null
saml module configuration or null
oidc module configuration or null
websocket to tcp adapter configuration or null
A class encapsulating the IpPolicy resource.
A class encapsulating the IpPolicy resource. -
unique identifier for this IP policy
URI of the IP Policy API resource
timestamp when the IP policy was created, RFC 3339 format
human-readable description of the source IPs of this IP policy. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.
A class encapsulating the IpPolicyList resource.
A class encapsulating the IpPolicyList resource. -
the list of all IP policies on this account
URI of the IP policy list API resource
URI of the next page, or null if there is no next page
A class encapsulating the IpPolicyRule resource.
A class encapsulating the IpPolicyRule resource. -
unique identifier for this IP policy rule
URI of the IP policy rule API resource
timestamp when the IP policy rule was created, RFC 3339 format
human-readable description of the source IPs of this IP rule. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.
an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
object describing the IP policy this IP Policy Rule belongs to
the action to apply to the policy rule, either allow or deny
A class encapsulating the IpPolicyRuleList resource.
A class encapsulating the IpPolicyRuleList resource. -
the list of all IP policy rules on this account
URI of the IP policy rule list API resource
URI of the next page, or null if there is no next page
A class encapsulating the IpRestriction resource.
A class encapsulating the IpRestriction resource. -
unique identifier for this IP restriction
URI of the IP restriction API resource
timestamp when the IP restriction was created, RFC 3339 format
human-readable description of this IP restriction. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
true if the IP restriction will be enforced. if false, only warnings will be issued
the set of IP policies that are used to enforce the restriction
A class encapsulating the IpRestrictionList resource.
A class encapsulating the IpRestrictionList resource. -
the list of all IP restrictions on this account
URI of the IP restrictions list API resource
URI of the next page, or null if there is no next page
Representation of an API error from ngrok.
Representation of an API error from ngrok. -
descriptive error message.
HTTP status returned from the server
ngrok-specific error code, if any
key-value map of error details
exception cause, if any
Wrapper class that holds a single page of a Pageable response.
Wrapper class that holds a single page of a Pageable response. -
underlying page type
Trait indicating a resource type that can have more than one page of responses.
A class encapsulating the Ref resource.
A class encapsulating the Ref resource. -
a resource identifier
a uri for locating a resource
A class encapsulating the ReservedAddr resource.
A class encapsulating the ReservedAddr resource. -
unique reserved address resource identifier
URI of the reserved address API resource
timestamp when the reserved address was created, RFC 3339 format
human-readable description of what this reserved address will be used for
arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
hostname:port of the reserved address that was assigned at creation time
reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
A class encapsulating the ReservedAddrList resource.
A class encapsulating the ReservedAddrList resource. -
the list of all reserved addresses on this account
URI of the reserved address list API resource
URI of the next page, or null if there is no next page
A class encapsulating the ReservedDomain resource.
A class encapsulating the ReservedDomain resource. -
unique reserved domain resource identifier
URI of the reserved domain API resource
timestamp when the reserved domain was created, RFC 3339 format
human-readable description of what this reserved domain will be used for
arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
hostname of the reserved domain
reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io
object referencing the TLS certificate used for connections to this domain. This can be either a user-uploaded certificate, the most recently issued automatic one, or null otherwise.
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
status of the automatic certificate management for this domain, or null if automatic management is disabled
DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.
A class encapsulating the ReservedDomainCertJob resource.
A class encapsulating the ReservedDomainCertJob resource. -
if present, an error code indicating why provisioning is failing. It may be either a temporary condition (INTERNAL_ERROR), or a permanent one the user must correct (DNS_ERROR).
a message describing the current status or error
timestamp when the provisioning job started, RFC 3339 format
timestamp when the provisioning job will be retried
A class encapsulating the ReservedDomainCertPolicy resource.
A class encapsulating the ReservedDomainCertPolicy resource. -
certificate authority to request certificates from. The only supported value is letsencrypt.
type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.
A class encapsulating the ReservedDomainCertStatus resource.
A class encapsulating the ReservedDomainCertStatus resource. -
timestamp when the next renewal will be requested, RFC 3339 format
status of the certificate provisioning job, or null if the certificiate isn't being provisioned or renewed
A class encapsulating the ReservedDomainList resource.
A class encapsulating the ReservedDomainList resource. -
the list of all reserved domains on this account
URI of the reserved domain list API resource
URI of the next page, or null if there is no next page
A class encapsulating the SshCertificateAuthority resource.
A class encapsulating the SshCertificateAuthority resource. -
unique identifier for this SSH Certificate Authority
URI of the SSH Certificate Authority API resource
timestamp when the SSH Certificate Authority API resource was created, RFC 3339 format
human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
raw public key for this SSH Certificate Authority
the type of private key for this SSH Certificate Authority
A class encapsulating the SshCertificateAuthorityList resource.
A class encapsulating the SshCertificateAuthorityList resource. -
the list of all certificate authorities on this account
URI of the certificates authorities list API resource
URI of the next page, or null if there is no next page
A class encapsulating the SshCredential resource.
A class encapsulating the SshCredential resource. -
unique ssh credential resource identifier
URI of the ssh credential API resource
timestamp when the ssh credential was created, RFC 3339 format
human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.
arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
the PEM-encoded public key of the SSH keypair that will be used to authenticate
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.
A class encapsulating the SshCredentialList resource.
A class encapsulating the SshCredentialList resource. -
the list of all ssh credentials on this account
URI of the ssh credential list API resource
URI of the next page, or null if there is no next page
A class encapsulating the SshHostCertificate resource.
A class encapsulating the SshHostCertificate resource. -
unique identifier for this SSH Host Certificate
URI of the SSH Host Certificate API resource
timestamp when the SSH Host Certificate API resource was created, RFC 3339 format
human-readable description of this SSH Host Certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.
a public key in OpenSSH Authorized Keys format that this certificate signs
the key type of the public_key, one of rsa, ecdsa or ed25519
the ssh certificate authority that is used to sign this ssh host certificate
the list of principals included in the ssh host certificate. This is the list of hostnames and/or IP addresses that are authorized to serve SSH traffic with this certificate. Dangerously, if no principals are specified, this certificate is considered valid for all hosts.
the time when the ssh host certificate becomes valid, in RFC 3339 format.
the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
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
A class encapsulating the SshHostCertificateList resource.
A class encapsulating the SshHostCertificateList resource. -
the list of all ssh host certificates on this account
URI of the ssh host certificates list API resource
URI of the next page, or null if there is no next page
A class encapsulating the SshUserCertificate resource.
A class encapsulating the SshUserCertificate resource. -
unique identifier for this SSH User Certificate
URI of the SSH User Certificate API resource
timestamp when the SSH User Certificate API resource was created, RFC 3339 format
human-readable description of this SSH User Certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
a public key in OpenSSH Authorized Keys format that this certificate signs
the key type of the public_key, one of rsa, ecdsa or ed25519
the ssh certificate authority that is used to sign this ssh user certificate
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.
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.
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.
the time when the ssh host certificate becomes valid, in RFC 3339 format.
the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
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
A class encapsulating the SshUserCertificateList resource.
A class encapsulating the SshUserCertificateList resource. -
the list of all ssh user certificates on this account
URI of the ssh user certificates list API resource
URI of the next page, or null if there is no next page
A class encapsulating the TcpEdge resource.
A class encapsulating the TcpEdge resource. -
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
timestamp when the edge was created, RFC 3339 format
URI of the edge API resource
hostports served by this edge
edge modules
the value of the ip_restriction parameter as a EndpointIpPolicy
A class encapsulating the TcpEdgeList resource.
A class encapsulating the TcpEdgeList resource. -
the list of all TCP Edges on this account
URI of the TCP Edge list API resource
URI of the next page, or null if there is no next page
A class encapsulating the TlsCertificate resource.
A class encapsulating the TlsCertificate resource. -
unique identifier for this TLS certificate
URI of the TLS certificate API resource
timestamp when the TLS certificate was created, RFC 3339 format
human-readable description of this TLS certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.
chain of PEM-encoded certificates, leaf first. See Certificate Bundles.
subject common name from the leaf of this TLS certificate
subject alternative names (SANs) from the leaf of this TLS certificate
timestamp (in RFC 3339 format) when this TLS certificate was issued automatically, or null if this certificate was user-uploaded
timestamp when this TLS certificate becomes valid, RFC 3339 format
timestamp when this TLS certificate becomes invalid, RFC 3339 format
set of actions the private key of this TLS certificate can be used for
extended set of actions the private key of this TLS certificate can be used for
type of the private key of this TLS certificate. One of rsa, ecdsa, or ed25519.
issuer common name from the leaf of this TLS certificate
serial number of the leaf of this TLS certificate
subject organization from the leaf of this TLS certificate
subject organizational unit from the leaf of this TLS certificate
subject locality from the leaf of this TLS certificate
subject province from the leaf of this TLS certificate
subject country from the leaf of this TLS certificate
A class encapsulating the TlsCertificateList resource.
A class encapsulating the TlsCertificateList resource. -
the list of all TLS certificates on this account
URI of the TLS certificates list API resource
URI of the next page, or null if there is no next page
A class encapsulating the TlsCertificateSaNs resource.
A class encapsulating the TlsCertificateSaNs resource. -
set of additional domains (including wildcards) this TLS certificate is valid for
set of IP addresses this TLS certificate is also valid for
A class encapsulating the TlsEdge resource.
A class encapsulating the TlsEdge resource. -
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
timestamp when the edge configuration was created, RFC 3339 format
URI of the edge API resource
hostports served by this edge
edge modules
the value of the ip_restriction parameter as a EndpointIpPolicy
the value of the mutual_tls parameter as a EndpointMutualTls
the value of the tls_termination parameter as a EndpointTlsTermination
A class encapsulating the TlsEdgeList resource.
A class encapsulating the TlsEdgeList resource. -
the list of all TLS Edges on this account
URI of the TLS Edge list API resource
URI of the next page, or null if there is no next page
A class encapsulating the Tunnel resource.
A class encapsulating the Tunnel resource. -
unique tunnel resource identifier
URL of the ephemeral tunnel's public endpoint
timestamp when the tunnel was initiated in RFC 3339 format
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.
tunnel protocol for ephemeral tunnels. one of http, https, tcp or tls
identifier of tune region where the tunnel is running
reference object pointing to the tunnel session on which this tunnel was started
the ephemeral endpoint this tunnel is associated with, if this is an agent-initiated tunnel
the labels the tunnel group backends will match against, if this is a backend tunnel
tunnel group backends served by this backend tunnel
upstream address the ngrok agent forwards traffic over this tunnel to. this may be expressed as a URL or a network address.
A class encapsulating the TunnelGroupBackend resource.
A class encapsulating the TunnelGroupBackend resource. -
unique identifier for this TunnelGroup backend
URI of the TunnelGroupBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
labels to watch for tunnels on, e.g. app->foo, dc->bar
tunnels matching this backend
A class encapsulating the TunnelGroupBackendList resource.
A class encapsulating the TunnelGroupBackendList resource. -
the list of all TunnelGroup backends on this account
URI of the TunnelGroup backends list API resource
URI of the next page, or null if there is no next page
A class encapsulating the TunnelList resource.
A class encapsulating the TunnelList resource. -
the list of all online tunnels on this account
URI of the tunnels list API resource
URI of the next page, or null if there is no next page
A class encapsulating the TunnelSession resource.
A class encapsulating the TunnelSession resource. -
version of the ngrok agent that started this ngrok tunnel session
reference to the tunnel credential or ssh credential used by the ngrok agent to start this tunnel session
unique tunnel session resource identifier
source ip address of the tunnel session
arbitrary user-defined data specified in the metadata property in the ngrok configuration file. See the metadata configuration option
operating system of the host the ngrok agent is running on
the ngrok region identifier in which this tunnel session was started
time when the tunnel session first connected to the ngrok servers
the transport protocol used to start the tunnel session. Either ngrok/v2 or ssh
URI to the API resource of the tunnel session
A class encapsulating the TunnelSessionList resource.
A class encapsulating the TunnelSessionList resource. -
list of all tunnel sessions on this account
URI to the API resource of the tunnel session list
URI of the next page, or null if there is no next page
A class encapsulating the WeightedBackend resource.
A class encapsulating the WeightedBackend resource. -
unique identifier for this Weighted backend
URI of the WeightedBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
the ids of the child backends to their weights [0-10000]
A class encapsulating the WeightedBackendList resource.
A class encapsulating the WeightedBackendList resource. -
the list of all Weighted backends on this account
URI of the Weighted backends list API resource
URI of the next page, or null if there is no next page
A class encapsulating the AbuseReport resource.
A class encapsulating the AbuseReport resource. +
ID of the abuse report
URI of the abuse report API resource
timestamp that the abuse report record was created in RFC 3339 format
a list of URLs containing suspected abusive content
arbitrary user-defined data about this abuse report. Optional, max 4096 bytes.
Indicates whether ngrok has processed the abuse report. one of PENDING, PROCESSED, or PARTIALLY_PROCESSED
an array of hostname statuses related to the report
A class encapsulating the AbuseReportHostname resource.
A class encapsulating the AbuseReportHostname resource. +
the hostname ngrok has parsed out of one of the reported URLs in this abuse report
indicates what action ngrok has taken against the hostname. one of PENDING, BANNED, UNBANNED, or IGNORE
A class encapsulating the AgentIngress resource.
A class encapsulating the AgentIngress resource. +
unique Agent Ingress resource identifier
URI to the API resource of this Agent ingress
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
the domain that you own to be used as the base domain name to generate regional agent ingress domains.
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
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
timestamp when the Agent Ingress was created, RFC 3339 format
A class encapsulating the AgentIngressList resource.
A class encapsulating the AgentIngressList resource. +
the list of Agent Ingresses owned by this account
URI of the Agent Ingress list API resource
URI of the next page, or null if there is no next page
A class encapsulating the ApiKey resource.
A class encapsulating the ApiKey resource. +
unique API key resource identifier
URI to the API resource of this API key
human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
arbitrary user-defined data of this API key. optional, max 4096 bytes
timestamp when the api key was created, RFC 3339 format
the bearer token that can be placed into the Authorization header to authenticate request to the ngrok API. This value is only available one time, on the API response from key creation. Otherwise it is null.
A class encapsulating the ApiKeyList resource.
A class encapsulating the ApiKeyList resource. +
the list of API keys for this account
URI of the API keys list API resource
URI of the next page, or null if there is no next page
A class encapsulating the AwsAuth resource.
A class encapsulating the AwsAuth resource. +
A role for ngrok to assume on your behalf to deposit events into your AWS account.
Credentials to your AWS account if you prefer ngrok to sign in with long-term access keys.
A class encapsulating the AwsCredentials resource.
A class encapsulating the AwsCredentials resource. +
The ID portion of an AWS access key.
The secret portion of an AWS access key.
A class encapsulating the AwsRole resource.
A class encapsulating the AwsRole resource. +
An ARN that specifies the role that ngrok should use to deliver to the configured target.
A class encapsulating the CertificateAuthority resource.
A class encapsulating the CertificateAuthority resource. +
unique identifier for this Certificate Authority
URI of the Certificate Authority API resource
timestamp when the Certificate Authority was created, RFC 3339 format
human-readable description of this Certificate Authority. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.
raw PEM of the Certificate Authority
subject common name of the Certificate Authority
timestamp when this Certificate Authority becomes valid, RFC 3339 format
timestamp when this Certificate Authority becomes invalid, RFC 3339 format
set of actions the private key of this Certificate Authority can be used for
extended set of actions the private key of this Certificate Authority can be used for
A class encapsulating the CertificateAuthorityList resource.
A class encapsulating the CertificateAuthorityList resource. +
the list of all certificate authorities on this account
URI of the certificates authorities list API resource
URI of the next page, or null if there is no next page
A class encapsulating the Credential resource.
A class encapsulating the Credential resource. +
unique tunnel credential resource identifier
URI of the tunnel credential API resource
timestamp when the tunnel credential was created, RFC 3339 format
human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
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.
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.
A class encapsulating the CredentialList resource.
A class encapsulating the CredentialList resource. +
the list of all tunnel credentials on this account
URI of the tunnel credential list API resource
URI of the next page, or null if there is no next page
A class encapsulating the Endpoint resource.
A class encapsulating the Endpoint resource. +
unique endpoint resource identifier
identifier of the region this endpoint belongs to
timestamp when the endpoint was created in RFC 3339 format
timestamp when the endpoint was updated in RFC 3339 format
URL of the hostport served by this endpoint
protocol served by this endpoint. one of http, https, tcp, or tls
hostport served by this endpoint (hostname:port)
user-supplied metadata of the associated tunnel or edge object
the domain reserved for this endpoint
the address reserved for this endpoint
the tunnel serving requests to this endpoint, if this is an ephemeral endpoint
the edge serving requests to this endpoint, if this is an edge endpoint
A class encapsulating the EndpointBackend resource.
A class encapsulating the EndpointBackend resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
backend to be used to back this endpoint
A class encapsulating the EndpointBackendMutate resource.
A class encapsulating the EndpointBackendMutate resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
backend to be used to back this endpoint
A class encapsulating the EndpointCircuitBreaker resource.
A class encapsulating the EndpointCircuitBreaker resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
Integer number of seconds after which the circuit is tripped to wait before re-evaluating upstream health
Integer number of seconds in the statistical rolling window that metrics are retained for.
Integer number of buckets into which metrics are retained. Max 128.
Integer number of requests in a rolling window that will trip the circuit. Helpful if traffic volume is low.
Error threshold percentage should be between 0 - 1.0, not 0-100.0
A class encapsulating the EndpointCompression resource.
A class encapsulating the EndpointCompression resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
A class encapsulating the EndpointIpPolicy resource.
A class encapsulating the EndpointIpPolicy resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
the value of the ip_policies parameter as a scala.List of Ref
A class encapsulating the EndpointIpPolicyMutate resource.
A class encapsulating the EndpointIpPolicyMutate resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
list of all IP policies that will be used to check if a source IP is allowed access to the endpoint
A class encapsulating the EndpointList resource.
A class encapsulating the EndpointList resource. +
the list of all active endpoints on this account
URI of the endpoints list API resource
URI of the next page, or null if there is no next page
A class encapsulating the EndpointMutualTls resource.
A class encapsulating the EndpointMutualTls resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
PEM-encoded CA certificates that will be used to validate. Multiple CAs may be provided by concatenating them together.
A class encapsulating the EndpointMutualTlsMutate resource.
A class encapsulating the EndpointMutualTlsMutate resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
list of certificate authorities that will be used to validate the TLS client certificate presented by the initiator of the TLS connection
A class encapsulating the EndpointOAuth resource.
A class encapsulating the EndpointOAuth resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
an object which defines the identity provider to use for authentication and configuration for who may access the endpoint
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
Integer number of seconds after which ngrok guarantees it will refresh user state from the identity provider and recheck whether the user is still authorized to access the endpoint. This is the preferred tunable to use to enforce a minimum amount of time after which a revoked user will no longer be able to access the resource.
A class encapsulating the EndpointOAuthFacebook resource.
A class encapsulating the EndpointOAuthFacebook resource. +
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
A class encapsulating the EndpointOAuthGitHub resource.
A class encapsulating the EndpointOAuthGitHub resource. +
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
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
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'
A class encapsulating the EndpointOAuthGoogle resource.
A class encapsulating the EndpointOAuthGoogle resource. +
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
A class encapsulating the EndpointOAuthMicrosoft resource.
A class encapsulating the EndpointOAuthMicrosoft resource. +
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 well.
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.
a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
A class encapsulating the EndpointOAuthProvider resource.
A class encapsulating the EndpointOAuthProvider resource. +
configuration for using github as the identity provider
configuration for using facebook as the identity provider
configuration for using microsoft as the identity provider
configuration for using google as the identity provider
A class encapsulating the EndpointOidc resource.
A class encapsulating the EndpointOidc resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
URL of the OIDC "OpenID provider". This is the base URL used for discovery.
The OIDC app's client ID and OIDC audience.
The OIDC app's client secret.
The set of scopes to request from the OIDC identity provider.
A class encapsulating the EndpointRequestHeaders resource.
A class encapsulating the EndpointRequestHeaders resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
a map of header key to header value that will be injected into the HTTP Request before being sent to the upstream application server
a list of header names that will be removed from the HTTP Request before being sent to the upstream application server
A class encapsulating the EndpointResponseHeaders resource.
A class encapsulating the EndpointResponseHeaders resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
a map of header key to header value that will be injected into the HTTP Response returned to the HTTP client
a list of header names that will be removed from the HTTP Response returned to the HTTP client
A class encapsulating the EndpointSaml resource.
A class encapsulating the EndpointSaml resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.
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.
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.
If present, only users who are a member of one of the listed groups may access the target endpoint.
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 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 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 configuration if it is supported.
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.
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.
A class encapsulating the EndpointSamlMutate resource.
A class encapsulating the EndpointSamlMutate resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
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.
Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.
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.
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.
If present, only users who are a member of one of the listed groups may access the target endpoint.
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.
A class encapsulating the EndpointTlsTermination resource.
A class encapsulating the EndpointTlsTermination resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
edge if the ngrok edge should terminate TLS traffic, upstream if TLS traffic should be passed through to the upstream ngrok agent / application server for termination. if upstream is chosen, most other modules will be disallowed because they rely on the ngrok edge being able to access the underlying traffic.
The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if terminate_at is set to upstream.
A class encapsulating the EndpointTlsTerminationAtEdge resource.
A class encapsulating the EndpointTlsTerminationAtEdge resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
The minimum TLS version used for termination and advertised to the client during the TLS handshake. if unspecified, ngrok will choose an industry-safe default. This value must be null if terminate_at is set to upstream.
A class encapsulating the EndpointWebhookValidation resource.
A class encapsulating the EndpointWebhookValidation resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers: SLACK, SNS, STRIPE, GITHUB, TWILIO, SHOPIFY, GITLAB, INTERCOM, SENDGRID, XERO, PAGERDUTY.
a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret
A class encapsulating the EndpointWebsocketTcpConverter resource.
A class encapsulating the EndpointWebsocketTcpConverter resource. +
true if the module will be applied to traffic, false to disable. default true if unspecified
A class encapsulating the EventDestination resource.
A class encapsulating the EventDestination resource. +
Unique identifier for this Event Destination.
Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
Timestamp when the Event Destination was created, RFC 3339 format.
Human-readable description of the Event Destination. Optional, max 255 bytes.
The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
URI of the Event Destination API resource.
A class encapsulating the EventDestinationList resource.
A class encapsulating the EventDestinationList resource. +
The list of all Event Destinations on this account.
URI of the Event Destinations list API resource.
URI of the next page, or null if there is no next page.
A class encapsulating the EventSource resource.
A class encapsulating the EventSource resource. +
URI of the Event Source API resource.
A class encapsulating the EventSourceList resource.
A class encapsulating the EventSourceList resource. +
The list of all Event Sources for an Event Subscription
URI of the next page, or null if there is no next page.
A class encapsulating the EventSourceReplace resource.
A class encapsulating the EventSubscription resource.
A class encapsulating the EventSubscription resource. +
Unique identifier for this Event Subscription.
URI of the Event Subscription API resource.
When the Event Subscription was created (RFC 3339 format).
Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
Sources containing the types for which this event subscription will trigger
Destinations to which these events will be sent
A class encapsulating the EventSubscriptionList resource.
A class encapsulating the EventSubscriptionList resource. +
The list of all Event Subscriptions on this account.
URI of the Event Subscriptions list API resource.
URI of next page, or null if there is no next page.
A class encapsulating the EventTarget resource.
A class encapsulating the EventTarget resource. +
Configuration used to send events to Amazon Kinesis Data Firehose.
Configuration used to send events to Amazon Kinesis.
Configuration used to send events to Amazon CloudWatch Logs.
A class encapsulating the EventTargetCloudwatchLogs resource.
A class encapsulating the EventTargetCloudwatchLogs resource. +
Configuration for how to authenticate into your AWS account. Exactly one of role or creds should be configured.
An Amazon Resource Name specifying the CloudWatch Logs group to deposit events into.
A class encapsulating the EventTargetFirehose resource.
A class encapsulating the EventTargetFirehose resource. +
Configuration for how to authenticate into your AWS account. Exactly one of role or creds should be configured.
An Amazon Resource Name specifying the Firehose delivery stream to deposit events into.
A class encapsulating the EventTargetKinesis resource.
A class encapsulating the EventTargetKinesis resource. +
Configuration for how to authenticate into your AWS account. Exactly one of role or creds should be configured.
An Amazon Resource Name specifying the Kinesis stream to deposit events into.
A class encapsulating the FailoverBackend resource.
A class encapsulating the FailoverBackend resource. +
unique identifier for this Failover backend
URI of the FailoverBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
the ids of the child backends in order
A class encapsulating the FailoverBackendList resource.
A class encapsulating the FailoverBackendList resource. +
the list of all Failover backends on this account
URI of the Failover backends list API resource
URI of the next page, or null if there is no next page
A class encapsulating the HttpResponseBackend resource.
A class encapsulating the HttpResponseBackend resource. +
the value of the id parameter as a scala.Predef.String
URI of the HTTPResponseBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
body to return as fixed content
headers to return
status code to return
A class encapsulating the HttpResponseBackendList resource.
A class encapsulating the HttpResponseBackendList resource. +
the value of the backends parameter as a scala.List of HttpResponseBackend
the value of the uri parameter as a java.net.URI
the value of the next_page_uri parameter as a java.net.URI
A class encapsulating the HttpsEdge resource.
A class encapsulating the HttpsEdge resource. +
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes.
timestamp when the edge configuration was created, RFC 3339 format
URI of the edge API resource
hostports served by this edge
edge modules
the value of the tls_termination parameter as a EndpointTlsTermination
routes
A class encapsulating the HttpsEdgeList resource.
A class encapsulating the HttpsEdgeList resource. +
the list of all HTTPS Edges on this account
URI of the HTTPS Edge list API resource
URI of the next page, or null if there is no next page
A class encapsulating the HttpsEdgeRoute resource.
A class encapsulating the HttpsEdgeRoute resource. +
unique identifier of this edge
unique identifier of this edge route
timestamp when the edge configuration was created, RFC 3339 format
Type of match to use for this route. Valid values are "exact_path" and "path_prefix".
URI of the edge API resource
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
backend module configuration or null
ip restriction module configuration or null
circuit breaker module configuration or null
compression module configuration or null
request headers module configuration or null
response headers module configuration or null
webhook verification module configuration or null
oauth module configuration or null
saml module configuration or null
oidc module configuration or null
websocket to tcp adapter configuration or null
A class encapsulating the IpPolicy resource.
A class encapsulating the IpPolicy resource. +
unique identifier for this IP policy
URI of the IP Policy API resource
timestamp when the IP policy was created, RFC 3339 format
human-readable description of the source IPs of this IP policy. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.
A class encapsulating the IpPolicyList resource.
A class encapsulating the IpPolicyList resource. +
the list of all IP policies on this account
URI of the IP policy list API resource
URI of the next page, or null if there is no next page
A class encapsulating the IpPolicyRule resource.
A class encapsulating the IpPolicyRule resource. +
unique identifier for this IP policy rule
URI of the IP policy rule API resource
timestamp when the IP policy rule was created, RFC 3339 format
human-readable description of the source IPs of this IP rule. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.
an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
object describing the IP policy this IP Policy Rule belongs to
the action to apply to the policy rule, either allow or deny
A class encapsulating the IpPolicyRuleList resource.
A class encapsulating the IpPolicyRuleList resource. +
the list of all IP policy rules on this account
URI of the IP policy rule list API resource
URI of the next page, or null if there is no next page
A class encapsulating the IpRestriction resource.
A class encapsulating the IpRestriction resource. +
unique identifier for this IP restriction
URI of the IP restriction API resource
timestamp when the IP restriction was created, RFC 3339 format
human-readable description of this IP restriction. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
true if the IP restriction will be enforced. if false, only warnings will be issued
the set of IP policies that are used to enforce the restriction
A class encapsulating the IpRestrictionList resource.
A class encapsulating the IpRestrictionList resource. +
the list of all IP restrictions on this account
URI of the IP restrictions list API resource
URI of the next page, or null if there is no next page
Representation of an API error from ngrok.
Representation of an API error from ngrok. +
descriptive error message.
HTTP status returned from the server
ngrok-specific error code, if any
key-value map of error details
exception cause, if any
Wrapper class that holds a single page of a Pageable response.
Wrapper class that holds a single page of a Pageable response. +
underlying page type
Trait indicating a resource type that can have more than one page of responses.
A class encapsulating the Ref resource.
A class encapsulating the Ref resource. +
a resource identifier
a uri for locating a resource
A class encapsulating the ReservedAddr resource.
A class encapsulating the ReservedAddr resource. +
unique reserved address resource identifier
URI of the reserved address API resource
timestamp when the reserved address was created, RFC 3339 format
human-readable description of what this reserved address will be used for
arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
hostname:port of the reserved address that was assigned at creation time
reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
A class encapsulating the ReservedAddrList resource.
A class encapsulating the ReservedAddrList resource. +
the list of all reserved addresses on this account
URI of the reserved address list API resource
URI of the next page, or null if there is no next page
A class encapsulating the ReservedDomain resource.
A class encapsulating the ReservedDomain resource. +
unique reserved domain resource identifier
URI of the reserved domain API resource
timestamp when the reserved domain was created, RFC 3339 format
human-readable description of what this reserved domain will be used for
arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
hostname of the reserved domain
reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io
object referencing the TLS certificate used for connections to this domain. This can be either a user-uploaded certificate, the most recently issued automatic one, or null otherwise.
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled
status of the automatic certificate management for this domain, or null if automatic management is disabled
DNS CNAME target for the host _acme-challenge.example.com, where example.com is your reserved domain name. This is required to issue certificates for wildcard, non-ngrok reserved domains. Must be null for non-wildcard domains and ngrok subdomains.
A class encapsulating the ReservedDomainCertJob resource.
A class encapsulating the ReservedDomainCertJob resource. +
if present, an error code indicating why provisioning is failing. It may be either a temporary condition (INTERNAL_ERROR), or a permanent one the user must correct (DNS_ERROR).
a message describing the current status or error
timestamp when the provisioning job started, RFC 3339 format
timestamp when the provisioning job will be retried
A class encapsulating the ReservedDomainCertPolicy resource.
A class encapsulating the ReservedDomainCertPolicy resource. +
certificate authority to request certificates from. The only supported value is letsencrypt.
type of private key to use when requesting certificates. Defaults to rsa, can be either rsa or ecdsa.
A class encapsulating the ReservedDomainCertStatus resource.
A class encapsulating the ReservedDomainCertStatus resource. +
timestamp when the next renewal will be requested, RFC 3339 format
status of the certificate provisioning job, or null if the certificiate isn't being provisioned or renewed
A class encapsulating the ReservedDomainList resource.
A class encapsulating the ReservedDomainList resource. +
the list of all reserved domains on this account
URI of the reserved domain list API resource
URI of the next page, or null if there is no next page
A class encapsulating the SshCertificateAuthority resource.
A class encapsulating the SshCertificateAuthority resource. +
unique identifier for this SSH Certificate Authority
URI of the SSH Certificate Authority API resource
timestamp when the SSH Certificate Authority API resource was created, RFC 3339 format
human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
raw public key for this SSH Certificate Authority
the type of private key for this SSH Certificate Authority
A class encapsulating the SshCertificateAuthorityList resource.
A class encapsulating the SshCertificateAuthorityList resource. +
the list of all certificate authorities on this account
URI of the certificates authorities list API resource
URI of the next page, or null if there is no next page
A class encapsulating the SshCredential resource.
A class encapsulating the SshCredential resource. +
unique ssh credential resource identifier
URI of the ssh credential API resource
timestamp when the ssh credential was created, RFC 3339 format
human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.
arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
the PEM-encoded public key of the SSH keypair that will be used to authenticate
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.
A class encapsulating the SshCredentialList resource.
A class encapsulating the SshCredentialList resource. +
the list of all ssh credentials on this account
URI of the ssh credential list API resource
URI of the next page, or null if there is no next page
A class encapsulating the SshHostCertificate resource.
A class encapsulating the SshHostCertificate resource. +
unique identifier for this SSH Host Certificate
URI of the SSH Host Certificate API resource
timestamp when the SSH Host Certificate API resource was created, RFC 3339 format
human-readable description of this SSH Host Certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.
a public key in OpenSSH Authorized Keys format that this certificate signs
the key type of the public_key, one of rsa, ecdsa or ed25519
the ssh certificate authority that is used to sign this ssh host certificate
the list of principals included in the ssh host certificate. This is the list of hostnames and/or IP addresses that are authorized to serve SSH traffic with this certificate. Dangerously, if no principals are specified, this certificate is considered valid for all hosts.
the time when the ssh host certificate becomes valid, in RFC 3339 format.
the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
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
A class encapsulating the SshHostCertificateList resource.
A class encapsulating the SshHostCertificateList resource. +
the list of all ssh host certificates on this account
URI of the ssh host certificates list API resource
URI of the next page, or null if there is no next page
A class encapsulating the SshUserCertificate resource.
A class encapsulating the SshUserCertificate resource. +
unique identifier for this SSH User Certificate
URI of the SSH User Certificate API resource
timestamp when the SSH User Certificate API resource was created, RFC 3339 format
human-readable description of this SSH User Certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
a public key in OpenSSH Authorized Keys format that this certificate signs
the key type of the public_key, one of rsa, ecdsa or ed25519
the ssh certificate authority that is used to sign this ssh user certificate
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.
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.
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.
the time when the ssh host certificate becomes valid, in RFC 3339 format.
the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
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
A class encapsulating the SshUserCertificateList resource.
A class encapsulating the SshUserCertificateList resource. +
the list of all ssh user certificates on this account
URI of the ssh user certificates list API resource
URI of the next page, or null if there is no next page
A class encapsulating the TcpEdge resource.
A class encapsulating the TcpEdge resource. +
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
timestamp when the edge was created, RFC 3339 format
URI of the edge API resource
hostports served by this edge
edge modules
the value of the ip_restriction parameter as a EndpointIpPolicy
A class encapsulating the TcpEdgeList resource.
A class encapsulating the TcpEdgeList resource. +
the list of all TCP Edges on this account
URI of the TCP Edge list API resource
URI of the next page, or null if there is no next page
A class encapsulating the TlsCertificate resource.
A class encapsulating the TlsCertificate resource. +
unique identifier for this TLS certificate
URI of the TLS certificate API resource
timestamp when the TLS certificate was created, RFC 3339 format
human-readable description of this TLS certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.
chain of PEM-encoded certificates, leaf first. See Certificate Bundles.
subject common name from the leaf of this TLS certificate
subject alternative names (SANs) from the leaf of this TLS certificate
timestamp (in RFC 3339 format) when this TLS certificate was issued automatically, or null if this certificate was user-uploaded
timestamp when this TLS certificate becomes valid, RFC 3339 format
timestamp when this TLS certificate becomes invalid, RFC 3339 format
set of actions the private key of this TLS certificate can be used for
extended set of actions the private key of this TLS certificate can be used for
type of the private key of this TLS certificate. One of rsa, ecdsa, or ed25519.
issuer common name from the leaf of this TLS certificate
serial number of the leaf of this TLS certificate
subject organization from the leaf of this TLS certificate
subject organizational unit from the leaf of this TLS certificate
subject locality from the leaf of this TLS certificate
subject province from the leaf of this TLS certificate
subject country from the leaf of this TLS certificate
A class encapsulating the TlsCertificateList resource.
A class encapsulating the TlsCertificateList resource. +
the list of all TLS certificates on this account
URI of the TLS certificates list API resource
URI of the next page, or null if there is no next page
A class encapsulating the TlsCertificateSaNs resource.
A class encapsulating the TlsCertificateSaNs resource. +
set of additional domains (including wildcards) this TLS certificate is valid for
set of IP addresses this TLS certificate is also valid for
A class encapsulating the TlsEdge resource.
A class encapsulating the TlsEdge resource. +
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
timestamp when the edge configuration was created, RFC 3339 format
URI of the edge API resource
hostports served by this edge
edge modules
the value of the ip_restriction parameter as a EndpointIpPolicy
the value of the mutual_tls parameter as a EndpointMutualTls
the value of the tls_termination parameter as a EndpointTlsTermination
A class encapsulating the TlsEdgeList resource.
A class encapsulating the TlsEdgeList resource. +
the list of all TLS Edges on this account
URI of the TLS Edge list API resource
URI of the next page, or null if there is no next page
A class encapsulating the Tunnel resource.
A class encapsulating the Tunnel resource. +
unique tunnel resource identifier
URL of the ephemeral tunnel's public endpoint
timestamp when the tunnel was initiated in RFC 3339 format
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.
tunnel protocol for ephemeral tunnels. one of http, https, tcp or tls
identifier of tune region where the tunnel is running
reference object pointing to the tunnel session on which this tunnel was started
the ephemeral endpoint this tunnel is associated with, if this is an agent-initiated tunnel
the labels the tunnel group backends will match against, if this is a backend tunnel
tunnel group backends served by this backend tunnel
upstream address the ngrok agent forwards traffic over this tunnel to. this may be expressed as a URL or a network address.
A class encapsulating the TunnelGroupBackend resource.
A class encapsulating the TunnelGroupBackend resource. +
unique identifier for this TunnelGroup backend
URI of the TunnelGroupBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
labels to watch for tunnels on, e.g. app->foo, dc->bar
tunnels matching this backend
A class encapsulating the TunnelGroupBackendList resource.
A class encapsulating the TunnelGroupBackendList resource. +
the list of all TunnelGroup backends on this account
URI of the TunnelGroup backends list API resource
URI of the next page, or null if there is no next page
A class encapsulating the TunnelList resource.
A class encapsulating the TunnelList resource. +
the list of all online tunnels on this account
URI of the tunnels list API resource
URI of the next page, or null if there is no next page
A class encapsulating the TunnelSession resource.
A class encapsulating the TunnelSession resource. +
version of the ngrok agent that started this ngrok tunnel session
reference to the tunnel credential or ssh credential used by the ngrok agent to start this tunnel session
unique tunnel session resource identifier
source ip address of the tunnel session
arbitrary user-defined data specified in the metadata property in the ngrok configuration file. See the metadata configuration option
operating system of the host the ngrok agent is running on
the ngrok region identifier in which this tunnel session was started
time when the tunnel session first connected to the ngrok servers
the transport protocol used to start the tunnel session. Either ngrok/v2 or ssh
URI to the API resource of the tunnel session
A class encapsulating the TunnelSessionList resource.
A class encapsulating the TunnelSessionList resource. +
list of all tunnel sessions on this account
URI to the API resource of the tunnel session list
URI of the next page, or null if there is no next page
A class encapsulating the WeightedBackend resource.
A class encapsulating the WeightedBackend resource. +
unique identifier for this Weighted backend
URI of the WeightedBackend API resource
timestamp when the backend was created, RFC 3339 format
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
the ids of the child backends to their weights [0-10000]
A class encapsulating the WeightedBackendList resource.
A class encapsulating the WeightedBackendList resource. +
the list of all Weighted backends on this account
URI of the Weighted backends list API resource
URI of the next page, or null if there is no next page
Default implementation of NgrokApiClient based on the Armeria HTTP client.
Main entry point for the ngrok API.
API client interface.
API client interface.
Concrete implementations can be written and passed to Ngrok on construction +
Default implementation of NgrokApiClient based on the Armeria HTTP client.
Main entry point for the ngrok API.
API client interface.
API client interface.
Concrete implementations can be written and passed to Ngrok on construction in order to make HTTP requests or test business logic.
Helpers for creating new DefaultNgrokApiClient instances.
Factory for Ngrok instances.
Helpful constants and enums for making API requests.
Client version information.
Abuse Reports allow you to submit take-down requests for URLs hosted by - ngrok that violate ngrok's terms of service.
See also https://ngrok.com/docs/api#api-abuse-reports. -
Creates a new abuse report which will be reviewed by our system and abuse +
Abuse Reports allow you to submit take-down requests for URLs hosted by + ngrok that violate ngrok's terms of service.
See also https://ngrok.com/docs/api#api-abuse-reports. +
Creates a new abuse report which will be reviewed by our system and abuse response team.
Creates a new abuse report which will be reviewed by our system and abuse response team. This API is only available to authorized accounts. Contact abuse@ngrok.com to request access
See also https://ngrok.com/docs/api#api-abuse-reports-create. -
a list of URLs containing suspected abusive content
arbitrary user-defined data about this abuse report. Optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
Get the detailed status of abuse report by ID.
Get the detailed status of abuse report by ID.
See also https://ngrok.com/docs/api#api-abuse-reports-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
a list of URLs containing suspected abusive content
arbitrary user-defined data about this abuse report. Optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
Get the detailed status of abuse report by ID.
Get the detailed status of abuse report by ID.
See also https://ngrok.com/docs/api#api-abuse-reports-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for AgentIngresses.
See also https://ngrok.com/docs/api#api-agent-ingresses. -
Create a new Agent Ingress.
Create a new Agent Ingress. The ngrok agent can be configured to connect to +
An API client for AgentIngresses.
See also https://ngrok.com/docs/api#api-agent-ingresses. +
Create a new Agent Ingress.
Create a new Agent Ingress. The ngrok agent can be configured to connect to ngrok via the new set of addresses on the returned Agent Ingress.
See also https://ngrok.com/docs/api#api-agent-ingresses-create. -
the domain that you own to be used as the base domain name to generate regional agent ingress domains.
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
a scala.concurrent.Future encapsulating the API call's result
Delete an Agent Ingress by ID
Delete an Agent Ingress by ID
See also https://ngrok.com/docs/api#api-agent-ingresses-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get the details of an Agent Ingress by ID.
Get the details of an Agent Ingress by ID.
See also https://ngrok.com/docs/api#api-agent-ingresses-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all Agent Ingresses owned by this account
List all Agent Ingresses owned by this account
See also https://ngrok.com/docs/api#api-agent-ingresses-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update attributes of an Agent Ingress by ID.
Update attributes of an Agent Ingress by ID.
See also https://ngrok.com/docs/api#api-agent-ingresses-update. -
the value of the id parameter as a scala.Predef.String
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
the domain that you own to be used as the base domain name to generate regional agent ingress domains.
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
a scala.concurrent.Future encapsulating the API call's result
Delete an Agent Ingress by ID
Delete an Agent Ingress by ID
See also https://ngrok.com/docs/api#api-agent-ingresses-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get the details of an Agent Ingress by ID.
Get the details of an Agent Ingress by ID.
See also https://ngrok.com/docs/api#api-agent-ingresses-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all Agent Ingresses owned by this account
List all Agent Ingresses owned by this account
See also https://ngrok.com/docs/api#api-agent-ingresses-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update attributes of an Agent Ingress by ID.
Update attributes of an Agent Ingress by ID.
See also https://ngrok.com/docs/api#api-agent-ingresses-update. +
the value of the id parameter as a scala.Predef.String
human-readable description of the use of this Agent Ingress. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
API Keys are used to authenticate to the <a +
API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">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.
See also https://ngrok.com/docs/api#api-api-keys. -
Create a new API key.
Create a new API key. The generated API key can be used to authenticate to the +
Create a new API key.
Create a new API key. The generated API key can be used to authenticate to the ngrok API.
See also https://ngrok.com/docs/api#api-api-keys-create. -
human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
arbitrary user-defined data of this API key. optional, max 4096 bytes
a scala.concurrent.Future encapsulating the API call's result
Delete an API key by ID
Delete an API key by ID
See also https://ngrok.com/docs/api#api-api-keys-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get the details of an API key by ID.
Get the details of an API key by ID.
See also https://ngrok.com/docs/api#api-api-keys-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all API keys owned by this account
List all API keys owned by this account
See also https://ngrok.com/docs/api#api-api-keys-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update attributes of an API key by ID.
Update attributes of an API key by ID.
See also https://ngrok.com/docs/api#api-api-keys-update. -
the value of the id parameter as a scala.Predef.String
human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
arbitrary user-defined data of this API key. optional, max 4096 bytes
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
arbitrary user-defined data of this API key. optional, max 4096 bytes
a scala.concurrent.Future encapsulating the API call's result
Delete an API key by ID
Delete an API key by ID
See also https://ngrok.com/docs/api#api-api-keys-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get the details of an API key by ID.
Get the details of an API key by ID.
See also https://ngrok.com/docs/api#api-api-keys-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all API keys owned by this account
List all API keys owned by this account
See also https://ngrok.com/docs/api#api-api-keys-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update attributes of an API key by ID.
Update attributes of an API key by ID.
See also https://ngrok.com/docs/api#api-api-keys-update. +
the value of the id parameter as a scala.Predef.String
human-readable description of what uses the API key to authenticate. optional, max 255 bytes.
arbitrary user-defined data of this API key. optional, max 4096 bytes
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Certificate Authorities are x509 certificates that are used to sign other +
Certificate Authorities are x509 certificates that are used to sign other x509 certificates. Attach a Certificate Authority to the Mutual TLS module to verify that the TLS certificate presented by a client has been signed by this CA. Certificate Authorities are used only for mTLS validation only and thus a private key is not included in the resource.
See also https://ngrok.com/docs/api#api-certificate-authorities. -
Upload a new Certificate Authority
Upload a new Certificate Authority
See also https://ngrok.com/docs/api#api-certificate-authorities-create. -
raw PEM of the Certificate Authority
human-readable description of this Certificate Authority. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
Delete a Certificate Authority
Delete a Certificate Authority
See also https://ngrok.com/docs/api#api-certificate-authorities-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about a certficate authority
Get detailed information about a certficate authority
See also https://ngrok.com/docs/api#api-certificate-authorities-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all Certificate Authority on this account
List all Certificate Authority on this account
See also https://ngrok.com/docs/api#api-certificate-authorities-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update attributes of a Certificate Authority by ID
Update attributes of a Certificate Authority by ID
See also https://ngrok.com/docs/api#api-certificate-authorities-update. -
the value of the id parameter as a scala.Predef.String
human-readable description of this Certificate Authority. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Upload a new Certificate Authority
Upload a new Certificate Authority
See also https://ngrok.com/docs/api#api-certificate-authorities-create. +
raw PEM of the Certificate Authority
human-readable description of this Certificate Authority. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
Delete a Certificate Authority
Delete a Certificate Authority
See also https://ngrok.com/docs/api#api-certificate-authorities-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about a certficate authority
Get detailed information about a certficate authority
See also https://ngrok.com/docs/api#api-certificate-authorities-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all Certificate Authority on this account
List all Certificate Authority on this account
See also https://ngrok.com/docs/api#api-certificate-authorities-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update attributes of a Certificate Authority by ID
Update attributes of a Certificate Authority by ID
See also https://ngrok.com/docs/api#api-certificate-authorities-update. +
the value of the id parameter as a scala.Predef.String
human-readable description of this Certificate Authority. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok +
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.
See also https://ngrok.com/docs/api#api-credentials. -
Create a new tunnel authtoken credential.
Create a new tunnel authtoken credential. This authtoken credential can be used +
Create a new tunnel authtoken credential.
Create a new tunnel authtoken credential. This authtoken credential can be used to start a new tunnel session. The response to this API call is the only time the generated token is available. If you need it for future use, you must save it securely yourself.
See also https://ngrok.com/docs/api#api-credentials-create. -
human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
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.
a scala.concurrent.Future encapsulating the API call's result
Delete a tunnel authtoken credential by ID
Delete a tunnel authtoken credential by ID
See also https://ngrok.com/docs/api#api-credentials-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about a tunnel authtoken credential
Get detailed information about a tunnel authtoken credential
See also https://ngrok.com/docs/api#api-credentials-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all tunnel authtoken credentials on this account
List all tunnel authtoken credentials on this account
See also https://ngrok.com/docs/api#api-credentials-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update attributes of an tunnel authtoken credential by ID
Update attributes of an tunnel authtoken credential by ID
See also https://ngrok.com/docs/api#api-credentials-update. -
the value of the id parameter as a scala.Predef.String
human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
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.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
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.
a scala.concurrent.Future encapsulating the API call's result
Delete a tunnel authtoken credential by ID
Delete a tunnel authtoken credential by ID
See also https://ngrok.com/docs/api#api-credentials-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about a tunnel authtoken credential
Get detailed information about a tunnel authtoken credential
See also https://ngrok.com/docs/api#api-credentials-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all tunnel authtoken credentials on this account
List all tunnel authtoken credentials on this account
See also https://ngrok.com/docs/api#api-credentials-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update attributes of an tunnel authtoken credential by ID
Update attributes of an tunnel authtoken credential by ID
See also https://ngrok.com/docs/api#api-credentials-update. +
the value of the id parameter as a scala.Predef.String
human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
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.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgeRouteBackendModule.
See also https://ngrok.com/docs/api#api-edge-route-backend-module. -
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-edge-route-backend-module-delete. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-edge-route-backend-module-get. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-edge-route-backend-module-replace. -
the value of the edge_id parameter as a scala.Predef.String
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointBackendMutate
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgeRouteBackendModule.
See also https://ngrok.com/docs/api#api-edge-route-backend-module. +
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-edge-route-backend-module-delete. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-edge-route-backend-module-get. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-edge-route-backend-module-replace. +
the value of the edge_id parameter as a scala.Predef.String
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointBackendMutate
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgeRouteCircuitBreakerModule.
See also https://ngrok.com/docs/api#api-edge-route-circuit-breaker-module. -
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-edge-route-circuit-breaker-module-delete. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-edge-route-circuit-breaker-module-get. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-edge-route-circuit-breaker-module-replace. -
the value of the edge_id parameter as a scala.Predef.String
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointCircuitBreaker
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgeRouteCircuitBreakerModule.
See also https://ngrok.com/docs/api#api-edge-route-circuit-breaker-module. +
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-edge-route-circuit-breaker-module-delete. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-edge-route-circuit-breaker-module-get. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-edge-route-circuit-breaker-module-replace. +
the value of the edge_id parameter as a scala.Predef.String
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointCircuitBreaker
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgeRouteCompressionModule.
See also https://ngrok.com/docs/api#api-edge-route-compression-module. -
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-edge-route-compression-module-delete. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-edge-route-compression-module-get. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-edge-route-compression-module-replace. -
the value of the edge_id parameter as a scala.Predef.String
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointCompression
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgeRouteCompressionModule.
See also https://ngrok.com/docs/api#api-edge-route-compression-module. +
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-edge-route-compression-module-delete. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-edge-route-compression-module-get. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-edge-route-compression-module-replace. +
the value of the edge_id parameter as a scala.Predef.String
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointCompression
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgeRouteIpRestrictionModule.
See also https://ngrok.com/docs/api#api-edge-route-ip-restriction-module. -
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-edge-route-ip-restriction-module-delete. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-edge-route-ip-restriction-module-get. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-edge-route-ip-restriction-module-replace. -
the value of the edge_id parameter as a scala.Predef.String
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointIpPolicyMutate
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgeRouteIpRestrictionModule.
See also https://ngrok.com/docs/api#api-edge-route-ip-restriction-module. +
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-edge-route-ip-restriction-module-delete. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-edge-route-ip-restriction-module-get. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-edge-route-ip-restriction-module-replace. +
the value of the edge_id parameter as a scala.Predef.String
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointIpPolicyMutate
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgeRouteOAuthModule.
See also https://ngrok.com/docs/api#api-edge-route-o-auth-module. -
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-edge-route-o-auth-module-delete. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-edge-route-o-auth-module-get. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-edge-route-o-auth-module-replace. -
the value of the edge_id parameter as a scala.Predef.String
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointOAuth
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgeRouteOAuthModule.
See also https://ngrok.com/docs/api#api-edge-route-o-auth-module. +
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-edge-route-o-auth-module-delete. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-edge-route-o-auth-module-get. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-edge-route-o-auth-module-replace. +
the value of the edge_id parameter as a scala.Predef.String
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointOAuth
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgeRouteOidcModule.
See also https://ngrok.com/docs/api#api-edge-route-oidc-module. -
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-edge-route-oidc-module-delete. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-edge-route-oidc-module-get. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-edge-route-oidc-module-replace. -
the value of the edge_id parameter as a scala.Predef.String
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointOidc
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgeRouteOidcModule.
See also https://ngrok.com/docs/api#api-edge-route-oidc-module. +
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-edge-route-oidc-module-delete. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-edge-route-oidc-module-get. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-edge-route-oidc-module-replace. +
the value of the edge_id parameter as a scala.Predef.String
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointOidc
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgeRouteRequestHeadersModule.
See also https://ngrok.com/docs/api#api-edge-route-request-headers-module. -
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-edge-route-request-headers-module-delete. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-edge-route-request-headers-module-get. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-edge-route-request-headers-module-replace. -
the value of the edge_id parameter as a scala.Predef.String
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointRequestHeaders
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgeRouteRequestHeadersModule.
See also https://ngrok.com/docs/api#api-edge-route-request-headers-module. +
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-edge-route-request-headers-module-delete. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-edge-route-request-headers-module-get. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-edge-route-request-headers-module-replace. +
the value of the edge_id parameter as a scala.Predef.String
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointRequestHeaders
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgeRouteResponseHeadersModule.
See also https://ngrok.com/docs/api#api-edge-route-response-headers-module. -
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-edge-route-response-headers-module-delete. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-edge-route-response-headers-module-get. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-edge-route-response-headers-module-replace. -
the value of the edge_id parameter as a scala.Predef.String
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointResponseHeaders
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgeRouteResponseHeadersModule.
See also https://ngrok.com/docs/api#api-edge-route-response-headers-module. +
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-edge-route-response-headers-module-delete. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-edge-route-response-headers-module-get. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-edge-route-response-headers-module-replace. +
the value of the edge_id parameter as a scala.Predef.String
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointResponseHeaders
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgeRouteSamlModule.
See also https://ngrok.com/docs/api#api-edge-route-saml-module. -
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-edge-route-saml-module-delete. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-edge-route-saml-module-get. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-edge-route-saml-module-replace. -
the value of the edge_id parameter as a scala.Predef.String
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointSamlMutate
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgeRouteSamlModule.
See also https://ngrok.com/docs/api#api-edge-route-saml-module. +
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-edge-route-saml-module-delete. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-edge-route-saml-module-get. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-edge-route-saml-module-replace. +
the value of the edge_id parameter as a scala.Predef.String
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointSamlMutate
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgeRouteWebhookVerificationModule.
See also https://ngrok.com/docs/api#api-edge-route-webhook-verification-module. -
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-edge-route-webhook-verification-module-delete. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-edge-route-webhook-verification-module-get. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-edge-route-webhook-verification-module-replace. -
the value of the edge_id parameter as a scala.Predef.String
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointWebhookValidation
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgeRouteWebhookVerificationModule.
See also https://ngrok.com/docs/api#api-edge-route-webhook-verification-module. +
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-edge-route-webhook-verification-module-delete. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-edge-route-webhook-verification-module-get. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-edge-route-webhook-verification-module-replace. +
the value of the edge_id parameter as a scala.Predef.String
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointWebhookValidation
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgeRouteWebsocketTcpConverterModule.
See also https://ngrok.com/docs/api#api-edge-route-websocket-tcp-converter-module. -
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-edge-route-websocket-tcp-converter-module-delete. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-edge-route-websocket-tcp-converter-module-get. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-edge-route-websocket-tcp-converter-module-replace. -
the value of the edge_id parameter as a scala.Predef.String
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointWebsocketTcpConverter
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgeRouteWebsocketTcpConverterModule.
See also https://ngrok.com/docs/api#api-edge-route-websocket-tcp-converter-module. +
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-edge-route-websocket-tcp-converter-module-delete. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-edge-route-websocket-tcp-converter-module-get. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-edge-route-websocket-tcp-converter-module-replace. +
the value of the edge_id parameter as a scala.Predef.String
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointWebsocketTcpConverter
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgesHttps.
See also https://ngrok.com/docs/api#api-edges-https. -
Create an HTTPS Edge
Create an HTTPS Edge
See also https://ngrok.com/docs/api#api-edges-https-create. -
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes.
hostports served by this edge
edge modules
the value of the tls_termination parameter as a EndpointTlsTerminationAtEdge
a scala.concurrent.Future encapsulating the API call's result
Delete an HTTPS Edge by ID
Delete an HTTPS Edge by ID
See also https://ngrok.com/docs/api#api-edges-https-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get an HTTPS Edge by ID
Get an HTTPS Edge by ID
See also https://ngrok.com/docs/api#api-edges-https-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Returns a list of all HTTPS Edges on this account
Returns a list of all HTTPS Edges on this account
See also https://ngrok.com/docs/api#api-edges-https-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Updates an HTTPS Edge by ID.
Updates an HTTPS Edge by ID. If a module is not specified in the update, it will +
An API client for EdgesHttps.
See also https://ngrok.com/docs/api#api-edges-https. +
Create an HTTPS Edge
Create an HTTPS Edge
See also https://ngrok.com/docs/api#api-edges-https-create. +
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes.
hostports served by this edge
edge modules
the value of the tls_termination parameter as a EndpointTlsTerminationAtEdge
a scala.concurrent.Future encapsulating the API call's result
Delete an HTTPS Edge by ID
Delete an HTTPS Edge by ID
See also https://ngrok.com/docs/api#api-edges-https-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get an HTTPS Edge by ID
Get an HTTPS Edge by ID
See also https://ngrok.com/docs/api#api-edges-https-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Returns a list of all HTTPS Edges on this account
Returns a list of all HTTPS Edges on this account
See also https://ngrok.com/docs/api#api-edges-https-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Updates an HTTPS Edge by ID.
Updates an HTTPS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
See also https://ngrok.com/docs/api#api-edges-https-update. -
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes.
hostports served by this edge
edge modules
the value of the tls_termination parameter as a EndpointTlsTerminationAtEdge
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes.
hostports served by this edge
edge modules
the value of the tls_termination parameter as a EndpointTlsTerminationAtEdge
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgesHttpsRoutes.
See also https://ngrok.com/docs/api#api-edges-https-routes. -
Create an HTTPS Edge Route
Create an HTTPS Edge Route
See also https://ngrok.com/docs/api#api-edges-https-routes-create. -
unique identifier of this edge
Type of match to use for this route. Valid values are "exact_path" and "path_prefix".
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
backend module configuration or null
ip restriction module configuration or null
circuit breaker module configuration or null
compression module configuration or null
request headers module configuration or null
response headers module configuration or null
webhook verification module configuration or null
oauth module configuration or null
saml module configuration or null
oidc module configuration or null
websocket to tcp adapter configuration or null
a scala.concurrent.Future encapsulating the API call's result
Delete an HTTPS Edge Route by ID
Delete an HTTPS Edge Route by ID
See also https://ngrok.com/docs/api#api-edges-https-routes-delete. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Get an HTTPS Edge Route by ID
Get an HTTPS Edge Route by ID
See also https://ngrok.com/docs/api#api-edges-https-routes-get. -
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Updates an HTTPS Edge Route by ID.
Updates an HTTPS Edge Route by ID. If a module is not specified in the update, +
An API client for EdgesHttpsRoutes.
See also https://ngrok.com/docs/api#api-edges-https-routes. +
Create an HTTPS Edge Route
Create an HTTPS Edge Route
See also https://ngrok.com/docs/api#api-edges-https-routes-create. +
unique identifier of this edge
Type of match to use for this route. Valid values are "exact_path" and "path_prefix".
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
backend module configuration or null
ip restriction module configuration or null
circuit breaker module configuration or null
compression module configuration or null
request headers module configuration or null
response headers module configuration or null
webhook verification module configuration or null
oauth module configuration or null
saml module configuration or null
oidc module configuration or null
websocket to tcp adapter configuration or null
a scala.concurrent.Future encapsulating the API call's result
Delete an HTTPS Edge Route by ID
Delete an HTTPS Edge Route by ID
See also https://ngrok.com/docs/api#api-edges-https-routes-delete. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Get an HTTPS Edge Route by ID
Get an HTTPS Edge Route by ID
See also https://ngrok.com/docs/api#api-edges-https-routes-get. +
unique identifier of this edge
unique identifier of this edge route
a scala.concurrent.Future encapsulating the API call's result
Updates an HTTPS Edge Route by ID.
Updates an HTTPS Edge Route by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
See also https://ngrok.com/docs/api#api-edges-https-routes-update. -
unique identifier of this edge
unique identifier of this edge route
Type of match to use for this route. Valid values are "exact_path" and "path_prefix".
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
backend module configuration or null
ip restriction module configuration or null
circuit breaker module configuration or null
compression module configuration or null
request headers module configuration or null
response headers module configuration or null
webhook verification module configuration or null
oauth module configuration or null
saml module configuration or null
oidc module configuration or null
websocket to tcp adapter configuration or null
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
unique identifier of this edge
unique identifier of this edge route
Type of match to use for this route. Valid values are "exact_path" and "path_prefix".
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
backend module configuration or null
ip restriction module configuration or null
circuit breaker module configuration or null
compression module configuration or null
request headers module configuration or null
response headers module configuration or null
webhook verification module configuration or null
oauth module configuration or null
saml module configuration or null
oidc module configuration or null
websocket to tcp adapter configuration or null
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgesTcp.
See also https://ngrok.com/docs/api#api-edges-tcp. -
Create a TCP Edge
Create a TCP Edge
See also https://ngrok.com/docs/api#api-edges-tcp-create. -
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
hostports served by this edge
edge modules
the value of the ip_restriction parameter as a EndpointIpPolicyMutate
a scala.concurrent.Future encapsulating the API call's result
Delete a TCP Edge by ID
Delete a TCP Edge by ID
See also https://ngrok.com/docs/api#api-edges-tcp-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get a TCP Edge by ID
Get a TCP Edge by ID
See also https://ngrok.com/docs/api#api-edges-tcp-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Returns a list of all TCP Edges on this account
Returns a list of all TCP Edges on this account
See also https://ngrok.com/docs/api#api-edges-tcp-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Updates a TCP Edge by ID.
Updates a TCP Edge by ID. If a module is not specified in the update, it will +
An API client for EdgesTcp.
See also https://ngrok.com/docs/api#api-edges-tcp. +
Create a TCP Edge
Create a TCP Edge
See also https://ngrok.com/docs/api#api-edges-tcp-create. +
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
hostports served by this edge
edge modules
the value of the ip_restriction parameter as a EndpointIpPolicyMutate
a scala.concurrent.Future encapsulating the API call's result
Delete a TCP Edge by ID
Delete a TCP Edge by ID
See also https://ngrok.com/docs/api#api-edges-tcp-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get a TCP Edge by ID
Get a TCP Edge by ID
See also https://ngrok.com/docs/api#api-edges-tcp-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Returns a list of all TCP Edges on this account
Returns a list of all TCP Edges on this account
See also https://ngrok.com/docs/api#api-edges-tcp-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Updates a TCP Edge by ID.
Updates a TCP Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
See also https://ngrok.com/docs/api#api-edges-tcp-update. -
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
hostports served by this edge
edge modules
the value of the ip_restriction parameter as a EndpointIpPolicyMutate
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
hostports served by this edge
edge modules
the value of the ip_restriction parameter as a EndpointIpPolicyMutate
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EdgesTls.
See also https://ngrok.com/docs/api#api-edges-tls. -
Create a TLS Edge
Create a TLS Edge
See also https://ngrok.com/docs/api#api-edges-tls-create. -
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
hostports served by this edge
edge modules
the value of the ip_restriction parameter as a EndpointIpPolicyMutate
the value of the mutual_tls parameter as a EndpointMutualTlsMutate
the value of the tls_termination parameter as a EndpointTlsTermination
a scala.concurrent.Future encapsulating the API call's result
Delete a TLS Edge by ID
Delete a TLS Edge by ID
See also https://ngrok.com/docs/api#api-edges-tls-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get a TLS Edge by ID
Get a TLS Edge by ID
See also https://ngrok.com/docs/api#api-edges-tls-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Returns a list of all TLS Edges on this account
Returns a list of all TLS Edges on this account
See also https://ngrok.com/docs/api#api-edges-tls-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Updates a TLS Edge by ID.
Updates a TLS Edge by ID. If a module is not specified in the update, it will +
An API client for EdgesTls.
See also https://ngrok.com/docs/api#api-edges-tls. +
Create a TLS Edge
Create a TLS Edge
See also https://ngrok.com/docs/api#api-edges-tls-create. +
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
hostports served by this edge
edge modules
the value of the ip_restriction parameter as a EndpointIpPolicyMutate
the value of the mutual_tls parameter as a EndpointMutualTlsMutate
the value of the tls_termination parameter as a EndpointTlsTermination
a scala.concurrent.Future encapsulating the API call's result
Delete a TLS Edge by ID
Delete a TLS Edge by ID
See also https://ngrok.com/docs/api#api-edges-tls-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get a TLS Edge by ID
Get a TLS Edge by ID
See also https://ngrok.com/docs/api#api-edges-tls-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Returns a list of all TLS Edges on this account
Returns a list of all TLS Edges on this account
See also https://ngrok.com/docs/api#api-edges-tls-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Updates a TLS Edge by ID.
Updates a TLS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
See also https://ngrok.com/docs/api#api-edges-tls-update. -
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
hostports served by this edge
edge modules
the value of the ip_restriction parameter as a EndpointIpPolicyMutate
the value of the mutual_tls parameter as a EndpointMutualTlsMutate
the value of the tls_termination parameter as a EndpointTlsTermination
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
unique identifier of this edge
human-readable description of what this edge will be used for; optional, max 255 bytes.
arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
hostports served by this edge
edge modules
the value of the ip_restriction parameter as a EndpointIpPolicyMutate
the value of the mutual_tls parameter as a EndpointMutualTlsMutate
the value of the tls_termination parameter as a EndpointTlsTermination
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Endpoints provides an API for querying the endpoint objects +
Endpoints provides an API for querying the endpoint objects which define what tunnel or edge is used to serve a hostport. Only active endpoints associated with a tunnel or backend are returned.
See also https://ngrok.com/docs/api#api-endpoints. -
Get the status of an endpoint by ID
Get the status of an endpoint by ID
See also https://ngrok.com/docs/api#api-endpoints-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all active endpoints on the account
List all active endpoints on the account
See also https://ngrok.com/docs/api#api-endpoints-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Get the status of an endpoint by ID
Get the status of an endpoint by ID
See also https://ngrok.com/docs/api#api-endpoints-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all active endpoints on the account
List all active endpoints on the account
See also https://ngrok.com/docs/api#api-endpoints-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EventDestinations.
See also https://ngrok.com/docs/api#api-event-destinations. -
Create a new Event Destination.
Create a new Event Destination. It will not apply to anything until it is +
An API client for EventDestinations.
See also https://ngrok.com/docs/api#api-event-destinations. +
Create a new Event Destination.
Create a new Event Destination. It will not apply to anything until it is associated with an Event Stream, and that Event Stream is associated with an Endpoint Config.
See also https://ngrok.com/docs/api#api-event-destinations-create. -
Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
Human-readable description of the Event Destination. Optional, max 255 bytes.
The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
a scala.concurrent.Future encapsulating the API call's result
Delete an Event Destination.
Delete an Event Destination. If the Event Destination is still referenced by an +
Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
Human-readable description of the Event Destination. Optional, max 255 bytes.
The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
a scala.concurrent.Future encapsulating the API call's result
Delete an Event Destination.
Delete an Event Destination. If the Event Destination is still referenced by an Event Subscription.
See also https://ngrok.com/docs/api#api-event-destinations-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about an Event Destination by ID.
Get detailed information about an Event Destination by ID.
See also https://ngrok.com/docs/api#api-event-destinations-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all Event Destinations on this account.
List all Event Destinations on this account.
See also https://ngrok.com/docs/api#api-event-destinations-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update attributes of an Event Destination.
Update attributes of an Event Destination.
See also https://ngrok.com/docs/api#api-event-destinations-update. -
Unique identifier for this Event Destination.
Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
Human-readable description of the Event Destination. Optional, max 255 bytes.
The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about an Event Destination by ID.
Get detailed information about an Event Destination by ID.
See also https://ngrok.com/docs/api#api-event-destinations-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all Event Destinations on this account.
List all Event Destinations on this account.
See also https://ngrok.com/docs/api#api-event-destinations-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update attributes of an Event Destination.
Update attributes of an Event Destination.
See also https://ngrok.com/docs/api#api-event-destinations-update. +
Unique identifier for this Event Destination.
Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.
Human-readable description of the Event Destination. Optional, max 255 bytes.
The output format you would like to serialize events into when sending to their target. Currently the only accepted value is JSON.
An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: kinesis, firehose, cloudwatch_logs, or s3.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EventSources.
See also https://ngrok.com/docs/api#api-event-sources. -
Add an additional type for which this event subscription will trigger
Add an additional type for which this event subscription will trigger
See also https://ngrok.com/docs/api#api-event-sources-create. -
The unique identifier for the Event Subscription that this Event Source is attached to.
a scala.concurrent.Future encapsulating the API call's result
Remove a type for which this event subscription will trigger
Remove a type for which this event subscription will trigger
See also https://ngrok.com/docs/api#api-event-sources-delete. -
The unique identifier for the Event Subscription that this Event Source is attached to.
a scala.concurrent.Future encapsulating the API call's result
Get the details for a given type that triggers for the given event subscription
Get the details for a given type that triggers for the given event subscription
See also https://ngrok.com/docs/api#api-event-sources-get. -
The unique identifier for the Event Subscription that this Event Source is attached to.
a scala.concurrent.Future encapsulating the API call's result
List the types for which this event subscription will trigger
List the types for which this event subscription will trigger
See also https://ngrok.com/docs/api#api-event-sources-list. -
The unique identifier for the Event Subscription that this Event Source is attached to.
a scala.concurrent.Future encapsulating the API call's result
Update the type for which this event subscription will trigger
Update the type for which this event subscription will trigger
See also https://ngrok.com/docs/api#api-event-sources-update. -
The unique identifier for the Event Subscription that this Event Source is attached to.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EventSources.
See also https://ngrok.com/docs/api#api-event-sources. +
Add an additional type for which this event subscription will trigger
Add an additional type for which this event subscription will trigger
See also https://ngrok.com/docs/api#api-event-sources-create. +
The unique identifier for the Event Subscription that this Event Source is attached to.
a scala.concurrent.Future encapsulating the API call's result
Remove a type for which this event subscription will trigger
Remove a type for which this event subscription will trigger
See also https://ngrok.com/docs/api#api-event-sources-delete. +
The unique identifier for the Event Subscription that this Event Source is attached to.
a scala.concurrent.Future encapsulating the API call's result
Get the details for a given type that triggers for the given event subscription
Get the details for a given type that triggers for the given event subscription
See also https://ngrok.com/docs/api#api-event-sources-get. +
The unique identifier for the Event Subscription that this Event Source is attached to.
a scala.concurrent.Future encapsulating the API call's result
List the types for which this event subscription will trigger
List the types for which this event subscription will trigger
See also https://ngrok.com/docs/api#api-event-sources-list. +
The unique identifier for the Event Subscription that this Event Source is attached to.
a scala.concurrent.Future encapsulating the API call's result
Update the type for which this event subscription will trigger
Update the type for which this event subscription will trigger
See also https://ngrok.com/docs/api#api-event-sources-update. +
The unique identifier for the Event Subscription that this Event Source is attached to.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EventSubscriptions.
See also https://ngrok.com/docs/api#api-event-subscriptions. -
Create an Event Subscription.
Create an Event Subscription.
See also https://ngrok.com/docs/api#api-event-subscriptions-create. -
Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
Sources containing the types for which this event subscription will trigger
A list of Event Destination IDs which should be used for this Event Subscription.
a scala.concurrent.Future encapsulating the API call's result
Delete an Event Subscription.
Delete an Event Subscription.
See also https://ngrok.com/docs/api#api-event-subscriptions-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get an Event Subscription by ID.
Get an Event Subscription by ID.
See also https://ngrok.com/docs/api#api-event-subscriptions-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List this Account's Event Subscriptions.
List this Account's Event Subscriptions.
See also https://ngrok.com/docs/api#api-event-subscriptions-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update an Event Subscription.
Update an Event Subscription.
See also https://ngrok.com/docs/api#api-event-subscriptions-update. -
Unique identifier for this Event Subscription.
Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
Sources containing the types for which this event subscription will trigger
A list of Event Destination IDs which should be used for this Event Subscription.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for EventSubscriptions.
See also https://ngrok.com/docs/api#api-event-subscriptions. +
Create an Event Subscription.
Create an Event Subscription.
See also https://ngrok.com/docs/api#api-event-subscriptions-create. +
Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
Sources containing the types for which this event subscription will trigger
A list of Event Destination IDs which should be used for this Event Subscription.
a scala.concurrent.Future encapsulating the API call's result
Delete an Event Subscription.
Delete an Event Subscription.
See also https://ngrok.com/docs/api#api-event-subscriptions-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get an Event Subscription by ID.
Get an Event Subscription by ID.
See also https://ngrok.com/docs/api#api-event-subscriptions-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List this Account's Event Subscriptions.
List this Account's Event Subscriptions.
See also https://ngrok.com/docs/api#api-event-subscriptions-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update an Event Subscription.
Update an Event Subscription.
See also https://ngrok.com/docs/api#api-event-subscriptions-update. +
Unique identifier for this Event Subscription.
Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.
Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.
Sources containing the types for which this event subscription will trigger
A list of Event Destination IDs which should be used for this Event Subscription.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A Failover backend defines failover behavior within a list of referenced +
A Failover backend defines failover behavior within a list of referenced backends. Traffic is sent to the first backend in the list. If that backend is offline or no connection can be established, ngrok attempts to connect to the next backend in the list until one is successful.
See also https://ngrok.com/docs/api#api-failover-backends. -
Create a new Failover backend
Create a new Failover backend
See also https://ngrok.com/docs/api#api-failover-backends-create. -
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
the ids of the child backends in order
a scala.concurrent.Future encapsulating the API call's result
Delete a Failover backend by ID.
Delete a Failover backend by ID.
See also https://ngrok.com/docs/api#api-failover-backends-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about a Failover backend by ID
Get detailed information about a Failover backend by ID
See also https://ngrok.com/docs/api#api-failover-backends-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all Failover backends on this account
List all Failover backends on this account
See also https://ngrok.com/docs/api#api-failover-backends-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update Failover backend by ID
Update Failover backend by ID
See also https://ngrok.com/docs/api#api-failover-backends-update. -
the value of the id parameter as a scala.Predef.String
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
the ids of the child backends in order
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Create a new Failover backend
Create a new Failover backend
See also https://ngrok.com/docs/api#api-failover-backends-create. +
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
the ids of the child backends in order
a scala.concurrent.Future encapsulating the API call's result
Delete a Failover backend by ID.
Delete a Failover backend by ID.
See also https://ngrok.com/docs/api#api-failover-backends-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about a Failover backend by ID
Get detailed information about a Failover backend by ID
See also https://ngrok.com/docs/api#api-failover-backends-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all Failover backends on this account
List all Failover backends on this account
See also https://ngrok.com/docs/api#api-failover-backends-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update Failover backend by ID
Update Failover backend by ID
See also https://ngrok.com/docs/api#api-failover-backends-update. +
the value of the id parameter as a scala.Predef.String
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
the ids of the child backends in order
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for HttpResponseBackends.
See also https://ngrok.com/docs/api#api-http-response-backends. -
Sends an API request for the Create operation.
Sends an API request for the Create operation.
See also https://ngrok.com/docs/api#api-http-response-backends-create. -
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
body to return as fixed content
headers to return
status code to return
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-http-response-backends-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-http-response-backends-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the List operation.
Sends an API request for the List operation.
See also https://ngrok.com/docs/api#api-http-response-backends-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Update operation.
Sends an API request for the Update operation.
See also https://ngrok.com/docs/api#api-http-response-backends-update. -
the value of the id parameter as a scala.Predef.String
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
body to return as fixed content
headers to return
status code to return
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for HttpResponseBackends.
See also https://ngrok.com/docs/api#api-http-response-backends. +
Sends an API request for the Create operation.
Sends an API request for the Create operation.
See also https://ngrok.com/docs/api#api-http-response-backends-create. +
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
body to return as fixed content
headers to return
status code to return
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-http-response-backends-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-http-response-backends-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the List operation.
Sends an API request for the List operation.
See also https://ngrok.com/docs/api#api-http-response-backends-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Update operation.
Sends an API request for the Update operation.
See also https://ngrok.com/docs/api#api-http-response-backends-update. +
the value of the id parameter as a scala.Predef.String
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
body to return as fixed content
headers to return
status code to return
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for HttpsEdgeMutualTlsModule.
See also https://ngrok.com/docs/api#api-https-edge-mutual-tls-module. -
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-https-edge-mutual-tls-module-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-https-edge-mutual-tls-module-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-https-edge-mutual-tls-module-replace. -
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointMutualTlsMutate
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for HttpsEdgeMutualTlsModule.
See also https://ngrok.com/docs/api#api-https-edge-mutual-tls-module. +
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-https-edge-mutual-tls-module-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-https-edge-mutual-tls-module-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-https-edge-mutual-tls-module-replace. +
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointMutualTlsMutate
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for HttpsEdgeTlsTerminationModule.
See also https://ngrok.com/docs/api#api-https-edge-tls-termination-module. -
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-https-edge-tls-termination-module-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-https-edge-tls-termination-module-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-https-edge-tls-termination-module-replace. -
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointTlsTerminationAtEdge
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for HttpsEdgeTlsTerminationModule.
See also https://ngrok.com/docs/api#api-https-edge-tls-termination-module. +
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-https-edge-tls-termination-module-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-https-edge-tls-termination-module-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-https-edge-tls-termination-module-replace. +
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointTlsTerminationAtEdge
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
IP Policies are reusable groups of CIDR ranges with an allow or
+
IP Policies are reusable groups of CIDR ranges with an allow or
deny
action. They can be attached to endpoints via the Endpoint Configuration IP
Policy module. They can also be used with IP Restrictions to control source
IP ranges that can start tunnel sessions and connect to the API and dashboard.
See also https://ngrok.com/docs/api#api-ip-policies. -
Create a new IP policy.
Create a new IP policy. It will not apply to any traffic until you associate to +
Create a new IP policy.
Create a new IP policy. It will not apply to any traffic until you associate to a traffic source via an endpoint configuration or IP restriction.
See also https://ngrok.com/docs/api#api-ip-policies-create. -
human-readable description of the source IPs of this IP policy. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
Delete an IP policy.
Delete an IP policy. If the IP policy is referenced by another object for the +
human-readable description of the source IPs of this IP policy. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
Delete an IP policy.
Delete an IP policy. If the IP policy is referenced by another object for the purposes of traffic restriction it will be treated as if the IP policy remains but has zero rules.
See also https://ngrok.com/docs/api#api-ip-policies-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about an IP policy by ID.
Get detailed information about an IP policy by ID.
See also https://ngrok.com/docs/api#api-ip-policies-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all IP policies on this account
List all IP policies on this account
See also https://ngrok.com/docs/api#api-ip-policies-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update attributes of an IP policy by ID
Update attributes of an IP policy by ID
See also https://ngrok.com/docs/api#api-ip-policies-update. -
the value of the id parameter as a scala.Predef.String
human-readable description of the source IPs of this IP policy. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about an IP policy by ID.
Get detailed information about an IP policy by ID.
See also https://ngrok.com/docs/api#api-ip-policies-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all IP policies on this account
List all IP policies on this account
See also https://ngrok.com/docs/api#api-ip-policies-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update attributes of an IP policy by ID
Update attributes of an IP policy by ID
See also https://ngrok.com/docs/api#api-ip-policies-update. +
the value of the id parameter as a scala.Predef.String
human-readable description of the source IPs of this IP policy. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
IP Policy Rules are the IPv4 or IPv6 CIDRs entries that +
IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.
See also https://ngrok.com/docs/api#api-ip-policy-rules. -
Create a new IP policy rule attached to an IP Policy.
Create a new IP policy rule attached to an IP Policy.
See also https://ngrok.com/docs/api#api-ip-policy-rules-create. -
an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
ID of the IP policy this IP policy rule will be attached to
human-readable description of the source IPs of this IP rule. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.
the action to apply to the policy rule, either allow or deny
a scala.concurrent.Future encapsulating the API call's result
Delete an IP policy rule.
Delete an IP policy rule.
See also https://ngrok.com/docs/api#api-ip-policy-rules-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about an IP policy rule by ID.
Get detailed information about an IP policy rule by ID.
See also https://ngrok.com/docs/api#api-ip-policy-rules-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all IP policy rules on this account
List all IP policy rules on this account
See also https://ngrok.com/docs/api#api-ip-policy-rules-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update attributes of an IP policy rule by ID
Update attributes of an IP policy rule by ID
See also https://ngrok.com/docs/api#api-ip-policy-rules-update. -
the value of the id parameter as a scala.Predef.String
human-readable description of the source IPs of this IP rule. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.
an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Create a new IP policy rule attached to an IP Policy.
Create a new IP policy rule attached to an IP Policy.
See also https://ngrok.com/docs/api#api-ip-policy-rules-create. +
an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
ID of the IP policy this IP policy rule will be attached to
the action to apply to the policy rule, either allow or deny
human-readable description of the source IPs of this IP rule. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
Delete an IP policy rule.
Delete an IP policy rule.
See also https://ngrok.com/docs/api#api-ip-policy-rules-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about an IP policy rule by ID.
Get detailed information about an IP policy rule by ID.
See also https://ngrok.com/docs/api#api-ip-policy-rules-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all IP policy rules on this account
List all IP policy rules on this account
See also https://ngrok.com/docs/api#api-ip-policy-rules-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update attributes of an IP policy rule by ID
Update attributes of an IP policy rule by ID
See also https://ngrok.com/docs/api#api-ip-policy-rules-update. +
the value of the id parameter as a scala.Predef.String
human-readable description of the source IPs of this IP rule. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.
an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An IP restriction is a restriction placed on the CIDRs that are allowed to +
An IP restriction is a restriction placed on the CIDRs that are allowed to initiate traffic to a specific aspect of your ngrok account. An IP restriction has a type which defines the ingress it applies to. IP restrictions can be used to enforce the source IPs that can make API requests, log in to the dashboard, start ngrok agents, and connect to your public-facing endpoints.
See also https://ngrok.com/docs/api#api-ip-restrictions. -
Create a new IP restriction
Create a new IP restriction
See also https://ngrok.com/docs/api#api-ip-restrictions-create. -
the set of IP policy identifiers that are used to enforce the restriction
human-readable description of this IP restriction. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
true if the IP restriction will be enforced. if false, only warnings will be issued
a scala.concurrent.Future encapsulating the API call's result
Delete an IP restriction
Delete an IP restriction
See also https://ngrok.com/docs/api#api-ip-restrictions-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about an IP restriction
Get detailed information about an IP restriction
See also https://ngrok.com/docs/api#api-ip-restrictions-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all IP restrictions on this account
List all IP restrictions on this account
See also https://ngrok.com/docs/api#api-ip-restrictions-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update attributes of an IP restriction by ID
Update attributes of an IP restriction by ID
See also https://ngrok.com/docs/api#api-ip-restrictions-update. -
the value of the id parameter as a scala.Predef.String
human-readable description of this IP restriction. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
true if the IP restriction will be enforced. if false, only warnings will be issued
the set of IP policy identifiers that are used to enforce the restriction
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Create a new IP restriction
Create a new IP restriction
See also https://ngrok.com/docs/api#api-ip-restrictions-create. +
the set of IP policy identifiers that are used to enforce the restriction
human-readable description of this IP restriction. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
true if the IP restriction will be enforced. if false, only warnings will be issued
a scala.concurrent.Future encapsulating the API call's result
Delete an IP restriction
Delete an IP restriction
See also https://ngrok.com/docs/api#api-ip-restrictions-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about an IP restriction
Get detailed information about an IP restriction
See also https://ngrok.com/docs/api#api-ip-restrictions-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all IP restrictions on this account
List all IP restrictions on this account
See also https://ngrok.com/docs/api#api-ip-restrictions-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update attributes of an IP restriction by ID
Update attributes of an IP restriction by ID
See also https://ngrok.com/docs/api#api-ip-restrictions-update. +
the value of the id parameter as a scala.Predef.String
human-readable description of this IP restriction. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
true if the IP restriction will be enforced. if false, only warnings will be issued
the set of IP policy identifiers that are used to enforce the restriction
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Reserved Addresses are TCP addresses that can be used to listen for traffic. +
Reserved Addresses are TCP addresses that can be used to listen for traffic. TCP address hostnames and ports are assigned by ngrok, they cannot be chosen.
See also https://ngrok.com/docs/api#api-reserved-addrs. -
Create a new reserved address.
Create a new reserved address.
See also https://ngrok.com/docs/api#api-reserved-addrs-create. -
human-readable description of what this reserved address will be used for
arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
a scala.concurrent.Future encapsulating the API call's result
Delete a reserved address.
Delete a reserved address.
See also https://ngrok.com/docs/api#api-reserved-addrs-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get the details of a reserved address.
Get the details of a reserved address.
See also https://ngrok.com/docs/api#api-reserved-addrs-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all reserved addresses on this account.
List all reserved addresses on this account.
See also https://ngrok.com/docs/api#api-reserved-addrs-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update the attributes of a reserved address.
Update the attributes of a reserved address.
See also https://ngrok.com/docs/api#api-reserved-addrs-update. -
the value of the id parameter as a scala.Predef.String
human-readable description of what this reserved address will be used for
arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Create a new reserved address.
Create a new reserved address.
See also https://ngrok.com/docs/api#api-reserved-addrs-create. +
human-readable description of what this reserved address will be used for
arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
a scala.concurrent.Future encapsulating the API call's result
Delete a reserved address.
Delete a reserved address.
See also https://ngrok.com/docs/api#api-reserved-addrs-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get the details of a reserved address.
Get the details of a reserved address.
See also https://ngrok.com/docs/api#api-reserved-addrs-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all reserved addresses on this account.
List all reserved addresses on this account.
See also https://ngrok.com/docs/api#api-reserved-addrs-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update the attributes of a reserved address.
Update the attributes of a reserved address.
See also https://ngrok.com/docs/api#api-reserved-addrs-update. +
the value of the id parameter as a scala.Predef.String
human-readable description of what this reserved address will be used for
arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Reserved Domains are hostnames that you can listen for traffic on. Domains +
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.
See also https://ngrok.com/docs/api#api-reserved-domains. -
Create a new reserved domain.
Create a new reserved domain.
See also https://ngrok.com/docs/api#api-reserved-domains-create. -
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.
reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
human-readable description of what this reserved domain will be used for
arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with certificate_id.
a scala.concurrent.Future encapsulating the API call's result
Delete a reserved domain.
Delete a reserved domain.
See also https://ngrok.com/docs/api#api-reserved-domains-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Detach the certificate attached to a reserved domain.
Detach the certificate attached to a reserved domain.
See also https://ngrok.com/docs/api#api-reserved-domains-delete-certificate. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Detach the certificate management policy attached to a reserved domain.
Detach the certificate management policy attached to a reserved domain.
See also https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get the details of a reserved domain.
Get the details of a reserved domain.
See also https://ngrok.com/docs/api#api-reserved-domains-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all reserved domains on this account.
List all reserved domains on this account.
See also https://ngrok.com/docs/api#api-reserved-domains-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update the attributes of a reserved domain.
Update the attributes of a reserved domain.
See also https://ngrok.com/docs/api#api-reserved-domains-update. -
the value of the id parameter as a scala.Predef.String
human-readable description of what this reserved domain will be used for
arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with certificate_id.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
See also https://ngrok.com/docs/api#api-reserved-domains. +
Create a new reserved domain.
Create a new reserved domain.
See also https://ngrok.com/docs/api#api-reserved-domains-create. +
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.
reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
human-readable description of what this reserved domain will be used for
arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with certificate_id.
a scala.concurrent.Future encapsulating the API call's result
Delete a reserved domain.
Delete a reserved domain.
See also https://ngrok.com/docs/api#api-reserved-domains-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Detach the certificate attached to a reserved domain.
Detach the certificate attached to a reserved domain.
See also https://ngrok.com/docs/api#api-reserved-domains-delete-certificate. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Detach the certificate management policy attached to a reserved domain.
Detach the certificate management policy attached to a reserved domain.
See also https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get the details of a reserved domain.
Get the details of a reserved domain.
See also https://ngrok.com/docs/api#api-reserved-domains-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all reserved domains on this account.
List all reserved domains on this account.
See also https://ngrok.com/docs/api#api-reserved-domains-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update the attributes of a reserved domain.
Update the attributes of a reserved domain.
See also https://ngrok.com/docs/api#api-reserved-domains-update. +
the value of the id parameter as a scala.Predef.String
human-readable description of what this reserved domain will be used for
arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with certificate_management_policy.
configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with certificate_id.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An SSH Certificate Authority is a pair of an SSH Certificate and its private +
An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.
See also https://ngrok.com/docs/api#api-ssh-certificate-authorities. -
Create a new SSH Certificate Authority
Create a new SSH Certificate Authority
See also https://ngrok.com/docs/api#api-ssh-certificate-authorities-create. -
human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
the type of private key to generate. one of rsa, ecdsa, ed25519
the type of elliptic curve to use when creating an ECDSA key
the key size to use when creating an RSA key. one of 2048 or 4096
a scala.concurrent.Future encapsulating the API call's result
Delete an SSH Certificate Authority
Delete an SSH Certificate Authority
See also https://ngrok.com/docs/api#api-ssh-certificate-authorities-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about an SSH Certficate Authority
Get detailed information about an SSH Certficate Authority
See also https://ngrok.com/docs/api#api-ssh-certificate-authorities-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all SSH Certificate Authorities on this account
List all SSH Certificate Authorities on this account
See also https://ngrok.com/docs/api#api-ssh-certificate-authorities-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update an SSH Certificate Authority
Update an SSH Certificate Authority
See also https://ngrok.com/docs/api#api-ssh-certificate-authorities-update. -
the value of the id parameter as a scala.Predef.String
human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Create a new SSH Certificate Authority
Create a new SSH Certificate Authority
See also https://ngrok.com/docs/api#api-ssh-certificate-authorities-create. +
human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
the type of private key to generate. one of rsa, ecdsa, ed25519
the type of elliptic curve to use when creating an ECDSA key
the key size to use when creating an RSA key. one of 2048 or 4096
a scala.concurrent.Future encapsulating the API call's result
Delete an SSH Certificate Authority
Delete an SSH Certificate Authority
See also https://ngrok.com/docs/api#api-ssh-certificate-authorities-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about an SSH Certficate Authority
Get detailed information about an SSH Certficate Authority
See also https://ngrok.com/docs/api#api-ssh-certificate-authorities-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all SSH Certificate Authorities on this account
List all SSH Certificate Authorities on this account
See also https://ngrok.com/docs/api#api-ssh-certificate-authorities-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update an SSH Certificate Authority
Update an SSH Certificate Authority
See also https://ngrok.com/docs/api#api-ssh-certificate-authorities-update. +
the value of the id parameter as a scala.Predef.String
human-readable description of this SSH Certificate Authority. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH Certificate Authority. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
SSH Credentials are SSH public keys that can be used to start SSH tunnels +
SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.
See also https://ngrok.com/docs/api#api-ssh-credentials. -
Create a new ssh_credential from an uploaded public SSH key.
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.
See also https://ngrok.com/docs/api#api-ssh-credentials-create. -
the PEM-encoded public key of the SSH keypair that will be used to authenticate
human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.
arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
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.
a scala.concurrent.Future encapsulating the API call's result
Delete an ssh_credential by ID
Delete an ssh_credential by ID
See also https://ngrok.com/docs/api#api-ssh-credentials-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about an ssh_credential
Get detailed information about an ssh_credential
See also https://ngrok.com/docs/api#api-ssh-credentials-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all ssh credentials on this account
List all ssh credentials on this account
See also https://ngrok.com/docs/api#api-ssh-credentials-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update attributes of an ssh_credential by ID
Update attributes of an ssh_credential by ID
See also https://ngrok.com/docs/api#api-ssh-credentials-update. -
the value of the id parameter as a scala.Predef.String
human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.
arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
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.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Create a new ssh_credential from an uploaded public SSH key.
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.
See also https://ngrok.com/docs/api#api-ssh-credentials-create. +
the PEM-encoded public key of the SSH keypair that will be used to authenticate
human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.
arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
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.
a scala.concurrent.Future encapsulating the API call's result
Delete an ssh_credential by ID
Delete an ssh_credential by ID
See also https://ngrok.com/docs/api#api-ssh-credentials-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about an ssh_credential
Get detailed information about an ssh_credential
See also https://ngrok.com/docs/api#api-ssh-credentials-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all ssh credentials on this account
List all ssh credentials on this account
See also https://ngrok.com/docs/api#api-ssh-credentials-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update attributes of an ssh_credential by ID
Update attributes of an ssh_credential by ID
See also https://ngrok.com/docs/api#api-ssh-credentials-update. +
the value of the id parameter as a scala.Predef.String
human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.
arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
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.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
SSH Host Certificates along with the corresponding private key allows an SSH +
SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.
See also https://ngrok.com/docs/api#api-ssh-host-certificates. -
Create a new SSH Host Certificate
Create a new SSH Host Certificate
See also https://ngrok.com/docs/api#api-ssh-host-certificates-create. -
the ssh certificate authority that is used to sign this ssh host certificate
a public key in OpenSSH Authorized Keys format that this certificate signs
the list of principals included in the ssh host certificate. This is the list of hostnames and/or IP addresses that are authorized to serve SSH traffic with this certificate. Dangerously, if no principals are specified, this certificate is considered valid for all hosts.
The time when the host certificate becomes valid, in RFC 3339 format. Defaults to the current time if unspecified.
The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of one year in the future will be used. The OpenSSH certificates RFC calls this valid_before.
human-readable description of this SSH Host Certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
Delete an SSH Host Certificate
Delete an SSH Host Certificate
See also https://ngrok.com/docs/api#api-ssh-host-certificates-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about an SSH Host Certficate
Get detailed information about an SSH Host Certficate
See also https://ngrok.com/docs/api#api-ssh-host-certificates-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all SSH Host Certificates issued on this account
List all SSH Host Certificates issued on this account
See also https://ngrok.com/docs/api#api-ssh-host-certificates-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update an SSH Host Certificate
Update an SSH Host Certificate
See also https://ngrok.com/docs/api#api-ssh-host-certificates-update. -
the value of the id parameter as a scala.Predef.String
human-readable description of this SSH Host Certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Create a new SSH Host Certificate
Create a new SSH Host Certificate
See also https://ngrok.com/docs/api#api-ssh-host-certificates-create. +
the ssh certificate authority that is used to sign this ssh host certificate
a public key in OpenSSH Authorized Keys format that this certificate signs
the list of principals included in the ssh host certificate. This is the list of hostnames and/or IP addresses that are authorized to serve SSH traffic with this certificate. Dangerously, if no principals are specified, this certificate is considered valid for all hosts.
The time when the host certificate becomes valid, in RFC 3339 format. Defaults to the current time if unspecified.
The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of one year in the future will be used. The OpenSSH certificates RFC calls this valid_before.
human-readable description of this SSH Host Certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
Delete an SSH Host Certificate
Delete an SSH Host Certificate
See also https://ngrok.com/docs/api#api-ssh-host-certificates-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about an SSH Host Certficate
Get detailed information about an SSH Host Certficate
See also https://ngrok.com/docs/api#api-ssh-host-certificates-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all SSH Host Certificates issued on this account
List all SSH Host Certificates issued on this account
See also https://ngrok.com/docs/api#api-ssh-host-certificates-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update an SSH Host Certificate
Update an SSH Host Certificate
See also https://ngrok.com/docs/api#api-ssh-host-certificates-update. +
the value of the id parameter as a scala.Predef.String
human-readable description of this SSH Host Certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH Host Certificate. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
SSH User Certificates are presented by SSH clients when connecting to an SSH +
SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection. The SSH server must trust the SSH Certificate Authority used to sign the certificate.
See also https://ngrok.com/docs/api#api-ssh-user-certificates. -
Create a new SSH User Certificate
Create a new SSH User Certificate
See also https://ngrok.com/docs/api#api-ssh-user-certificates-create. -
the ssh certificate authority that is used to sign this ssh user certificate
a public key in OpenSSH Authorized Keys format that this certificate signs
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.
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.
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.
The time when the user certificate becomes valid, in RFC 3339 format. Defaults to the current time if unspecified.
The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of 24 hours will be used. The OpenSSH certificates RFC calls this valid_before.
human-readable description of this SSH User Certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
Delete an SSH User Certificate
Delete an SSH User Certificate
See also https://ngrok.com/docs/api#api-ssh-user-certificates-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about an SSH User Certficate
Get detailed information about an SSH User Certficate
See also https://ngrok.com/docs/api#api-ssh-user-certificates-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all SSH User Certificates issued on this account
List all SSH User Certificates issued on this account
See also https://ngrok.com/docs/api#api-ssh-user-certificates-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update an SSH User Certificate
Update an SSH User Certificate
See also https://ngrok.com/docs/api#api-ssh-user-certificates-update. -
the value of the id parameter as a scala.Predef.String
human-readable description of this SSH User Certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Create a new SSH User Certificate
Create a new SSH User Certificate
See also https://ngrok.com/docs/api#api-ssh-user-certificates-create. +
the ssh certificate authority that is used to sign this ssh user certificate
a public key in OpenSSH Authorized Keys format that this certificate signs
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.
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.
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.
The time when the user certificate becomes valid, in RFC 3339 format. Defaults to the current time if unspecified.
The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of 24 hours will be used. The OpenSSH certificates RFC calls this valid_before.
human-readable description of this SSH User Certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
Delete an SSH User Certificate
Delete an SSH User Certificate
See also https://ngrok.com/docs/api#api-ssh-user-certificates-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about an SSH User Certficate
Get detailed information about an SSH User Certficate
See also https://ngrok.com/docs/api#api-ssh-user-certificates-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all SSH User Certificates issued on this account
List all SSH User Certificates issued on this account
See also https://ngrok.com/docs/api#api-ssh-user-certificates-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update an SSH User Certificate
Update an SSH User Certificate
See also https://ngrok.com/docs/api#api-ssh-user-certificates-update. +
the value of the id parameter as a scala.Predef.String
human-readable description of this SSH User Certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this SSH User Certificate. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for TcpEdgeBackendModule.
See also https://ngrok.com/docs/api#api-tcp-edge-backend-module. -
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-tcp-edge-backend-module-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-tcp-edge-backend-module-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-tcp-edge-backend-module-replace. -
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointBackendMutate
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for TcpEdgeBackendModule.
See also https://ngrok.com/docs/api#api-tcp-edge-backend-module. +
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-tcp-edge-backend-module-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-tcp-edge-backend-module-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-tcp-edge-backend-module-replace. +
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointBackendMutate
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for TcpEdgeIpRestrictionModule.
See also https://ngrok.com/docs/api#api-tcp-edge-ip-restriction-module. -
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-tcp-edge-ip-restriction-module-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-tcp-edge-ip-restriction-module-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-tcp-edge-ip-restriction-module-replace. -
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointIpPolicyMutate
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for TcpEdgeIpRestrictionModule.
See also https://ngrok.com/docs/api#api-tcp-edge-ip-restriction-module. +
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-tcp-edge-ip-restriction-module-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-tcp-edge-ip-restriction-module-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-tcp-edge-ip-restriction-module-replace. +
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointIpPolicyMutate
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
TLS Certificates are pairs of x509 certificates and their matching private +
TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic. TLS certificates are unused until they are attached to a Domain. TLS Certificates may also be provisioned by ngrok automatically for domains on which you have enabled automated certificate provisioning.
See also https://ngrok.com/docs/api#api-tls-certificates. -
Upload a new TLS certificate
Upload a new TLS certificate
See also https://ngrok.com/docs/api#api-tls-certificates-create. -
chain of PEM-encoded certificates, leaf first. See Certificate Bundles.
private key for the TLS certificate, PEM-encoded. See Private Keys.
human-readable description of this TLS certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
Delete a TLS certificate
Delete a TLS certificate
See also https://ngrok.com/docs/api#api-tls-certificates-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about a TLS certificate
Get detailed information about a TLS certificate
See also https://ngrok.com/docs/api#api-tls-certificates-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all TLS certificates on this account
List all TLS certificates on this account
See also https://ngrok.com/docs/api#api-tls-certificates-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update attributes of a TLS Certificate by ID
Update attributes of a TLS Certificate by ID
See also https://ngrok.com/docs/api#api-tls-certificates-update. -
the value of the id parameter as a scala.Predef.String
human-readable description of this TLS certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Upload a new TLS certificate
Upload a new TLS certificate
See also https://ngrok.com/docs/api#api-tls-certificates-create. +
chain of PEM-encoded certificates, leaf first. See Certificate Bundles.
private key for the TLS certificate, PEM-encoded. See Private Keys.
human-readable description of this TLS certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
Delete a TLS certificate
Delete a TLS certificate
See also https://ngrok.com/docs/api#api-tls-certificates-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about a TLS certificate
Get detailed information about a TLS certificate
See also https://ngrok.com/docs/api#api-tls-certificates-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all TLS certificates on this account
List all TLS certificates on this account
See also https://ngrok.com/docs/api#api-tls-certificates-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update attributes of a TLS Certificate by ID
Update attributes of a TLS Certificate by ID
See also https://ngrok.com/docs/api#api-tls-certificates-update. +
the value of the id parameter as a scala.Predef.String
human-readable description of this TLS certificate. optional, max 255 bytes.
arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for TlsEdgeBackendModule.
See also https://ngrok.com/docs/api#api-tls-edge-backend-module. -
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-tls-edge-backend-module-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-tls-edge-backend-module-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-tls-edge-backend-module-replace. -
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointBackendMutate
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for TlsEdgeBackendModule.
See also https://ngrok.com/docs/api#api-tls-edge-backend-module. +
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-tls-edge-backend-module-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-tls-edge-backend-module-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-tls-edge-backend-module-replace. +
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointBackendMutate
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for TlsEdgeIpRestrictionModule.
See also https://ngrok.com/docs/api#api-tls-edge-ip-restriction-module. -
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-tls-edge-ip-restriction-module-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-tls-edge-ip-restriction-module-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-tls-edge-ip-restriction-module-replace. -
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointIpPolicyMutate
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for TlsEdgeIpRestrictionModule.
See also https://ngrok.com/docs/api#api-tls-edge-ip-restriction-module. +
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-tls-edge-ip-restriction-module-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-tls-edge-ip-restriction-module-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-tls-edge-ip-restriction-module-replace. +
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointIpPolicyMutate
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for TlsEdgeMutualTlsModule.
See also https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module. -
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module-replace. -
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointMutualTlsMutate
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for TlsEdgeMutualTlsModule.
See also https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module. +
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module-replace. +
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointMutualTlsMutate
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for TlsEdgeTlsTerminationModule.
See also https://ngrok.com/docs/api#api-tls-edge-tls-termination-module. -
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-tls-edge-tls-termination-module-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-tls-edge-tls-termination-module-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-tls-edge-tls-termination-module-replace. -
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointTlsTermination
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
An API client for TlsEdgeTlsTerminationModule.
See also https://ngrok.com/docs/api#api-tls-edge-tls-termination-module. +
Sends an API request for the Delete operation.
Sends an API request for the Delete operation.
See also https://ngrok.com/docs/api#api-tls-edge-tls-termination-module-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Get operation.
Sends an API request for the Get operation.
See also https://ngrok.com/docs/api#api-tls-edge-tls-termination-module-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Sends an API request for the Replace operation.
Sends an API request for the Replace operation.
See also https://ngrok.com/docs/api#api-tls-edge-tls-termination-module-replace. +
the value of the id parameter as a scala.Predef.String
the value of the module parameter as a EndpointTlsTermination
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A Tunnel Group Backend balances traffic among all online tunnels that match +
A Tunnel Group Backend balances traffic among all online tunnels that match a label selector.
See also https://ngrok.com/docs/api#api-tunnel-group-backends. -
Create a new TunnelGroup backend
Create a new TunnelGroup backend
See also https://ngrok.com/docs/api#api-tunnel-group-backends-create. -
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
labels to watch for tunnels on, e.g. app->foo, dc->bar
a scala.concurrent.Future encapsulating the API call's result
Delete a TunnelGroup backend by ID.
Delete a TunnelGroup backend by ID.
See also https://ngrok.com/docs/api#api-tunnel-group-backends-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about a TunnelGroup backend by ID
Get detailed information about a TunnelGroup backend by ID
See also https://ngrok.com/docs/api#api-tunnel-group-backends-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all TunnelGroup backends on this account
List all TunnelGroup backends on this account
See also https://ngrok.com/docs/api#api-tunnel-group-backends-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update TunnelGroup backend by ID
Update TunnelGroup backend by ID
See also https://ngrok.com/docs/api#api-tunnel-group-backends-update. -
the value of the id parameter as a scala.Predef.String
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
labels to watch for tunnels on, e.g. app->foo, dc->bar
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Create a new TunnelGroup backend
Create a new TunnelGroup backend
See also https://ngrok.com/docs/api#api-tunnel-group-backends-create. +
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
labels to watch for tunnels on, e.g. app->foo, dc->bar
a scala.concurrent.Future encapsulating the API call's result
Delete a TunnelGroup backend by ID.
Delete a TunnelGroup backend by ID.
See also https://ngrok.com/docs/api#api-tunnel-group-backends-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about a TunnelGroup backend by ID
Get detailed information about a TunnelGroup backend by ID
See also https://ngrok.com/docs/api#api-tunnel-group-backends-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all TunnelGroup backends on this account
List all TunnelGroup backends on this account
See also https://ngrok.com/docs/api#api-tunnel-group-backends-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update TunnelGroup backend by ID
Update TunnelGroup backend by ID
See also https://ngrok.com/docs/api#api-tunnel-group-backends-update. +
the value of the id parameter as a scala.Predef.String
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
labels to watch for tunnels on, e.g. app->foo, dc->bar
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel +
Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service. Each tunnel session can include one or more Tunnels.
See also https://ngrok.com/docs/api#api-tunnel-sessions. -
Get the detailed status of a tunnel session by ID
Get the detailed status of a tunnel session by ID
See also https://ngrok.com/docs/api#api-tunnel-sessions-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all online tunnel sessions running on this account.
List all online tunnel sessions running on this account.
See also https://ngrok.com/docs/api#api-tunnel-sessions-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Issues a command instructing the ngrok agent to restart.
Issues a command instructing the ngrok agent to restart. The agent restarts +
Get the detailed status of a tunnel session by ID
Get the detailed status of a tunnel session by ID
See also https://ngrok.com/docs/api#api-tunnel-sessions-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all online tunnel sessions running on this account.
List all online tunnel sessions running on this account.
See also https://ngrok.com/docs/api#api-tunnel-sessions-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Issues a command instructing the ngrok agent to restart.
Issues a command instructing the ngrok agent to restart. The agent restarts itself by calling exec() on platforms that support it. This operation is notably not supported on Windows. When an agent restarts, it reconnects with a new tunnel session ID.
See also https://ngrok.com/docs/api#api-tunnel-sessions-restart. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Issues a command instructing the ngrok agent that started this tunnel session to +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Issues a command instructing the ngrok agent that started this tunnel session to exit.
Issues a command instructing the ngrok agent that started this tunnel session to exit.
See also https://ngrok.com/docs/api#api-tunnel-sessions-stop. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Issues a command instructing the ngrok agent to update itself to the latest +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Issues a command instructing the ngrok agent to update itself to the latest version.
Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to @@ -21,7 +21,9 @@ breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following -circumstances: there is no update available the ngrok agent's configuration +circumstances: there is no update available the ngrok agent's configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted
See also https://ngrok.com/docs/api#api-tunnel-sessions-update. -
the value of the id parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
the value of the id parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Tunnels provide endpoints to access services exposed by a running ngrok +
Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.
See also https://ngrok.com/docs/api#api-tunnels. -
Get the status of a tunnel by ID
Get the status of a tunnel by ID
See also https://ngrok.com/docs/api#api-tunnels-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all online tunnels currently running on the account.
List all online tunnels currently running on the account.
See also https://ngrok.com/docs/api#api-tunnels-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Get the status of a tunnel by ID
Get the status of a tunnel by ID
See also https://ngrok.com/docs/api#api-tunnels-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all online tunnels currently running on the account.
List all online tunnels currently running on the account.
See also https://ngrok.com/docs/api#api-tunnels-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
A Weighted Backend balances traffic among the referenced backends. Traffic +
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. -
Create a new Weighted backend
Create a new Weighted backend
See also https://ngrok.com/docs/api#api-weighted-backends-create. -
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
the ids of the child backends to their weights [0-10000]
a scala.concurrent.Future encapsulating the API call's result
Delete a Weighted backend by ID.
Delete a Weighted backend by ID.
See also https://ngrok.com/docs/api#api-weighted-backends-delete. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about a Weighted backend by ID
Get detailed information about a Weighted backend by ID
See also https://ngrok.com/docs/api#api-weighted-backends-get. -
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all Weighted backends on this account
List all Weighted backends on this account
See also https://ngrok.com/docs/api#api-weighted-backends-list. -
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update Weighted backend by ID
Update Weighted backend by ID
See also https://ngrok.com/docs/api#api-weighted-backends-update. -
the value of the id parameter as a scala.Predef.String
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
the ids of the child backends to their weights [0-10000]
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Create a new Weighted backend
Create a new Weighted backend
See also https://ngrok.com/docs/api#api-weighted-backends-create. +
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
the ids of the child backends to their weights [0-10000]
a scala.concurrent.Future encapsulating the API call's result
Delete a Weighted backend by ID.
Delete a Weighted backend by ID.
See also https://ngrok.com/docs/api#api-weighted-backends-delete. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
Get detailed information about a Weighted backend by ID
Get detailed information about a Weighted backend by ID
See also https://ngrok.com/docs/api#api-weighted-backends-get. +
a resource identifier
a scala.concurrent.Future encapsulating the API call's result
List all Weighted backends on this account
List all Weighted backends on this account
See also https://ngrok.com/docs/api#api-weighted-backends-list. +
the value of the before_id parameter as a scala.Predef.String
the value of the limit parameter as a scala.Predef.String
a scala.concurrent.Future encapsulating the API call's result
Update Weighted backend by ID
Update Weighted backend by ID
See also https://ngrok.com/docs/api#api-weighted-backends-update. +
the value of the id parameter as a scala.Predef.String
human-readable description of this backend. Optional
arbitrary user-defined machine-readable data of this backend. Optional
the ids of the child backends to their weights [0-10000]
a scala.concurrent.Future encapsulating the API call's result
(Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString),
+or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.
Abuse Reports allow you to submit take-down requests for URLs hosted by - ngrok that violate ngrok's terms of service.
Abuse Reports allow you to submit take-down requests for URLs hosted by - ngrok that violate ngrok's terms of service.
See also https://ngrok.com/docs/api#api-abuse-reports. -
An API client for AgentIngresses.
An API client for AgentIngresses.
See also https://ngrok.com/docs/api#api-agent-ingresses. -
API Keys are used to authenticate to the <a +
Abuse Reports allow you to submit take-down requests for URLs hosted by + ngrok that violate ngrok's terms of service.
Abuse Reports allow you to submit take-down requests for URLs hosted by + ngrok that violate ngrok's terms of service.
See also https://ngrok.com/docs/api#api-abuse-reports. +
An API client for AgentIngresses.
An API client for AgentIngresses.
See also https://ngrok.com/docs/api#api-agent-ingresses. +
API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">ngrok API.
API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">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.
See also https://ngrok.com/docs/api#api-api-keys. -
Certificate Authorities are x509 certificates that are used to sign other +
Certificate Authorities are x509 certificates that are used to sign other x509 certificates.
Certificate Authorities are x509 certificates that are used to sign other x509 certificates. Attach a Certificate Authority to the Mutual TLS module to verify that the TLS certificate presented by a client has been signed by this CA. Certificate Authorities are used only for mTLS validation only and thus a private key is not included in the resource.
See also https://ngrok.com/docs/api#api-certificate-authorities. -
Tunnel Credentials are ngrok agent authtokens.
Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok +
Tunnel Credentials are ngrok agent authtokens.
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.
See also https://ngrok.com/docs/api#api-credentials. -
An API client for EdgeRouteBackendModule.
An API client for EdgeRouteBackendModule.
See also https://ngrok.com/docs/api#api-edge-route-backend-module. -
An API client for EdgeRouteCircuitBreakerModule.
An API client for EdgeRouteCircuitBreakerModule.
See also https://ngrok.com/docs/api#api-edge-route-circuit-breaker-module. -
An API client for EdgeRouteCompressionModule.
An API client for EdgeRouteCompressionModule.
See also https://ngrok.com/docs/api#api-edge-route-compression-module. -
An API client for EdgeRouteIpRestrictionModule.
An API client for EdgeRouteIpRestrictionModule.
See also https://ngrok.com/docs/api#api-edge-route-ip-restriction-module. -
An API client for EdgeRouteOAuthModule.
An API client for EdgeRouteOAuthModule.
See also https://ngrok.com/docs/api#api-edge-route-o-auth-module. -
An API client for EdgeRouteOidcModule.
An API client for EdgeRouteOidcModule.
See also https://ngrok.com/docs/api#api-edge-route-oidc-module. -
An API client for EdgeRouteRequestHeadersModule.
An API client for EdgeRouteRequestHeadersModule.
See also https://ngrok.com/docs/api#api-edge-route-request-headers-module. -
An API client for EdgeRouteResponseHeadersModule.
An API client for EdgeRouteResponseHeadersModule.
See also https://ngrok.com/docs/api#api-edge-route-response-headers-module. -
An API client for EdgeRouteSamlModule.
An API client for EdgeRouteSamlModule.
See also https://ngrok.com/docs/api#api-edge-route-saml-module. -
An API client for EdgeRouteWebhookVerificationModule.
An API client for EdgeRouteWebhookVerificationModule.
See also https://ngrok.com/docs/api#api-edge-route-webhook-verification-module. -
An API client for EdgeRouteWebsocketTcpConverterModule.
An API client for EdgeRouteWebsocketTcpConverterModule.
See also https://ngrok.com/docs/api#api-edge-route-websocket-tcp-converter-module. -
An API client for EdgesHttps.
An API client for EdgesHttps.
See also https://ngrok.com/docs/api#api-edges-https. -
An API client for EdgesHttpsRoutes.
An API client for EdgesHttpsRoutes.
See also https://ngrok.com/docs/api#api-edges-https-routes. -
An API client for EdgesTcp.
An API client for EdgesTcp.
See also https://ngrok.com/docs/api#api-edges-tcp. -
An API client for EdgesTls.
An API client for EdgesTls.
See also https://ngrok.com/docs/api#api-edges-tls. -
Endpoints provides an API for querying the endpoint objects +
An API client for EdgeRouteBackendModule.
An API client for EdgeRouteBackendModule.
See also https://ngrok.com/docs/api#api-edge-route-backend-module. +
An API client for EdgeRouteCircuitBreakerModule.
An API client for EdgeRouteCircuitBreakerModule.
See also https://ngrok.com/docs/api#api-edge-route-circuit-breaker-module. +
An API client for EdgeRouteCompressionModule.
An API client for EdgeRouteCompressionModule.
See also https://ngrok.com/docs/api#api-edge-route-compression-module. +
An API client for EdgeRouteIpRestrictionModule.
An API client for EdgeRouteIpRestrictionModule.
See also https://ngrok.com/docs/api#api-edge-route-ip-restriction-module. +
An API client for EdgeRouteOAuthModule.
An API client for EdgeRouteOAuthModule.
See also https://ngrok.com/docs/api#api-edge-route-o-auth-module. +
An API client for EdgeRouteOidcModule.
An API client for EdgeRouteOidcModule.
See also https://ngrok.com/docs/api#api-edge-route-oidc-module. +
An API client for EdgeRouteRequestHeadersModule.
An API client for EdgeRouteRequestHeadersModule.
See also https://ngrok.com/docs/api#api-edge-route-request-headers-module. +
An API client for EdgeRouteResponseHeadersModule.
An API client for EdgeRouteResponseHeadersModule.
See also https://ngrok.com/docs/api#api-edge-route-response-headers-module. +
An API client for EdgeRouteSamlModule.
An API client for EdgeRouteSamlModule.
See also https://ngrok.com/docs/api#api-edge-route-saml-module. +
An API client for EdgeRouteWebhookVerificationModule.
An API client for EdgeRouteWebhookVerificationModule.
See also https://ngrok.com/docs/api#api-edge-route-webhook-verification-module. +
An API client for EdgeRouteWebsocketTcpConverterModule.
An API client for EdgeRouteWebsocketTcpConverterModule.
See also https://ngrok.com/docs/api#api-edge-route-websocket-tcp-converter-module. +
An API client for EdgesHttps.
An API client for EdgesHttps.
See also https://ngrok.com/docs/api#api-edges-https. +
An API client for EdgesHttpsRoutes.
An API client for EdgesHttpsRoutes.
See also https://ngrok.com/docs/api#api-edges-https-routes. +
An API client for EdgesTcp.
An API client for EdgesTcp.
See also https://ngrok.com/docs/api#api-edges-tcp. +
An API client for EdgesTls.
An API client for EdgesTls.
See also https://ngrok.com/docs/api#api-edges-tls. +
Endpoints provides an API for querying the endpoint objects which define what tunnel or edge is used to serve a hostport.
Endpoints provides an API for querying the endpoint objects which define what tunnel or edge is used to serve a hostport. Only active endpoints associated with a tunnel or backend are returned.
See also https://ngrok.com/docs/api#api-endpoints. -
An API client for EventDestinations.
An API client for EventDestinations.
See also https://ngrok.com/docs/api#api-event-destinations. -
An API client for EventSources.
An API client for EventSources.
See also https://ngrok.com/docs/api#api-event-sources. -
An API client for EventSubscriptions.
An API client for EventSubscriptions.
See also https://ngrok.com/docs/api#api-event-subscriptions. -
A Failover backend defines failover behavior within a list of referenced +
An API client for EventDestinations.
An API client for EventDestinations.
See also https://ngrok.com/docs/api#api-event-destinations. +
An API client for EventSources.
An API client for EventSources.
See also https://ngrok.com/docs/api#api-event-sources. +
An API client for EventSubscriptions.
An API client for EventSubscriptions.
See also https://ngrok.com/docs/api#api-event-subscriptions. +
A Failover backend defines failover behavior within a list of referenced backends.
A Failover backend defines failover behavior within a list of referenced backends. Traffic is sent to the first backend in the list. If that backend is offline or no connection can be established, ngrok attempts to connect to the next backend in the list until one is successful.
See also https://ngrok.com/docs/api#api-failover-backends. -
An API client for HttpResponseBackends.
An API client for HttpResponseBackends.
See also https://ngrok.com/docs/api#api-http-response-backends. -
An API client for HttpsEdgeMutualTlsModule.
An API client for HttpsEdgeMutualTlsModule.
See also https://ngrok.com/docs/api#api-https-edge-mutual-tls-module. -
An API client for HttpsEdgeTlsTerminationModule.
An API client for HttpsEdgeTlsTerminationModule.
See also https://ngrok.com/docs/api#api-https-edge-tls-termination-module. -
IP Policies are reusable groups of CIDR ranges with an allow or
+
An API client for HttpResponseBackends.
An API client for HttpResponseBackends.
See also https://ngrok.com/docs/api#api-http-response-backends. +
An API client for HttpsEdgeMutualTlsModule.
An API client for HttpsEdgeMutualTlsModule.
See also https://ngrok.com/docs/api#api-https-edge-mutual-tls-module. +
An API client for HttpsEdgeTlsTerminationModule.
An API client for HttpsEdgeTlsTerminationModule.
See also https://ngrok.com/docs/api#api-https-edge-tls-termination-module. +
IP Policies are reusable groups of CIDR ranges with an allow or
deny
action.
IP Policies are reusable groups of CIDR ranges with an allow or
deny
action. They can be attached to endpoints via the Endpoint Configuration IP
Policy module. They can also be used with IP Restrictions to control source
IP ranges that can start tunnel sessions and connect to the API and dashboard.
See also https://ngrok.com/docs/api#api-ip-policies. -
IP Policy Rules are the IPv4 or IPv6 CIDRs entries that +
IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.
IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.
See also https://ngrok.com/docs/api#api-ip-policy-rules. -
An IP restriction is a restriction placed on the CIDRs that are allowed to +
An IP restriction is a restriction placed on the CIDRs that are allowed to initiate traffic to a specific aspect of your ngrok account.
An IP restriction is a restriction placed on the CIDRs that are allowed to initiate traffic to a specific aspect of your ngrok account. An IP restriction has a type which defines the ingress it applies to. IP restrictions can be used to enforce the source IPs that can make API requests, log in to the dashboard, start ngrok agents, and connect to your public-facing endpoints.
See also https://ngrok.com/docs/api#api-ip-restrictions. -
Reserved Addresses are TCP addresses that can be used to listen for traffic.
Reserved Addresses are TCP addresses that can be used to listen for traffic. +
Reserved Addresses are TCP addresses that can be used to listen for traffic.
Reserved Addresses are TCP addresses that can be used to listen for traffic. TCP address hostnames and ports are assigned by ngrok, they cannot be chosen.
See also https://ngrok.com/docs/api#api-reserved-addrs. -
Reserved Domains are hostnames that you can listen for traffic on.
Reserved Domains are hostnames that you can listen for traffic on. Domains +
Reserved Domains are hostnames that you can listen for traffic on.
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.
See also https://ngrok.com/docs/api#api-reserved-domains. -
An SSH Certificate Authority is a pair of an SSH Certificate and its private + This CNAME record points traffic for that domain to ngrok's edge servers.
See also https://ngrok.com/docs/api#api-reserved-domains. +
An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.
An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.
See also https://ngrok.com/docs/api#api-ssh-certificate-authorities. -
SSH Credentials are SSH public keys that can be used to start SSH tunnels +
SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.
SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.
See also https://ngrok.com/docs/api#api-ssh-credentials. -
SSH Host Certificates along with the corresponding private key allows an SSH +
SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.
SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.
See also https://ngrok.com/docs/api#api-ssh-host-certificates. -
SSH User Certificates are presented by SSH clients when connecting to an SSH +
SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection.
SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection. The SSH server must trust the SSH Certificate Authority used to sign the certificate.
See also https://ngrok.com/docs/api#api-ssh-user-certificates. -
An API client for TcpEdgeBackendModule.
An API client for TcpEdgeBackendModule.
See also https://ngrok.com/docs/api#api-tcp-edge-backend-module. -
An API client for TcpEdgeIpRestrictionModule.
An API client for TcpEdgeIpRestrictionModule.
See also https://ngrok.com/docs/api#api-tcp-edge-ip-restriction-module. -
TLS Certificates are pairs of x509 certificates and their matching private +
An API client for TcpEdgeBackendModule.
An API client for TcpEdgeBackendModule.
See also https://ngrok.com/docs/api#api-tcp-edge-backend-module. +
An API client for TcpEdgeIpRestrictionModule.
An API client for TcpEdgeIpRestrictionModule.
See also https://ngrok.com/docs/api#api-tcp-edge-ip-restriction-module. +
TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic.
TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic. TLS certificates are unused until they are attached to a Domain. TLS Certificates may also be provisioned by ngrok automatically for domains on which you have enabled automated certificate provisioning.
See also https://ngrok.com/docs/api#api-tls-certificates. -
An API client for TlsEdgeBackendModule.
An API client for TlsEdgeBackendModule.
See also https://ngrok.com/docs/api#api-tls-edge-backend-module. -
An API client for TlsEdgeIpRestrictionModule.
An API client for TlsEdgeIpRestrictionModule.
See also https://ngrok.com/docs/api#api-tls-edge-ip-restriction-module. -
An API client for TlsEdgeMutualTlsModule.
An API client for TlsEdgeMutualTlsModule.
See also https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module. -
An API client for TlsEdgeTlsTerminationModule.
An API client for TlsEdgeTlsTerminationModule.
See also https://ngrok.com/docs/api#api-tls-edge-tls-termination-module. -
A Tunnel Group Backend balances traffic among all online tunnels that match +
An API client for TlsEdgeBackendModule.
An API client for TlsEdgeBackendModule.
See also https://ngrok.com/docs/api#api-tls-edge-backend-module. +
An API client for TlsEdgeIpRestrictionModule.
An API client for TlsEdgeIpRestrictionModule.
See also https://ngrok.com/docs/api#api-tls-edge-ip-restriction-module. +
An API client for TlsEdgeMutualTlsModule.
An API client for TlsEdgeMutualTlsModule.
See also https://ngrok.com/docs/api#api-tls-edge-mutual-tls-module. +
An API client for TlsEdgeTlsTerminationModule.
An API client for TlsEdgeTlsTerminationModule.
See also https://ngrok.com/docs/api#api-tls-edge-tls-termination-module. +
A Tunnel Group Backend balances traffic among all online tunnels that match a label selector.
A Tunnel Group Backend balances traffic among all online tunnels that match a label selector.
See also https://ngrok.com/docs/api#api-tunnel-group-backends. -
Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel +
Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service.
Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service. Each tunnel session can include one or more Tunnels.
See also https://ngrok.com/docs/api#api-tunnel-sessions. -
Tunnels provide endpoints to access services exposed by a running ngrok +
Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.
Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.
See also https://ngrok.com/docs/api#api-tunnels. -
A Weighted Backend balances traffic among the referenced backends.
A Weighted Backend balances traffic among the referenced backends. Traffic +
A Weighted Backend balances traffic among the referenced backends.
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. -
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.
*
@@ -174,7 +175,7 @@ class Ngrok private (apiClient: NgrokApiClient)(implicit ec: ExecutionContext) {
/** 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.
*
@@ -302,7 +303,7 @@ class Ngrok private (apiClient: NgrokApiClient)(implicit ec: ExecutionContext) {
/** 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/src/main/scala/com/ngrok/definitions/AbuseReport.scala b/src/main/scala/com/ngrok/definitions/AbuseReport.scala
index 9d9f0cd..2d19f78 100644
--- a/src/main/scala/com/ngrok/definitions/AbuseReport.scala
+++ b/src/main/scala/com/ngrok/definitions/AbuseReport.scala
@@ -41,17 +41,17 @@ object AbuseReport {
id <- c.downField("id").as[String]
uri <- c.downField("uri").as[java.net.URI]
createdAt <- c.downField("created_at").as[java.time.OffsetDateTime]
- urls <- c.downField("urls").as[List[java.net.URI]]
+ urls <- c.downField("urls").as[Option[List[java.net.URI]]]
metadata <- c.downField("metadata").as[String]
status <- c.downField("status").as[String]
- hostnames <- c.downField("hostnames").as[List[AbuseReportHostname]]
+ hostnames <- c.downField("hostnames").as[Option[List[AbuseReportHostname]]]
} yield AbuseReport(
id,
uri,
createdAt,
- urls,
+ urls.getOrElse(List.empty),
metadata,
status,
- hostnames
+ hostnames.getOrElse(List.empty)
)
}
diff --git a/src/main/scala/com/ngrok/definitions/AgentIngress.scala b/src/main/scala/com/ngrok/definitions/AgentIngress.scala
index 896c117..7ed1506 100644
--- a/src/main/scala/com/ngrok/definitions/AgentIngress.scala
+++ b/src/main/scala/com/ngrok/definitions/AgentIngress.scala
@@ -22,7 +22,7 @@ final case class AgentIngress(
domain: String,
nsTargets: List[String],
regionDomains: List[String],
- createdAt: String
+ createdAt: java.time.OffsetDateTime
)
object AgentIngress {
@@ -46,17 +46,17 @@ object AgentIngress {
description <- c.downField("description").as[String]
metadata <- c.downField("metadata").as[String]
domain <- c.downField("domain").as[String]
- nsTargets <- c.downField("ns_targets").as[List[String]]
- regionDomains <- c.downField("region_domains").as[List[String]]
- createdAt <- c.downField("created_at").as[String]
+ nsTargets <- c.downField("ns_targets").as[Option[List[String]]]
+ regionDomains <- c.downField("region_domains").as[Option[List[String]]]
+ createdAt <- c.downField("created_at").as[java.time.OffsetDateTime]
} yield AgentIngress(
id,
uri,
description,
metadata,
domain,
- nsTargets,
- regionDomains,
+ nsTargets.getOrElse(List.empty),
+ regionDomains.getOrElse(List.empty),
createdAt
)
}
diff --git a/src/main/scala/com/ngrok/definitions/AgentIngressList.scala b/src/main/scala/com/ngrok/definitions/AgentIngressList.scala
index a02e60c..47f1111 100644
--- a/src/main/scala/com/ngrok/definitions/AgentIngressList.scala
+++ b/src/main/scala/com/ngrok/definitions/AgentIngressList.scala
@@ -27,11 +27,11 @@ object AgentIngressList {
implicit val decodeAgentIngressList: io.circe.Decoder[AgentIngressList] = (c: io.circe.HCursor) =>
for {
- ingresses <- c.downField("ingresses").as[List[AgentIngress]]
+ ingresses <- c.downField("ingresses").as[Option[List[AgentIngress]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield AgentIngressList(
- ingresses,
+ ingresses.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/ApiKeyList.scala b/src/main/scala/com/ngrok/definitions/ApiKeyList.scala
index 1b6c2e1..9f6ee49 100644
--- a/src/main/scala/com/ngrok/definitions/ApiKeyList.scala
+++ b/src/main/scala/com/ngrok/definitions/ApiKeyList.scala
@@ -26,11 +26,11 @@ object ApiKeyList {
implicit val decodeApiKeyList: io.circe.Decoder[ApiKeyList] = (c: io.circe.HCursor) =>
for {
- keys <- c.downField("keys").as[List[ApiKey]]
+ keys <- c.downField("keys").as[Option[List[ApiKey]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield ApiKeyList(
- keys,
+ keys.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/CertificateAuthority.scala b/src/main/scala/com/ngrok/definitions/CertificateAuthority.scala
index 052c742..28c16bc 100644
--- a/src/main/scala/com/ngrok/definitions/CertificateAuthority.scala
+++ b/src/main/scala/com/ngrok/definitions/CertificateAuthority.scala
@@ -60,8 +60,8 @@ object CertificateAuthority {
subjectCommonName <- c.downField("subject_common_name").as[String]
notBefore <- c.downField("not_before").as[java.time.OffsetDateTime]
notAfter <- c.downField("not_after").as[java.time.OffsetDateTime]
- keyUsages <- c.downField("key_usages").as[List[String]]
- extendedKeyUsages <- c.downField("extended_key_usages").as[List[String]]
+ keyUsages <- c.downField("key_usages").as[Option[List[String]]]
+ extendedKeyUsages <- c.downField("extended_key_usages").as[Option[List[String]]]
} yield CertificateAuthority(
id,
uri,
@@ -72,7 +72,7 @@ object CertificateAuthority {
subjectCommonName,
notBefore,
notAfter,
- keyUsages,
- extendedKeyUsages
+ keyUsages.getOrElse(List.empty),
+ extendedKeyUsages.getOrElse(List.empty)
)
}
diff --git a/src/main/scala/com/ngrok/definitions/CertificateAuthorityList.scala b/src/main/scala/com/ngrok/definitions/CertificateAuthorityList.scala
index 98e30e3..8543616 100644
--- a/src/main/scala/com/ngrok/definitions/CertificateAuthorityList.scala
+++ b/src/main/scala/com/ngrok/definitions/CertificateAuthorityList.scala
@@ -27,11 +27,11 @@ object CertificateAuthorityList {
implicit val decodeCertificateAuthorityList: io.circe.Decoder[CertificateAuthorityList] = (c: io.circe.HCursor) =>
for {
- certificateAuthorities <- c.downField("certificate_authorities").as[List[CertificateAuthority]]
+ certificateAuthorities <- c.downField("certificate_authorities").as[Option[List[CertificateAuthority]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield CertificateAuthorityList(
- certificateAuthorities,
+ certificateAuthorities.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/Credential.scala b/src/main/scala/com/ngrok/definitions/Credential.scala
index 2180619..d0a88c8 100644
--- a/src/main/scala/com/ngrok/definitions/Credential.scala
+++ b/src/main/scala/com/ngrok/definitions/Credential.scala
@@ -10,8 +10,8 @@ import io.circe.syntax._
* @param createdAt timestamp when the tunnel credential was created, RFC 3339 format
* @param description human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
* @param metadata arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
- * @param 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.
- * @param 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.
+ * @param 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.
+ * @param 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.
*/
final case class Credential(
id: String,
@@ -44,7 +44,7 @@ object Credential {
description <- c.downField("description").as[String]
metadata <- c.downField("metadata").as[String]
token <- c.downField("token").as[Option[String]]
- acl <- c.downField("acl").as[List[String]]
+ acl <- c.downField("acl").as[Option[List[String]]]
} yield Credential(
id,
uri,
@@ -52,6 +52,6 @@ object Credential {
description,
metadata,
token,
- acl
+ acl.getOrElse(List.empty)
)
}
diff --git a/src/main/scala/com/ngrok/definitions/CredentialList.scala b/src/main/scala/com/ngrok/definitions/CredentialList.scala
index 44b07d8..be267d5 100644
--- a/src/main/scala/com/ngrok/definitions/CredentialList.scala
+++ b/src/main/scala/com/ngrok/definitions/CredentialList.scala
@@ -27,11 +27,11 @@ object CredentialList {
implicit val decodeCredentialList: io.circe.Decoder[CredentialList] = (c: io.circe.HCursor) =>
for {
- credentials <- c.downField("credentials").as[List[Credential]]
+ credentials <- c.downField("credentials").as[Option[List[Credential]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield CredentialList(
- credentials,
+ credentials.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/EndpointIpPolicy.scala b/src/main/scala/com/ngrok/definitions/EndpointIpPolicy.scala
index 8aab0ea..08e2d9a 100644
--- a/src/main/scala/com/ngrok/definitions/EndpointIpPolicy.scala
+++ b/src/main/scala/com/ngrok/definitions/EndpointIpPolicy.scala
@@ -25,9 +25,9 @@ object EndpointIpPolicy {
implicit val decodeEndpointIpPolicy: io.circe.Decoder[EndpointIpPolicy] = (c: io.circe.HCursor) =>
for {
enabled <- c.downField("enabled").as[Option[Boolean]]
- ipPolicies <- c.downField("ip_policies").as[List[Ref]]
+ ipPolicies <- c.downField("ip_policies").as[Option[List[Ref]]]
} yield EndpointIpPolicy(
enabled,
- ipPolicies
+ ipPolicies.getOrElse(List.empty)
)
}
diff --git a/src/main/scala/com/ngrok/definitions/EndpointIpPolicyMutate.scala b/src/main/scala/com/ngrok/definitions/EndpointIpPolicyMutate.scala
index 97ac7bc..cc0a285 100644
--- a/src/main/scala/com/ngrok/definitions/EndpointIpPolicyMutate.scala
+++ b/src/main/scala/com/ngrok/definitions/EndpointIpPolicyMutate.scala
@@ -25,9 +25,9 @@ object EndpointIpPolicyMutate {
implicit val decodeEndpointIpPolicyMutate: io.circe.Decoder[EndpointIpPolicyMutate] = (c: io.circe.HCursor) =>
for {
enabled <- c.downField("enabled").as[Option[Boolean]]
- ipPolicyIds <- c.downField("ip_policy_ids").as[List[String]]
+ ipPolicyIds <- c.downField("ip_policy_ids").as[Option[List[String]]]
} yield EndpointIpPolicyMutate(
enabled,
- ipPolicyIds
+ ipPolicyIds.getOrElse(List.empty)
)
}
diff --git a/src/main/scala/com/ngrok/definitions/EndpointList.scala b/src/main/scala/com/ngrok/definitions/EndpointList.scala
index 4c240f8..1bf56eb 100644
--- a/src/main/scala/com/ngrok/definitions/EndpointList.scala
+++ b/src/main/scala/com/ngrok/definitions/EndpointList.scala
@@ -26,11 +26,11 @@ object EndpointList {
implicit val decodeEndpointList: io.circe.Decoder[EndpointList] = (c: io.circe.HCursor) =>
for {
- endpoints <- c.downField("endpoints").as[List[Endpoint]]
+ endpoints <- c.downField("endpoints").as[Option[List[Endpoint]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield EndpointList(
- endpoints,
+ endpoints.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/EndpointMutualTls.scala b/src/main/scala/com/ngrok/definitions/EndpointMutualTls.scala
index 3358848..f7b43c9 100644
--- a/src/main/scala/com/ngrok/definitions/EndpointMutualTls.scala
+++ b/src/main/scala/com/ngrok/definitions/EndpointMutualTls.scala
@@ -25,9 +25,9 @@ object EndpointMutualTls {
implicit val decodeEndpointMutualTls: io.circe.Decoder[EndpointMutualTls] = (c: io.circe.HCursor) =>
for {
enabled <- c.downField("enabled").as[Option[Boolean]]
- certificateAuthorities <- c.downField("certificate_authorities").as[List[Ref]]
+ certificateAuthorities <- c.downField("certificate_authorities").as[Option[List[Ref]]]
} yield EndpointMutualTls(
enabled,
- certificateAuthorities
+ certificateAuthorities.getOrElse(List.empty)
)
}
diff --git a/src/main/scala/com/ngrok/definitions/EndpointMutualTlsMutate.scala b/src/main/scala/com/ngrok/definitions/EndpointMutualTlsMutate.scala
index 39e8823..46ff20a 100644
--- a/src/main/scala/com/ngrok/definitions/EndpointMutualTlsMutate.scala
+++ b/src/main/scala/com/ngrok/definitions/EndpointMutualTlsMutate.scala
@@ -25,9 +25,9 @@ object EndpointMutualTlsMutate {
implicit val decodeEndpointMutualTlsMutate: io.circe.Decoder[EndpointMutualTlsMutate] = (c: io.circe.HCursor) =>
for {
enabled <- c.downField("enabled").as[Option[Boolean]]
- certificateAuthorityIds <- c.downField("certificate_authority_ids").as[List[String]]
+ certificateAuthorityIds <- c.downField("certificate_authority_ids").as[Option[List[String]]]
} yield EndpointMutualTlsMutate(
enabled,
- certificateAuthorityIds
+ certificateAuthorityIds.getOrElse(List.empty)
)
}
diff --git a/src/main/scala/com/ngrok/definitions/EndpointOAuth.scala b/src/main/scala/com/ngrok/definitions/EndpointOAuth.scala
index b6f1bcb..a7d036f 100644
--- a/src/main/scala/com/ngrok/definitions/EndpointOAuth.scala
+++ b/src/main/scala/com/ngrok/definitions/EndpointOAuth.scala
@@ -8,7 +8,7 @@ import io.circe.syntax._
* @param enabled true if the module will be applied to traffic, false to disable. default true if unspecified
* @param provider an object which defines the identity provider to use for authentication and configuration for who may access the endpoint
* @param optionsPassthrough Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
- * @param cookiePrefix the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
+ * @param cookiePrefix the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
* @param 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.
* @param maximumDuration Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
* @param authCheckInterval Integer number of seconds after which ngrok guarantees it will refresh user state from the identity provider and recheck whether the user is still authorized to access the endpoint. This is the preferred tunable to use to enforce a minimum amount of time after which a revoked user will no longer be able to access the resource.
diff --git a/src/main/scala/com/ngrok/definitions/EndpointOAuthFacebook.scala b/src/main/scala/com/ngrok/definitions/EndpointOAuthFacebook.scala
index d16c01c..952b7b7 100644
--- a/src/main/scala/com/ngrok/definitions/EndpointOAuthFacebook.scala
+++ b/src/main/scala/com/ngrok/definitions/EndpointOAuthFacebook.scala
@@ -5,8 +5,8 @@ import io.circe.syntax._
/** A class encapsulating the [[EndpointOAuthFacebook]] resource.
*
* @constructor create a new EndpointOAuthFacebook.
- * @param clientId 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 well.
- * @param clientSecret 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.
+ * @param clientId 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 well.
+ * @param clientSecret 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.
* @param scopes a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
* @param emailAddresses a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
* @param emailDomains a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
@@ -35,14 +35,14 @@ object EndpointOAuthFacebook {
for {
clientId <- c.downField("client_id").as[Option[String]]
clientSecret <- c.downField("client_secret").as[Option[String]]
- scopes <- c.downField("scopes").as[List[String]]
- emailAddresses <- c.downField("email_addresses").as[List[String]]
- emailDomains <- c.downField("email_domains").as[List[String]]
+ scopes <- c.downField("scopes").as[Option[List[String]]]
+ emailAddresses <- c.downField("email_addresses").as[Option[List[String]]]
+ emailDomains <- c.downField("email_domains").as[Option[List[String]]]
} yield EndpointOAuthFacebook(
clientId,
clientSecret,
- scopes,
- emailAddresses,
- emailDomains
+ scopes.getOrElse(List.empty),
+ emailAddresses.getOrElse(List.empty),
+ emailDomains.getOrElse(List.empty)
)
}
diff --git a/src/main/scala/com/ngrok/definitions/EndpointOAuthGitHub.scala b/src/main/scala/com/ngrok/definitions/EndpointOAuthGitHub.scala
index 114ce17..b3b2a1a 100644
--- a/src/main/scala/com/ngrok/definitions/EndpointOAuthGitHub.scala
+++ b/src/main/scala/com/ngrok/definitions/EndpointOAuthGitHub.scala
@@ -5,13 +5,13 @@ import io.circe.syntax._
/** A class encapsulating the [[EndpointOAuthGitHub]] resource.
*
* @constructor create a new EndpointOAuthGitHub.
- * @param clientId 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 well.
- * @param clientSecret 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.
+ * @param clientId 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 well.
+ * @param clientSecret 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.
* @param scopes a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
* @param emailAddresses a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
* @param emailDomains a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
- * @param teams 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
- * @param organizations 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'
+ * @param teams 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
+ * @param organizations 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'
*/
final case class EndpointOAuthGitHub(
clientId: Option[String] = None,
@@ -41,18 +41,18 @@ object EndpointOAuthGitHub {
for {
clientId <- c.downField("client_id").as[Option[String]]
clientSecret <- c.downField("client_secret").as[Option[String]]
- scopes <- c.downField("scopes").as[List[String]]
- emailAddresses <- c.downField("email_addresses").as[List[String]]
- emailDomains <- c.downField("email_domains").as[List[String]]
- teams <- c.downField("teams").as[List[String]]
- organizations <- c.downField("organizations").as[List[String]]
+ scopes <- c.downField("scopes").as[Option[List[String]]]
+ emailAddresses <- c.downField("email_addresses").as[Option[List[String]]]
+ emailDomains <- c.downField("email_domains").as[Option[List[String]]]
+ teams <- c.downField("teams").as[Option[List[String]]]
+ organizations <- c.downField("organizations").as[Option[List[String]]]
} yield EndpointOAuthGitHub(
clientId,
clientSecret,
- scopes,
- emailAddresses,
- emailDomains,
- teams,
- organizations
+ scopes.getOrElse(List.empty),
+ emailAddresses.getOrElse(List.empty),
+ emailDomains.getOrElse(List.empty),
+ teams.getOrElse(List.empty),
+ organizations.getOrElse(List.empty)
)
}
diff --git a/src/main/scala/com/ngrok/definitions/EndpointOAuthGoogle.scala b/src/main/scala/com/ngrok/definitions/EndpointOAuthGoogle.scala
index 7d9bf5d..1170df2 100644
--- a/src/main/scala/com/ngrok/definitions/EndpointOAuthGoogle.scala
+++ b/src/main/scala/com/ngrok/definitions/EndpointOAuthGoogle.scala
@@ -5,8 +5,8 @@ import io.circe.syntax._
/** A class encapsulating the [[EndpointOAuthGoogle]] resource.
*
* @constructor create a new EndpointOAuthGoogle.
- * @param clientId 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 well.
- * @param clientSecret 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.
+ * @param clientId 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 well.
+ * @param clientSecret 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.
* @param scopes a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
* @param emailAddresses a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
* @param emailDomains a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
@@ -35,14 +35,14 @@ object EndpointOAuthGoogle {
for {
clientId <- c.downField("client_id").as[Option[String]]
clientSecret <- c.downField("client_secret").as[Option[String]]
- scopes <- c.downField("scopes").as[List[String]]
- emailAddresses <- c.downField("email_addresses").as[List[String]]
- emailDomains <- c.downField("email_domains").as[List[String]]
+ scopes <- c.downField("scopes").as[Option[List[String]]]
+ emailAddresses <- c.downField("email_addresses").as[Option[List[String]]]
+ emailDomains <- c.downField("email_domains").as[Option[List[String]]]
} yield EndpointOAuthGoogle(
clientId,
clientSecret,
- scopes,
- emailAddresses,
- emailDomains
+ scopes.getOrElse(List.empty),
+ emailAddresses.getOrElse(List.empty),
+ emailDomains.getOrElse(List.empty)
)
}
diff --git a/src/main/scala/com/ngrok/definitions/EndpointOAuthMicrosoft.scala b/src/main/scala/com/ngrok/definitions/EndpointOAuthMicrosoft.scala
index 6786447..310f08a 100644
--- a/src/main/scala/com/ngrok/definitions/EndpointOAuthMicrosoft.scala
+++ b/src/main/scala/com/ngrok/definitions/EndpointOAuthMicrosoft.scala
@@ -5,8 +5,8 @@ import io.circe.syntax._
/** A class encapsulating the [[EndpointOAuthMicrosoft]] resource.
*
* @constructor create a new EndpointOAuthMicrosoft.
- * @param clientId 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 well.
- * @param clientSecret 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.
+ * @param clientId 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 well.
+ * @param clientSecret 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.
* @param scopes a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both client_id and client_secret to set scopes)
* @param emailAddresses a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
* @param emailDomains a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
@@ -35,14 +35,14 @@ object EndpointOAuthMicrosoft {
for {
clientId <- c.downField("client_id").as[Option[String]]
clientSecret <- c.downField("client_secret").as[Option[String]]
- scopes <- c.downField("scopes").as[List[String]]
- emailAddresses <- c.downField("email_addresses").as[List[String]]
- emailDomains <- c.downField("email_domains").as[List[String]]
+ scopes <- c.downField("scopes").as[Option[List[String]]]
+ emailAddresses <- c.downField("email_addresses").as[Option[List[String]]]
+ emailDomains <- c.downField("email_domains").as[Option[List[String]]]
} yield EndpointOAuthMicrosoft(
clientId,
clientSecret,
- scopes,
- emailAddresses,
- emailDomains
+ scopes.getOrElse(List.empty),
+ emailAddresses.getOrElse(List.empty),
+ emailDomains.getOrElse(List.empty)
)
}
diff --git a/src/main/scala/com/ngrok/definitions/EndpointOidc.scala b/src/main/scala/com/ngrok/definitions/EndpointOidc.scala
index fb81c28..856e8c1 100644
--- a/src/main/scala/com/ngrok/definitions/EndpointOidc.scala
+++ b/src/main/scala/com/ngrok/definitions/EndpointOidc.scala
@@ -7,12 +7,12 @@ import io.circe.syntax._
* @constructor create a new EndpointOidc.
* @param enabled true if the module will be applied to traffic, false to disable. default true if unspecified
* @param optionsPassthrough Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
- * @param cookiePrefix the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
+ * @param cookiePrefix the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
* @param 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.
* @param maximumDuration Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
- * @param issuer URL of the OIDC "OpenID provider". This is the base URL used for discovery.
- * @param clientId The OIDC app's client ID and OIDC audience.
- * @param clientSecret The OIDC app's client secret.
+ * @param issuer URL of the OIDC "OpenID provider". This is the base URL used for discovery.
+ * @param clientId The OIDC app's client ID and OIDC audience.
+ * @param clientSecret The OIDC app's client secret.
* @param scopes The set of scopes to request from the OIDC identity provider.
*/
final case class EndpointOidc(
@@ -52,7 +52,7 @@ object EndpointOidc {
issuer <- c.downField("issuer").as[String]
clientId <- c.downField("client_id").as[String]
clientSecret <- c.downField("client_secret").as[String]
- scopes <- c.downField("scopes").as[List[String]]
+ scopes <- c.downField("scopes").as[Option[List[String]]]
} yield EndpointOidc(
enabled,
optionsPassthrough,
@@ -62,6 +62,6 @@ object EndpointOidc {
issuer,
clientId,
clientSecret,
- scopes
+ scopes.getOrElse(List.empty)
)
}
diff --git a/src/main/scala/com/ngrok/definitions/EndpointRequestHeaders.scala b/src/main/scala/com/ngrok/definitions/EndpointRequestHeaders.scala
index b25a937..890217b 100644
--- a/src/main/scala/com/ngrok/definitions/EndpointRequestHeaders.scala
+++ b/src/main/scala/com/ngrok/definitions/EndpointRequestHeaders.scala
@@ -28,11 +28,11 @@ object EndpointRequestHeaders {
implicit val decodeEndpointRequestHeaders: io.circe.Decoder[EndpointRequestHeaders] = (c: io.circe.HCursor) =>
for {
enabled <- c.downField("enabled").as[Option[Boolean]]
- add <- c.downField("add").as[Map[String, String]]
- remove <- c.downField("remove").as[List[String]]
+ add <- c.downField("add").as[Option[Map[String, String]]]
+ remove <- c.downField("remove").as[Option[List[String]]]
} yield EndpointRequestHeaders(
enabled,
- add,
- remove
+ add.getOrElse(Map.empty),
+ remove.getOrElse(List.empty)
)
}
diff --git a/src/main/scala/com/ngrok/definitions/EndpointResponseHeaders.scala b/src/main/scala/com/ngrok/definitions/EndpointResponseHeaders.scala
index 87dd75b..e550393 100644
--- a/src/main/scala/com/ngrok/definitions/EndpointResponseHeaders.scala
+++ b/src/main/scala/com/ngrok/definitions/EndpointResponseHeaders.scala
@@ -28,11 +28,11 @@ object EndpointResponseHeaders {
implicit val decodeEndpointResponseHeaders: io.circe.Decoder[EndpointResponseHeaders] = (c: io.circe.HCursor) =>
for {
enabled <- c.downField("enabled").as[Option[Boolean]]
- add <- c.downField("add").as[Map[String, String]]
- remove <- c.downField("remove").as[List[String]]
+ add <- c.downField("add").as[Option[Map[String, String]]]
+ remove <- c.downField("remove").as[Option[List[String]]]
} yield EndpointResponseHeaders(
enabled,
- add,
- remove
+ add.getOrElse(Map.empty),
+ remove.getOrElse(List.empty)
)
}
diff --git a/src/main/scala/com/ngrok/definitions/EndpointSaml.scala b/src/main/scala/com/ngrok/definitions/EndpointSaml.scala
index c5055ef..204f321 100644
--- a/src/main/scala/com/ngrok/definitions/EndpointSaml.scala
+++ b/src/main/scala/com/ngrok/definitions/EndpointSaml.scala
@@ -7,18 +7,18 @@ import io.circe.syntax._
* @constructor create a new EndpointSaml.
* @param enabled true if the module will be applied to traffic, false to disable. default true if unspecified
* @param optionsPassthrough Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
- * @param cookiePrefix the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
+ * @param cookiePrefix the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
* @param 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.
* @param maximumDuration Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
* @param idpMetadata The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.
* @param 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.
* @param 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.
* @param authorizedGroups If present, only users who are a member of one of the listed groups may access the target endpoint.
- * @param 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.
- * @param 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.
- * @param 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.
- * @param 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.
- * @param 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.
+ * @param 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.
+ * @param 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.
+ * @param 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.
+ * @param 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.
+ * @param 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.
* @param 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.
*/
final case class EndpointSaml(
@@ -70,7 +70,7 @@ object EndpointSaml {
idpMetadata <- c.downField("idp_metadata").as[String]
forceAuthn <- c.downField("force_authn").as[Boolean]
allowIdpInitiated <- c.downField("allow_idp_initiated").as[Option[Boolean]]
- authorizedGroups <- c.downField("authorized_groups").as[List[String]]
+ authorizedGroups <- c.downField("authorized_groups").as[Option[List[String]]]
entityId <- c.downField("entity_id").as[String]
assertionConsumerServiceUrl <- c.downField("assertion_consumer_service_url").as[java.net.URI]
singleLogoutUrl <- c.downField("single_logout_url").as[java.net.URI]
@@ -86,7 +86,7 @@ object EndpointSaml {
idpMetadata,
forceAuthn,
allowIdpInitiated,
- authorizedGroups,
+ authorizedGroups.getOrElse(List.empty),
entityId,
assertionConsumerServiceUrl,
singleLogoutUrl,
diff --git a/src/main/scala/com/ngrok/definitions/EndpointSamlMutate.scala b/src/main/scala/com/ngrok/definitions/EndpointSamlMutate.scala
index b91a498..868c1cf 100644
--- a/src/main/scala/com/ngrok/definitions/EndpointSamlMutate.scala
+++ b/src/main/scala/com/ngrok/definitions/EndpointSamlMutate.scala
@@ -7,7 +7,7 @@ import io.circe.syntax._
* @constructor create a new EndpointSamlMutate.
* @param enabled true if the module will be applied to traffic, false to disable. default true if unspecified
* @param optionsPassthrough Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
- * @param cookiePrefix the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
+ * @param cookiePrefix the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
* @param 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.
* @param maximumDuration Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
* @param idpMetadata The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.
@@ -56,7 +56,7 @@ object EndpointSamlMutate {
idpMetadata <- c.downField("idp_metadata").as[String]
forceAuthn <- c.downField("force_authn").as[Boolean]
allowIdpInitiated <- c.downField("allow_idp_initiated").as[Option[Boolean]]
- authorizedGroups <- c.downField("authorized_groups").as[List[String]]
+ authorizedGroups <- c.downField("authorized_groups").as[Option[List[String]]]
nameidFormat <- c.downField("nameid_format").as[String]
} yield EndpointSamlMutate(
enabled,
@@ -67,7 +67,7 @@ object EndpointSamlMutate {
idpMetadata,
forceAuthn,
allowIdpInitiated,
- authorizedGroups,
+ authorizedGroups.getOrElse(List.empty),
nameidFormat
)
}
diff --git a/src/main/scala/com/ngrok/definitions/EventDestinationList.scala b/src/main/scala/com/ngrok/definitions/EventDestinationList.scala
index cf013ad..ff9e787 100644
--- a/src/main/scala/com/ngrok/definitions/EventDestinationList.scala
+++ b/src/main/scala/com/ngrok/definitions/EventDestinationList.scala
@@ -27,11 +27,11 @@ object EventDestinationList {
implicit val decodeEventDestinationList: io.circe.Decoder[EventDestinationList] = (c: io.circe.HCursor) =>
for {
- eventDestinations <- c.downField("event_destinations").as[List[EventDestination]]
+ eventDestinations <- c.downField("event_destinations").as[Option[List[EventDestination]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield EventDestinationList(
- eventDestinations,
+ eventDestinations.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/EventSourceList.scala b/src/main/scala/com/ngrok/definitions/EventSourceList.scala
index 3d810e3..0838a21 100644
--- a/src/main/scala/com/ngrok/definitions/EventSourceList.scala
+++ b/src/main/scala/com/ngrok/definitions/EventSourceList.scala
@@ -24,10 +24,10 @@ object EventSourceList {
implicit val decodeEventSourceList: io.circe.Decoder[EventSourceList] = (c: io.circe.HCursor) =>
for {
- sources <- c.downField("sources").as[List[EventSource]]
+ sources <- c.downField("sources").as[Option[List[EventSource]]]
uri <- c.downField("uri").as[java.net.URI]
} yield EventSourceList(
- sources,
+ sources.getOrElse(List.empty),
uri
)
}
diff --git a/src/main/scala/com/ngrok/definitions/EventSubscription.scala b/src/main/scala/com/ngrok/definitions/EventSubscription.scala
index 1e35fb2..ba0acf3 100644
--- a/src/main/scala/com/ngrok/definitions/EventSubscription.scala
+++ b/src/main/scala/com/ngrok/definitions/EventSubscription.scala
@@ -44,15 +44,15 @@ object EventSubscription {
createdAt <- c.downField("created_at").as[java.time.OffsetDateTime]
metadata <- c.downField("metadata").as[String]
description <- c.downField("description").as[String]
- sources <- c.downField("sources").as[List[EventSource]]
- destinations <- c.downField("destinations").as[List[Ref]]
+ sources <- c.downField("sources").as[Option[List[EventSource]]]
+ destinations <- c.downField("destinations").as[Option[List[Ref]]]
} yield EventSubscription(
id,
uri,
createdAt,
metadata,
description,
- sources,
- destinations
+ sources.getOrElse(List.empty),
+ destinations.getOrElse(List.empty)
)
}
diff --git a/src/main/scala/com/ngrok/definitions/EventSubscriptionList.scala b/src/main/scala/com/ngrok/definitions/EventSubscriptionList.scala
index 77b873f..ffe25b9 100644
--- a/src/main/scala/com/ngrok/definitions/EventSubscriptionList.scala
+++ b/src/main/scala/com/ngrok/definitions/EventSubscriptionList.scala
@@ -27,11 +27,11 @@ object EventSubscriptionList {
implicit val decodeEventSubscriptionList: io.circe.Decoder[EventSubscriptionList] = (c: io.circe.HCursor) =>
for {
- eventSubscriptions <- c.downField("event_subscriptions").as[List[EventSubscription]]
+ eventSubscriptions <- c.downField("event_subscriptions").as[Option[List[EventSubscription]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield EventSubscriptionList(
- eventSubscriptions,
+ eventSubscriptions.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/FailoverBackend.scala b/src/main/scala/com/ngrok/definitions/FailoverBackend.scala
index 997e6a0..adb6008 100644
--- a/src/main/scala/com/ngrok/definitions/FailoverBackend.scala
+++ b/src/main/scala/com/ngrok/definitions/FailoverBackend.scala
@@ -14,7 +14,7 @@ import io.circe.syntax._
*/
final case class FailoverBackend(
id: String,
- uri: String,
+ uri: java.net.URI,
createdAt: java.time.OffsetDateTime,
description: String,
metadata: String,
@@ -37,17 +37,17 @@ object FailoverBackend {
implicit val decodeFailoverBackend: io.circe.Decoder[FailoverBackend] = (c: io.circe.HCursor) =>
for {
id <- c.downField("id").as[String]
- uri <- c.downField("uri").as[String]
+ uri <- c.downField("uri").as[java.net.URI]
createdAt <- c.downField("created_at").as[java.time.OffsetDateTime]
description <- c.downField("description").as[String]
metadata <- c.downField("metadata").as[String]
- backends <- c.downField("backends").as[List[String]]
+ backends <- c.downField("backends").as[Option[List[String]]]
} yield FailoverBackend(
id,
uri,
createdAt,
description,
metadata,
- backends
+ backends.getOrElse(List.empty)
)
}
diff --git a/src/main/scala/com/ngrok/definitions/FailoverBackendList.scala b/src/main/scala/com/ngrok/definitions/FailoverBackendList.scala
index ee60e8b..98921c4 100644
--- a/src/main/scala/com/ngrok/definitions/FailoverBackendList.scala
+++ b/src/main/scala/com/ngrok/definitions/FailoverBackendList.scala
@@ -27,11 +27,11 @@ object FailoverBackendList {
implicit val decodeFailoverBackendList: io.circe.Decoder[FailoverBackendList] = (c: io.circe.HCursor) =>
for {
- backends <- c.downField("backends").as[List[FailoverBackend]]
+ backends <- c.downField("backends").as[Option[List[FailoverBackend]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield FailoverBackendList(
- backends,
+ backends.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/HttpResponseBackend.scala b/src/main/scala/com/ngrok/definitions/HttpResponseBackend.scala
index 305d400..a288fdb 100644
--- a/src/main/scala/com/ngrok/definitions/HttpResponseBackend.scala
+++ b/src/main/scala/com/ngrok/definitions/HttpResponseBackend.scala
@@ -16,7 +16,7 @@ import io.circe.syntax._
*/
final case class HttpResponseBackend(
id: String,
- uri: String,
+ uri: java.net.URI,
createdAt: java.time.OffsetDateTime,
description: String,
metadata: String,
@@ -43,12 +43,12 @@ object HttpResponseBackend {
implicit val decodeHttpResponseBackend: io.circe.Decoder[HttpResponseBackend] = (c: io.circe.HCursor) =>
for {
id <- c.downField("id").as[String]
- uri <- c.downField("uri").as[String]
+ uri <- c.downField("uri").as[java.net.URI]
createdAt <- c.downField("created_at").as[java.time.OffsetDateTime]
description <- c.downField("description").as[String]
metadata <- c.downField("metadata").as[String]
body <- c.downField("body").as[String]
- headers <- c.downField("headers").as[Map[String, String]]
+ headers <- c.downField("headers").as[Option[Map[String, String]]]
statusCode <- c.downField("status_code").as[Int]
} yield HttpResponseBackend(
id,
@@ -57,7 +57,7 @@ object HttpResponseBackend {
description,
metadata,
body,
- headers,
+ headers.getOrElse(Map.empty),
statusCode
)
}
diff --git a/src/main/scala/com/ngrok/definitions/HttpResponseBackendList.scala b/src/main/scala/com/ngrok/definitions/HttpResponseBackendList.scala
index dc1bcfb..45159d8 100644
--- a/src/main/scala/com/ngrok/definitions/HttpResponseBackendList.scala
+++ b/src/main/scala/com/ngrok/definitions/HttpResponseBackendList.scala
@@ -27,11 +27,11 @@ object HttpResponseBackendList {
implicit val decodeHttpResponseBackendList: io.circe.Decoder[HttpResponseBackendList] = (c: io.circe.HCursor) =>
for {
- backends <- c.downField("backends").as[List[HttpResponseBackend]]
+ backends <- c.downField("backends").as[Option[List[HttpResponseBackend]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield HttpResponseBackendList(
- backends,
+ backends.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/HttpsEdge.scala b/src/main/scala/com/ngrok/definitions/HttpsEdge.scala
index 428faa4..a537f2f 100644
--- a/src/main/scala/com/ngrok/definitions/HttpsEdge.scala
+++ b/src/main/scala/com/ngrok/definitions/HttpsEdge.scala
@@ -19,8 +19,8 @@ final case class HttpsEdge(
id: String,
description: String,
metadata: String,
- createdAt: String,
- uri: String,
+ createdAt: java.time.OffsetDateTime,
+ uri: java.net.URI,
hostports: Option[List[String]] = None,
mutualTls: Option[EndpointMutualTls] = None,
tlsTermination: Option[EndpointTlsTermination] = None,
@@ -35,7 +35,7 @@ object HttpsEdge {
Option(("metadata", value.metadata.asJson)),
Option(("created_at", value.createdAt.asJson)),
Option(("uri", value.uri.asJson)),
- value.hostports.map(_.asJson).map(("hostports", _)),
+ if (value.hostports.isEmpty) None else Option(("hostports", value.hostports.asJson)),
value.mutualTls.map(_.asJson).map(("mutual_tls", _)),
value.tlsTermination.map(_.asJson).map(("tls_termination", _)),
Option(("routes", value.routes.asJson))
@@ -47,12 +47,12 @@ object HttpsEdge {
id <- c.downField("id").as[String]
description <- c.downField("description").as[String]
metadata <- c.downField("metadata").as[String]
- createdAt <- c.downField("created_at").as[String]
- uri <- c.downField("uri").as[String]
+ createdAt <- c.downField("created_at").as[java.time.OffsetDateTime]
+ uri <- c.downField("uri").as[java.net.URI]
hostports <- c.downField("hostports").as[Option[List[String]]]
mutualTls <- c.downField("mutual_tls").as[Option[EndpointMutualTls]]
tlsTermination <- c.downField("tls_termination").as[Option[EndpointTlsTermination]]
- routes <- c.downField("routes").as[List[HttpsEdgeRoute]]
+ routes <- c.downField("routes").as[Option[List[HttpsEdgeRoute]]]
} yield HttpsEdge(
id,
description,
@@ -62,6 +62,6 @@ object HttpsEdge {
hostports,
mutualTls,
tlsTermination,
- routes
+ routes.getOrElse(List.empty)
)
}
diff --git a/src/main/scala/com/ngrok/definitions/HttpsEdgeList.scala b/src/main/scala/com/ngrok/definitions/HttpsEdgeList.scala
index 818782a..b15a43b 100644
--- a/src/main/scala/com/ngrok/definitions/HttpsEdgeList.scala
+++ b/src/main/scala/com/ngrok/definitions/HttpsEdgeList.scala
@@ -27,11 +27,11 @@ object HttpsEdgeList {
implicit val decodeHttpsEdgeList: io.circe.Decoder[HttpsEdgeList] = (c: io.circe.HCursor) =>
for {
- httpsEdges <- c.downField("https_edges").as[List[HttpsEdge]]
+ httpsEdges <- c.downField("https_edges").as[Option[List[HttpsEdge]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield HttpsEdgeList(
- httpsEdges,
+ httpsEdges.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/HttpsEdgeRoute.scala b/src/main/scala/com/ngrok/definitions/HttpsEdgeRoute.scala
index 1b562ac..bba20dc 100644
--- a/src/main/scala/com/ngrok/definitions/HttpsEdgeRoute.scala
+++ b/src/main/scala/com/ngrok/definitions/HttpsEdgeRoute.scala
@@ -8,8 +8,8 @@ import io.circe.syntax._
* @param edgeId unique identifier of this edge
* @param id unique identifier of this edge route
* @param createdAt timestamp when the edge configuration was created, RFC 3339 format
- * @param matchType Type of match to use for this route. Valid values are "exact_path" and "path_prefix".
- * @param `match` Route selector: "/blog" or "example.com" or "example.com/blog"
+ * @param matchType Type of match to use for this route. Valid values are "exact_path" and "path_prefix".
+ * @param `match` Route selector: "/blog" or "example.com" or "example.com/blog"
* @param uri URI of the edge API resource
* @param description human-readable description of what this edge will be used for; optional, max 255 bytes.
* @param metadata arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
@@ -28,10 +28,10 @@ import io.circe.syntax._
final case class HttpsEdgeRoute(
edgeId: String,
id: String,
- createdAt: String,
+ createdAt: java.time.OffsetDateTime,
matchType: String,
`match`: String,
- uri: String,
+ uri: java.net.URI,
description: String,
metadata: String,
backend: Option[EndpointBackend] = None,
@@ -77,10 +77,10 @@ object HttpsEdgeRoute {
for {
edgeId <- c.downField("edge_id").as[String]
id <- c.downField("id").as[String]
- createdAt <- c.downField("created_at").as[String]
+ createdAt <- c.downField("created_at").as[java.time.OffsetDateTime]
matchType <- c.downField("match_type").as[String]
`match` <- c.downField("match").as[String]
- uri <- c.downField("uri").as[String]
+ uri <- c.downField("uri").as[java.net.URI]
description <- c.downField("description").as[String]
metadata <- c.downField("metadata").as[String]
backend <- c.downField("backend").as[Option[EndpointBackend]]
diff --git a/src/main/scala/com/ngrok/definitions/IpPolicyList.scala b/src/main/scala/com/ngrok/definitions/IpPolicyList.scala
index 2127c0d..be2eabb 100644
--- a/src/main/scala/com/ngrok/definitions/IpPolicyList.scala
+++ b/src/main/scala/com/ngrok/definitions/IpPolicyList.scala
@@ -26,11 +26,11 @@ object IpPolicyList {
implicit val decodeIpPolicyList: io.circe.Decoder[IpPolicyList] = (c: io.circe.HCursor) =>
for {
- ipPolicies <- c.downField("ip_policies").as[List[IpPolicy]]
+ ipPolicies <- c.downField("ip_policies").as[Option[List[IpPolicy]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield IpPolicyList(
- ipPolicies,
+ ipPolicies.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/IpPolicyRuleList.scala b/src/main/scala/com/ngrok/definitions/IpPolicyRuleList.scala
index 9337252..0d689d2 100644
--- a/src/main/scala/com/ngrok/definitions/IpPolicyRuleList.scala
+++ b/src/main/scala/com/ngrok/definitions/IpPolicyRuleList.scala
@@ -27,11 +27,11 @@ object IpPolicyRuleList {
implicit val decodeIpPolicyRuleList: io.circe.Decoder[IpPolicyRuleList] = (c: io.circe.HCursor) =>
for {
- ipPolicyRules <- c.downField("ip_policy_rules").as[List[IpPolicyRule]]
+ ipPolicyRules <- c.downField("ip_policy_rules").as[Option[List[IpPolicyRule]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield IpPolicyRuleList(
- ipPolicyRules,
+ ipPolicyRules.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/IpRestriction.scala b/src/main/scala/com/ngrok/definitions/IpRestriction.scala
index bf6fc6c..c136385 100644
--- a/src/main/scala/com/ngrok/definitions/IpRestriction.scala
+++ b/src/main/scala/com/ngrok/definitions/IpRestriction.scala
@@ -49,7 +49,7 @@ object IpRestriction {
metadata <- c.downField("metadata").as[String]
enforced <- c.downField("enforced").as[Boolean]
`type` <- c.downField("type").as[String]
- ipPolicies <- c.downField("ip_policies").as[List[Ref]]
+ ipPolicies <- c.downField("ip_policies").as[Option[List[Ref]]]
} yield IpRestriction(
id,
uri,
@@ -58,6 +58,6 @@ object IpRestriction {
metadata,
enforced,
`type`,
- ipPolicies
+ ipPolicies.getOrElse(List.empty)
)
}
diff --git a/src/main/scala/com/ngrok/definitions/IpRestrictionList.scala b/src/main/scala/com/ngrok/definitions/IpRestrictionList.scala
index 425a57a..d3b6b9b 100644
--- a/src/main/scala/com/ngrok/definitions/IpRestrictionList.scala
+++ b/src/main/scala/com/ngrok/definitions/IpRestrictionList.scala
@@ -27,11 +27,11 @@ object IpRestrictionList {
implicit val decodeIpRestrictionList: io.circe.Decoder[IpRestrictionList] = (c: io.circe.HCursor) =>
for {
- ipRestrictions <- c.downField("ip_restrictions").as[List[IpRestriction]]
+ ipRestrictions <- c.downField("ip_restrictions").as[Option[List[IpRestriction]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield IpRestrictionList(
- ipRestrictions,
+ ipRestrictions.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/ReservedAddrList.scala b/src/main/scala/com/ngrok/definitions/ReservedAddrList.scala
index a90be0d..bb903df 100644
--- a/src/main/scala/com/ngrok/definitions/ReservedAddrList.scala
+++ b/src/main/scala/com/ngrok/definitions/ReservedAddrList.scala
@@ -27,11 +27,11 @@ object ReservedAddrList {
implicit val decodeReservedAddrList: io.circe.Decoder[ReservedAddrList] = (c: io.circe.HCursor) =>
for {
- reservedAddrs <- c.downField("reserved_addrs").as[List[ReservedAddr]]
+ reservedAddrs <- c.downField("reserved_addrs").as[Option[List[ReservedAddr]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield ReservedAddrList(
- reservedAddrs,
+ reservedAddrs.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/ReservedDomainCertStatus.scala b/src/main/scala/com/ngrok/definitions/ReservedDomainCertStatus.scala
index 1e4f366..6c35460 100644
--- a/src/main/scala/com/ngrok/definitions/ReservedDomainCertStatus.scala
+++ b/src/main/scala/com/ngrok/definitions/ReservedDomainCertStatus.scala
@@ -6,7 +6,7 @@ import io.circe.syntax._
*
* @constructor create a new ReservedDomainCertStatus.
* @param renewsAt timestamp when the next renewal will be requested, RFC 3339 format
- * @param provisioningJob status of the certificate provisioning job, or null if the certificiate isn't being provisioned or renewed
+ * @param provisioningJob status of the certificate provisioning job, or null if the certificiate isn't being provisioned or renewed
*/
final case class ReservedDomainCertStatus(
renewsAt: Option[java.time.OffsetDateTime] = None,
diff --git a/src/main/scala/com/ngrok/definitions/ReservedDomainList.scala b/src/main/scala/com/ngrok/definitions/ReservedDomainList.scala
index 7feb182..549fb75 100644
--- a/src/main/scala/com/ngrok/definitions/ReservedDomainList.scala
+++ b/src/main/scala/com/ngrok/definitions/ReservedDomainList.scala
@@ -27,11 +27,11 @@ object ReservedDomainList {
implicit val decodeReservedDomainList: io.circe.Decoder[ReservedDomainList] = (c: io.circe.HCursor) =>
for {
- reservedDomains <- c.downField("reserved_domains").as[List[ReservedDomain]]
+ reservedDomains <- c.downField("reserved_domains").as[Option[List[ReservedDomain]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield ReservedDomainList(
- reservedDomains,
+ reservedDomains.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/SshCertificateAuthorityList.scala b/src/main/scala/com/ngrok/definitions/SshCertificateAuthorityList.scala
index a08960a..7c0ba37 100644
--- a/src/main/scala/com/ngrok/definitions/SshCertificateAuthorityList.scala
+++ b/src/main/scala/com/ngrok/definitions/SshCertificateAuthorityList.scala
@@ -28,11 +28,13 @@ object SshCertificateAuthorityList {
implicit val decodeSshCertificateAuthorityList: io.circe.Decoder[SshCertificateAuthorityList] =
(c: io.circe.HCursor) =>
for {
- sshCertificateAuthorities <- c.downField("ssh_certificate_authorities").as[List[SshCertificateAuthority]]
- uri <- c.downField("uri").as[java.net.URI]
- nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
+ sshCertificateAuthorities <- c
+ .downField("ssh_certificate_authorities")
+ .as[Option[List[SshCertificateAuthority]]]
+ uri <- c.downField("uri").as[java.net.URI]
+ nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield SshCertificateAuthorityList(
- sshCertificateAuthorities,
+ sshCertificateAuthorities.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/SshCredential.scala b/src/main/scala/com/ngrok/definitions/SshCredential.scala
index a5bbb30..47c935e 100644
--- a/src/main/scala/com/ngrok/definitions/SshCredential.scala
+++ b/src/main/scala/com/ngrok/definitions/SshCredential.scala
@@ -11,7 +11,7 @@ import io.circe.syntax._
* @param description human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.
* @param metadata arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
* @param publicKey the PEM-encoded public key of the SSH keypair that will be used to authenticate
- * @param 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.
+ * @param 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.
*/
final case class SshCredential(
id: String,
@@ -45,7 +45,7 @@ object SshCredential {
description <- c.downField("description").as[String]
metadata <- c.downField("metadata").as[String]
publicKey <- c.downField("public_key").as[String]
- acl <- c.downField("acl").as[List[String]]
+ acl <- c.downField("acl").as[Option[List[String]]]
} yield SshCredential(
id,
uri,
@@ -53,6 +53,6 @@ object SshCredential {
description,
metadata,
publicKey,
- acl
+ acl.getOrElse(List.empty)
)
}
diff --git a/src/main/scala/com/ngrok/definitions/SshCredentialList.scala b/src/main/scala/com/ngrok/definitions/SshCredentialList.scala
index bd56b9d..b8d41b9 100644
--- a/src/main/scala/com/ngrok/definitions/SshCredentialList.scala
+++ b/src/main/scala/com/ngrok/definitions/SshCredentialList.scala
@@ -27,11 +27,11 @@ object SshCredentialList {
implicit val decodeSshCredentialList: io.circe.Decoder[SshCredentialList] = (c: io.circe.HCursor) =>
for {
- sshCredentials <- c.downField("ssh_credentials").as[List[SshCredential]]
+ sshCredentials <- c.downField("ssh_credentials").as[Option[List[SshCredential]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield SshCredentialList(
- sshCredentials,
+ sshCredentials.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/SshHostCertificate.scala b/src/main/scala/com/ngrok/definitions/SshHostCertificate.scala
index 270b1f5..2c93d56 100644
--- a/src/main/scala/com/ngrok/definitions/SshHostCertificate.scala
+++ b/src/main/scala/com/ngrok/definitions/SshHostCertificate.scala
@@ -62,7 +62,7 @@ object SshHostCertificate {
publicKey <- c.downField("public_key").as[String]
keyType <- c.downField("key_type").as[String]
sshCertificateAuthorityId <- c.downField("ssh_certificate_authority_id").as[String]
- principals <- c.downField("principals").as[List[String]]
+ principals <- c.downField("principals").as[Option[List[String]]]
validAfter <- c.downField("valid_after").as[java.time.OffsetDateTime]
validUntil <- c.downField("valid_until").as[java.time.OffsetDateTime]
certificate <- c.downField("certificate").as[String]
@@ -75,7 +75,7 @@ object SshHostCertificate {
publicKey,
keyType,
sshCertificateAuthorityId,
- principals,
+ principals.getOrElse(List.empty),
validAfter,
validUntil,
certificate
diff --git a/src/main/scala/com/ngrok/definitions/SshHostCertificateList.scala b/src/main/scala/com/ngrok/definitions/SshHostCertificateList.scala
index 8b8a607..b4d4810 100644
--- a/src/main/scala/com/ngrok/definitions/SshHostCertificateList.scala
+++ b/src/main/scala/com/ngrok/definitions/SshHostCertificateList.scala
@@ -27,11 +27,11 @@ object SshHostCertificateList {
implicit val decodeSshHostCertificateList: io.circe.Decoder[SshHostCertificateList] = (c: io.circe.HCursor) =>
for {
- sshHostCertificates <- c.downField("ssh_host_certificates").as[List[SshHostCertificate]]
+ sshHostCertificates <- c.downField("ssh_host_certificates").as[Option[List[SshHostCertificate]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield SshHostCertificateList(
- sshHostCertificates,
+ sshHostCertificates.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/SshUserCertificate.scala b/src/main/scala/com/ngrok/definitions/SshUserCertificate.scala
index f0e02da..8fdf794 100644
--- a/src/main/scala/com/ngrok/definitions/SshUserCertificate.scala
+++ b/src/main/scala/com/ngrok/definitions/SshUserCertificate.scala
@@ -15,7 +15,7 @@ import io.circe.syntax._
* @param sshCertificateAuthorityId the ssh certificate authority that is used to sign this ssh user certificate
* @param 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.
* @param 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.
- * @param 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.
+ * @param 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.
* @param validAfter the time when the ssh host certificate becomes valid, in RFC 3339 format.
* @param validUntil the time after which the ssh host certificate becomes invalid, in RFC 3339 format. the OpenSSH certificates RFC calls this valid_before.
* @param 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
@@ -68,9 +68,9 @@ object SshUserCertificate {
publicKey <- c.downField("public_key").as[String]
keyType <- c.downField("key_type").as[String]
sshCertificateAuthorityId <- c.downField("ssh_certificate_authority_id").as[String]
- principals <- c.downField("principals").as[List[String]]
- criticalOptions <- c.downField("critical_options").as[Map[String, String]]
- extensions <- c.downField("extensions").as[Map[String, String]]
+ principals <- c.downField("principals").as[Option[List[String]]]
+ criticalOptions <- c.downField("critical_options").as[Option[Map[String, String]]]
+ extensions <- c.downField("extensions").as[Option[Map[String, String]]]
validAfter <- c.downField("valid_after").as[java.time.OffsetDateTime]
validUntil <- c.downField("valid_until").as[java.time.OffsetDateTime]
certificate <- c.downField("certificate").as[String]
@@ -83,9 +83,9 @@ object SshUserCertificate {
publicKey,
keyType,
sshCertificateAuthorityId,
- principals,
- criticalOptions,
- extensions,
+ principals.getOrElse(List.empty),
+ criticalOptions.getOrElse(Map.empty),
+ extensions.getOrElse(Map.empty),
validAfter,
validUntil,
certificate
diff --git a/src/main/scala/com/ngrok/definitions/SshUserCertificateList.scala b/src/main/scala/com/ngrok/definitions/SshUserCertificateList.scala
index 9f5aac1..ed88c08 100644
--- a/src/main/scala/com/ngrok/definitions/SshUserCertificateList.scala
+++ b/src/main/scala/com/ngrok/definitions/SshUserCertificateList.scala
@@ -27,11 +27,11 @@ object SshUserCertificateList {
implicit val decodeSshUserCertificateList: io.circe.Decoder[SshUserCertificateList] = (c: io.circe.HCursor) =>
for {
- sshUserCertificates <- c.downField("ssh_user_certificates").as[List[SshUserCertificate]]
+ sshUserCertificates <- c.downField("ssh_user_certificates").as[Option[List[SshUserCertificate]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield SshUserCertificateList(
- sshUserCertificates,
+ sshUserCertificates.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/TcpEdge.scala b/src/main/scala/com/ngrok/definitions/TcpEdge.scala
index 2926093..45ee770 100644
--- a/src/main/scala/com/ngrok/definitions/TcpEdge.scala
+++ b/src/main/scala/com/ngrok/definitions/TcpEdge.scala
@@ -33,7 +33,7 @@ object TcpEdge {
Option(("metadata", value.metadata.asJson)),
Option(("created_at", value.createdAt.asJson)),
Option(("uri", value.uri.asJson)),
- value.hostports.map(_.asJson).map(("hostports", _)),
+ if (value.hostports.isEmpty) None else Option(("hostports", value.hostports.asJson)),
value.backend.map(_.asJson).map(("backend", _)),
value.ipRestriction.map(_.asJson).map(("ip_restriction", _))
).flatten.toMap.asJsonObject
diff --git a/src/main/scala/com/ngrok/definitions/TcpEdgeList.scala b/src/main/scala/com/ngrok/definitions/TcpEdgeList.scala
index 607ed6f..07dab45 100644
--- a/src/main/scala/com/ngrok/definitions/TcpEdgeList.scala
+++ b/src/main/scala/com/ngrok/definitions/TcpEdgeList.scala
@@ -26,11 +26,11 @@ object TcpEdgeList {
implicit val decodeTcpEdgeList: io.circe.Decoder[TcpEdgeList] = (c: io.circe.HCursor) =>
for {
- tcpEdges <- c.downField("tcp_edges").as[List[TcpEdge]]
+ tcpEdges <- c.downField("tcp_edges").as[Option[List[TcpEdge]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield TcpEdgeList(
- tcpEdges,
+ tcpEdges.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/TlsCertificate.scala b/src/main/scala/com/ngrok/definitions/TlsCertificate.scala
index 8d3e6d0..e86e40e 100644
--- a/src/main/scala/com/ngrok/definitions/TlsCertificate.scala
+++ b/src/main/scala/com/ngrok/definitions/TlsCertificate.scala
@@ -92,8 +92,8 @@ object TlsCertificate {
issuedAt <- c.downField("issued_at").as[Option[java.time.OffsetDateTime]]
notBefore <- c.downField("not_before").as[java.time.OffsetDateTime]
notAfter <- c.downField("not_after").as[java.time.OffsetDateTime]
- keyUsages <- c.downField("key_usages").as[List[String]]
- extendedKeyUsages <- c.downField("extended_key_usages").as[List[String]]
+ keyUsages <- c.downField("key_usages").as[Option[List[String]]]
+ extendedKeyUsages <- c.downField("extended_key_usages").as[Option[List[String]]]
privateKeyType <- c.downField("private_key_type").as[String]
issuerCommonName <- c.downField("issuer_common_name").as[String]
serialNumber <- c.downField("serial_number").as[String]
@@ -114,8 +114,8 @@ object TlsCertificate {
issuedAt,
notBefore,
notAfter,
- keyUsages,
- extendedKeyUsages,
+ keyUsages.getOrElse(List.empty),
+ extendedKeyUsages.getOrElse(List.empty),
privateKeyType,
issuerCommonName,
serialNumber,
diff --git a/src/main/scala/com/ngrok/definitions/TlsCertificateList.scala b/src/main/scala/com/ngrok/definitions/TlsCertificateList.scala
index fae4563..243314a 100644
--- a/src/main/scala/com/ngrok/definitions/TlsCertificateList.scala
+++ b/src/main/scala/com/ngrok/definitions/TlsCertificateList.scala
@@ -27,11 +27,11 @@ object TlsCertificateList {
implicit val decodeTlsCertificateList: io.circe.Decoder[TlsCertificateList] = (c: io.circe.HCursor) =>
for {
- tlsCertificates <- c.downField("tls_certificates").as[List[TlsCertificate]]
+ tlsCertificates <- c.downField("tls_certificates").as[Option[List[TlsCertificate]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield TlsCertificateList(
- tlsCertificates,
+ tlsCertificates.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/TlsCertificateSaNs.scala b/src/main/scala/com/ngrok/definitions/TlsCertificateSaNs.scala
index d7ca910..a7066f0 100644
--- a/src/main/scala/com/ngrok/definitions/TlsCertificateSaNs.scala
+++ b/src/main/scala/com/ngrok/definitions/TlsCertificateSaNs.scala
@@ -24,10 +24,10 @@ object TlsCertificateSaNs {
implicit val decodeTlsCertificateSaNs: io.circe.Decoder[TlsCertificateSaNs] = (c: io.circe.HCursor) =>
for {
- dnsNames <- c.downField("dns_names").as[List[String]]
- ips <- c.downField("ips").as[List[String]]
+ dnsNames <- c.downField("dns_names").as[Option[List[String]]]
+ ips <- c.downField("ips").as[Option[List[String]]]
} yield TlsCertificateSaNs(
- dnsNames,
- ips
+ dnsNames.getOrElse(List.empty),
+ ips.getOrElse(List.empty)
)
}
diff --git a/src/main/scala/com/ngrok/definitions/TlsEdge.scala b/src/main/scala/com/ngrok/definitions/TlsEdge.scala
index a3061f5..9925857 100644
--- a/src/main/scala/com/ngrok/definitions/TlsEdge.scala
+++ b/src/main/scala/com/ngrok/definitions/TlsEdge.scala
@@ -37,7 +37,7 @@ object TlsEdge {
Option(("metadata", value.metadata.asJson)),
Option(("created_at", value.createdAt.asJson)),
Option(("uri", value.uri.asJson)),
- value.hostports.map(_.asJson).map(("hostports", _)),
+ if (value.hostports.isEmpty) None else Option(("hostports", value.hostports.asJson)),
value.backend.map(_.asJson).map(("backend", _)),
value.ipRestriction.map(_.asJson).map(("ip_restriction", _)),
value.mutualTls.map(_.asJson).map(("mutual_tls", _)),
diff --git a/src/main/scala/com/ngrok/definitions/TlsEdgeList.scala b/src/main/scala/com/ngrok/definitions/TlsEdgeList.scala
index 776a8e1..b251f41 100644
--- a/src/main/scala/com/ngrok/definitions/TlsEdgeList.scala
+++ b/src/main/scala/com/ngrok/definitions/TlsEdgeList.scala
@@ -26,11 +26,11 @@ object TlsEdgeList {
implicit val decodeTlsEdgeList: io.circe.Decoder[TlsEdgeList] = (c: io.circe.HCursor) =>
for {
- tlsEdges <- c.downField("tls_edges").as[List[TlsEdge]]
+ tlsEdges <- c.downField("tls_edges").as[Option[List[TlsEdge]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield TlsEdgeList(
- tlsEdges,
+ tlsEdges.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/Tunnel.scala b/src/main/scala/com/ngrok/definitions/Tunnel.scala
index ccc7797..580c46d 100644
--- a/src/main/scala/com/ngrok/definitions/Tunnel.scala
+++ b/src/main/scala/com/ngrok/definitions/Tunnel.scala
@@ -6,7 +6,7 @@ import io.circe.syntax._
*
* @constructor create a new Tunnel.
* @param id unique tunnel resource identifier
- * @param publicUrl URL of the ephemeral tunnel's public endpoint
+ * @param publicUrl URL of the ephemeral tunnel's public endpoint
* @param startedAt timestamp when the tunnel was initiated in RFC 3339 format
* @param 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.
* @param proto tunnel protocol for ephemeral tunnels. one of http, https, tcp or tls
@@ -43,7 +43,7 @@ object Tunnel {
Option(("tunnel_session", value.tunnelSession.asJson)),
value.endpoint.map(_.asJson).map(("endpoint", _)),
Option(("labels", value.labels.asJson)),
- value.backends.map(_.asJson).map(("backends", _)),
+ if (value.backends.isEmpty) None else Option(("backends", value.backends.asJson)),
Option(("forwards_to", value.forwardsTo.asJson))
).flatten.toMap.asJsonObject
)
@@ -58,7 +58,7 @@ object Tunnel {
region <- c.downField("region").as[String]
tunnelSession <- c.downField("tunnel_session").as[Ref]
endpoint <- c.downField("endpoint").as[Option[Ref]]
- labels <- c.downField("labels").as[Map[String, String]]
+ labels <- c.downField("labels").as[Option[Map[String, String]]]
backends <- c.downField("backends").as[Option[List[Ref]]]
forwardsTo <- c.downField("forwards_to").as[String]
} yield Tunnel(
@@ -70,7 +70,7 @@ object Tunnel {
region,
tunnelSession,
endpoint,
- labels,
+ labels.getOrElse(Map.empty),
backends,
forwardsTo
)
diff --git a/src/main/scala/com/ngrok/definitions/TunnelGroupBackend.scala b/src/main/scala/com/ngrok/definitions/TunnelGroupBackend.scala
index 4bca4d3..a4c04e5 100644
--- a/src/main/scala/com/ngrok/definitions/TunnelGroupBackend.scala
+++ b/src/main/scala/com/ngrok/definitions/TunnelGroupBackend.scala
@@ -10,12 +10,12 @@ import io.circe.syntax._
* @param createdAt timestamp when the backend was created, RFC 3339 format
* @param description human-readable description of this backend. Optional
* @param metadata arbitrary user-defined machine-readable data of this backend. Optional
- * @param labels labels to watch for tunnels on, e.g. app->foo, dc->bar
+ * @param labels labels to watch for tunnels on, e.g. app->foo, dc->bar
* @param tunnels tunnels matching this backend
*/
final case class TunnelGroupBackend(
id: String,
- uri: String,
+ uri: java.net.URI,
createdAt: java.time.OffsetDateTime,
description: String,
metadata: String,
@@ -40,19 +40,19 @@ object TunnelGroupBackend {
implicit val decodeTunnelGroupBackend: io.circe.Decoder[TunnelGroupBackend] = (c: io.circe.HCursor) =>
for {
id <- c.downField("id").as[String]
- uri <- c.downField("uri").as[String]
+ uri <- c.downField("uri").as[java.net.URI]
createdAt <- c.downField("created_at").as[java.time.OffsetDateTime]
description <- c.downField("description").as[String]
metadata <- c.downField("metadata").as[String]
- labels <- c.downField("labels").as[Map[String, String]]
- tunnels <- c.downField("tunnels").as[List[Ref]]
+ labels <- c.downField("labels").as[Option[Map[String, String]]]
+ tunnels <- c.downField("tunnels").as[Option[List[Ref]]]
} yield TunnelGroupBackend(
id,
uri,
createdAt,
description,
metadata,
- labels,
- tunnels
+ labels.getOrElse(Map.empty),
+ tunnels.getOrElse(List.empty)
)
}
diff --git a/src/main/scala/com/ngrok/definitions/TunnelGroupBackendList.scala b/src/main/scala/com/ngrok/definitions/TunnelGroupBackendList.scala
index 09099c8..ecfa5cb 100644
--- a/src/main/scala/com/ngrok/definitions/TunnelGroupBackendList.scala
+++ b/src/main/scala/com/ngrok/definitions/TunnelGroupBackendList.scala
@@ -27,11 +27,11 @@ object TunnelGroupBackendList {
implicit val decodeTunnelGroupBackendList: io.circe.Decoder[TunnelGroupBackendList] = (c: io.circe.HCursor) =>
for {
- backends <- c.downField("backends").as[List[TunnelGroupBackend]]
+ backends <- c.downField("backends").as[Option[List[TunnelGroupBackend]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield TunnelGroupBackendList(
- backends,
+ backends.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/TunnelList.scala b/src/main/scala/com/ngrok/definitions/TunnelList.scala
index 1cfe879..ad92977 100644
--- a/src/main/scala/com/ngrok/definitions/TunnelList.scala
+++ b/src/main/scala/com/ngrok/definitions/TunnelList.scala
@@ -26,11 +26,11 @@ object TunnelList {
implicit val decodeTunnelList: io.circe.Decoder[TunnelList] = (c: io.circe.HCursor) =>
for {
- tunnels <- c.downField("tunnels").as[List[Tunnel]]
+ tunnels <- c.downField("tunnels").as[Option[List[Tunnel]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield TunnelList(
- tunnels,
+ tunnels.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/TunnelSessionList.scala b/src/main/scala/com/ngrok/definitions/TunnelSessionList.scala
index df287b3..c00349e 100644
--- a/src/main/scala/com/ngrok/definitions/TunnelSessionList.scala
+++ b/src/main/scala/com/ngrok/definitions/TunnelSessionList.scala
@@ -27,11 +27,11 @@ object TunnelSessionList {
implicit val decodeTunnelSessionList: io.circe.Decoder[TunnelSessionList] = (c: io.circe.HCursor) =>
for {
- tunnelSessions <- c.downField("tunnel_sessions").as[List[TunnelSession]]
+ tunnelSessions <- c.downField("tunnel_sessions").as[Option[List[TunnelSession]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield TunnelSessionList(
- tunnelSessions,
+ tunnelSessions.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/definitions/WeightedBackend.scala b/src/main/scala/com/ngrok/definitions/WeightedBackend.scala
index 2c5b960..51a90dc 100644
--- a/src/main/scala/com/ngrok/definitions/WeightedBackend.scala
+++ b/src/main/scala/com/ngrok/definitions/WeightedBackend.scala
@@ -14,7 +14,7 @@ import io.circe.syntax._
*/
final case class WeightedBackend(
id: String,
- uri: String,
+ uri: java.net.URI,
createdAt: java.time.OffsetDateTime,
description: String,
metadata: String,
@@ -37,17 +37,17 @@ object WeightedBackend {
implicit val decodeWeightedBackend: io.circe.Decoder[WeightedBackend] = (c: io.circe.HCursor) =>
for {
id <- c.downField("id").as[String]
- uri <- c.downField("uri").as[String]
+ uri <- c.downField("uri").as[java.net.URI]
createdAt <- c.downField("created_at").as[java.time.OffsetDateTime]
description <- c.downField("description").as[String]
metadata <- c.downField("metadata").as[String]
- backends <- c.downField("backends").as[Map[String, Long]]
+ backends <- c.downField("backends").as[Option[Map[String, Long]]]
} yield WeightedBackend(
id,
uri,
createdAt,
description,
metadata,
- backends
+ backends.getOrElse(Map.empty)
)
}
diff --git a/src/main/scala/com/ngrok/definitions/WeightedBackendList.scala b/src/main/scala/com/ngrok/definitions/WeightedBackendList.scala
index 260ba09..8aaa63a 100644
--- a/src/main/scala/com/ngrok/definitions/WeightedBackendList.scala
+++ b/src/main/scala/com/ngrok/definitions/WeightedBackendList.scala
@@ -27,11 +27,11 @@ object WeightedBackendList {
implicit val decodeWeightedBackendList: io.circe.Decoder[WeightedBackendList] = (c: io.circe.HCursor) =>
for {
- backends <- c.downField("backends").as[List[WeightedBackend]]
+ backends <- c.downField("backends").as[Option[List[WeightedBackend]]]
uri <- c.downField("uri").as[java.net.URI]
nextPageUri <- c.downField("next_page_uri").as[Option[java.net.URI]]
} yield WeightedBackendList(
- backends,
+ backends.getOrElse(List.empty),
uri,
nextPageUri
)
diff --git a/src/main/scala/com/ngrok/services/AbuseReports.scala b/src/main/scala/com/ngrok/services/AbuseReports.scala
index 44962ac..c2ad032 100644
--- a/src/main/scala/com/ngrok/services/AbuseReports.scala
+++ b/src/main/scala/com/ngrok/services/AbuseReports.scala
@@ -24,7 +24,7 @@ object AbuseReports {
}
/** 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.
*/
diff --git a/src/main/scala/com/ngrok/services/ApiKeys.scala b/src/main/scala/com/ngrok/services/ApiKeys.scala
index 201ffc9..35a68c9 100644
--- a/src/main/scala/com/ngrok/services/ApiKeys.scala
+++ b/src/main/scala/com/ngrok/services/ApiKeys.scala
@@ -40,7 +40,8 @@ object ApiKeys {
/** 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/src/main/scala/com/ngrok/services/Credentials.scala b/src/main/scala/com/ngrok/services/Credentials.scala
index b795969..a235544 100644
--- a/src/main/scala/com/ngrok/services/Credentials.scala
+++ b/src/main/scala/com/ngrok/services/Credentials.scala
@@ -10,7 +10,7 @@ object Credentials {
private case class CredentialsCreate(
description: Option[String],
metadata: Option[String],
- acl: Option[List[String]]
+ acl: List[String]
)
private object CredentialsCreate {
@@ -18,7 +18,7 @@ object Credentials {
List(
value.description.map(_.asJson).map(("description", _)),
value.metadata.map(_.asJson).map(("metadata", _)),
- value.acl.map(_.asJson).map(("acl", _))
+ if (value.acl.isEmpty) None else Option(("acl", value.acl.asJson))
).flatten.toMap.asJsonObject
)
}
@@ -26,7 +26,7 @@ object Credentials {
private case class CredentialsUpdate(
description: Option[String],
metadata: Option[String],
- acl: Option[List[String]]
+ acl: List[String]
)
private object CredentialsUpdate {
@@ -34,7 +34,7 @@ object Credentials {
List(
value.description.map(_.asJson).map(("description", _)),
value.metadata.map(_.asJson).map(("metadata", _)),
- value.acl.map(_.asJson).map(("acl", _))
+ if (value.acl.isEmpty) None else Option(("acl", value.acl.asJson))
).flatten.toMap.asJsonObject
)
}
@@ -43,7 +43,7 @@ object Credentials {
/** 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.
*
@@ -61,13 +61,13 @@ class Credentials private[ngrok] (apiClient: NgrokApiClient)(implicit ec: Execut
*
* @param description human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
* @param metadata arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
- * @param 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.
+ * @param 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.
* @return a [[scala.concurrent.Future]] encapsulating the API call's result
*/
def create(
description: Option[String] = None,
metadata: Option[String] = None,
- acl: Option[List[String]] = None
+ acl: List[String] = List.empty
): Future[Credential] =
apiClient.sendRequest[Credential](
NgrokApiClient.HttpMethod.Post,
@@ -147,14 +147,14 @@ class Credentials private[ngrok] (apiClient: NgrokApiClient)(implicit ec: Execut
* @param id the value of the id parameter as a [[scala.Predef.String]]
* @param description human-readable description of who or what will use the credential to authenticate. Optional, max 255 bytes.
* @param metadata arbitrary user-defined machine-readable data of this credential. Optional, max 4096 bytes.
- * @param 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.
+ * @param 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.
* @return a [[scala.concurrent.Future]] encapsulating the API call's result
*/
def update(
id: String,
description: Option[String] = None,
metadata: Option[String] = None,
- acl: Option[List[String]] = None
+ acl: List[String] = List.empty
): Future[Credential] =
apiClient.sendRequest[Credential](
NgrokApiClient.HttpMethod.Patch,
diff --git a/src/main/scala/com/ngrok/services/EdgesHttps.scala b/src/main/scala/com/ngrok/services/EdgesHttps.scala
index 37dd4dc..a1d604c 100644
--- a/src/main/scala/com/ngrok/services/EdgesHttps.scala
+++ b/src/main/scala/com/ngrok/services/EdgesHttps.scala
@@ -10,7 +10,7 @@ object EdgesHttps {
private case class EdgesHttpsCreate(
description: Option[String],
metadata: Option[String],
- hostports: Option[List[String]],
+ hostports: List[String],
mutualTls: Option[EndpointMutualTlsMutate],
tlsTermination: Option[EndpointTlsTerminationAtEdge]
)
@@ -20,7 +20,7 @@ object EdgesHttps {
List(
value.description.map(_.asJson).map(("description", _)),
value.metadata.map(_.asJson).map(("metadata", _)),
- value.hostports.map(_.asJson).map(("hostports", _)),
+ if (value.hostports.isEmpty) None else Option(("hostports", value.hostports.asJson)),
value.mutualTls.map(_.asJson).map(("mutual_tls", _)),
value.tlsTermination.map(_.asJson).map(("tls_termination", _))
).flatten.toMap.asJsonObject
@@ -30,7 +30,7 @@ object EdgesHttps {
private case class EdgesHttpsUpdate(
description: Option[String],
metadata: Option[String],
- hostports: Option[List[String]],
+ hostports: List[String],
mutualTls: Option[EndpointMutualTlsMutate],
tlsTermination: Option[EndpointTlsTerminationAtEdge]
)
@@ -40,7 +40,7 @@ object EdgesHttps {
List(
value.description.map(_.asJson).map(("description", _)),
value.metadata.map(_.asJson).map(("metadata", _)),
- value.hostports.map(_.asJson).map(("hostports", _)),
+ if (value.hostports.isEmpty) None else Option(("hostports", value.hostports.asJson)),
value.mutualTls.map(_.asJson).map(("mutual_tls", _)),
value.tlsTermination.map(_.asJson).map(("tls_termination", _))
).flatten.toMap.asJsonObject
@@ -70,7 +70,7 @@ class EdgesHttps private[ngrok] (apiClient: NgrokApiClient)(implicit ec: Executi
def create(
description: Option[String] = None,
metadata: Option[String] = None,
- hostports: Option[List[String]] = None,
+ hostports: List[String] = List.empty,
mutualTls: Option[EndpointMutualTlsMutate] = None,
tlsTermination: Option[EndpointTlsTerminationAtEdge] = None
): Future[HttpsEdge] =
@@ -149,7 +149,7 @@ class EdgesHttps private[ngrok] (apiClient: NgrokApiClient)(implicit ec: Executi
id: String,
description: Option[String] = None,
metadata: Option[String] = None,
- hostports: Option[List[String]] = None,
+ hostports: List[String] = List.empty,
mutualTls: Option[EndpointMutualTlsMutate] = None,
tlsTermination: Option[EndpointTlsTerminationAtEdge] = None
): Future[HttpsEdge] =
diff --git a/src/main/scala/com/ngrok/services/EdgesHttpsRoutes.scala b/src/main/scala/com/ngrok/services/EdgesHttpsRoutes.scala
index eb65f3e..7260a98 100644
--- a/src/main/scala/com/ngrok/services/EdgesHttpsRoutes.scala
+++ b/src/main/scala/com/ngrok/services/EdgesHttpsRoutes.scala
@@ -103,8 +103,8 @@ class EdgesHttpsRoutes private[ngrok] (apiClient: NgrokApiClient)(implicit ec: E
* See also https://ngrok.com/docs/api#api-edges-https-routes-create.
*
* @param edgeId unique identifier of this edge
- * @param matchType Type of match to use for this route. Valid values are "exact_path" and "path_prefix".
- * @param `match` Route selector: "/blog" or "example.com" or "example.com/blog"
+ * @param matchType Type of match to use for this route. Valid values are "exact_path" and "path_prefix".
+ * @param `match` Route selector: "/blog" or "example.com" or "example.com/blog"
* @param description human-readable description of what this edge will be used for; optional, max 255 bytes.
* @param metadata arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
* @param backend backend module configuration or null
@@ -191,8 +191,8 @@ class EdgesHttpsRoutes private[ngrok] (apiClient: NgrokApiClient)(implicit ec: E
*
* @param edgeId unique identifier of this edge
* @param id unique identifier of this edge route
- * @param matchType Type of match to use for this route. Valid values are "exact_path" and "path_prefix".
- * @param `match` Route selector: "/blog" or "example.com" or "example.com/blog"
+ * @param matchType Type of match to use for this route. Valid values are "exact_path" and "path_prefix".
+ * @param `match` Route selector: "/blog" or "example.com" or "example.com/blog"
* @param description human-readable description of what this edge will be used for; optional, max 255 bytes.
* @param metadata arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.
* @param backend backend module configuration or null
diff --git a/src/main/scala/com/ngrok/services/EdgesTcp.scala b/src/main/scala/com/ngrok/services/EdgesTcp.scala
index 6014882..d234696 100644
--- a/src/main/scala/com/ngrok/services/EdgesTcp.scala
+++ b/src/main/scala/com/ngrok/services/EdgesTcp.scala
@@ -10,7 +10,7 @@ object EdgesTcp {
private case class EdgesTcpCreate(
description: Option[String],
metadata: Option[String],
- hostports: Option[List[String]],
+ hostports: List[String],
backend: Option[EndpointBackendMutate],
ipRestriction: Option[EndpointIpPolicyMutate]
)
@@ -20,7 +20,7 @@ object EdgesTcp {
List(
value.description.map(_.asJson).map(("description", _)),
value.metadata.map(_.asJson).map(("metadata", _)),
- value.hostports.map(_.asJson).map(("hostports", _)),
+ if (value.hostports.isEmpty) None else Option(("hostports", value.hostports.asJson)),
value.backend.map(_.asJson).map(("backend", _)),
value.ipRestriction.map(_.asJson).map(("ip_restriction", _))
).flatten.toMap.asJsonObject
@@ -30,7 +30,7 @@ object EdgesTcp {
private case class EdgesTcpUpdate(
description: Option[String],
metadata: Option[String],
- hostports: Option[List[String]],
+ hostports: List[String],
backend: Option[EndpointBackendMutate],
ipRestriction: Option[EndpointIpPolicyMutate]
)
@@ -40,7 +40,7 @@ object EdgesTcp {
List(
value.description.map(_.asJson).map(("description", _)),
value.metadata.map(_.asJson).map(("metadata", _)),
- value.hostports.map(_.asJson).map(("hostports", _)),
+ if (value.hostports.isEmpty) None else Option(("hostports", value.hostports.asJson)),
value.backend.map(_.asJson).map(("backend", _)),
value.ipRestriction.map(_.asJson).map(("ip_restriction", _))
).flatten.toMap.asJsonObject
@@ -70,7 +70,7 @@ class EdgesTcp private[ngrok] (apiClient: NgrokApiClient)(implicit ec: Execution
def create(
description: Option[String] = None,
metadata: Option[String] = None,
- hostports: Option[List[String]] = None,
+ hostports: List[String] = List.empty,
backend: Option[EndpointBackendMutate] = None,
ipRestriction: Option[EndpointIpPolicyMutate] = None
): Future[TcpEdge] =
@@ -149,7 +149,7 @@ class EdgesTcp private[ngrok] (apiClient: NgrokApiClient)(implicit ec: Execution
id: String,
description: Option[String] = None,
metadata: Option[String] = None,
- hostports: Option[List[String]] = None,
+ hostports: List[String] = List.empty,
backend: Option[EndpointBackendMutate] = None,
ipRestriction: Option[EndpointIpPolicyMutate] = None
): Future[TcpEdge] =
diff --git a/src/main/scala/com/ngrok/services/EdgesTls.scala b/src/main/scala/com/ngrok/services/EdgesTls.scala
index b68fcb5..d50c97d 100644
--- a/src/main/scala/com/ngrok/services/EdgesTls.scala
+++ b/src/main/scala/com/ngrok/services/EdgesTls.scala
@@ -10,7 +10,7 @@ object EdgesTls {
private case class EdgesTlsCreate(
description: Option[String],
metadata: Option[String],
- hostports: Option[List[String]],
+ hostports: List[String],
backend: Option[EndpointBackendMutate],
ipRestriction: Option[EndpointIpPolicyMutate],
mutualTls: Option[EndpointMutualTlsMutate],
@@ -22,7 +22,7 @@ object EdgesTls {
List(
value.description.map(_.asJson).map(("description", _)),
value.metadata.map(_.asJson).map(("metadata", _)),
- value.hostports.map(_.asJson).map(("hostports", _)),
+ if (value.hostports.isEmpty) None else Option(("hostports", value.hostports.asJson)),
value.backend.map(_.asJson).map(("backend", _)),
value.ipRestriction.map(_.asJson).map(("ip_restriction", _)),
value.mutualTls.map(_.asJson).map(("mutual_tls", _)),
@@ -34,7 +34,7 @@ object EdgesTls {
private case class EdgesTlsUpdate(
description: Option[String],
metadata: Option[String],
- hostports: Option[List[String]],
+ hostports: List[String],
backend: Option[EndpointBackendMutate],
ipRestriction: Option[EndpointIpPolicyMutate],
mutualTls: Option[EndpointMutualTlsMutate],
@@ -46,7 +46,7 @@ object EdgesTls {
List(
value.description.map(_.asJson).map(("description", _)),
value.metadata.map(_.asJson).map(("metadata", _)),
- value.hostports.map(_.asJson).map(("hostports", _)),
+ if (value.hostports.isEmpty) None else Option(("hostports", value.hostports.asJson)),
value.backend.map(_.asJson).map(("backend", _)),
value.ipRestriction.map(_.asJson).map(("ip_restriction", _)),
value.mutualTls.map(_.asJson).map(("mutual_tls", _)),
@@ -80,7 +80,7 @@ class EdgesTls private[ngrok] (apiClient: NgrokApiClient)(implicit ec: Execution
def create(
description: Option[String] = None,
metadata: Option[String] = None,
- hostports: Option[List[String]] = None,
+ hostports: List[String] = List.empty,
backend: Option[EndpointBackendMutate] = None,
ipRestriction: Option[EndpointIpPolicyMutate] = None,
mutualTls: Option[EndpointMutualTlsMutate] = None,
@@ -165,7 +165,7 @@ class EdgesTls private[ngrok] (apiClient: NgrokApiClient)(implicit ec: Execution
id: String,
description: Option[String] = None,
metadata: Option[String] = None,
- hostports: Option[List[String]] = None,
+ hostports: List[String] = List.empty,
backend: Option[EndpointBackendMutate] = None,
ipRestriction: Option[EndpointIpPolicyMutate] = None,
mutualTls: Option[EndpointMutualTlsMutate] = None,
diff --git a/src/main/scala/com/ngrok/services/EventSubscriptions.scala b/src/main/scala/com/ngrok/services/EventSubscriptions.scala
index ba7929a..8e42caa 100644
--- a/src/main/scala/com/ngrok/services/EventSubscriptions.scala
+++ b/src/main/scala/com/ngrok/services/EventSubscriptions.scala
@@ -10,8 +10,8 @@ object EventSubscriptions {
private case class EventSubscriptionsCreate(
metadata: Option[String],
description: Option[String],
- sources: Option[List[EventSourceReplace]],
- destinationIds: Option[List[String]]
+ sources: List[EventSourceReplace],
+ destinationIds: List[String]
)
private object EventSubscriptionsCreate {
@@ -20,8 +20,8 @@ object EventSubscriptions {
List(
value.metadata.map(_.asJson).map(("metadata", _)),
value.description.map(_.asJson).map(("description", _)),
- value.sources.map(_.asJson).map(("sources", _)),
- value.destinationIds.map(_.asJson).map(("destination_ids", _))
+ if (value.sources.isEmpty) None else Option(("sources", value.sources.asJson)),
+ if (value.destinationIds.isEmpty) None else Option(("destination_ids", value.destinationIds.asJson))
).flatten.toMap.asJsonObject
)
}
@@ -29,8 +29,8 @@ object EventSubscriptions {
private case class EventSubscriptionsUpdate(
metadata: Option[String],
description: Option[String],
- sources: Option[List[EventSourceReplace]],
- destinationIds: Option[List[String]]
+ sources: List[EventSourceReplace],
+ destinationIds: List[String]
)
private object EventSubscriptionsUpdate {
@@ -39,8 +39,8 @@ object EventSubscriptions {
List(
value.metadata.map(_.asJson).map(("metadata", _)),
value.description.map(_.asJson).map(("description", _)),
- value.sources.map(_.asJson).map(("sources", _)),
- value.destinationIds.map(_.asJson).map(("destination_ids", _))
+ if (value.sources.isEmpty) None else Option(("sources", value.sources.asJson)),
+ if (value.destinationIds.isEmpty) None else Option(("destination_ids", value.destinationIds.asJson))
).flatten.toMap.asJsonObject
)
}
@@ -67,8 +67,8 @@ class EventSubscriptions private[ngrok] (apiClient: NgrokApiClient)(implicit ec:
def create(
metadata: Option[String] = None,
description: Option[String] = None,
- sources: Option[List[EventSourceReplace]] = None,
- destinationIds: Option[List[String]] = None
+ sources: List[EventSourceReplace] = List.empty,
+ destinationIds: List[String] = List.empty
): Future[EventSubscription] =
apiClient.sendRequest[EventSubscription](
NgrokApiClient.HttpMethod.Post,
@@ -118,7 +118,7 @@ class EventSubscriptions private[ngrok] (apiClient: NgrokApiClient)(implicit ec:
Option.empty
)
- /** List this Account's Event Subscriptions.
+ /** List this Account's Event Subscriptions.
*
* See also https://ngrok.com/docs/api#api-event-subscriptions-list.
*
@@ -157,8 +157,8 @@ class EventSubscriptions private[ngrok] (apiClient: NgrokApiClient)(implicit ec:
id: String,
metadata: Option[String] = None,
description: Option[String] = None,
- sources: Option[List[EventSourceReplace]] = None,
- destinationIds: Option[List[String]] = None
+ sources: List[EventSourceReplace] = List.empty,
+ destinationIds: List[String] = List.empty
): Future[EventSubscription] =
apiClient.sendRequest[EventSubscription](
NgrokApiClient.HttpMethod.Patch,
diff --git a/src/main/scala/com/ngrok/services/FailoverBackends.scala b/src/main/scala/com/ngrok/services/FailoverBackends.scala
index 40d7975..d40a245 100644
--- a/src/main/scala/com/ngrok/services/FailoverBackends.scala
+++ b/src/main/scala/com/ngrok/services/FailoverBackends.scala
@@ -10,7 +10,7 @@ object FailoverBackends {
private case class FailoverBackendsCreate(
description: Option[String],
metadata: Option[String],
- backends: Option[List[String]]
+ backends: List[String]
)
private object FailoverBackendsCreate {
@@ -19,7 +19,7 @@ object FailoverBackends {
List(
value.description.map(_.asJson).map(("description", _)),
value.metadata.map(_.asJson).map(("metadata", _)),
- value.backends.map(_.asJson).map(("backends", _))
+ if (value.backends.isEmpty) None else Option(("backends", value.backends.asJson))
).flatten.toMap.asJsonObject
)
}
@@ -27,7 +27,7 @@ object FailoverBackends {
private case class FailoverBackendsUpdate(
description: Option[String],
metadata: Option[String],
- backends: Option[List[String]]
+ backends: List[String]
)
private object FailoverBackendsUpdate {
@@ -36,7 +36,7 @@ object FailoverBackends {
List(
value.description.map(_.asJson).map(("description", _)),
value.metadata.map(_.asJson).map(("metadata", _)),
- value.backends.map(_.asJson).map(("backends", _))
+ if (value.backends.isEmpty) None else Option(("backends", value.backends.asJson))
).flatten.toMap.asJsonObject
)
}
@@ -65,7 +65,7 @@ class FailoverBackends private[ngrok] (apiClient: NgrokApiClient)(implicit ec: E
def create(
description: Option[String] = None,
metadata: Option[String] = None,
- backends: Option[List[String]] = None
+ backends: List[String] = List.empty
): Future[FailoverBackend] =
apiClient.sendRequest[FailoverBackend](
NgrokApiClient.HttpMethod.Post,
@@ -152,7 +152,7 @@ class FailoverBackends private[ngrok] (apiClient: NgrokApiClient)(implicit ec: E
id: String,
description: Option[String] = None,
metadata: Option[String] = None,
- backends: Option[List[String]] = None
+ backends: List[String] = List.empty
): Future[FailoverBackend] =
apiClient.sendRequest[FailoverBackend](
NgrokApiClient.HttpMethod.Patch,
diff --git a/src/main/scala/com/ngrok/services/HttpResponseBackends.scala b/src/main/scala/com/ngrok/services/HttpResponseBackends.scala
index c365f6d..ed124aa 100644
--- a/src/main/scala/com/ngrok/services/HttpResponseBackends.scala
+++ b/src/main/scala/com/ngrok/services/HttpResponseBackends.scala
@@ -11,7 +11,7 @@ object HttpResponseBackends {
description: Option[String],
metadata: Option[String],
body: Option[String],
- headers: Option[Map[String, String]],
+ headers: Map[String, String],
statusCode: Option[Int]
)
@@ -22,7 +22,7 @@ object HttpResponseBackends {
value.description.map(_.asJson).map(("description", _)),
value.metadata.map(_.asJson).map(("metadata", _)),
value.body.map(_.asJson).map(("body", _)),
- value.headers.map(_.asJson).map(("headers", _)),
+ if (value.headers.isEmpty) None else Option(("headers", value.headers.asJson)),
value.statusCode.map(_.asJson).map(("status_code", _))
).flatten.toMap.asJsonObject
)
@@ -32,7 +32,7 @@ object HttpResponseBackends {
description: Option[String],
metadata: Option[String],
body: Option[String],
- headers: Option[Map[String, String]],
+ headers: Map[String, String],
statusCode: Option[Int]
)
@@ -43,7 +43,7 @@ object HttpResponseBackends {
value.description.map(_.asJson).map(("description", _)),
value.metadata.map(_.asJson).map(("metadata", _)),
value.body.map(_.asJson).map(("body", _)),
- value.headers.map(_.asJson).map(("headers", _)),
+ if (value.headers.isEmpty) None else Option(("headers", value.headers.asJson)),
value.statusCode.map(_.asJson).map(("status_code", _))
).flatten.toMap.asJsonObject
)
@@ -73,7 +73,7 @@ class HttpResponseBackends private[ngrok] (apiClient: NgrokApiClient)(implicit e
description: Option[String] = None,
metadata: Option[String] = None,
body: Option[String] = None,
- headers: Option[Map[String, String]] = None,
+ headers: Map[String, String] = Map.empty,
statusCode: Option[Int] = None
): Future[HttpResponseBackend] =
apiClient.sendRequest[HttpResponseBackend](
@@ -166,7 +166,7 @@ class HttpResponseBackends private[ngrok] (apiClient: NgrokApiClient)(implicit e
description: Option[String] = None,
metadata: Option[String] = None,
body: Option[String] = None,
- headers: Option[Map[String, String]] = None,
+ headers: Map[String, String] = Map.empty,
statusCode: Option[Int] = None
): Future[HttpResponseBackend] =
apiClient.sendRequest[HttpResponseBackend](
diff --git a/src/main/scala/com/ngrok/services/IpPolicyRules.scala b/src/main/scala/com/ngrok/services/IpPolicyRules.scala
index d0a2361..e6d9e70 100644
--- a/src/main/scala/com/ngrok/services/IpPolicyRules.scala
+++ b/src/main/scala/com/ngrok/services/IpPolicyRules.scala
@@ -12,7 +12,7 @@ object IpPolicyRules {
metadata: Option[String],
cidr: String,
ipPolicyId: String,
- action: Option[String]
+ action: String
)
private object IpPolicyRulesCreate {
@@ -22,7 +22,7 @@ object IpPolicyRules {
value.metadata.map(_.asJson).map(("metadata", _)),
Option(("cidr", value.cidr.asJson)),
Option(("ip_policy_id", value.ipPolicyId.asJson)),
- value.action.map(_.asJson).map(("action", _))
+ Option(("action", value.action.asJson))
).flatten.toMap.asJsonObject
)
}
@@ -59,17 +59,17 @@ class IpPolicyRules private[ngrok] (apiClient: NgrokApiClient)(implicit ec: Exec
*
* @param cidr an IP or IP range specified in CIDR notation. IPv4 and IPv6 are both supported.
* @param ipPolicyId ID of the IP policy this IP policy rule will be attached to
+ * @param action the action to apply to the policy rule, either allow or deny
* @param description human-readable description of the source IPs of this IP rule. optional, max 255 bytes.
* @param metadata arbitrary user-defined machine-readable data of this IP policy rule. optional, max 4096 bytes.
- * @param action the action to apply to the policy rule, either allow or deny
* @return a [[scala.concurrent.Future]] encapsulating the API call's result
*/
def create(
cidr: String,
ipPolicyId: String,
+ action: String,
description: Option[String] = None,
- metadata: Option[String] = None,
- action: Option[String] = None
+ metadata: Option[String] = None
): Future[IpPolicyRule] =
apiClient.sendRequest[IpPolicyRule](
NgrokApiClient.HttpMethod.Post,
diff --git a/src/main/scala/com/ngrok/services/IpRestrictions.scala b/src/main/scala/com/ngrok/services/IpRestrictions.scala
index ae10254..2d3854e 100644
--- a/src/main/scala/com/ngrok/services/IpRestrictions.scala
+++ b/src/main/scala/com/ngrok/services/IpRestrictions.scala
@@ -31,7 +31,7 @@ object IpRestrictions {
description: Option[String],
metadata: Option[String],
enforced: Option[Boolean],
- ipPolicyIds: Option[List[String]]
+ ipPolicyIds: List[String]
)
private object IpRestrictionsUpdate {
@@ -40,7 +40,7 @@ object IpRestrictions {
value.description.map(_.asJson).map(("description", _)),
value.metadata.map(_.asJson).map(("metadata", _)),
value.enforced.map(_.asJson).map(("enforced", _)),
- value.ipPolicyIds.map(_.asJson).map(("ip_policy_ids", _))
+ if (value.ipPolicyIds.isEmpty) None else Option(("ip_policy_ids", value.ipPolicyIds.asJson))
).flatten.toMap.asJsonObject
)
}
@@ -166,7 +166,7 @@ class IpRestrictions private[ngrok] (apiClient: NgrokApiClient)(implicit ec: Exe
description: Option[String] = None,
metadata: Option[String] = None,
enforced: Option[Boolean] = None,
- ipPolicyIds: Option[List[String]] = None
+ ipPolicyIds: List[String] = List.empty
): Future[IpRestriction] =
apiClient.sendRequest[IpRestriction](
NgrokApiClient.HttpMethod.Patch,
diff --git a/src/main/scala/com/ngrok/services/ReservedDomains.scala b/src/main/scala/com/ngrok/services/ReservedDomains.scala
index 5b304c5..2c2116e 100644
--- a/src/main/scala/com/ngrok/services/ReservedDomains.scala
+++ b/src/main/scala/com/ngrok/services/ReservedDomains.scala
@@ -54,7 +54,7 @@ object ReservedDomains {
/** 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.
*/
@@ -65,7 +65,7 @@ class ReservedDomains private[ngrok] (apiClient: NgrokApiClient)(implicit ec: Ex
*
* See also https://ngrok.com/docs/api#api-reserved-domains-create.
*
- * @param 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.
+ * @param 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.
* @param region reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
* @param description human-readable description of what this reserved domain will be used for
* @param metadata arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
diff --git a/src/main/scala/com/ngrok/services/SshCredentials.scala b/src/main/scala/com/ngrok/services/SshCredentials.scala
index a154a7b..e2a03e5 100644
--- a/src/main/scala/com/ngrok/services/SshCredentials.scala
+++ b/src/main/scala/com/ngrok/services/SshCredentials.scala
@@ -10,7 +10,7 @@ object SshCredentials {
private case class SshCredentialsCreate(
description: Option[String],
metadata: Option[String],
- acl: Option[List[String]],
+ acl: List[String],
publicKey: String
)
@@ -19,7 +19,7 @@ object SshCredentials {
List(
value.description.map(_.asJson).map(("description", _)),
value.metadata.map(_.asJson).map(("metadata", _)),
- value.acl.map(_.asJson).map(("acl", _)),
+ if (value.acl.isEmpty) None else Option(("acl", value.acl.asJson)),
Option(("public_key", value.publicKey.asJson))
).flatten.toMap.asJsonObject
)
@@ -28,7 +28,7 @@ object SshCredentials {
private case class SshCredentialsUpdate(
description: Option[String],
metadata: Option[String],
- acl: Option[List[String]]
+ acl: List[String]
)
private object SshCredentialsUpdate {
@@ -36,7 +36,7 @@ object SshCredentials {
List(
value.description.map(_.asJson).map(("description", _)),
value.metadata.map(_.asJson).map(("metadata", _)),
- value.acl.map(_.asJson).map(("acl", _))
+ if (value.acl.isEmpty) None else Option(("acl", value.acl.asJson))
).flatten.toMap.asJsonObject
)
}
@@ -52,21 +52,21 @@ class SshCredentials private[ngrok] (apiClient: NgrokApiClient)(implicit ec: Exe
import SshCredentials._
/** 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.
*
* @param publicKey the PEM-encoded public key of the SSH keypair that will be used to authenticate
* @param description human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.
* @param metadata arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
- * @param 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.
+ * @param 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.
* @return a [[scala.concurrent.Future]] encapsulating the API call's result
*/
def create(
publicKey: String,
description: Option[String] = None,
metadata: Option[String] = None,
- acl: Option[List[String]] = None
+ acl: List[String] = List.empty
): Future[SshCredential] =
apiClient.sendRequest[SshCredential](
NgrokApiClient.HttpMethod.Post,
@@ -147,14 +147,14 @@ class SshCredentials private[ngrok] (apiClient: NgrokApiClient)(implicit ec: Exe
* @param id the value of the id parameter as a [[scala.Predef.String]]
* @param description human-readable description of who or what will use the ssh credential to authenticate. Optional, max 255 bytes.
* @param metadata arbitrary user-defined machine-readable data of this ssh credential. Optional, max 4096 bytes.
- * @param 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.
+ * @param 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.
* @return a [[scala.concurrent.Future]] encapsulating the API call's result
*/
def update(
id: String,
description: Option[String] = None,
metadata: Option[String] = None,
- acl: Option[List[String]] = None
+ acl: List[String] = List.empty
): Future[SshCredential] =
apiClient.sendRequest[SshCredential](
NgrokApiClient.HttpMethod.Patch,
diff --git a/src/main/scala/com/ngrok/services/SshHostCertificates.scala b/src/main/scala/com/ngrok/services/SshHostCertificates.scala
index 21a339d..84798e5 100644
--- a/src/main/scala/com/ngrok/services/SshHostCertificates.scala
+++ b/src/main/scala/com/ngrok/services/SshHostCertificates.scala
@@ -10,7 +10,7 @@ object SshHostCertificates {
private case class SshHostCertificatesCreate(
sshCertificateAuthorityId: String,
publicKey: String,
- principals: Option[List[String]],
+ principals: List[String],
validAfter: Option[java.time.OffsetDateTime],
validUntil: Option[java.time.OffsetDateTime],
description: Option[String],
@@ -23,7 +23,7 @@ object SshHostCertificates {
List(
Option(("ssh_certificate_authority_id", value.sshCertificateAuthorityId.asJson)),
Option(("public_key", value.publicKey.asJson)),
- value.principals.map(_.asJson).map(("principals", _)),
+ if (value.principals.isEmpty) None else Option(("principals", value.principals.asJson)),
value.validAfter.map(_.asJson).map(("valid_after", _)),
value.validUntil.map(_.asJson).map(("valid_until", _)),
value.description.map(_.asJson).map(("description", _)),
@@ -74,7 +74,7 @@ class SshHostCertificates private[ngrok] (apiClient: NgrokApiClient)(implicit ec
def create(
sshCertificateAuthorityId: String,
publicKey: String,
- principals: Option[List[String]] = None,
+ principals: List[String] = List.empty,
validAfter: Option[java.time.OffsetDateTime] = None,
validUntil: Option[java.time.OffsetDateTime] = None,
description: Option[String] = None,
diff --git a/src/main/scala/com/ngrok/services/SshUserCertificates.scala b/src/main/scala/com/ngrok/services/SshUserCertificates.scala
index 3080071..8708b6d 100644
--- a/src/main/scala/com/ngrok/services/SshUserCertificates.scala
+++ b/src/main/scala/com/ngrok/services/SshUserCertificates.scala
@@ -10,9 +10,9 @@ object SshUserCertificates {
private case class SshUserCertificatesCreate(
sshCertificateAuthorityId: String,
publicKey: String,
- principals: Option[List[String]],
- criticalOptions: Option[Map[String, String]],
- extensions: Option[Map[String, String]],
+ principals: List[String],
+ criticalOptions: Map[String, String],
+ extensions: Map[String, String],
validAfter: Option[java.time.OffsetDateTime],
validUntil: Option[java.time.OffsetDateTime],
description: Option[String],
@@ -25,9 +25,9 @@ object SshUserCertificates {
List(
Option(("ssh_certificate_authority_id", value.sshCertificateAuthorityId.asJson)),
Option(("public_key", value.publicKey.asJson)),
- value.principals.map(_.asJson).map(("principals", _)),
- value.criticalOptions.map(_.asJson).map(("critical_options", _)),
- value.extensions.map(_.asJson).map(("extensions", _)),
+ if (value.principals.isEmpty) None else Option(("principals", value.principals.asJson)),
+ if (value.criticalOptions.isEmpty) None else Option(("critical_options", value.criticalOptions.asJson)),
+ if (value.extensions.isEmpty) None else Option(("extensions", value.extensions.asJson)),
value.validAfter.map(_.asJson).map(("valid_after", _)),
value.validUntil.map(_.asJson).map(("valid_until", _)),
value.description.map(_.asJson).map(("description", _)),
@@ -70,7 +70,7 @@ class SshUserCertificates private[ngrok] (apiClient: NgrokApiClient)(implicit ec
* @param publicKey a public key in OpenSSH Authorized Keys format that this certificate signs
* @param 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.
* @param 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.
- * @param 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.
+ * @param 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.
* @param validAfter The time when the user certificate becomes valid, in RFC 3339 format. Defaults to the current time if unspecified.
* @param validUntil The time when this host certificate becomes invalid, in RFC 3339 format. If unspecified, a default value of 24 hours will be used. The OpenSSH certificates RFC calls this valid_before.
* @param description human-readable description of this SSH User Certificate. optional, max 255 bytes.
@@ -80,9 +80,9 @@ class SshUserCertificates private[ngrok] (apiClient: NgrokApiClient)(implicit ec
def create(
sshCertificateAuthorityId: String,
publicKey: String,
- principals: Option[List[String]] = None,
- criticalOptions: Option[Map[String, String]] = None,
- extensions: Option[Map[String, String]] = None,
+ principals: List[String] = List.empty,
+ criticalOptions: Map[String, String] = Map.empty,
+ extensions: Map[String, String] = Map.empty,
validAfter: Option[java.time.OffsetDateTime] = None,
validUntil: Option[java.time.OffsetDateTime] = None,
description: Option[String] = None,
diff --git a/src/main/scala/com/ngrok/services/TunnelGroupBackends.scala b/src/main/scala/com/ngrok/services/TunnelGroupBackends.scala
index 6574054..7e79d3d 100644
--- a/src/main/scala/com/ngrok/services/TunnelGroupBackends.scala
+++ b/src/main/scala/com/ngrok/services/TunnelGroupBackends.scala
@@ -10,7 +10,7 @@ object TunnelGroupBackends {
private case class TunnelGroupBackendsCreate(
description: Option[String],
metadata: Option[String],
- labels: Option[Map[String, String]]
+ labels: Map[String, String]
)
private object TunnelGroupBackendsCreate {
@@ -19,7 +19,7 @@ object TunnelGroupBackends {
List(
value.description.map(_.asJson).map(("description", _)),
value.metadata.map(_.asJson).map(("metadata", _)),
- value.labels.map(_.asJson).map(("labels", _))
+ if (value.labels.isEmpty) None else Option(("labels", value.labels.asJson))
).flatten.toMap.asJsonObject
)
}
@@ -27,7 +27,7 @@ object TunnelGroupBackends {
private case class TunnelGroupBackendsUpdate(
description: Option[String],
metadata: Option[String],
- labels: Option[Map[String, String]]
+ labels: Map[String, String]
)
private object TunnelGroupBackendsUpdate {
@@ -36,7 +36,7 @@ object TunnelGroupBackends {
List(
value.description.map(_.asJson).map(("description", _)),
value.metadata.map(_.asJson).map(("metadata", _)),
- value.labels.map(_.asJson).map(("labels", _))
+ if (value.labels.isEmpty) None else Option(("labels", value.labels.asJson))
).flatten.toMap.asJsonObject
)
}
@@ -57,13 +57,13 @@ class TunnelGroupBackends private[ngrok] (apiClient: NgrokApiClient)(implicit ec
*
* @param description human-readable description of this backend. Optional
* @param metadata arbitrary user-defined machine-readable data of this backend. Optional
- * @param labels labels to watch for tunnels on, e.g. app->foo, dc->bar
+ * @param labels labels to watch for tunnels on, e.g. app->foo, dc->bar
* @return a [[scala.concurrent.Future]] encapsulating the API call's result
*/
def create(
description: Option[String] = None,
metadata: Option[String] = None,
- labels: Option[Map[String, String]] = None
+ labels: Map[String, String] = Map.empty
): Future[TunnelGroupBackend] =
apiClient.sendRequest[TunnelGroupBackend](
NgrokApiClient.HttpMethod.Post,
@@ -143,14 +143,14 @@ class TunnelGroupBackends private[ngrok] (apiClient: NgrokApiClient)(implicit ec
* @param id the value of the id parameter as a [[scala.Predef.String]]
* @param description human-readable description of this backend. Optional
* @param metadata arbitrary user-defined machine-readable data of this backend. Optional
- * @param labels labels to watch for tunnels on, e.g. app->foo, dc->bar
+ * @param labels labels to watch for tunnels on, e.g. app->foo, dc->bar
* @return a [[scala.concurrent.Future]] encapsulating the API call's result
*/
def update(
id: String,
description: Option[String] = None,
metadata: Option[String] = None,
- labels: Option[Map[String, String]] = None
+ labels: Map[String, String] = Map.empty
): Future[TunnelGroupBackend] =
apiClient.sendRequest[TunnelGroupBackend](
NgrokApiClient.HttpMethod.Patch,
diff --git a/src/main/scala/com/ngrok/services/TunnelSessions.scala b/src/main/scala/com/ngrok/services/TunnelSessions.scala
index 02a7e43..b6e4896 100644
--- a/src/main/scala/com/ngrok/services/TunnelSessions.scala
+++ b/src/main/scala/com/ngrok/services/TunnelSessions.scala
@@ -105,7 +105,7 @@ class TunnelSessions private[ngrok] (apiClient: NgrokApiClient)(implicit ec: Exe
* breaking compatibility issues. If you wish to update to a new major version,
* that must be done manually. Still, please be aware that updating your ngrok
* agent could break your integration. This call will fail in any of the following
- * circumstances: there is no update available the ngrok agent's configuration
+ * circumstances: there is no update available the ngrok agent's configuration
* disabled update checks the agent is currently in process of updating the agent
* has already successfully updated but has not yet been restarted
*
diff --git a/src/main/scala/com/ngrok/services/WeightedBackends.scala b/src/main/scala/com/ngrok/services/WeightedBackends.scala
index 2b5d501..a125d0c 100644
--- a/src/main/scala/com/ngrok/services/WeightedBackends.scala
+++ b/src/main/scala/com/ngrok/services/WeightedBackends.scala
@@ -10,7 +10,7 @@ object WeightedBackends {
private case class WeightedBackendsCreate(
description: Option[String],
metadata: Option[String],
- backends: Option[Map[String, Long]]
+ backends: Map[String, Long]
)
private object WeightedBackendsCreate {
@@ -19,7 +19,7 @@ object WeightedBackends {
List(
value.description.map(_.asJson).map(("description", _)),
value.metadata.map(_.asJson).map(("metadata", _)),
- value.backends.map(_.asJson).map(("backends", _))
+ if (value.backends.isEmpty) None else Option(("backends", value.backends.asJson))
).flatten.toMap.asJsonObject
)
}
@@ -27,7 +27,7 @@ object WeightedBackends {
private case class WeightedBackendsUpdate(
description: Option[String],
metadata: Option[String],
- backends: Option[Map[String, Long]]
+ backends: Map[String, Long]
)
private object WeightedBackendsUpdate {
@@ -36,7 +36,7 @@ object WeightedBackends {
List(
value.description.map(_.asJson).map(("description", _)),
value.metadata.map(_.asJson).map(("metadata", _)),
- value.backends.map(_.asJson).map(("backends", _))
+ if (value.backends.isEmpty) None else Option(("backends", value.backends.asJson))
).flatten.toMap.asJsonObject
)
}
@@ -45,7 +45,7 @@ object WeightedBackends {
/** 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.
@@ -65,7 +65,7 @@ class WeightedBackends private[ngrok] (apiClient: NgrokApiClient)(implicit ec: E
def create(
description: Option[String] = None,
metadata: Option[String] = None,
- backends: Option[Map[String, Long]] = None
+ backends: Map[String, Long] = Map.empty
): Future[WeightedBackend] =
apiClient.sendRequest[WeightedBackend](
NgrokApiClient.HttpMethod.Post,
@@ -152,7 +152,7 @@ class WeightedBackends private[ngrok] (apiClient: NgrokApiClient)(implicit ec: E
id: String,
description: Option[String] = None,
metadata: Option[String] = None,
- backends: Option[Map[String, Long]] = None
+ backends: Map[String, Long] = Map.empty
): Future[WeightedBackend] =
apiClient.sendRequest[WeightedBackend](
NgrokApiClient.HttpMethod.Patch,
diff --git a/src/test/scala/com/ngrok/services/ApiKeysTest.scala b/src/test/scala/com/ngrok/services/ApiKeysTest.scala
index 3d4c378..9bd885c 100644
--- a/src/test/scala/com/ngrok/services/ApiKeysTest.scala
+++ b/src/test/scala/com/ngrok/services/ApiKeysTest.scala
@@ -67,10 +67,7 @@ class ApiKeysTest extends AnyFreeSpec with Matchers with ScalaFutures with Optio
wireMock.stubFor(
post(urlPathEqualTo("/api_keys"))
.withHeader(HttpHeaderNames.AUTHORIZATION.toString(), equalTo(s"Bearer $FakeApiSecret"))
- .withHeader(
- HttpHeaderNames.USER_AGENT.toString(),
- equalTo(s"ngrok-api-client-scala/${Version.ClientVersion}")
- )
+ .withHeader(HttpHeaderNames.USER_AGENT.toString(), equalTo(UserAgent))
.withHeader("ngrok-version", equalTo(Version.ApiVersion))
.withHeader(HttpHeaderNames.CONTENT_TYPE.toString(), containing("application/json"))
.withRequestBody(equalToJson(apiKeyCreate.asJson.noSpaces))
@@ -83,10 +80,7 @@ class ApiKeysTest extends AnyFreeSpec with Matchers with ScalaFutures with Optio
wireMock.stubFor(
get(urlPathEqualTo(s"/api_keys/${apiKey.id}"))
.withHeader(HttpHeaderNames.AUTHORIZATION.toString(), equalTo(s"Bearer $FakeApiSecret"))
- .withHeader(
- HttpHeaderNames.USER_AGENT.toString(),
- equalTo(s"ngrok-api-client-scala/${Version.ClientVersion}")
- )
+ .withHeader(HttpHeaderNames.USER_AGENT.toString(), equalTo(UserAgent))
.withHeader("ngrok-version", equalTo(Version.ApiVersion))
.willReturn(
ok(apiKeyNoToken.asJson.noSpaces)
@@ -98,10 +92,7 @@ class ApiKeysTest extends AnyFreeSpec with Matchers with ScalaFutures with Optio
get(urlPathEqualTo("/api_keys"))
.withQueryParam("limit", equalTo("10"))
.withHeader(HttpHeaderNames.AUTHORIZATION.toString(), equalTo(s"Bearer $FakeApiSecret"))
- .withHeader(
- HttpHeaderNames.USER_AGENT.toString(),
- equalTo(s"ngrok-api-client-scala/${Version.ClientVersion}")
- )
+ .withHeader(HttpHeaderNames.USER_AGENT.toString(), equalTo(UserAgent))
.withHeader("ngrok-version", equalTo(Version.ApiVersion))
.willReturn(
ok(apiKeyList.asJson.noSpaces)
@@ -112,10 +103,7 @@ class ApiKeysTest extends AnyFreeSpec with Matchers with ScalaFutures with Optio
wireMock.stubFor(
patch(urlPathEqualTo(s"/api_keys/${apiKey.id}"))
.withHeader(HttpHeaderNames.AUTHORIZATION.toString(), equalTo(s"Bearer $FakeApiSecret"))
- .withHeader(
- HttpHeaderNames.USER_AGENT.toString(),
- equalTo(s"ngrok-api-client-scala/${Version.ClientVersion}")
- )
+ .withHeader(HttpHeaderNames.USER_AGENT.toString(), equalTo(UserAgent))
.withHeader("ngrok-version", equalTo(Version.ApiVersion))
.withHeader(HttpHeaderNames.CONTENT_TYPE.toString(), containing("application/json"))
.withRequestBody(equalToJson(apiKeyUpdate.asJson.noSpaces))
@@ -128,10 +116,7 @@ class ApiKeysTest extends AnyFreeSpec with Matchers with ScalaFutures with Optio
wireMock.stubFor(
delete(urlPathEqualTo(s"/api_keys/${apiKey.id}"))
.withHeader(HttpHeaderNames.AUTHORIZATION.toString(), equalTo(s"Bearer $FakeApiSecret"))
- .withHeader(
- HttpHeaderNames.USER_AGENT.toString(),
- equalTo(s"ngrok-api-client-scala/${Version.ClientVersion}")
- )
+ .withHeader(HttpHeaderNames.USER_AGENT.toString(), equalTo(UserAgent))
.withHeader("ngrok-version", equalTo(Version.ApiVersion))
.willReturn(noContent())
)
diff --git a/src/test/scala/com/ngrok/services/EventSubscriptionsTest.scala b/src/test/scala/com/ngrok/services/EventSubscriptionsTest.scala
index 5a3426e..da4be80 100644
--- a/src/test/scala/com/ngrok/services/EventSubscriptionsTest.scala
+++ b/src/test/scala/com/ngrok/services/EventSubscriptionsTest.scala
@@ -116,7 +116,7 @@ class EventSubscriptionsTest
wireMock.stubFor(
post(urlPathEqualTo("/event_destinations"))
.withHeader(HttpHeaderNames.AUTHORIZATION.toString, equalTo(s"Bearer $FakeApiSecret"))
- .withHeader(HttpHeaderNames.USER_AGENT.toString, equalTo(s"ngrok-api-client-scala/${Version.ClientVersion}"))
+ .withHeader(HttpHeaderNames.USER_AGENT.toString, equalTo(UserAgent))
.withHeader("ngrok-version", equalTo(Version.ApiVersion))
.withHeader(HttpHeaderNames.CONTENT_TYPE.toString, containing("application/json"))
.withRequestBody(equalToJson(eventDestinationCreate.asJson.noSpaces))
@@ -129,7 +129,7 @@ class EventSubscriptionsTest
wireMock.stubFor(
delete(urlPathEqualTo(s"/event_destinations/${eventDestination.id}"))
.withHeader(HttpHeaderNames.AUTHORIZATION.toString, equalTo(s"Bearer $FakeApiSecret"))
- .withHeader(HttpHeaderNames.USER_AGENT.toString, equalTo(s"ngrok-api-client-scala/${Version.ClientVersion}"))
+ .withHeader(HttpHeaderNames.USER_AGENT.toString, equalTo(UserAgent))
.withHeader("ngrok-version", equalTo(Version.ApiVersion))
.willReturn(noContent)
)
@@ -137,7 +137,7 @@ class EventSubscriptionsTest
wireMock.stubFor(
post(urlPathEqualTo("/event_subscriptions"))
.withHeader(HttpHeaderNames.AUTHORIZATION.toString, equalTo(s"Bearer $FakeApiSecret"))
- .withHeader(HttpHeaderNames.USER_AGENT.toString, equalTo(s"ngrok-api-client-scala/${Version.ClientVersion}"))
+ .withHeader(HttpHeaderNames.USER_AGENT.toString, equalTo(UserAgent))
.withHeader("ngrok-version", equalTo(Version.ApiVersion))
.withHeader(HttpHeaderNames.CONTENT_TYPE.toString, containing("application/json"))
.withRequestBody(equalToJson(eventSubscriptionCreate.asJson.noSpaces))
@@ -149,7 +149,7 @@ class EventSubscriptionsTest
wireMock.stubFor(
get(urlPathEqualTo(s"/event_subscriptions/${eventSubscription.id}"))
.withHeader(HttpHeaderNames.AUTHORIZATION.toString, equalTo(s"Bearer $FakeApiSecret"))
- .withHeader(HttpHeaderNames.USER_AGENT.toString, equalTo(s"ngrok-api-client-scala/${Version.ClientVersion}"))
+ .withHeader(HttpHeaderNames.USER_AGENT.toString, equalTo(UserAgent))
.withHeader("ngrok-version", equalTo(Version.ApiVersion))
.willReturn(
ok(eventSubscription.asJson.noSpaces).withHeader(HttpHeaderNames.CONTENT_TYPE.toString, "application/json")
@@ -160,7 +160,7 @@ class EventSubscriptionsTest
get(urlPathEqualTo("/event_subscriptions"))
.withQueryParam("limit", equalTo("10"))
.withHeader(HttpHeaderNames.AUTHORIZATION.toString, equalTo(s"Bearer $FakeApiSecret"))
- .withHeader(HttpHeaderNames.USER_AGENT.toString, equalTo(s"ngrok-api-client-scala/${Version.ClientVersion}"))
+ .withHeader(HttpHeaderNames.USER_AGENT.toString, equalTo(UserAgent))
.withHeader("ngrok-version", equalTo(Version.ApiVersion))
.willReturn(
ok(eventSubscriptionList.asJson.noSpaces)
@@ -171,7 +171,7 @@ class EventSubscriptionsTest
wireMock.stubFor(
patch(urlPathEqualTo(s"/event_subscriptions/${eventSubscription.id}"))
.withHeader(HttpHeaderNames.AUTHORIZATION.toString, equalTo(s"Bearer $FakeApiSecret"))
- .withHeader(HttpHeaderNames.USER_AGENT.toString, equalTo(s"ngrok-api-client-scala/${Version.ClientVersion}"))
+ .withHeader(HttpHeaderNames.USER_AGENT.toString, equalTo(UserAgent))
.withHeader("ngrok-version", equalTo(Version.ApiVersion))
.withHeader(HttpHeaderNames.CONTENT_TYPE.toString, containing("application/json"))
.withRequestBody(equalToJson(eventSubscriptionUpdate.asJson.noSpaces))
@@ -184,7 +184,7 @@ class EventSubscriptionsTest
wireMock.stubFor(
delete(urlPathEqualTo(s"/event_subscriptions/${eventSubscription.id}"))
.withHeader(HttpHeaderNames.AUTHORIZATION.toString, equalTo(s"Bearer $FakeApiSecret"))
- .withHeader(HttpHeaderNames.USER_AGENT.toString, equalTo(s"ngrok-api-client-scala/${Version.ClientVersion}"))
+ .withHeader(HttpHeaderNames.USER_AGENT.toString, equalTo(UserAgent))
.withHeader("ngrok-version", equalTo(Version.ApiVersion))
.willReturn(noContent)
)
@@ -222,8 +222,8 @@ class EventSubscriptionsTest
.create(
description = Some(eventSubscription.description),
metadata = Some(eventSubscription.metadata),
- sources = Some(eventSubscription.sources.map(source => EventSourceReplace(source.`type`))),
- destinationIds = Some(eventDestinationIds)
+ sources = eventSubscription.sources.map(source => EventSourceReplace(source.`type`)),
+ destinationIds = eventDestinationIds
)
.futureValue
assertEventSubscriptionFields(createdEventSubscription)
diff --git a/src/test/scala/com/ngrok/services/HttpsEdgesTest.scala b/src/test/scala/com/ngrok/services/HttpsEdgesTest.scala
new file mode 100644
index 0000000..1db2a3c
--- /dev/null
+++ b/src/test/scala/com/ngrok/services/HttpsEdgesTest.scala
@@ -0,0 +1,119 @@
+package com.ngrok.services
+
+import java.net.URI
+import java.time.OffsetDateTime
+
+import com.github.tomakehurst.wiremock.client.WireMock._
+import com.linecorp.armeria.common.HttpHeaderNames
+import com.ngrok.Version
+import com.ngrok.definitions.{HttpsEdge, HttpsEdgeList}
+import io.circe.syntax._
+import org.scalatest.OptionValues
+import org.scalatest.concurrent.ScalaFutures
+import org.scalatest.freespec.AnyFreeSpec
+import org.scalatest.matchers.must.Matchers
+import org.scalatest.time.{Seconds, Span}
+import support.TestBase
+
+import scala.util.Try
+
+object HttpsEdgesTest {
+ private val liveHostport = Option(System.getenv("NGROK_HOSTPORT"))
+ private val testHostport = "test-hostport-123.ngrok.io:443"
+
+ private val mockEdge = HttpsEdge(
+ id = "some-id",
+ description = "",
+ metadata = "test scala client",
+ createdAt = OffsetDateTime.now,
+ uri = new URI("https://api.ngrok.com/edges/https/some-id"),
+ hostports = Some(List(testHostport)),
+ routes = List.empty
+ )
+
+ private val mockEdgeList = HttpsEdgeList(
+ httpsEdges = List(mockEdge),
+ uri = new URI("https://api.ngrok.com/edges/https")
+ )
+}
+
+class HttpsEdgesTest extends AnyFreeSpec with Matchers with ScalaFutures with OptionValues with TestBase {
+ import HttpsEdgesTest._
+
+ implicit private val defaultPatience: PatienceConfig = PatienceConfig(timeout = Span(10, Seconds))
+
+ private val testHostports = if (UseLiveApi) liveHostport.toList else List(testHostport)
+
+ override def beforeEach(): Unit = {
+ super.beforeEach()
+
+ if (!UseLiveApi) {
+ wireMock.stubFor(
+ post(urlPathEqualTo("/edges/https"))
+ .withHeader(HttpHeaderNames.AUTHORIZATION.toString(), equalTo(s"Bearer $FakeApiSecret"))
+ .withHeader(HttpHeaderNames.USER_AGENT.toString(), equalTo(UserAgent))
+ .withHeader("ngrok-version", equalTo(Version.ApiVersion))
+ .withHeader(HttpHeaderNames.CONTENT_TYPE.toString(), containing("application/json"))
+ .withRequestBody(equalToJson(Map(
+ "metadata" -> mockEdge.metadata.asJson,
+ "hostports" -> testHostports.asJson
+ ).asJson.noSpaces))
+ .willReturn(
+ ok(mockEdge.asJson.noSpaces)
+ .withHeader(HttpHeaderNames.CONTENT_TYPE.toString(), "application/json")
+ )
+ )
+
+ wireMock.stubFor(
+ get(urlPathEqualTo("/edges/https"))
+ .withHeader(HttpHeaderNames.AUTHORIZATION.toString(), equalTo(s"Bearer $FakeApiSecret"))
+ .withHeader(HttpHeaderNames.USER_AGENT.toString(), equalTo(UserAgent))
+ .withHeader("ngrok-version", equalTo(Version.ApiVersion))
+ .willReturn(
+ ok(mockEdgeList.asJson.noSpaces)
+ .withHeader(HttpHeaderNames.CONTENT_TYPE.toString(), "application/json")
+ )
+ )
+
+ wireMock.stubFor(
+ delete(urlPathEqualTo(s"/edges/https/${mockEdge.id}"))
+ .withHeader(HttpHeaderNames.AUTHORIZATION.toString(), equalTo(s"Bearer $FakeApiSecret"))
+ .withHeader(HttpHeaderNames.USER_AGENT.toString(), equalTo(UserAgent))
+ .withHeader("ngrok-version", equalTo(Version.ApiVersion))
+ .willReturn(noContent())
+ )
+ }
+ }
+
+ "HTTPS Edges can be created and listed" in {
+ if (UseLiveApi) {
+ if (liveHostport.isEmpty) {
+ fail("Please set NGROK_HOSTPORT to a valid endpoint HOST:PORT before running this test live")
+ }
+ }
+
+ val edgesId = createHttpsEdge(testHostports)
+ try {
+ listHttpsEdges(edgesId, testHostports)
+ } finally {
+ Try(deleteHttpsEdge(edgesId))
+ }
+ }
+
+ private def createHttpsEdge(hostports: List[String]): String = {
+ val edge = ngrok.edges.https.create(
+ metadata = Some(mockEdge.metadata),
+ hostports = hostports
+ ).futureValue
+ edge.hostports mustBe Some(hostports)
+ edge.id
+ }
+
+ private def listHttpsEdges(expectedId: String, expectedHostports: List[String]): Unit = {
+ val edge = ngrok.edges.https.list().futureValue.page.httpsEdges.find(_.metadata == mockEdge.metadata).value
+ edge.id mustBe expectedId
+ edge.hostports mustBe Some(expectedHostports)
+ }
+
+ private def deleteHttpsEdge(id: String): Unit = ngrok.edges.https.delete(id).futureValue
+}
diff --git a/src/test/scala/com/ngrok/services/IpPolicyRulesTest.scala b/src/test/scala/com/ngrok/services/IpPolicyRulesTest.scala
new file mode 100644
index 0000000..9eb1689
--- /dev/null
+++ b/src/test/scala/com/ngrok/services/IpPolicyRulesTest.scala
@@ -0,0 +1,119 @@
+package com.ngrok.services
+
+import java.net.URI
+import java.time.OffsetDateTime
+
+import com.github.tomakehurst.wiremock.client.WireMock._
+import com.linecorp.armeria.common.HttpHeaderNames
+import com.ngrok.Version
+import com.ngrok.definitions.{IpPolicy, IpPolicyRule, Ref}
+import io.circe.syntax._
+import org.scalatest.concurrent.ScalaFutures
+import org.scalatest.freespec.AnyFreeSpec
+import org.scalatest.matchers.must.Matchers
+import org.scalatest.time.{Seconds, Span}
+import support.TestBase
+
+import scala.util.Try
+
+object IpPolicyRulesTest {
+ private val mockIpPolicy = IpPolicy(
+ id = "some-id",
+ uri = new URI("https://api.ngrok.com/ip_policies/some-id"),
+ createdAt = OffsetDateTime.now,
+ description = "",
+ metadata = ""
+ )
+
+ private val mockIpPolicyRule = IpPolicyRule(
+ id = "some-rule-id",
+ uri = new URI("https://api.ngrok.com/ip_policy_rules/some-rule-id"),
+ createdAt = OffsetDateTime.now,
+ description = "",
+ metadata = "",
+ cidr = "10.1.2.0/24",
+ ipPolicy = Ref(id = "some-id", uri = new URI("https://api.ngrok.com/ip_policy/some-id")),
+ action = "allow"
+ )
+}
+
+class IpPolicyRulesTest extends AnyFreeSpec with Matchers with ScalaFutures with TestBase {
+ import IpPolicyRulesTest._
+
+ implicit private val defaultPatience: PatienceConfig = PatienceConfig(timeout = Span(4, Seconds))
+
+ override def beforeEach(): Unit = {
+ super.beforeEach()
+
+ if (!UseLiveApi) {
+ wireMock.stubFor(
+ post(urlPathEqualTo("/ip_policies"))
+ .withHeader(HttpHeaderNames.AUTHORIZATION.toString(), equalTo(s"Bearer $FakeApiSecret"))
+ .withHeader(HttpHeaderNames.USER_AGENT.toString(), equalTo(UserAgent))
+ .withHeader("ngrok-version", equalTo(Version.ApiVersion))
+ .withHeader(HttpHeaderNames.CONTENT_TYPE.toString(), containing("application/json"))
+ .withRequestBody(equalToJson("{}"))
+ .willReturn(
+ ok(mockIpPolicy.asJson.noSpaces)
+ .withHeader(HttpHeaderNames.CONTENT_TYPE.toString(), "application/json")
+ )
+ )
+
+ wireMock.stubFor(
+ delete(urlPathEqualTo(s"/ip_policies/${mockIpPolicy.id}"))
+ .withHeader(HttpHeaderNames.AUTHORIZATION.toString(), equalTo(s"Bearer $FakeApiSecret"))
+ .withHeader(HttpHeaderNames.USER_AGENT.toString(), equalTo(UserAgent))
+ .withHeader("ngrok-version", equalTo(Version.ApiVersion))
+ .willReturn(noContent())
+ )
+
+ wireMock.stubFor(
+ post(urlPathEqualTo("/ip_policy_rules"))
+ .withHeader(HttpHeaderNames.AUTHORIZATION.toString(), equalTo(s"Bearer $FakeApiSecret"))
+ .withHeader(HttpHeaderNames.USER_AGENT.toString(), equalTo(UserAgent))
+ .withHeader("ngrok-version", equalTo(Version.ApiVersion))
+ .withHeader(HttpHeaderNames.CONTENT_TYPE.toString(), containing("application/json"))
+ .withRequestBody(equalToJson(Map(
+ "ip_policy_id" -> mockIpPolicy.id,
+ "cidr" -> mockIpPolicyRule.cidr,
+ "action" -> mockIpPolicyRule.action
+ ).asJson.noSpaces))
+ .willReturn(
+ ok(mockIpPolicyRule.asJson.noSpaces)
+ .withHeader(HttpHeaderNames.CONTENT_TYPE.toString(), "application/json")
+ )
+ )
+
+ wireMock.stubFor(
+ delete(urlPathEqualTo(s"/ip_policy_rules/${mockIpPolicyRule.id}"))
+ .withHeader(HttpHeaderNames.AUTHORIZATION.toString(), equalTo(s"Bearer $FakeApiSecret"))
+ .withHeader(HttpHeaderNames.USER_AGENT.toString(), equalTo(UserAgent))
+ .withHeader("ngrok-version", equalTo(Version.ApiVersion))
+ .willReturn(noContent())
+ )
+ }
+ }
+
+ "IP policies and rules can be created and deleted" in {
+ val policyId = createIpPolicy()
+ try {
+ val ruleId = createIpPolicyRule(policyId)
+ deleteIpPolicyRule(ruleId)
+ } finally {
+ Try(deleteIpPolicy(policyId))
+ }
+ }
+
+ private def createIpPolicy(): String = ngrok.ipPolicies.create().futureValue.id
+ private def deleteIpPolicy(id: String): Unit = ngrok.ipPolicies.delete(id).futureValue
+
+ private def createIpPolicyRule(policyId: String): String = {
+ val rule = ngrok.ipPolicyRules.create("10.1.2.0/24", policyId, "allow").futureValue
+ rule.ipPolicy.id mustBe policyId
+ rule.action mustBe "allow"
+ rule.cidr mustBe "10.1.2.0/24"
+ rule.id
+ }
+
+ private def deleteIpPolicyRule(id: String): Unit = ngrok.ipPolicyRules.delete(id).futureValue
+}
diff --git a/src/test/scala/support/TestBase.scala b/src/test/scala/support/TestBase.scala
index 7698e3f..27266c7 100644
--- a/src/test/scala/support/TestBase.scala
+++ b/src/test/scala/support/TestBase.scala
@@ -2,14 +2,16 @@ package support
import java.net.URI
-import com.ngrok.{DefaultNgrokApiClient, Ngrok, NgrokApiClient}
+import com.ngrok.{DefaultNgrokApiClient, Ngrok, NgrokApiClient, Version}
import org.scalatest.Suite
import scala.concurrent.ExecutionContext.Implicits.global
+import scala.util.Properties
trait TestBase extends WireMockSupport { this: Suite =>
protected val FakeApiSecret: String = "s3kr1t"
protected val UseLiveApi: Boolean = Option(System.getenv("TEST_NO_MOCK")).exists(java.lang.Boolean.parseBoolean)
+ protected val UserAgent: String = s"ngrok-api-scala/${Version.ClientVersion}/${Properties.versionNumberString}"
protected def ngrok: Ngrok = Ngrok(
DefaultNgrokApiClient(