Add URLs and IP addresses to an API-managed category

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

The POST command described in this section can be used to add URLs, IP addresses, and ranges to an API-managed category.


Method	URL	Description
POST	https:<ps_ip_address>:15873/api/web/v1/categories/urls	Adds new URLs or IP addresses to the API-managed category specified in the JSON request

JSON request data

Adding URLs and IP addresses by category name

When the API-managed category for a set of URLs or IP addresses is specified by name, the JSON request includes:

The transaction ID obtained in the start transaction call

The category name (required; must be unique)

This field is used to define which category is returned when a URL or IP address is matched. An error is returned if the category name does not correspond to the ID of an API-managed category already in the system.

The URLs to add to the category (optional if IP addresses are present)

The IPs (IP addresses or ranges) to add to the category (optional if URLs are present)

For example:

{

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

"Category Name":"Malicious XYZ",

"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"

Adding URLs and IP addresses by category ID

The transaction ID obtained in the start transaction call

The category ID

This field is used to define which category is returned when a URL or IP address is matched. An error is returned if the category ID does not match the ID of an API-managed category already in the system.

The field can appear as part of the file path in the URI or in the JSON request.

The URLs to add to the category (optional if IP addresses are present)

The IPs (IP addresses or ranges) to add to the category (optional if URLs are present)

For example:

{

"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"

JSON response to adding URLs and IP addresses to categories

The Categories field contains an array of API-managed category IDs and the total number of URLs and IP addresses added to each category.

{

"Categories":

[

"Name": "Malicious XYZ",

Response codes


200	OK (URLs and IP addresses successfully added to the transaction)
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 Message"

]

}