Proxy Templates

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

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

HTTPcURLJavaScriptPython

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

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

HTTPcURLJavaScriptPython

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"
      ]
    }
  ]
}

Modify Proxy Template

put

Update an individual Proxy Template within a configuration

Path parameters

configstringRequired

entry_idstringRequired

Body

application/json

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

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

HTTPcURLJavaScriptPython

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

application/json

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

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

HTTPcURLJavaScriptPython

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"
}

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

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

HTTPcURLJavaScriptPython

DELETE /api/v4.0/conf/{config}/proxy-templates/{entry_id} HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully deleted entry"
}