Skip to content
QuantCDN

Get details of a proxy rule

GET
/api/v2/organizations/{organization}/projects/{project}/rules/proxy/{rule}

Authorizations

Parameters

Path Parameters

organization
required
string
project
required
string
rule
required
string

Responses

200

The request has succeeded.

object
rule_id

Rule ID

string
action_config
required
object
mode

WAF operation mode

string
default: report
Allowed values: report block
paranoia_level

OWASP paranoia level

integer
default: 1 >= 1 <= 4
allow_rules

WAF rule IDs to allow/whitelist

Array<string>
allow_ip

IP addresses to allow

Array<string>
block_ip

IP addresses to block

Array<string>
block_asn

ASN numbers to block

Array<string>
block_ua

User agent patterns to block

Array<string>
block_referer

Referer patterns to block

Array<string>
notify_slack

Slack webhook URL for notifications

string
https://hooks.slack.com/services/XXX
notify_slack_hits_rpm

Minimum hits per minute to trigger Slack notification

integer
100
notify_email

Email addresses for notifications

Array<string>
httpbl

Project Honey Pot HTTP:BL configuration

object
httpbl_enabled

Enable HTTP:BL

boolean
block_suspicious

Block suspicious IPs

boolean
block_harvester

Block email harvesters

boolean
block_spam

Block spam sources

boolean
block_search_engine

Block search engines

boolean
httpbl_key

HTTP:BL API key

string
block_lists

Enable predefined block lists

object
user_agent

Block known bad user agents

boolean
referer

Block known bad referers

boolean
ip

Block known bad IPs

boolean
ai

Block AI crawlers

boolean
thresholds

Rate limiting thresholds

Array<object>
object
type

Threshold type

string
Allowed values: ip header waf_hit_by_ip
rps

Requests per second limit (for ip/header)

integer
10
hits

Hit count limit (for waf_hit_by_ip)

integer
10
minutes

Time window in minutes (for waf_hit_by_ip)

integer
5
cooldown

Cooldown period in seconds

integer
30
mode

Threshold enforcement mode

string
default: disabled
Allowed values: disabled report block
value

Header name (for header type)

string
nullable
notify_slack

Slack webhook for this threshold

string
nullable
to

Target URL to proxy to

string
https://backend.test-domain.com
host

Host header override

string
backend.test-domain.com
auth_user

Basic auth username

string
admin
auth_pass

Basic auth password

string
secure_password
disable_ssl_verify

Disable SSL verification

boolean
cache_lifetime

Cache lifetime

string
nullable 
3600
only_proxy_404

Only proxy 404 responses

boolean
inject_headers

Headers to inject

object
key
additional properties
string
{
  "X-Custom-Header": "value",
  "Authorization": "Bearer token"
}
proxy_strip_headers

Headers to strip from response

Array<string>
[
  "Set-Cookie",
  "Server"
]
proxy_strip_request_headers

Headers to strip from request

Array<string>
[
  "Cookie",
  "Authorization"
]
origin_timeout

Origin timeout

string
30
failover_mode

Enable failover mode

boolean
true
failover_origin_ttfb

Failover TTFB threshold

string
default: 2000 
2000
failover_origin_status_codes

Status codes for failover (default: 200,404,301,302,304)

Array<string>
[
  "200",
  "404",
  "301",
  "302",
  "304"
]
failover_lifetime

Failover cache lifetime

string
default: 300 
300
notify

Notification type (none, slack)

string
default: none
Allowed values: none slack 
slack
notify_config

Notification configuration (required when notify is slack)

object
webhook_url

Slack webhook URL

string
https://hooks.slack.com/services/XXXXXX
waf_enabled

WAF enabled

boolean
waf_config
One of:

Web Application Firewall configuration

object
mode

WAF operation mode

string
default: report
Allowed values: report block
paranoia_level

OWASP paranoia level

integer
default: 1 >= 1 <= 4
allow_rules

WAF rule IDs to allow/whitelist

Array<string>
allow_ip

IP addresses to allow

Array<string>
block_ip

IP addresses to block

Array<string>
block_asn

ASN numbers to block

Array<string>
block_ua

User agent patterns to block

Array<string>
block_referer

Referer patterns to block

Array<string>
notify_slack

Slack webhook URL for notifications

string
https://hooks.slack.com/services/XXX
notify_slack_hits_rpm

Minimum hits per minute to trigger Slack notification

integer
100
notify_email

Email addresses for notifications

Array<string>
httpbl

Project Honey Pot HTTP:BL configuration

object
httpbl_enabled

Enable HTTP:BL

boolean
block_suspicious

Block suspicious IPs

boolean
block_harvester

Block email harvesters

boolean
block_spam

Block spam sources

boolean
block_search_engine

Block search engines

boolean
httpbl_key

HTTP:BL API key

string
block_lists

Enable predefined block lists

object
user_agent

Block known bad user agents

boolean
referer

Block known bad referers

boolean
ip

Block known bad IPs

boolean
ai

Block AI crawlers

boolean
thresholds

Rate limiting thresholds

Array<object>
object
type

Threshold type

string
Allowed values: ip header waf_hit_by_ip
rps

Requests per second limit (for ip/header)

integer
10
hits

Hit count limit (for waf_hit_by_ip)

integer
10
minutes

Time window in minutes (for waf_hit_by_ip)

integer
5
cooldown

Cooldown period in seconds

integer
30
mode

Threshold enforcement mode

string
default: disabled
Allowed values: disabled report block
value

Header name (for header type)

string
nullable
notify_slack

Slack webhook for this threshold

string
nullable
proxy_alert_enabled

Proxy alert enabled

boolean
proxy_inline_fn_enabled

Proxy inline function enabled

boolean
quant_cloud_selection

Quant Cloud application proxy selection (only present for Quant Cloud App proxies)

object
app

Application name

string
my-app
env

Environment name

string
production
container

Container name

string
web
port

Container port

integer
80

400

The server could not understand the request due to invalid syntax.

object
message
required

Error message

string
The requested resource was not found
error
required

Error flag

boolean
true

403

Access is forbidden.

object
message
required

Error message

string
The requested resource was not found
error
required

Error flag

boolean
true