Connection Variables

The following variables are available under the conn namespace:

Name	Type	Description
`conn.bytes_in`	`int64`	The number of bytes entering the endpoint from the client.
`conn.bytes_out`	`int64`	The number of bytes leaving an endpoint to the client.
`conn.client_ip`	`string`	Source IP of the connection to the ngrok endpoint.
`conn.client_port`	`int32`	Source port of the connection to the ngrok endpoint.
`conn.server_ip`	`string`	The IP that this connection was established on.
`conn.server_port`	`int32`	The port that this connection was established on.
`conn.server_region`	`string`	The ngrok PoP (Point of Presence) that this connection was established on and serviced through.
`conn.ts.start`	`timestamp`	Timestamp when the connection to ngrok was started.

`conn.bytes_in`

The number of bytes entering the endpoint from the client.

Loading…

`conn.bytes_out`

The number of bytes leaving an endpoint to the client.

Loading…

`conn.client_ip`

Source IP of the connection to the ngrok endpoint.

Loading…

`conn.client_port`

Source port of the connection to the ngrok endpoint.

Loading…

`conn.server_ip`

The IP that this connection was established on.

Loading…

`conn.server_port`

The port that this connection was established on.

Loading…

`conn.server_region`

The ngrok PoP (Point of Presence) that this connection was established on and serviced through.

Loading…

`conn.ts.start`

Timestamp when the connection to ngrok was started.

Loading…

Connection Geo Variables

The following variables are available under the conn.geo namespace:

Name	Type	Description
`conn.geo.city`	`string`	The name of the city, in EN, where the `conn.client_ip` is likely to originate.
`conn.geo.country`	`string`	The name of the country, in EN, where the `conn.client_ip` is likely to originate.
`conn.geo.country_code`	`string`	The two-letter ISO country code where the `conn.client_ip` is likely to originate.
`conn.geo.latitude`	`string`	The approximate latitude where the `conn.client_ip` is likely to originate.
`conn.geo.longitude`	`string`	The approximate longitude where the `conn.client_ip` is likely to originate.
`conn.geo.radius`	`string`	The radius in kilometers around the latitude and longitude where the `conn.client_ip` is likely to originate.
`conn.geo.subdivision`	`string`	The name of the subdivision, in EN, where the `conn.client_ip` is likely to originate.

`conn.geo.city`

The name of the city, in EN, where the conn.client_ip is likely to originate.

Loading…

`conn.geo.country`

The name of the country, in EN, where the conn.client_ip is likely to originate.

Loading…

`conn.geo.country_code`

The two-letter ISO country code where the conn.client_ip is likely to originate.

Loading…

`conn.geo.latitude`

The approximate latitude where the conn.client_ip is likely to originate.

Loading…

`conn.geo.longitude`

The approximate longitude where the conn.client_ip is likely to originate.

Loading…

`conn.geo.radius`

The radius in kilometers around the latitude and longitude where the conn.client_ip is likely to originate.

Loading…

`conn.geo.subdivision`

The name of the subdivision, in EN, where the conn.client_ip is likely to originate.

Loading…

Connection TLS Variables

The following variables are available under the conn.tls namespace:

Name	Type	Description
`conn.tls.cipher_suite`	`string`	The cipher suite selected during the TLS handshake.
`conn.tls.ja4_fingerprint`	`string`	The JA4 fingerprint of the TLS handshake.
`conn.tls.negotiated_alpn`	`string`	TLS Application-Layer Protocol Negotiation (ALPN) Protocol ID of the protocol agreed upon in the TLS handshake
`conn.tls.session_resumed`	`bool`	True if the TLS session was resumed. Currently always false
`conn.tls.sni`	`string`	The hostname included in the `ClientHello` message via the SNI extension.
`conn.tls.version`	`string`	The version of the TLS protocol used between the client and the ngrok edge.

`conn.tls.cipher_suite`

The cipher suite selected during the TLS handshake.

Loading…

`conn.tls.ja4_fingerprint`

The JA4 fingerprint of the TLS handshake.

Loading…

`conn.tls.negotiated_alpn`

The TLS Application-Layer Protocol Negotiation (ALPN) Protocol ID of the protocol agreed upon in the TLS handshake. Defaults to "" if no ALPN was successfully negotiated.

Loading…

`conn.tls.session_resumed`

