Flexy Proxy Config Specification

Type: object
No Additional Properties

root default_route
Type: object Default: {}

Defines the default behavior when no specific route matches.

 No Additional Properties

root default_route proxy
Type: string Default: ""

The URL of the proxy to connect to by default.
Example:

"http://default.proxy"

root default_route deny_access
Type: boolean Default: false

Whether to deny access if no routing matches.
Example:

true

root log_level
Type: enum (of string) Default: "INFO"

The level of logging detail. Possible values are 'DEBUG', 'INFO', 'WARN', or 'ERROR'.

Must be one of:

  • "DEBUG"
  • "INFO"
  • "WARN"
  • "ERROR"

Example:

"DEBUG"

root always_mitm
Type: boolean Default: true

If true, eavesdrop all HTTPS access to get the full URL. If false, only eavesdrop HTTP access if the host name matches.
Example:

true

root routes
Type: array of object Default: []

Routing settings. Each route defines a URL pattern and the response to return.

 No Additional Items

Each item of this array must be:

root routes routes items
Type: object

A single route configuration.

 No Additional Properties

root routes routes items url
Type: string

The URL pattern to match. If this URL matches, the specified response will be returned.
Examples:

"https://example.com/api"

"https://example.com/user/[^/]+/post/[^/]"

root routes routes items regex
Type: boolean Default: false

If true, regex can be used for URL matching.
Example:

false

root routes routes items response
Type: object or null

The response to return. One of 'rewrite', 'content', or 'file' can be specified.

 No Additional Properties

root routes routes items response rewrite

root routes routes items response rewrite oneOf item 0
Type: object

Rewrite settings. Defines how the URL should be rewritten.

 No Additional Properties

root routes routes items response rewrite oneOf item 0 from
Type: string

The pattern to be replaced.
Example:

"^https://example\\\\.com/user/([^/]+)/post/([^/]+)"

root routes routes items response rewrite oneOf item 0 to
Type: string

The replacement string.
Example:

"https://example.com/api?user=$1&post=$2"

root routes routes items response rewrite oneOf item 0 regex
Type: boolean Default: false

Whether to use regex for matching the 'from' URL.
Example:

false

root routes routes items response rewrite oneOf item 0 proxy
Type: string Default: ""

The URL of the proxy to use for this route. If not specified, 'default_route.proxy' will be used. To disable the proxy, specify an empty string.
Example:

"http://proxy.example.com"
root routes routes items response rewrite oneOf item 1
Type: string

The destination URL to rewrite.
Example:

"https://example.com/api?user=me"

root routes routes items response content
Type: string

The content to return as the response.
Examples:

"This is the response content"

"not found"

root routes routes items response content_type
Type: string Default: "text/plain"

The MIME type of the content.
Examples:

"text/plain"

"application/json"

root routes routes items response status
Type: integer Default: 200

The HTTP status code to return.
Examples:

200

404

root routes routes items response file
Type: string Default: ""

The file path to return as the response.
Examples:

"/path/to/file"

"sample.png"

root routes routes items response headers
Type: object Default: {}

Additional headers to include in the response.
Example:

{
    "Access-Control-Allow-Origin": "*"
}

root routes routes items response transform
Type: string Default: ""

The command to transform the response content.
Examples:

"sed -E 's/foo/bar/g'"

"bash ./script.sh"

root certificate
Type: string Default: ""

The path to the SSL certificate file.
Example:

"server.crt"

root certificate_key
Type: string Default: ""

The path to the private key file corresponding to the SSL certificate.
Example:

"server.key"