retain the incoming list of rules while remove everything else.
DELETE/pub/v4.0/network/purgeRules
remove invalid firewall security rules
Request
Query Parameters
customerid stringrequired
The customer ID to which the API call is directed
- application/json
Body
required
whiteList string[]required
List of firewall security rule uuids that will be retained.
Responses
- 200
- 4XX
- 5XX
Successful Response
- application/json
- Schema
- Example (from schema)
- purgeRulesResponse
Schema
api string
The path used to call the IoT Security API
ver string
The version of the IoT Security API
message string
The message indicating success
removedRules integer
The number of rules successfully removed
{
"api": "string",
"ver": "string",
"message": "string",
"removedRules": 0
}
{
"ver": "v4.0",
"api": "purgeRules",
"message": "OK",
"code": 1,
"removedRules": 1
}
Client Error Response
- application/json
- Schema
- Example (from schema)
- Bad Request
- Forbidden access
- Too many requests
Schema
code string
STATUS_CODE
msg string
GENERAL_MESSAGE
{
"code": "string",
"msg": "string"
}
{
"code": 400,
"msg": "Bad Request. This occurs when an HTTP request contains an invalid query string."
}
{
"code": 403,
"msg": "Forbidden access. Either the provided API key is invalid or it does not have the required RBAC permissions to run this API."
}
{
"code": 429,
"msg": "Too many requests. The number of requests for device details for a single device exceeded the rate limit of 180 queries per minute per tenant."
}
Server Error Response
- application/json
- Schema
- Example (from schema)
- purgeRulesResponse
Schema
code string
STATUS_CODE
msg string
GENERAL_MESSAGE
{
"code": "string",
"msg": "string"
}
{
"code": 500,
"msg": "Internal server error. A unified status for API communication type errors."
}
Loading...