True if the TLS session was resumed. Currently always false as we do not yet support TLS session resumption.

Loading…

`conn.tls.sni`

The hostname included in the ClientHello message via the SNI extension.

Loading…

`conn.tls.version`

The version of the TLS protocol used between the client and the ngrok edge.

Loading…

Connection TLS Client Variables

The following variables are available under the conn.tls.client namespace:

Name	Type	Description
`conn.tls.client.extensions`	`[]Extension`	Additional information added to the certificate.
`conn.tls.client.extensions[i].id`	`string`	The identifier (OID) that specifies the type of extension.
`conn.tls.client.extensions[i].critical`	`bool`	True if the extension is critical.
`conn.tls.client.extensions[i].value`	`[]byte`	The data for the extension.
`conn.tls.client.issuer`	`string`	The issuing authority of the certificate as a string roughly following the RFC 2253 Distinguished Names syntax.
`conn.tls.client.issuer.common_name`	`string`	Common name of the issuing authority, usually the domain name.
`conn.tls.client.issuer.country`	`[]string`	Country name(s) where the issuing authority is located.
`conn.tls.client.issuer.locality`	`[]string`	Locality or city of the issuing authority.
`conn.tls.client.issuer.organization`	`[]string`	Name(s) of the organization that issued the certificate.
`conn.tls.client.issuer.organizational_unit`	`[]string`	Division of the organization responsible for the certificate.
`conn.tls.client.issuer.postal_code`	`[]string`	Postal code of the issuing authority.
`conn.tls.client.issuer.province`	`[]string`	Province or state of the issuing authority.
`conn.tls.client.issuer.street_address`	`[]string`	Street address of the issuing authority.
`conn.tls.client.pem`	`string`	Full PEM-encoded client certificate of the TLS connection.
`conn.tls.client.san`	`string`	Subject alternative names of the client certificate.
`conn.tls.client.san.dns_names`	`[]string`	DNS names in the subject alternative names.
`conn.tls.client.san.email_addresses`	`[]string`	Email addresses in the subject alternative names.
`conn.tls.client.san.ip_addresses`	`[]string`	IP addresses in the subject alternative names.
`conn.tls.client.san.uris`	`[]string`	URIs in the subject alternative names.
`conn.tls.client.serial_number`	`string`	Unique identifier for the certificate.
`conn.tls.client.signature_algorithm`	`string`	Algorithm used to sign the certificate.
`conn.tls.client.subject`	`string`	The entity to whom the certificate is issued as a string roughly following the RFC 2253 Distinguished Names syntax.
`conn.tls.client.subject.common_name`	`string`	Common name of the subject, usually the domain name.
`conn.tls.client.subject.country`	`[]string`	Country name(s) where the subject of the certificate is located.
`conn.tls.client.subject.locality`	`[]string`	Locality or city where the subject is located.
`conn.tls.client.subject.organization`	`[]string`	Name(s) of the organization to which the subject belongs.
`conn.tls.client.subject.organizational_unit`	`[]string`	Division of the organization to which the subject belongs.
`conn.tls.client.subject.postal_code`	`[]string`	Postal code where the subject is located.
`conn.tls.client.subject.province`	`[]string`	Province or state where the subject is located.
`conn.tls.client.subject.street_address`	`[]string`	Street address where the subject is located.
`conn.tls.client.validity.not_after`	`timestamp`	Expiration date and time when the certificate is no longer valid.
`conn.tls.client.validity.not_before`	`timestamp`	Start date and time when the certificate becomes valid.

`conn.tls.client.extensions`

Additional information added to the certificate.

Loading…

`conn.tls.client.extensions[i].id`

The identifier (OID) that specifies the type of extension.

Loading…

`conn.tls.client.extensions[i].critical`

True if the extension is critical.

Loading…

`conn.tls.client.extensions[i].value`

The data for the extension.

Loading…

`conn.tls.client.issuer`

The issuing authority of the certificate as a string roughly following the RFC 2253 Distinguished Names syntax.

Loading…

`conn.tls.client.issuer.common_name`

Common name of the issuing authority, usually the domain name.

Loading…

`conn.tls.client.issuer.country`

Country name(s) where the issuing authority is located.

Loading…

`conn.tls.client.issuer.locality`

Locality or city of the issuing authority.

Loading…

`conn.tls.client.issuer.organization`

Name(s) of the organization that issued the certificate.

