Get details of a proxy rule
const url = 'https://dashboard.quantcdn.io/api/v2/organizations/example/projects/example/rules/proxy/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://dashboard.quantcdn.io/api/v2/organizations/example/projects/example/rules/proxy/example \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”The request has succeeded.
object
Rule name
Rule UUID
Rule ID
Rule weight
URL patterns
Domain patterns
Whether rule is disabled
Only apply with cookie
HTTP method
Allowed HTTP methods
Excluded HTTP methods
IP address
Allowed IP addresses
Excluded IP addresses
ASN filter type (asn_is, asn_is_not, any)
Allowed AS numbers
Excluded AS numbers
Country code
Allowed countries
Excluded countries
Rule action
Rule ID
object
Target URL to proxy to
Host header override
Basic auth username
Basic auth password
Disable SSL verification
Cache lifetime
Only proxy 404 responses
Headers to inject
object
Headers to strip from response
Headers to strip from request
Origin timeout
Enable failover mode
Failover TTFB threshold
Status codes for failover (default: 200,404,301,302,304)
Failover cache lifetime
Notification type (none, slack)
Notification configuration (required when notify is slack)
object
Slack webhook URL
WAF enabled
Web Application Firewall configuration
object
WAF operation mode
OWASP paranoia level
WAF rule IDs to allow/whitelist
IP addresses to allow
IP addresses to block
ASN numbers to block
User agent patterns to block
Referer patterns to block
Slack webhook URL for notifications
Minimum hits per minute to trigger Slack notification
Email addresses for notifications
Project Honey Pot HTTP:BL configuration
object
Enable HTTP:BL
Block suspicious IPs
Block email harvesters
Block spam sources
Block search engines
HTTP:BL API key
Enable predefined block lists
object
Block known bad user agents
Block known bad referers
Block known bad IPs
Block AI crawlers
Rate limiting thresholds
object
Threshold type
Requests per second limit (for ip/header)
Hit count limit (for waf_hit_by_ip)
Time window in minutes (for waf_hit_by_ip)
Cooldown period in seconds
Threshold enforcement mode
Header name (for header type)
Slack webhook for this threshold
Proxy alert enabled
Proxy inline function enabled
Enable Quant Cloud application proxy mode
Quant Cloud application name (required when application_proxy is true)
Quant Cloud application environment (required when application_proxy is true)
Quant Cloud application container (required when application_proxy is true)
Quant Cloud application port (required when application_proxy is true)
Quant Cloud application proxy selection (populated automatically when application_proxy is enabled)
object
Application name
Environment name
Container name
Container port
Static error page content (HTML) to serve on origin errors
Origin status codes that trigger static error page
Example
{ "name": "Test redirect rule", "uuid": "123e4567-e89b-12d3-a456-426614174000", "rule_id": "rule-001", "weight": 0, "url": [ "/old-path/*", "/legacy/*" ], "domain": [ "test-domain.com", "*.test-domain.com" ], "disabled": false, "only_with_cookie": "session_id", "method": "GET", "method_is": [ "GET", "POST" ], "method_is_not": [ "DELETE", "PUT" ], "ip": "192.168.1.1", "ip_is": [ "192.168.1.0/24", "10.0.0.1" ], "ip_is_not": [ "172.16.0.0/12" ], "asn": "any", "asn_is": [ "15169", "8075" ], "asn_is_not": [ "13335" ], "country": "US", "country_is": [ "US", "CA", "GB" ], "country_is_not": [ "CN", "RU" ], "action": "redirect", "action_config": { "to": "https://backend.test-domain.com", "host": "backend.test-domain.com", "auth_user": "admin", "auth_pass": "secure_password", "disable_ssl_verify": false, "cache_lifetime": "3600", "only_proxy_404": false, "inject_headers": { "X-Custom-Header": "value", "Authorization": "Bearer token" }, "proxy_strip_headers": [ "Set-Cookie", "Server" ], "proxy_strip_request_headers": [ "Cookie", "Authorization" ], "origin_timeout": "30", "failover_mode": false, "failover_origin_ttfb": "2000", "failover_origin_status_codes": [ "200", "404", "301", "302", "304" ], "failover_lifetime": "300", "notify": "none", "notify_config": { "webhook_url": "https://hooks.slack.com/services/XXXXXX" }, "waf_enabled": false, "waf_config": { "mode": "report", "paranoia_level": 1, "notify_slack": "https://hooks.slack.com/services/XXX", "notify_slack_hits_rpm": 100, "httpbl": { "httpbl_enabled": false, "block_suspicious": false, "block_harvester": false, "block_spam": false, "block_search_engine": false }, "block_lists": { "user_agent": false, "referer": false, "ip": false, "ai": false }, "thresholds": [ { "type": "ip", "rps": 10, "hits": 10, "minutes": 5, "cooldown": 30, "mode": "disabled" } ] }, "proxy_alert_enabled": false, "proxy_inline_fn_enabled": false, "application_proxy": false, "application_name": "my-app", "application_environment": "production", "application_container": "web", "application_port": 80, "quant_cloud_selection": { "app": "my-app", "env": "production", "container": "web", "port": 80 }, "static_error_page": "<html><body>Service temporarily unavailable</body></html>", "static_error_page_status_codes": [ "500", "502", "503", "504" ] }}The server could not understand the request due to invalid syntax.
object
Error message
Error flag
Example
{ "message": "The requested resource was not found", "error": true}Access is forbidden.
object
Error message
Error flag
Example
{ "message": "The requested resource was not found", "error": true}