Get the URL(s) of a specified URL Category

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

Get the URL(s) of a specified URL Category. 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}

Request Method: GET

Request URL Parameters:

Element

Type

Description
brand
Mandatory

string

Brand name code. Only "panorama" is supported.
category string Specified URL Category.

Response parameters

Element

Type

Description
categories map of objects

The list of URL categories, each populated by:

  • category name

  • urls and 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

Response example for 200

Copy 
{
  "categories": {
    "job-search": {
      "urls": {
        "www.indeed.com": [
          "169.45.207.200"
        ],
        "www.monster.com": [
          "65.9.100.58"
        ],
        "www.simplyhired.com": [
          "169.45.226.49"
        ]
      }
    },
    "abortion": {
      "urls": {
        "www.prochoice.org": [
          "130.211.137.150"
        ],
        "www.prochoiceamerica.org": [
          "104.198.98.23"
        ],
        "www.prolifeaction.org": [
          "104.21.63.237"
        ]
      }
    }
  }
}