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

Successful Response

application/json

Schema

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

Example (from schema)

{
  "api": "string",
  "ver": "string",
  "message": "string",
  "removedRules": 0
}

purgeRulesResponse

{
  "ver": "v4.0",
  "api": "purgeRules",
  "message": "OK",
  "code": 1,
  "removedRules": 1
}

4XX

Client Error Response

application/json

Schema

Schema

code string

STATUS_CODE

msg string

GENERAL_MESSAGE

Example (from schema)

{
  "code": "string",
  "msg": "string"
}

Bad Request

{
  "code": 400,
  "msg": "Bad Request. This occurs when an HTTP request contains an invalid query string."
}

Forbidden access

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

Too many requests

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

5XX

Server Error Response

application/json

Schema

Schema

code string

STATUS_CODE

msg string

GENERAL_MESSAGE

Example (from schema)

{
  "code": "string",
  "msg": "string"
}

purgeRulesResponse

{
  "code": 500,
  "msg": "Internal server error. A unified status for API communication type errors."
}

Loading...