Proxy Templates

Get Proxy Templates

Get all Proxy Templates in a configuration

GET/api/v4.0/conf/{config}/proxy-templates

Path parameters

config*Config

Response

200400500

Proxy Templates retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of ProxyTemplate

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/proxy-templates', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400500

{
  "total": 1,
  "items": [
    {
      "acao_header": false,
      "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": "text",
      "custom_listener": false,
      "description": "text",
      "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": "text",
      "ssl_protocols": [
        "SSLv2"
      ],
      "upstream_host": "text",
      "xff_header_name": "text",
      "xrealip_header_name": "text"
    }
  ]
}

Get Proxy Template

Get a Proxy Template from the specified configuration

GET/api/v4.0/conf/{config}/proxy-templates/{entry_id}

Path parameters

config*Config

entry_id*Id

Response

200400422500

Proxy Template retrieved successfully

Body

application/json

acao_header*Acao Header

client_body_buffer_size*Client Body Buffer Size

client_body_timeout*Client Body Timeout

client_header_buffer_size*Client Header Buffer Size

client_header_timeout*Client Header Timeout

client_max_body_size*Client Max Body Size

conf_specificConf Specific

custom_listener*Custom Listener

descriptionDescription

keepalive_timeout*Keepalive Timeout

large_client_header_buffers_count*Large Client Header Buffers Count

large_client_header_buffers_size*Large Client Header Buffers Size

limit_req_burst*Limit Req Burst

limit_req_rate*Limit Req Rate

mask_headers*Mask Headers

name*Name

proxy_connect_timeout*Proxy Connect Timeout

proxy_read_timeout*Proxy Read Timeout

proxy_send_timeout*Proxy Send Timeout

send_timeout*Send Timeout

ssl_ciphersSsl Ciphers

ssl_conf_specificSsl Conf Specific

ssl_protocolsSsl Protocols

upstream_host*Upstream Host

xff_header_name*Xff Header Name

xrealip_header_name*Xrealip Header Name

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/proxy-templates/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400422500

{
  "acao_header": false,
  "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": "text",
  "custom_listener": false,
  "description": "text",
  "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": "text",
  "ssl_protocols": [
    "SSLv2"
  ],
  "upstream_host": "text",
  "xff_header_name": "text",
  "xrealip_header_name": "text"
}

Modify Proxy Template

Update an individual Proxy Template within a configuration

PUT/api/v4.0/conf/{config}/proxy-templates/{entry_id}

Path parameters

config*Config

entry_id*Id

Body

application/json

acao_header*Acao Header

client_body_buffer_size*Client Body Buffer Size

client_body_timeout*Client Body Timeout

client_header_buffer_size*Client Header Buffer Size

client_header_timeout*Client Header Timeout

client_max_body_size*Client Max Body Size

conf_specificConf Specific

custom_listener*Custom Listener

descriptionDescription

keepalive_timeout*Keepalive Timeout

large_client_header_buffers_count*Large Client Header Buffers Count

large_client_header_buffers_size*Large Client Header Buffers Size

limit_req_burst*Limit Req Burst

limit_req_rate*Limit Req Rate

mask_headers*Mask Headers

name*Name

proxy_connect_timeout*Proxy Connect Timeout

proxy_read_timeout*Proxy Read Timeout

proxy_send_timeout*Proxy Send Timeout

send_timeout*Send Timeout

ssl_ciphersSsl Ciphers

ssl_conf_specificSsl Conf Specific

ssl_protocolsSsl Protocols

upstream_host*Upstream Host

xff_header_name*Xff Header Name

xrealip_header_name*Xrealip Header Name

Response

200400422500

Proxy Template updated successfully

Body

application/json

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/proxy-templates/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "acao_header": false,
      "xff_header_name": "text",
      "proxy_connect_timeout": "text",
      "proxy_read_timeout": "text",
      "proxy_send_timeout": "text",
      "upstream_host": "text",
      "client_body_timeout": "text",
      "client_body_buffer_size": "text",
      "client_header_timeout": "text",
      "keepalive_timeout": "text",
      "send_timeout": "text",
      "client_max_body_size": "text",
      "limit_req_rate": "text",
      "limit_req_burst": "text",
      "mask_headers": "text",
      "xrealip_header_name": "text",
      "custom_listener": false,
      "client_header_buffer_size": "text",
      "large_client_header_buffers_count": "text",
      "large_client_header_buffers_size": "text"
    }),
});
const data = await response.json();

Response

200400422500

{
  "message": "Successfully updated entry"
}

Create Proxy Template

Create an individual Proxy Template within a configuration

POST/api/v4.0/conf/{config}/proxy-templates/{entry_id}

Path parameters

config*Config

entry_id*Id

Pattern: ^[A-Za-z0-9\-\_]*$

Body

application/json

acao_header*Acao Header

client_body_buffer_size*Client Body Buffer Size

client_body_timeout*Client Body Timeout

client_header_buffer_size*Client Header Buffer Size

client_header_timeout*Client Header Timeout

client_max_body_size*Client Max Body Size

conf_specificConf Specific

custom_listener*Custom Listener

descriptionDescription

keepalive_timeout*Keepalive Timeout

large_client_header_buffers_count*Large Client Header Buffers Count

large_client_header_buffers_size*Large Client Header Buffers Size

limit_req_burst*Limit Req Burst

limit_req_rate*Limit Req Rate

mask_headers*Mask Headers

name*Name

proxy_connect_timeout*Proxy Connect Timeout

proxy_read_timeout*Proxy Read Timeout

proxy_send_timeout*Proxy Send Timeout

send_timeout*Send Timeout

ssl_ciphersSsl Ciphers

ssl_conf_specificSsl Conf Specific

ssl_protocolsSsl Protocols

upstream_host*Upstream Host

xff_header_name*Xff Header Name

xrealip_header_name*Xrealip Header Name

Response

201400422500

Proxy Template created successfully

Body

application/json

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/proxy-templates/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "acao_header": false,
      "xff_header_name": "text",
      "proxy_connect_timeout": "text",
      "proxy_read_timeout": "text",
      "proxy_send_timeout": "text",
      "upstream_host": "text",
      "client_body_timeout": "text",
      "client_body_buffer_size": "text",
      "client_header_timeout": "text",
      "keepalive_timeout": "text",
      "send_timeout": "text",
      "client_max_body_size": "text",
      "limit_req_rate": "text",
      "limit_req_burst": "text",
      "mask_headers": "text",
      "xrealip_header_name": "text",
      "custom_listener": false,
      "client_header_buffer_size": "text",
      "large_client_header_buffers_count": "text",
      "large_client_header_buffers_size": "text"
    }),
});
const data = await response.json();

Response

201400422500

{
  "message": "Successfully created entry"
}

Delete Proxy Template

Delete an individual Proxy Template from the specified configuration

DELETE/api/v4.0/conf/{config}/proxy-templates/{entry_id}

Path parameters

config*Config

entry_id*Id

Response

200400422500

Proxy Template deleted successfully

Body

application/json

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/proxy-templates/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400422500

{
  "message": "Successfully deleted entry"
}