Add IPs to URL

Note: Before you use this API, make sure to create the URL Categories override file by copying the file /usr/share/fa/data/plugins/panorama/url_categories.json to this location: /home/afa/.fa/plugins/panorama/.

  1. Login as afa user.
    (rw-r--r-- permissions are required for the url_categories.json file (644)).

  2. Run: 

    mkdir /home/afa/.fa/plugins/panorama/

  3. Run:

    cp /usr/share/fa/data/plugins/panorama/url_categories.json /home/afa/.fa/plugins/panorama/

  4. Run:

    chmod 644 /home/afa/.fa/plugins/panorama/url_categories.json

Add IPs to a URL associated with a URL Category in the URL Categories override file. Currently only Panorama devices are supported. Use the URL-categories-controller API GET /{category} method to return the list of available URL Categories.

For further information about the URL Categories override file see (optional) Enhance URL Category accuracy.

Resource Name: /api/v1/plugins/{brand}/URLcategory/{category}/URL/{url}/IP

Request Method: PUT

Request URL Parameters:

Element

Type

Description
brand
Mandatory

string

Brand name code. Only "panorama" is supported.

category
Mandatory

string Specified URL Category name.
url
Mandatory 		string URL to add IPs to.

Request Body Parameters:

Element

Type

Description
body
Mandatory 		string

A JSON list representing IP(s) to be added to the URL.

For example:

Copy 
[ 
    "169.45.207.192", 
    "169.47.19.136", 
    "169.45.207.200", 
    "169.44.165.64", 
    "169.44.162.72" 
]

Response parameters

Element

Type

Description
categories map of objects

The list of URL Categories, each populated by:

  • URL Category name.

  • URLs and their IPs.

Response:

Status codes:

Code

Description
200

ActiveChange was triggered

400

Input validation failure
403

Authentication failure
500

Failed to complete operation.

Request cURL examples 

curl -X PUT "https://localhost/afa/api/v1/plugins/panorama/URLCategory/sports/URL/www.nba.com/IP/" -H "accept: */*" -H "Content-Type: application/json" -d "[ \"169.45.207.192\", \"169.47.19.136\",\"169.45.207.200\",\"169.44.165.642\",\"169.44.162.72\",]"

Response example for 200

Copy 
{
  "categories": {
    "sports": {
      "urls": {
        "www.nba.com": [
              "169.45.207.192", 
            "169.47.19.136", 
            "169.45.207.200", 
            "169.44.165.64", 
            "169.44.162.72" 
            ]
         }
    },
    "abortion": {
      "urls": {
        "www.prochoice.org": [
          "130.211.137.150"
        ],
        "www.prochoiceamerica.org": [
          "104.198.98.23"
        ],
        "www.prolifeaction.org": [
          "104.21.63.237"
        ]
      }
    }
  }
}