Skip to content
/
Retrieve the file downloa...

Retrieve the file download blocking configuration

Request

Returns your organization's current file download 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
GET
/v1/controls/fileDownloadBlocking/configuration
curl -i -X GET \
  https://api.pushsecurity.com/v1/controls/fileDownloadBlocking/configuration \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
rulesArray of objects(File Download Blocking Rule)required

Complete list of File Download Blocking rules.

globalsobject

Reserved for control-wide settings. Empty for this control.

Example:
{}
Response
{
  "globals": {},
  "rules": [
    {
      "id": "c478966c-f927-411c-b919-179832d3d50c",
      "name": "Block executable downloads for Finance",
      "enabled": true,
      "mode": "BLOCK",
      "title": "Download blocked",
      "subtext": "This file type is not permitted on company devices.",
      "buttonText": "Download anyway",
      "criteria": {
        "employeeIds": {
          "matches": [ … ]
        },
        "employeeGroups": {
          "matches": [ … ]
        },
        "fileNames": {
          "matches": [ … ]
        },
        "fileNamePatterns": {
          "matches": [ … ]
        },
        "fileExtensions": {
          "matches": [ … ]
        },
        "urlPatterns": {
          "matches": [ … ]
        },
        "profileScope": {
          "matches": [ … ]
        }
      }
    }
  ]
}