Skip to content
/
Retrieve the domain categ...

Retrieve the domain category blocking configuration

Request

Returns your organization's current domain category blocking configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first.

Security
x-api-key
curl -i -X GET \
  https://eu1.api.pushsecurity.com/v1/controls/domainCategoryBlocking/configuration \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
globalsobject(Domain Category Blocking Globals)required

Control-wide settings that apply across every rule.

rulesArray of objects(Domain Category Blocking Rule)required

Complete list of Domain Category Blocking rules.

Response
{
  "globals": {
    "ignoredDomains": [
      "allowed-partner.example.com",
      "*.trusted.example.com"
    ]
  },
  "rules": [
    {
      "id": "c478966c-f927-411c-b919-179832d3d50c",
      "name": "Block gambling sites on company profiles",
      "enabled": true,
      "mode": "BLOCK",
      "title": "Access restricted",
      "subtext": "This site is blocked by your organization's browsing policy.",
      "buttonText": "Continue anyway",
      "ignoredDomains": [
        "allowed-partner.example.com"
      ],
      "urlGranularity": "DOMAIN",
      "displayFrequency": "ONCE_PER_BROWSER",
      "createDetections": true,
      "severity": "MEDIUM",
      "criteria": {
        "domainCategories": {
          "matches": [ … ]
        },
        "employeeIds": {
          "matches": [ … ]
        },
        "employeeGroups": {
          "matches": [ … ]
        },
        "profileScope": {
          "matches": [ … ]
        }
      }
    }
  ]
}