file-inspection template¶
Manage File Inspection template configuration
template Specification¶
Type Collection Object Key(s) name Collection Name template-list Collection URI /axapi/v3/file-inspection/template Element Name template Element URI /axapi/v3/file-inspection/template/{name} Element Attributes template_attributes Schema template schema
Operations Allowed:
Operation | Method | URI | Payload | |
---|---|---|---|---|
Create Object | POST | /axapi/v3/file-inspection/template | ||
Create List | POST | /axapi/v3/file-inspection/template | ||
Get Object | GET | /axapi/v3/file-inspection/template/{name} | ||
Get List | GET | /axapi/v3/file-inspection/template | ||
Modify Object | POST | /axapi/v3/file-inspection/template/{name} | ||
Replace Object | PUT | /axapi/v3/file-inspection/template/{name} | ||
Replace List | PUT | /axapi/v3/file-inspection/template | ||
Delete Object | DELETE | /axapi/v3/file-inspection/template/{name} |
template-list¶
template-list is JSON List of template attributes
template-list : [
]
template attributes¶
bad-downloads-action
Description ‘reset’: Reset Connection; ‘drop’: Drop File (default); ‘allow’: Allow File;
Type: string
Supported Values: reset, drop, allow
Default: drop
bad-uploads-action
Description ‘reset’: Reset Connection; ‘drop’: Drop File; ‘allow’: Allow File;
Type: string
Supported Values: reset, drop, allow
downloads-bad-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: log
downloads-external-inspect
Description respmod template for external icap inspection
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: downloads-external-inspect and suspect-downloads-action are mutually exclusive
Reference Object: /axapi/v3/slb/template/respmod-icap
downloads-external-suspect-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: log
downloads-good-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: log
downloads-suspect-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: log
good-downloads-action
Description ‘reset’: Reset Connection; ‘drop’: Drop File; ‘allow’: Allow File (default);
Type: string
Supported Values: reset, drop, allow
Default: allow
good-uploads-action
Description ‘reset’: Reset Connection; ‘drop’: Drop File; ‘allow’: Allow File;
Type: string
Supported Values: reset, drop, allow
inspect
Description: inspect is a JSON Block. Please see below for inspect
Type: Object
name
Description file-inspection template name
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
pre-filter
Description Black White Pre Filter by class-list
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/class-list
suspect-downloads-action
Description ‘reset’: Reset Connection; ‘drop’: Drop File; ‘allow’: Allow File (default);
Type: string
Supported Values: reset, drop, allow
Default: allow
Mutual Exclusion: suspect-downloads-action and downloads-external-inspect are mutually exclusive
suspect-uploads-action
Description ‘reset’: Reset Connection; ‘drop’: Drop File; ‘allow’: Allow File;
Type: string
Supported Values: reset, drop, allow
Mutual Exclusion: suspect-uploads-action and uploads-external-inspect are mutually exclusive
uploads-bad-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: log
uploads-external-inspect
Description reqmod template for external icap inspection
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Mutual Exclusion: uploads-external-inspect and suspect-uploads-action are mutually exclusive
Reference Object: /axapi/v3/slb/template/reqmod-icap
uploads-external-suspect-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: log
uploads-good-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: log
uploads-suspect-log
Description ‘log’: Log event (default); ‘no-log’: Do not Log event;
Type: string
Supported Values: log, no-log
Default: log
user-tag
Description Customized tag
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
inspect¶
Specification Type object download-icap
Description respmod icap template (respmod icap Config name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/respmod-icap
inspect-downloads
Description Inspect file downloads
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
inspect-uploads
Description Inspect file uploads
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
upload-icap
Description reqmod icap template (reqmod icap Config name)
Type: string
Format: string-rlx
Maximum Length: 127 characters
Maximum Length: 1 characters
Reference Object: /axapi/v3/slb/template/reqmod-icap