Loading…

`conn.tls.client.issuer.organizational_unit`

Division of the organization responsible for the certificate.

Loading…

`conn.tls.client.issuer.postal_code`

Postal code of the issuing authority.

Loading…

`conn.tls.client.issuer.province`

Province or state of the issuing authority.

Loading…

`conn.tls.client.issuer.street_address`

Street address of the issuing authority.

Loading…

`conn.tls.client.pem`

Full PEM-encoded client certificate of the TLS connection, with \n used for newlines.

Loading…

`conn.tls.client.san`

Subject alternative names of the client certificate.

Loading…

`conn.tls.client.san.dns_names`

DNS names in the subject alternative names.

Loading…

`conn.tls.client.san.email_addresses`

Email addresses in the subject alternative names.

Loading…

`conn.tls.client.san.ip_addresses`

IP addresses in the subject alternative names.

Loading…

`conn.tls.client.san.uris`

URIs in the subject alternative names.

Loading…

`conn.tls.client.serial_number`

Unique identifier for the certificate.

Loading…

`conn.tls.client.signature_algorithm`

Algorithm used to sign the certificate.

Loading…

`conn.tls.client.subject`

The entity to whom the certificate is issued as a string roughly following the RFC 2253 Distinguished Names syntax.

Loading…

`conn.tls.client.subject.common_name`

Common name of the subject, usually the domain name.

Loading…

`conn.tls.client.subject.country`

Country name(s) where the subject of the certificate is located.

Loading…

`conn.tls.client.subject.locality`

Locality or city where the subject is located.

Loading…

`conn.tls.client.subject.organization`

Name(s) of the organization to which the subject belongs.

Loading…

`conn.tls.client.subject.organizational_unit`

Division of the organization to which the subject belongs.

Loading…

`conn.tls.client.subject.postal_code`

Postal code where the subject is located.

Loading…

`conn.tls.client.subject.province`

Province or state where the subject is located.

Loading…

`conn.tls.client.subject.street_address`

Street address where the subject is located.

Loading…

`conn.tls.client.validity.not_after`

Expiration date and time when the certificate is no longer valid.

Loading…

`conn.tls.client.validity.not_before`

Start date and time when the certificate becomes valid.

Loading…

Connection TLS Server Variables

The following variables are available under the conn.tls.server namespace:

Name	Type	Description
`conn.tls.server.extensions`	`[]Extension`	Additional information added to the certificate.
`conn.tls.server.extensions[i].id`	`string`	The identifier that specifies the type of extension.
`conn.tls.server.extensions[i].critical`	`bool`	True if the extension is critical.
`conn.tls.server.extensions[i].value`	`[]byte`	The data for the extension.
`conn.tls.server.issuer`	`string`	The issuing authority of the certificate as a string roughly following the RFC 2253 Distinguished Names syntax.
`conn.tls.server.issuer.common_name`	`string`	Common name of the issuing authority, usually the domain name.
`conn.tls.server.issuer.country`	`[]string`	Country name(s) where the issuing authority is located.
`conn.tls.server.issuer.locality`	`[]string`	Locality or city of the issuing authority.
`conn.tls.server.issuer.organization`	`[]string`	Name(s) of the organization that issued the certificate.
`conn.tls.server.issuer.organizational_unit`	`[]string`	Division of the organization responsible for the certificate.
`conn.tls.server.issuer.postal_code`	`[]string`	Postal code of the issuing authority.
`conn.tls.server.issuer.province`	`[]string`	Province or state of the issuing authority.
`conn.tls.server.issuer.street_address`	`[]string`	Street address of the issuing authority.
`conn.tls.server.san`	`string`	Subject alternative names of the ngrok server's leaf TLS certificate.
`conn.tls.server.san.dns_names`	`[]string`	DNS names in the subject alternative names of the ngrok server's leaf TLS certificate.
`conn.tls.server.san.email_addresses`	`[]string`	Email addresses in the subject alternative names of the ngrok server's leaf TLS certificate.
`conn.tls.server.san.ip_addresses`	`[]string`	IP addresses in the subject alternative names of the ngrok server's leaf TLS certificate.
`conn.tls.server.san.uris`	`[]string`	URIs in the subject alternative names of the ngrok server's leaf TLS certificate.
`conn.tls.server.serial_number`	`string`	Unique identifier for the certificate.
`conn.tls.server.signature_algorithm`	`string`	Algorithm used to sign the certificate.
`conn.tls.server.subject`	`string`	The entity to whom the certificate is issued as a string roughly following the RFC 2253 Distinguished Names syntax.
`conn.tls.server.subject.common_name`	`string`	Common name of the subject, usually the domain name.
`conn.tls.server.subject.country`	`[]string`	Country name(s) where the subject of the certificate is located.
`conn.tls.server.subject.locality`	`[]string`	Locality or city where the subject is located.
`conn.tls.server.subject.organization`	`[]string`	Name(s) of the organization to which the subject belongs.
`conn.tls.server.subject.organizational_unit`	`[]string`	Division of the organization to which the subject belongs.
`conn.tls.server.subject.postal_code`	`[]string`	Postal code where the subject is located.
`conn.tls.server.subject.province`	`[]string`	Province or state where the subject is located.
`conn.tls.server.subject.street_address`	`[]string`	Street address where the subject is located.
`conn.tls.server.validity.not_after`	`timestamp`	Expiration date and time when the certificate is no longer valid.
`conn.tls.server.validity.not_before`	`timestamp`	Start date and time when the certificate becomes valid.

