HTTP Variables

Connection Variables

The following connection variables are available on the conn struct:

Name	Type	Description
`conn.ClientIP`	string	The source IP of the HTTP connection to the ngrok endpoint.
`conn.Geo.CountryCode`	string	The two-letter ISO country code based on the client IP.
`conn.Geo.Latitude`	string	The approximate latitude based on the client IP.
`conn.Geo.LatLongRadiusKm`	string	The radius in kilometers around the latitude and longitude where the client IP is likely to originate.
`conn.Geo.Longitude`	string	The approximate longitude based on the client IP.

`conn.ClientIP`

The source IP of the HTTP connection to the ngrok endpoint as a string.

YAML
JSON

expressions:
  - conn.ClientIP in ['::1', '127.0.0.1']

{
  "expressions": [
    "conn.ClientIP in ['::1', '127.0.0.1']"
  ]
}

`conn.Geo.CountryCode`

The two-letter ISO country code based on the client IP.

YAML
JSON

expressions:
  - conn.Geo.CountryCode != 'US'

{
  "expressions": [
    "conn.Geo.CountryCode != 'US'"
  ]
}

`conn.Geo.Latitude`

The approximate latitude based on the client IP.

YAML
JSON

expressions:
  - double(conn.Geo.Latitude) >= 45.0

{
  "expressions": [
    "double(conn.Geo.Latitude) >= 45.0"
  ]
}

`conn.Geo.LatLongRadiusKm`

The radius in kilometers around the latitude and longitude where the client IP is likely to originate.

YAML
JSON

expressions:
  - conn.Geo.LatLongRadiusKm <= '20'

{
  "expressions": [
    "conn.Geo.LatLongRadiusKm <= '20'"
  ]
}

`conn.Geo.Longitude`

The approximate longitude based on the client IP.

YAML
JSON

expressions:
  - double(conn.Geo.Longitude) <= -93.0

{
  "expressions": [
    "double(conn.Geo.Longitude) <= -93.0"
  ]
}

Request Variables

The following request variables are available on the req struct:

Name	Type	Description
`req.ClientTLS.CertCN`	string	The subject common name of the client's leaf TLS certificate.
`req.ClientTLS.CipherSuite`	string	The cipher suite negotiated on the connection.
`req.ClientTLS.SNI`	string	The Server Name Indication extension sent by the client.
`req.ClientTLS.Version`	string	The TLS Version used on the connection.
`req.ContentLength`	int	The length of the content associated with the request.
`req.Cookies`	list	The list of HTTP cookie objects provided in the request.
`req.Method`	string	The request method.
`req.URL`	string	The URL of the request.
`req.Path`	string	The Path part of the request URL with a leading slash.
`req.Params`	map	The query parameters of the request URL wherein a string key maps to a list of string values.
`req.Protocol`	string	The protocol version of the request.
`req.Host`	string	The host of the request.
`req.Location`	string	The 'Location' header of the request.
`req.Headers`	map	The headers of the request wherein a string key maps to a list of string values. Header keys must be written in canonical format.
`req.Trailers`	map	The trailers of the request wherein a string key maps to a list of string values. Trailer keys must be written in canonical format.

`req.ClientTLS.CertCN`

The subject common name of the client's leaf TLS certificate.

YAML
JSON

expressions:
  - req.ClientTLS.CertCN.startsWith('example')

{
  "expressions": [
    "req.ClientTLS.CertCN.startsWith('example')"
  ]
}

`req.ClientTLS.CipherSuite`

The cipher suite negotiated on the connection.

YAML
JSON

expressions:
  - req.ClientTLS.CipherSuite.contains('SHA256')

{
  "expressions": [
    "req.ClientTLS.CipherSuite.contains('SHA256')"
  ]
}

`req.ClientTLS.SNI`

The Server Name Indication extension sent by the client.

YAML
JSON

expressions:
  - req.ClientTLS.SNI.startsWith('domain')

{
  "expressions": [
    "req.ClientTLS.SNI.startsWith('domain')"
  ]
}

`req.ClientTLS.Version`

The TLS Version used on the connection.

YAML
JSON

expressions:
  - req.ClientTLS.Version.contains('1.3')

{
  "expressions": [
    "req.ClientTLS.Version.contains('1.3')"
  ]
}

`req.ContentLength`

The length of the content associated with the request.

YAML
JSON

expressions:
  - req.ContentLength > 10000000

{
  "expressions": [
    "req.ContentLength > 10000000"
  ]
}

`req.Method`

The request method.

YAML
JSON

expressions:
  - req.Method == 'POST' || req.Method == 'PUT'

{
  "expressions": [
    "req.Method == 'POST' || req.Method == 'PUT'"
  ]
}

`req.Cookies`

The list of HTTP cookie objects provided in the request.

YAML
JSON

expressions:
  - size(req.Cookies) > 0

{
  "expressions": [
    "size(req.Cookies) > 0"
  ]
}

`req.URL`

The URL of the request.

YAML
JSON

expressions:
  - req.URL.contains('/admin')

{
  "expressions": [
    "req.URL.contains('/admin')"
  ]
}

`req.Path`

The Path part of the request URL with a leading slash.

YAML
JSON

expressions:
  - req.Path.startsWith('/foo')

{
  "expressions": [
    "req.Path.startsWith('/foo')"
  ]
}

`req.Params`

The query parameters of the request URL wherein a string key maps to a list of string values.

YAML
JSON

