Skip to content
/
Retrieve the file upload...

Retrieve the file upload blocking configuration

Request

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

Responses

OK

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

Complete list of File Upload 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 uploads for Finance",
      "enabled": true,
      "mode": "BLOCK",
      "title": "Upload blocked",
      "subtext": "Uploading this file type is not permitted.",
      "buttonText": "Proceed anyway",
      "criteria": {
        "employeeIds": {
          "matches": [ … ]
        },
        "employeeGroups": {
          "matches": [ … ]
        },
        "fileNamePatterns": {
          "matches": [ … ]
        },
        "fileExtensions": {
          "matches": [ … ]
        },
        "urlPatterns": {
          "matches": [ … ]
        },
        "profileScope": {
          "matches": [ … ]
        }
      }
    }
  ]
}