Skip to content
QuantCDN

List proxy rules

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

Authorizations

Parameters

Path Parameters

organization
required
string
project
required
string

Responses

200

The request has succeeded.

Array<object>
object
name

Rule name

string
Test redirect rule
uuid
required

Rule UUID

string
123e4567-e89b-12d3-a456-426614174000
rule_id

Rule ID

string
rule-001
weight

Rule weight

integer
100
url

URL patterns

Array<string>
[
  "/old-path/*",
  "/legacy/*"
]
domain

Domain patterns

Array<string>
[
  "test-domain.com",
  "*.test-domain.com"
]
disabled
required

Whether rule is disabled

boolean
only_with_cookie

Only apply with cookie

string
session_id
method

HTTP method

string
GET
method_is

Allowed HTTP methods

Array<string>
[
  "GET",
  "POST"
]
method_is_not

Excluded HTTP methods

Array<string>
[
  "DELETE",
  "PUT"
]
ip

IP address

string
192.168.1.1
ip_is

Allowed IP addresses

Array<string>
[
  "192.168.1.0/24",
  "10.0.0.1"
]
ip_is_not

Excluded IP addresses

Array<string>
[
  "172.16.0.0/12"
]
country

Country code

string
US
country_is

Allowed countries

Array<string>
[
  "US",
  "CA",
  "GB"
]
country_is_not

Excluded countries

Array<string>
[
  "CN",
  "RU"
]
action
required

Rule action

string
redirect
rule_id

Rule ID

string
action_config
required
object
to
required

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
application_proxy

Enable Quant Cloud application proxy mode

boolean
application_name

Quant Cloud application name (required when application_proxy is true)

string
my-app
application_environment

Quant Cloud application environment (required when application_proxy is true)

string
production
application_container

Quant Cloud application container (required when application_proxy is true)

string
web
application_port

Quant Cloud application port (required when application_proxy is true)

integer
80
quant_cloud_selection

Quant Cloud application proxy selection (populated automatically when application_proxy is enabled)

object
app

Application name

string
my-app
env

Environment name

string
production
container

Container name

string
web
port

Container port

integer
80
static_error_page

Static error page content (HTML) to serve on origin errors

string
nullable 
<html><body>Service temporarily unavailable</body></html>
static_error_page_status_codes

Origin status codes that trigger static error page

Array<string>
[
  "500",
  "502",
  "503",
  "504"
]

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
{
  "message": "The requested resource was not found",
  "error": true
}

403

Access is forbidden.

object
message
required

Error message

string
The requested resource was not found
error
required

Error flag

boolean
true
{
  "message": "The requested resource was not found",
  "error": true
}