expressions:
  - "'bar' in req.Params['foo']"

{
  "expressions": [
    "'bar' in req.Params['foo']"
  ]
}

`req.Protocol`

The protocol version of the request.

YAML
JSON

expressions:
  - "`req.Protocol == 'HTTP/1.1'"

{
  "expressions": [
    "`req.Protocol == 'HTTP/1.1'"
  ]
}

`req.Host`

The host of the request.

YAML
JSON

expressions:
  - req.Host.contains(':8080')

{
  "expressions": [
    "req.Host.contains(':8080')"
  ]
}

`req.Location`

The 'Location' header of the request.

YAML
JSON

expressions:
  - req.Location == '/index.html'

{
  "expressions": [
    "req.Location == '/index.html'"
  ]
}

`req.Headers`

The headers of the request wherein a string key maps to a list of string values.

YAML
JSON

expressions:
  - "'Fizz' in req.Headers['Baz']"

{
  "expressions": [
    "'Fizz' in req.Headers['Baz']"
  ]
}

`req.Trailers`

The trailers of the request wherein a string key maps to a list of string values.

YAML
JSON

expressions:
  - "'Fizz' in req.Trailers['Baz']"

{
  "expressions": [
    "'Fizz' in req.Trailers['Baz']"
  ]
}

Response Variables

The following response variables are available on the res struct:

Name	Type	Description
`res.ContentLength`	int	The length of the content associated with the response.
`res.Cookies`	list	The list of HTTP cookie objects provided in the response.
`res.Headers`	map	The headers of the response wherein a string key maps to a list of string values. Header keys must be written in canonical format.
`res.Location`	string	The 'Location' header of the response.
`res.ServerTLS.CertCN`	string	The subject common name of the leaf TLS certificate.
`res.ServerTLS.CipherSuite`	string	The cipher suite negotiated on the connection.
`res.ServerTLS.SNI`	string	The Server Name Indication extension sent by the client.
`res.ServerTLS.Version`	string	The TLS Version used on the connection.
`res.StatusCode`	string	The status code of the response.
`res.Trailers`	map	The trailers of the response wherein a string key maps to a list of string values. Trailer keys must be written in canonical format.

`res.ContentLength`

The length of the content associated with the response.

YAML
JSON

expressions:
  - res.ContentLength != 0

{
  "expressions": [
    "res.ContentLength != 0"
  ]
}

`res.Cookies`

The list of HTTP cookie objects provided in the response.

YAML
JSON

expressions:
  - size(req.Cookies) > 0

{
  "expressions": [
    "size(req.Cookies) > 0"
  ]
}

`res.Headers`

The headers of the response wherein a string key maps to a list of string values.

YAML
JSON

expressions:
  - "'Fizz' in res.Headers['Baz']"

{
  "expressions": [
    "'Fizz' in res.Headers['Baz']"
  ]
}

`res.Location`

The 'Location' header of the response.

YAML
JSON

expressions:
  - res.Location == '/index.html'

{
  "expressions": [
    "res.Location == '/index.html'"
  ]
}

`res.ServerTLS.CertCN`

The subject common name of the leaf TLS certificate.

YAML
JSON

expressions:
  - res.ClientTLS.CertCN.startsWith('example')

{
  "expressions": [
    "res.ClientTLS.CertCN.startsWith('example')"
  ]
}

`res.ServerTLS.CipherSuite`

The cipher suite negotiated on the connection.

YAML
JSON

expressions:
  - res.ClientTLS.CipherSuite.contains('SHA256')

{
  "expressions": [
    "res.ClientTLS.CipherSuite.contains('SHA256')"
  ]
}

`res.ServerTLS.SNI`

The Server Name Indication extension sent by the client.

YAML
JSON

expressions:
  - res.ClientTLS.SNI.startsWith('domain')

{
  "expressions": [
    "res.ClientTLS.SNI.startsWith('domain')"
  ]
}

`res.ServerTLS.Version`

The TLS Version used on the connection.

YAML
JSON

expressions:
  - res.ClientTLS.Version.contains('1.3')

{
  "expressions": [
    "res.ClientTLS.Version.contains('1.3')"
  ]
}

`res.StatusCode`

The status code of the response.

YAML
JSON

expressions:
  - res.StatusCode >= '300'

{
  "expressions": [
    "res.StatusCode >= '300'"
  ]
}

`res.Trailers`

The trailers of the response wherein a string key maps to a list of string values.

YAML
JSON

expressions:
  - "'fizz' in res.Trailers['baz']"

{
  "expressions": [
    "'fizz' in res.Trailers['baz']"
  ]
}

HTTP Variables

Connection Variables​

conn.ClientIP​

conn.Geo.CountryCode​

conn.Geo.Latitude​

conn.Geo.LatLongRadiusKm​

conn.Geo.Longitude​

Request Variables​

req.ClientTLS.CertCN​

req.ClientTLS.CipherSuite​

req.ClientTLS.SNI​

req.ClientTLS.Version​

req.ContentLength​

req.Method​

req.Cookies​

req.URL​

req.Path​

req.Params​

req.Protocol​

req.Host​

req.Location​

req.Headers​

req.Trailers​

Response Variables​

res.ContentLength​

res.Cookies​

res.Headers​

res.Location​

res.ServerTLS.CertCN​

res.ServerTLS.CipherSuite​

res.ServerTLS.SNI​

res.ServerTLS.Version​

res.StatusCode​

res.Trailers​