Change Website's Proxy Mode

Changes the proxy mode of a website.

URL

/api/v1/website/[website_id]

HTTP Method

PUT

URL Parameters

Parameter

Required

Type

Description

website_id

true

integer

Specifies the website ID to change the proxy mode for.

PUT Parameters

Parameter

Required

Type

Description

Acceptable Values

proxy_mode

true

string containing proxy mode

Specifies the proxy mode to change to.

protect
detect
pass

Response Parameters

Returns a string indicating success/error.

Example: Change proxy mode for website 1

Request

PUT

/api/v1/website/1

cURL
Copy
curl -kv \
-u api_ninja:ninja_password \
-X PUT \
-H 'Content-Type: text/json' \
--data-binary @changeproxymode.json \
https://172.31.1.172:4849/api/v1/website/1

Contents of changeproxymode.json:

Copy
{
  "proxy_mode": "protect"
}

Response

Copy
{"result":"success"}