Function

This API is used to enable or disable the feature.

URI

POST /v1/{project_id}/ips/switch

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	project_id

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project id, the id generated by the enterprise project after the user supports the enterprise project.
fw_instance_id	No	String	Firewall instance ID, which is automatically generated after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. For details, see the API Explorer and Help Center FAQ.By default, if fw_instance_Id is not specified, information about the first firewall under the account is returned. If fw_instance_Id is specified, information about the firewall with this fw_instance_Id is returned.If object_Id is specified, information about the firewall with this object_Id is returned by default. If both fw_instance_Id and object_Id are specified, the specified object_Id must belong to the specified firewall.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.
X-Language	No	String	Language header, the default is zh-cn, if you need to use English, please select en-us.

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
object_id	Yes	String	Protected object ID, which is used to distinguish Internet border protection from VPC border protection after a CFW instance is created. You can obtain the ID by calling the API used for querying a firewall instance. Note that the value 0 indicates the ID of a protected object on the Internet border, and the value 1 indicates the ID of a protected object on the VPC border. For details, see the API Explorer and Help Center FAQ.
ips_type	Yes	Integer	Patch type. Only virtual patch is supported. The value is 2. Enumeration values: 1 2
status	Yes	Integer	IPS switch status

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
data	data object	object

**Table 6** data
Parameter	Type	Description
id	String	Protected object ID

Example Requests

Enable or disable the basic patch and virtual patch of the engine on the user portal. The following example shows how to enable the virtual patch function for project 14181c1245cf4fd786824efe1e2b9388 whose protected object ID is 1530de8a-522d-4771-9067-9fa4e2f53b48.

https://{Endpoint}/v1/14181c1245cf4fd786824efe1e2b9388/ips/switch?fw_instance_id=546af3f8-88e9-47f2-a205-2346d7090925&enterprise_project_id=default

{
  "ips_type" : 1,
  "object_id" : "1530de8a-522d-4771-9067-9fa4e2f53b48",
  "status" : 1
}

Example Responses

Status code: 200

OK

{
  "data" : {
    "id" : "1530de8a-522d-4771-9067-9fa4e2f53b48"
  },
  "trace_id" : "358144a9885ff55100aa63cb0d0e1039"
}

Status Codes

Status Code	Description
200	OK
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Error Codes

See Error Codes.

Enabling or Disabling IPS