Proxy Templates

PreviousPlanets NextRate Limit Rules

Last updated 2 months ago

Was this helpful?

Get Proxy Templates

Get all Proxy Templates in a configuration

get

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

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/proxy-templates'

200

400

500

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

Proxy Templates retrieved successfully

Get Proxy Template

Get a Proxy Template from the specified configuration

get

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

Path parameters

configConfigrequired

entry_idIdrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/v4.0/conf/{config}/proxy-templates/{entry_id}'

200

400

422

500

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

Proxy Template retrieved successfully

Modify Proxy Template

Update an individual Proxy Template within a configuration

put

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

Path parameters

configConfigrequired

entry_idIdrequired

Body

acao_headerAcao Headerrequired

client_body_buffer_sizeClient Body Buffer Sizerequired

client_body_timeoutClient Body Timeoutrequired

client_header_buffer_sizeClient Header Buffer Sizerequired

client_header_timeoutClient Header Timeoutrequired

client_max_body_sizeClient Max Body Sizerequired

conf_specificConf Specific

custom_listenerCustom Listenerrequired

descriptionDescription

keepalive_timeoutKeepalive Timeoutrequired

large_client_header_buffers_countLarge Client Header Buffers Countrequired

large_client_header_buffers_sizeLarge Client Header Buffers Sizerequired

limit_req_burstLimit Req Burstrequired

limit_req_rateLimit Req Raterequired

mask_headersMask Headersrequired

nameNamerequired

proxy_connect_timeoutProxy Connect Timeoutrequired

proxy_read_timeoutProxy Read Timeoutrequired

proxy_send_timeoutProxy Send Timeoutrequired

send_timeoutSend Timeoutrequired

ssl_ciphersSsl Ciphers

ssl_conf_specificSsl Conf Specific

upstream_hostUpstream Hostrequired

xff_header_nameXff Header Namerequired

xrealip_header_nameXrealip Header Namerequired

ssl_protocolsSsl Protocols

advanced_configurationAdvanced nginx configuration

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/proxy-templates/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{"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_conf_specific":"","upstream_host":"text","xff_header_name":"text","xrealip_header_name":"text","ssl_protocols":["SSLv2"],"advanced_configuration":[]}'

200

400

422

500

{
  "message": "Successfully updated entry"
}

Proxy Template updated successfully

Create Proxy Template

Create an individual Proxy Template within a configuration

post

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

Path parameters

configConfigrequired

entry_idIdrequired

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

Body

acao_headerAcao Headerrequired

client_body_buffer_sizeClient Body Buffer Sizerequired

client_body_timeoutClient Body Timeoutrequired

client_header_buffer_sizeClient Header Buffer Sizerequired

client_header_timeoutClient Header Timeoutrequired

client_max_body_sizeClient Max Body Sizerequired

conf_specificConf Specific

custom_listenerCustom Listenerrequired

descriptionDescription

keepalive_timeoutKeepalive Timeoutrequired

large_client_header_buffers_countLarge Client Header Buffers Countrequired

large_client_header_buffers_sizeLarge Client Header Buffers Sizerequired

limit_req_burstLimit Req Burstrequired

limit_req_rateLimit Req Raterequired

mask_headersMask Headersrequired

nameNamerequired

proxy_connect_timeoutProxy Connect Timeoutrequired

proxy_read_timeoutProxy Read Timeoutrequired

proxy_send_timeoutProxy Send Timeoutrequired

send_timeoutSend Timeoutrequired

ssl_ciphersSsl Ciphers

ssl_conf_specificSsl Conf Specific

upstream_hostUpstream Hostrequired

xff_header_nameXff Header Namerequired

xrealip_header_nameXrealip Header Namerequired

ssl_protocolsSsl Protocols

advanced_configurationAdvanced nginx configuration

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/proxy-templates/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{"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_conf_specific":"","upstream_host":"text","xff_header_name":"text","xrealip_header_name":"text","ssl_protocols":["SSLv2"],"advanced_configuration":[]}'

201

400

422

500

{
  "message": "Successfully created entry"
}

Proxy Template created successfully

Delete Proxy Template

Delete an individual Proxy Template from the specified configuration

delete

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

Path parameters

configConfigrequired

entry_idIdrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/proxy-templates/{entry_id}'

200

400

422

500

{
  "message": "Successfully deleted entry"
}

Proxy Template deleted successfully