Link11 WAAP
v5
v5
  • Link11 WAAP Documentation
  • Release Notes
  • Known Issues
  • User Guide
    • Introduction to Link11 WAAP
  • How Link11 WAAP Works
    • Traffic Filtering Process
    • Traffic Reporting and Analytics
    • Policy Mapping and Traffic Routing
    • Tagging
    • UI Overview and Common Elements
  • Console UI Walkthrough
    • Analytics
      • Dashboard
      • Events Log
    • Security
      • Global Filters
      • Flow Control Policies
      • Security Policies
      • Rate Limit Rules
      • ACL Profiles
      • Actions
      • Dynamic Rules
      • Quarantined
      • Content Filter
        • Content Filter Profiles
        • Content Filter Rules
    • Sites
      • Server Groups
      • Proxy Templates
      • Mobile Application Groups
      • Backend Services
      • Edge Functions
      • DNS Records
      • SSL
        • Load Balancers
        • Certificates
    • System
      • Interactive Challenge
      • SSO Configuration
      • Purge CDN Cache
      • Users Management
      • Security Alerts
      • Log Exporters
      • Version Control
      • System DB
      • Publish Changes
    • Account
  • Using the product
    • Best Practices
      • Saving and Publishing Your Changes
      • Enabling Passive Challenges
      • Understanding and Diagnosing Traffic Issues
    • How Do I...
      • Authenticate mobile app users
      • Ban, unban, and allowlist traffic sources
      • Bypass Link11 WAAP for loadtesting or other purposes
      • Configure a new path/section of a site
      • Control caching behavior
      • Enable GraphQL traffic
      • Enable mTLS (mutual TLS)
      • Protect sensitive information in logs and analytics
      • Quickly block an attacker
      • Redirect or block HTTP traffic
      • Run custom code
      • Set rate limits and exemptions
      • Stream event data to a SIEM solution or other destination
    • The Link11 WAAP API
      • Overview
      • Internal data structures
      • Using Swagger UI
      • Using curl
  • Reference Information
    • Acronyms
    • API
      • API access to traffic data
      • Types of namespaces
      • Namespace reference
        • ACL Profiles
        • Actions
        • Backend Services
        • Certificates
        • Configs
        • Content Filter Profiles
        • Content Filter Rules
        • Data queries
        • Dynamic Rules
        • Edge Functions
        • Flow Control Policies
        • Global Filters
        • Load Balancers
        • Log Exporters
        • Mobile Application Groups
        • Planets
        • Proxy Templates
        • Rate Limit Rules
        • Security Alerts
        • Security Policies
        • Server Groups
        • Tags
        • Tools
        • Users
    • Hostile Bot Detection / LWCSI
      • Environmental detection and browser verification
      • Client authentication
      • Biometric behavioral verification
    • HTTP Response Codes
    • Log Exporter Output
    • Pattern Matching Syntax
    • Query Filter Syntax and Best Practices
  • Support
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Reference Information
  2. API
  3. Namespace reference

Proxy Templates

PreviousPlanetsNextRate Limit Rules

Last updated 5 months ago

Was this helpful?

Get Proxy Templates

get

Get all Proxy Templates in a configuration

Path parameters
configstringRequired
Responses
200
Proxy Templates retrieved successfully
application/json
400
Input Error
application/json
500
Internal Server Error
application/json
get
GET /api/v4.0/conf/{config}/proxy-templates HTTP/1.1
Host: 
Accept: */*
{
  "total": 1,
  "items": [
    {
      "acao_header": true,
      "client_body_buffer_size": "text",
      "client_body_timeout": "text",
      "client_header_buffer_size": "text",
      "client_header_timeout": "text",
      "client_max_body_size": "text",
      "conf_specific": "",
      "custom_listener": true,
      "description": "",
      "keepalive_timeout": "text",
      "large_client_header_buffers_count": "text",
      "large_client_header_buffers_size": "text",
      "limit_req_burst": "text",
      "limit_req_rate": "text",
      "mask_headers": "text",
      "name": "text",
      "proxy_connect_timeout": "text",
      "proxy_read_timeout": "text",
      "proxy_send_timeout": "text",
      "send_timeout": "text",
      "ssl_ciphers": "text",
      "ssl_conf_specific": "",
      "ssl_protocols": [
        "SSLv2"
      ],
      "upstream_host": "text",
      "xff_header_name": "text",
      "xrealip_header_name": "text",
      "advanced_configuration": [
        {
          "configuration": "text",
          "description": "",
          "name": "text",
          "protocol": [
            "http"
          ]
        }
      ]
    }
  ]
}

Get Proxy Template

get

Get a Proxy Template from the specified configuration

Path parameters
configstringRequired
entry_idstringRequired
Responses
200
Proxy Template retrieved successfully
application/json
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
get
GET /api/v4.0/conf/{config}/proxy-templates/{entry_id} HTTP/1.1
Host: 
Accept: */*
{
  "acao_header": true,
  "client_body_buffer_size": "text",
  "client_body_timeout": "text",
  "client_header_buffer_size": "text",
  "client_header_timeout": "text",
  "client_max_body_size": "text",
  "conf_specific": "",
  "custom_listener": true,
  "description": "",
  "keepalive_timeout": "text",
  "large_client_header_buffers_count": "text",
  "large_client_header_buffers_size": "text",
  "limit_req_burst": "text",
  "limit_req_rate": "text",
  "mask_headers": "text",
  "name": "text",
  "proxy_connect_timeout": "text",
  "proxy_read_timeout": "text",
  "proxy_send_timeout": "text",
  "send_timeout": "text",
  "ssl_ciphers": "text",
  "ssl_conf_specific": "",
  "ssl_protocols": [
    "SSLv2"
  ],
  "upstream_host": "text",
  "xff_header_name": "text",
  "xrealip_header_name": "text",
  "advanced_configuration": [
    {
      "configuration": "text",
      "description": "",
      "name": "text",
      "protocol": [
        "http"
      ]
    }
  ]
}

