Action Variables

Map of headers that were added by the action.

Whether there were Basic Auth credentials presented in the Authorization header.

The username of the credentials presented.

Whether the presented basic auth credentials were authorized for this request.

Indicates whether the body was already compressed before the action was applied. Returns true if no further compression was performed.

The compression algorithm selected and applied by the action, based on the client’s request and action configuration.

Message for an error that occurred during the invocation of an action.

A list of HTTP responses for each request attempt.

The HTTP request.

The last attempted HTTP response. Unlike actions.ngrok.attempts[i] this variable also contains the response body.

The list of JSON Web Tokens (JWTs) processed by the action.

A machine-readable code describing an error that occurred during the action’s execution.

A human-readable message providing details about an error that occurred during the action’s execution.

A key-value map containing metadata that was logged during the action. Each key represents a metadata attribute, and the value provides its corresponding details.

Code for an error that occurred during the invocation of an action.

Message for an error that occurred during the invocation of an action.

Unique identifier for the ngrok Identity entity

Email address of the authorized user from the provider.

Name for the authorized user from the provider.

Identifier for the authorized user from the provider.

The current Identity session identifier for this request.

The access token from the provider.

The refresh token from the provider.

Timestamp when the current session will expire.

Returns true when the session timed out.

Returns true when the current session reached the max duration.

Returns true when ngrok updates the user information on the identity.

Code for an error that occurred during the invocation of an action.

Message for an error that occurred during the invocation of an action.

Unique identifier for the ngrok Identity entity

Email address of the authorized user from the provider.

Name for the authorized user from the provider.

Identifier for the authorized user from the provider.

The current Identity session identifier for this request.

The identity token from the provider for the current user.

The access token from the provider.

The refresh token from the provider.

Timestamp when the current session will expire.

Returns true when the session timed out.

Returns true when the current session reached the max duration.

Returns true when ngrok updates the user information on the identity.

The key used for bucketing requests. This is the key used to group and track requests in the rate-limiting process, ensuring that the same bucket is subject to the rate limit across multiple requests.

Indicates whether the request was limited by the rate limit. If true, the request was rate-limited based on the configured limits for the specified bucket.

A machine-readable code describing an error that occurred during the action’s execution.

A human-readable message providing details about an error that occurred during the action’s execution.

A list of elements that were matched during redirection. These represent the request components (e.g., path or query parameters) that triggered the action and resulted in the redirect.

The URL to which the traffic was redirected. This is the destination URL returned as part of the redirect response after the action was executed.

A machine-readable code describing an error that occurred during the action’s execution.

A human-readable message providing details about an error that occurred during the action’s execution.

A list of headers that were successfully removed by the action.

The action taken for this request.

The CIDR block that matched the incoming client’s IP address. If no match was found, this value will be empty.

A machine-readable code describing an error that occurred during the action’s execution.

A human-readable message providing details about an error that occurred during the action’s execution.

List of elements that matched the URL before the rewrite action was applied. These can be specific parts of the URL, such as the domain, path, or query parameters, that were matched based on the action configuration.

The final URL after the rewrite action has been applied. This is the new URL to which the original request is redirected after the specified modifications have been made.

A machine-readable code describing an error that occurred during the action’s execution.

A human-readable message providing details about an error that occurred during the action’s execution.

Indicates whether or not the request was successfully verified.

Code for an error that occurred during the invocation of an action.

Message for an error that occurred during the invocation of an action.