Delete URLs and IP addresses from an API-managed category

Management API Guide | Forcepoint Web Security | v8.4.x

The following DELETE or POST command can be used to remove URLs, IP addresses, and ranges from a specific API-managed category.


Method	URL	Description
DELETE	https:<ps_ip_address>:15873/api/web/v1/categories/urls	Deletes URLs and IP addresses from an API-managed category, as specified in the JSON request
POST	https:<ps_ip_address>:15873/api/web/v1/categories/delete/urls	Alternative format for curl and Python, which do not accept a payload for the DELETE method

JSON request

The JSON request has a list of URLs, IP addresses, or both to delete from the given category.

If a URL, IP address, or range is not found, processing continues to the next URL, IP address, or range.

The total number of items deleted of each type reflects the actual number removed from the system, and not any skipped items.

If a URL, IP address, or range has another category associated with it, the item remains in that second category, but is still included in the count of deleted items (since it was removed from the first category).

The total number of items deleted can be higher than expected if duplicates exist and are removed.

Example 1:

{

"Transaction ID":"44081c08-453a-11e6-a9de-d99213c464e0",

"Category ID":1945,

"URLs":

[

"http://www.test1.com/test1",

"http://www.test1.com/test2",

"http://www.test1.com/test3"

"IPs":

[

"167.34.15.117",

"167.34.16.118-167.34.16.120",

"2045:1221:1231::1331"

"Transaction ID":"44081c08-453a-11e6-a9de-d99213c464e0",

"Category Name":"Malicious 10_05_2017",

"URLs":

[

"http://www.test1.com/test1",

"http://www.test1.com/test2",

"http://www.test1.com/test3"

"IPs":

[

"167.34.15.117",

"167.34.16.118-167.34.16.120",

"2045:1221:1231::1331"

You can use the * wildcard to delete all custom URLs and IP addresses from a specific category. The category itself is not deleted.


	Important While you can use "*" to delete all URLs and IP addresses from an API-managed category, other uses of wildcards and regular expressions are not supported.

Example 3:

{

"Transaction ID":"44081c08-453a-11e6-a9de-d99213c464e0",

"Transaction ID":"44081c08-453a-11e6-a9de-d99213c464e0",

"Category Name":"Malicious_01_01_2016",

"URLs": ["*"],

"IPs": ["*"]

}

JSON response for deleting custom URLs and IP addresses from a category

{

"Category Name":"Malicious_01_01_2016",

Response codes


200	OK (URLs and IP addresses deleted)
400	Bad JSON format or data
403	Authentication failed
409	Bad transaction ID or not in a transaction
500	Internal server error

JSON for bad request

{

"Error" :

[

"Not in a transaction",

"Other Error Messages"

]

}


	Note Category names and IDs are not checked until the data is committed to the system. Error messages for duplicate and missing categories (by name or ID) appear in the response to a status API call after the commit has finished.