Delete Proxy Template

delete

Delete an individual Proxy Template from the specified configuration

Path parameters
configstringRequired
entry_idstringRequired
Responses
200
Proxy Template deleted successfully
application/json
400
Bad Request
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
delete
DELETE /api/v4.0/conf/{config}/proxy-templates/{entry_id} HTTP/1.1
Host: 
Accept: */*
{
  "message": "Successfully deleted entry"
}
  • GETGet Proxy Templates
  • GETGet Proxy Template
  • PUTModify Proxy Template
  • POSTCreate Proxy Template
  • DELETEDelete Proxy Template

Modify Proxy Template

put

Update an individual Proxy Template within a configuration

Path parameters
configstringRequired
entry_idstringRequired
Body
acao_headerbooleanRequired
client_body_buffer_sizestringRequired
client_body_timeoutstringRequired
client_header_buffer_sizestringRequired
client_header_timeoutstringRequired
client_max_body_sizestringRequired
conf_specificstringOptionalDefault: ""
custom_listenerbooleanRequired
descriptionstringOptionalDefault: ""
keepalive_timeoutstringRequired
large_client_header_buffers_countstringRequired
large_client_header_buffers_sizestringRequired
limit_req_burststringRequired
limit_req_ratestringRequired
mask_headersstringRequired
namestringRequired
proxy_connect_timeoutstringRequired
proxy_read_timeoutstringRequired
proxy_send_timeoutstringRequired
send_timeoutstringRequired
ssl_ciphersstringOptional
ssl_conf_specificstringOptionalDefault: ""
upstream_hoststringRequired
xff_header_namestringRequired
xrealip_header_namestringRequired
Responses
200
Proxy Template updated successfully
application/json
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
put
PUT /api/v4.0/conf/{config}/proxy-templates/{entry_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 793

{
  "acao_header": true,
  "client_body_buffer_size": "text",
  "client_body_timeout": "text",
  "client_header_buffer_size": "text",
  "client_header_timeout": "text",
  "client_max_body_size": "text",
  "conf_specific": "",
  "custom_listener": true,
  "description": "",
  "keepalive_timeout": "text",
  "large_client_header_buffers_count": "text",
  "large_client_header_buffers_size": "text",
  "limit_req_burst": "text",
  "limit_req_rate": "text",
  "mask_headers": "text",
  "name": "text",
  "proxy_connect_timeout": "text",
  "proxy_read_timeout": "text",
  "proxy_send_timeout": "text",
  "send_timeout": "text",
  "ssl_ciphers": "text",
  "ssl_conf_specific": "",
  "ssl_protocols": [
    "SSLv2"
  ],
  "upstream_host": "text",
  "xff_header_name": "text",
  "xrealip_header_name": "text",
  "advanced_configuration": [
    {
      "configuration": "text",
      "description": "",
      "name": "text",
      "protocol": [
        "http"
      ]
    }
  ]
}
{
  "message": "Successfully updated entry"
}

Create Proxy Template

post

Create an individual Proxy Template within a configuration

Path parameters
configstringRequired
entry_idstringRequiredPattern: ^[A-Za-z0-9\-\_]*$
Body
acao_headerbooleanRequired
client_body_buffer_sizestringRequired
client_body_timeoutstringRequired
client_header_buffer_sizestringRequired
client_header_timeoutstringRequired
client_max_body_sizestringRequired
conf_specificstringOptionalDefault: ""
custom_listenerbooleanRequired
descriptionstringOptionalDefault: ""
keepalive_timeoutstringRequired
large_client_header_buffers_countstringRequired
large_client_header_buffers_sizestringRequired
limit_req_burststringRequired
limit_req_ratestringRequired
mask_headersstringRequired
namestringRequired
proxy_connect_timeoutstringRequired
proxy_read_timeoutstringRequired
proxy_send_timeoutstringRequired
send_timeoutstringRequired
ssl_ciphersstringOptional
ssl_conf_specificstringOptionalDefault: ""
upstream_hoststringRequired
xff_header_namestringRequired
xrealip_header_namestringRequired
Responses
201
Proxy Template created successfully
application/json
400
Input Error
application/json
422
Validation Error
application/json
500
Internal Server Error
application/json
post
POST /api/v4.0/conf/{config}/proxy-templates/{entry_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 793

{
  "acao_header": true,
  "client_body_buffer_size": "text",
  "client_body_timeout": "text",
  "client_header_buffer_size": "text",
  "client_header_timeout": "text",
  "client_max_body_size": "text",
  "conf_specific": "",
  "custom_listener": true,
  "description": "",
  "keepalive_timeout": "text",
  "large_client_header_buffers_count": "text",
  "large_client_header_buffers_size": "text",
  "limit_req_burst": "text",
  "limit_req_rate": "text",
  "mask_headers": "text",
  "name": "text",
  "proxy_connect_timeout": "text",
  "proxy_read_timeout": "text",
  "proxy_send_timeout": "text",
  "send_timeout": "text",
  "ssl_ciphers": "text",
  "ssl_conf_specific": "",
  "ssl_protocols": [
    "SSLv2"
  ],
  "upstream_host": "text",
  "xff_header_name": "text",
  "xrealip_header_name": "text",
  "advanced_configuration": [
    {
      "configuration": "text",
      "description": "",
      "name": "text",
      "protocol": [
        "http"
      ]
    }
  ]
}
{
  "message": "Successfully created entry"
}