`conn.tls.server.extensions`

Additional information added to the certificate.

Loading…

`conn.tls.server.extensions[i].id`

The identifier that specifies the type of extension.

Loading…

`conn.tls.server.extensions[i].critical`

True if the extension is critical.

Loading…

`conn.tls.server.extensions[i].value`

The data for the extension.

Loading…

`conn.tls.server.issuer`

The issuing authority of the certificate as a string roughly following the RFC 2253 Distinguished Names syntax.

Loading…

`conn.tls.server.issuer.common_name`

Common name of the issuing authority, usually the domain name.

Loading…

`conn.tls.server.issuer.country`

Country name(s) where the issuing authority is located.

Loading…

`conn.tls.server.issuer.locality`

Locality or city of the issuing authority.

Loading…

`conn.tls.server.issuer.organization`

Name(s) of the organization that issued the certificate.

Loading…

`conn.tls.server.issuer.organizational_unit`

Division of the organization responsible for the certificate.

Loading…

`conn.tls.server.issuer.postal_code`

Postal code of the issuing authority.

Loading…

`conn.tls.server.issuer.province`

Province or state of the issuing authority.

Loading…

`conn.tls.server.issuer.street_address`

Street address of the issuing authority.

Loading…

`conn.tls.server.san`

Subject alternative names of the server certificate of the ngrok server's leaf TLS certificate.

Loading…

`conn.tls.server.san.dns_names`

DNS names in the subject alternative names of the ngrok server's leaf TLS certificate.

Loading…

`conn.tls.server.san.email_addresses`

Email addresses in the subject alternative names of the ngrok server's leaf TLS certificate.

Loading…

`conn.tls.server.san.ip_addresses`

IP addresses in the subject alternative names of the ngrok server's leaf TLS certificate.

Loading…

`conn.tls.server.san.uris`

URIs in the subject alternative names of the ngrok server's leaf TLS certificate.

Loading…

`conn.tls.server.serial_number`

Unique identifier for the certificate.

Loading…

`conn.tls.server.signature_algorithm`

Algorithm used to sign the certificate.

Loading…

`conn.tls.server.subject`

The entity to whom the certificate is issued as a string roughly following the RFC 2253 Distinguished Names syntax.

Loading…

`conn.tls.server.subject.common_name`

Common name of the subject, usually the domain name.

Loading…

`conn.tls.server.subject.country`

Country name(s) where the subject of the certificate is located.

Loading…

`conn.tls.server.subject.locality`

Locality or city where the subject is located.

Loading…

`conn.tls.server.subject.organization`

Name(s) of the organization to which the subject belongs.

Loading…

`conn.tls.server.subject.organizational_unit`

Division of the organization to which the subject belongs.

Loading…

`conn.tls.server.subject.postal_code`

Postal code where the subject is located.

Loading…

`conn.tls.server.subject.province`

Province or state where the subject is located.

Loading…

`conn.tls.server.subject.street_address`

Street address where the subject is located.

Loading…

`conn.tls.server.validity.not_after`

Expiration date and time when the certificate is no longer valid.

Loading…

`conn.tls.server.validity.not_before`

Start date and time when the certificate becomes valid.

Loading…