Skip to main content

TCP Variables

Action Result Variables​

The following variables are made available for use in subsequent expressions and CEL interpolations after the action has run. Variable values will only apply to the last action execution, results are not concatenated.

Log​

NameTypeDescription
actions.ngrok.log.metadatamap[string]stringThe key-value map of metadata that was logged.

Restrict IPs​

NameTypeDescription
actions.ngrok.restrict_ips.actionstringThe resulting action for this action execution. Supported values are either allow or deny.
actions.ngrok.restrict_ips.matched_cidrstringThe CIDR that matched for the incoming client ip. This may be empty.
actions.ngrok.restrict_ips.error.codestringCode for an error that occurred during the invocation of an action.
actions.ngrok.restrict_ips.error.messagestringMessage for an error that occurred during the invocation of an action.

Connection Variables​

The following variables are available under the conn namespace:

NameTypeDescription
conn.client_ipstringSource IP of the connection to the ngrok endpoint.
conn.client_portint32Source port of the connection to the ngrok endpoint.
conn.server_ipstringThe IP that this connection was established on.
conn.server_portint32The port that this connection was established on.
conn.server_regionstringThe ngrok PoP (Point of Presence) that this connection was established on and serviced through.
conn.ts.starttimestampTimestamp when the connection to ngrok was started.

conn.client_ip​

Source IP of the connection to the ngrok endpoint.

# snippet
---
expressions:
  - "conn.client_ip in ['::1', '127.0.0.1']"

conn.client_port​

Source port of the connection to the ngrok endpoint.

# snippet
---
expressions:
  - "conn.client_port == 80"

conn.server_ip​

The IP that this connection was established on.

# snippet
---
expressions:
  - "conn.server_ip == '192.168.1.1'"

conn.server_port​

The port that this connection was established on.

# snippet
---
expressions:
  - "conn.server_port == 80"

conn.server_region​

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

# snippet
---
expressions:
  - "conn.server_region == 'eu'"

conn.ts.start​

Timestamp when the connection to ngrok was started.

# snippet
---
expressions:
  - "conn.ts.start > timestamp('2023-12-31T00:00:00Z')"

Connection Geo Variables​

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

NameTypeDescription
conn.geo.citystringThe name of the city, in EN, where the conn.client_ip is likely to originate.
conn.geo.countrystringThe name of the country, in EN, where the conn.client_ip is likely to originate.
conn.geo.country_codestringThe two-letter ISO country code where the conn.client_ip is likely to originate.
conn.geo.latitudestringThe approximate latitude where the conn.client_ip is likely to originate.
conn.geo.longitudestringThe approximate longitude where the conn.client_ip is likely to originate.
conn.geo.radiusstringThe radius in kilometers around the latitude and longitude where the conn.client_ip is likely to originate.
conn.geo.subdivisionstringThe 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.

# snippet
---
expressions:
  - "conn.geo.city == 'Strongsville'"

conn.geo.country​

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

# snippet
---
expressions:
  - "conn.geo.country == 'United States'"

conn.geo.country_code​

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

# snippet
---
expressions:
  - "conn.geo.country_code != 'US'"

conn.geo.latitude​

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

# snippet
---
expressions:
  - "double(conn.geo.latitude) >= 45.0"

conn.geo.longitude​

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

# snippet
---
expressions:
  - "double(conn.geo.longitude) <= -93.0"

conn.geo.radius​

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

# snippet
---
expressions:
  - "conn.geo.radius <= '5'"

conn.geo.subdivision​

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

# snippet
---
expressions:
  - "conn.geo.subdivision == 'California'"

Endpoint Variables​

The following variables are available under the endpoint namespace:

NameTypeDescription
endpoint.addrstringThe address for this endpoint.
endpoint.hoststringThe hostname for this endpoint.
endpoint.idstringThe endpoint that serviced this connection.
endpoint.portint32The port for this endpoint.
endpoint.protocolstringThe protocol for this endpoint. Current supported values are http, https, tcp, and tls.
endpoint.urlstringThe url for this endpoint.

endpoint.addr​

The address for this endpoint.

# snippet
---
expressions:
  - "endpoint.addr == 'my-subdomain.ngrok.app:443'"

endpoint.host​

The hostname for this endpoint.

# snippet
---
expressions:
  - "endpoint.host == 'my-subdomain.ngrok.app'"

endpoint.id​

The id for this endpoint.

# snippet
---
expressions:
  - "endpoint.id == 'ep_2iL8LRbQilSCKYjaslRoqBwJcfT'"

endpoint.port​

The port for this endpoint.

# snippet
---
expressions:
  - "endpoint.port == 443"

endpoint.protocol​

The protocol for this endpoint. Current supported values are http, https, tcp, and tls.

# snippet
---
expressions:
  - "endpoint.protocol == 'https'"

endpoint.url​

The url for this endpoint.

# snippet
---
expressions:
  - "endpoint.url == 'https://my-subdomain.ngrok.app'"

Time variables​

The following variables are available under the time namespace:

NameTypeDescription
time.nowstringThe current UTC time in RFC3339 format.

time.now​

The current UTC time in RFC3339 format.

# snippet
---
expressions:
  - "conn.ts.end < timestamp(time.now)"