{
    "id":"/axapi/v3/file-inspection",
    "type":"object",
    "node-type":"intermediate",
    "title":"file-inspection",
    "operation-not-allowed": ["PUT", "POST", "DELETE"],
    "partition-visibility":"shared",
    "auto-created-object":1,
    "description":"File Inspection related commands",
    "properties":{
        "service":{
            "type":"object",
            "$ref":"/axapi/v3/file-inspection/service",
            "properties":{
                "enable":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Enable Internal File Inspection Service"
                },
                "service-down-action":{
                    "type":"string",
                    "format":"enum",
                    "default":"allow",
                    "partition-visibility":"shared",
                    "description":"'reset': Reset Connection; 'allow': Allow File; ",
                    "enum":[
                        "reset",
                        "allow"
                    ]
                },
                "health-check-disable":{
                    "type":"number",
                    "format":"flag",
                    "default":0,
                    "partition-visibility":"shared",
                    "not":"health-monitor",
                    "description":"Disable internal service health check"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        },
        "global":{
            "type":"object",
            "$ref":"/axapi/v3/file-inspection/global",
            "properties":{
                "max-file-size":{
                    "type":"number",
                    "format":"number",
                    "minimum":0,
                    "maximum":1073741824,
                    "default":157286400,
                    "partition-visibility":"shared",
                    "description":"Maximum file size (bytes) - default 157286400"
                },
                "max-buffer-size":{
                    "type":"number",
                    "format":"number",
                    "minimum":0,
                    "maximum":268435455,
                    "default":0,
                    "partition-visibility":"shared",
                    "description":"Maximum size (bytes) of content that can be buffered - default 0 (disabled) (Maximum size (bytes) content that can be buffered - default 0 (disabled))"
                },
                "classification":{
                    "type":"object",
                    "properties":{
                        "classification-disable":{
                            "type":"number",
                            "format":"flag",
                            "default":0,
                            "partition-visibility":"shared",
                            "description":"Disable Internal File Inspection Classification"
                        },
                        "min-classification-len":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":268435455,
                            "default":4096,
                            "partition-visibility":"shared",
                            "description":"minimum length to be taken for file classification - default 4096"
                        },
                        "max-classification-len":{
                            "type":"number",
                            "format":"number",
                            "minimum":1,
                            "maximum":268435455,
                            "default":65536,
                            "partition-visibility":"shared",
                            "description":"maximum length to be taken for file classification - default 65536"
                        }
                    }
                },
                "max-concurrent-files":{
                    "type":"number",
                    "format":"number",
                    "minimum":1,
                    "maximum":100,
                    "default":10,
                    "partition-visibility":"shared",
                    "description":"Max concurrenet inspected files per server - default 10 ( Max concurrenet inspected files per server - default 10)"
                },
                "max-concurrent-files-action":{
                    "type":"string",
                    "format":"enum",
                    "default":"bypass",
                    "partition-visibility":"shared",
                    "description":"'bypass': Bypass File Inspection (default); ",
                    "enum":[
                        "bypass"
                    ]
                },
                "logging":{
                    "type":"object",
                    "properties":{
                        "bypass":{
                            "type":"object",
                            "properties":{
                                "all-bypass-log":{
                                    "type":"string",
                                    "format":"enum",
                                    "default":"no-log",
                                    "partition-visibility":"shared",
                                    "not-list":[ "no-content-disposition-log", "old-http-version-log", "aflex-disabled-log", "service-disabled-log", "service-down-log", "max-concurrent-files-log", "filesize-overlimit-log", "internal-buffered-overlimit-log" ],
                                    "description":"'log': Log event (default); 'no-log': Do not Log event; ",
                                    "enum":[
                                        "log",
                                        "no-log"
                                    ]
                                },
                                "no-content-disposition-log":{
                                    "type":"string",
                                    "format":"enum",
                                    "default":"no-log",
                                    "partition-visibility":"shared",
                                    "not":"all-bypass-log",
                                    "description":"'log': Log event (default); 'no-log': Do not Log event; ",
                                    "enum":[
                                        "log",
                                        "no-log"
                                    ]
                                },
                                "old-http-version-log":{
                                    "type":"string",
                                    "format":"enum",
                                    "default":"no-log",
                                    "partition-visibility":"shared",
                                    "not":"all-bypass-log",
                                    "description":"'log': Log event (default); 'no-log': Do not Log event; ",
                                    "enum":[
                                        "log",
                                        "no-log"
                                    ]
                                },
                                "aflex-disabled-log":{
                                    "type":"string",
                                    "format":"enum",
                                    "default":"no-log",
                                    "partition-visibility":"shared",
                                    "not":"all-bypass-log",
                                    "description":"'log': Log event (default); 'no-log': Do not Log event; ",
                                    "enum":[
                                        "log",
                                        "no-log"
                                    ]
                                },
                                "service-disabled-log":{
                                    "type":"string",
                                    "format":"enum",
                                    "default":"no-log",
                                    "partition-visibility":"shared",
                                    "not":"all-bypass-log",
                                    "description":"'log': Log event (default); 'no-log': Do not Log event; ",
                                    "enum":[
                                        "log",
                                        "no-log"
                                    ]
                                },
                                "service-down-log":{
                                    "type":"string",
                                    "format":"enum",
                                    "default":"no-log",
                                    "partition-visibility":"shared",
                                    "not":"all-bypass-log",
                                    "description":"'log': Log event (default); 'no-log': Do not Log event; ",
                                    "enum":[
                                        "log",
                                        "no-log"
                                    ]
                                },
                                "max-concurrent-files-log":{
                                    "type":"string",
                                    "format":"enum",
                                    "default":"no-log",
                                    "partition-visibility":"shared",
                                    "not":"all-bypass-log",
                                    "description":"'log': Log event (default); 'no-log': Do not Log event; ",
                                    "enum":[
                                        "log",
                                        "no-log"
                                    ]
                                },
                                "filesize-overlimit-log":{
                                    "type":"string",
                                    "format":"enum",
                                    "default":"no-log",
                                    "partition-visibility":"shared",
                                    "not":"all-bypass-log",
                                    "description":"'log': Log event (default); 'no-log': Do not Log event; ",
                                    "enum":[
                                        "log",
                                        "no-log"
                                    ]
                                },
                                "internal-buffered-overlimit-log":{
                                    "type":"string",
                                    "format":"enum",
                                    "default":"no-log",
                                    "partition-visibility":"shared",
                                    "not":"all-bypass-log",
                                    "description":"'log': Log event (default); 'no-log': Do not Log event; ",
                                    "enum":[
                                        "log",
                                        "no-log"
                                    ]
                                }
                            }
                        },
                        "failed-transactions":{
                            "type":"string",
                            "format":"enum",
                            "default":"log",
                            "partition-visibility":"shared",
                            "description":"'log': Log event (default); 'no-log': Do not Log event; ",
                            "enum":[
                                "log",
                                "no-log"
                            ]
                        },
                        "local-logging-disable":{
                            "type":"number",
                            "format":"flag",
                            "default":0,
                            "partition-visibility":"shared",
                            "description":"Disable local logging"
                        }
                    }
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        },
        "data-file":{
            "type":"object",
            "$ref":"/axapi/v3/file-inspection/data-file",
            "properties":{
                "type":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":128,
                    "partition-visibility":"shared",
                    "description":"data file type"
                },
                "name":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":128,
                    "partition-visibility":"shared",
                    "description":"data file name"
                },
                "use-mgmt-port":{
                    "type":"number",
                    "format":"flag",
                    "plat-neg-list":["softax-aws"],
                    "default":0,
                    "partition-visibility":"shared",
                    "not":"source-ip-address",
                    "description":"Use management port as source port"
                },
                "source-ip-address":{
                    "type":"string",
                    "format":"ipv4-address",
                    "partition-visibility":"shared",
                    "not":"use-mgmt-port",
                    "description":"Source IP address"
                },
                "file-url":{
                    "type":"string",
                    "format":"url",
                    "partition-visibility":"shared",
                    "description":"File URL"
                },
                "action":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":128,
                    "partition-visibility":"shared",
                    "description":"data file action"
                },
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        },
        "status":{
            "type":"object",
            "$ref":"/axapi/v3/file-inspection/status",
            "properties":{
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                }
            }
        },
        "template-list":{
            "type":"array",
            "minItems":1,
            "items":{
                "type":"template"
            },
            "uniqueItems":true,
            "$ref":"/axapi/v3/file-inspection/template/{name}",
            "array":[
                {
                    "properties":{
                        "name":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":127,
                            "partition-visibility":"shared",
                            "description":"file-inspection template name",
                            "optional":false
                        },
                        "inspect":{
                            "type":"object",
                            "properties":{
                                "inspect-downloads":{
                                    "type":"number",
                                    "format":"flag",
                                    "default":0,
                                    "partition-visibility":"shared",
                                    "description":"Inspect file downloads"
                                },
                                "download-icap":{
                                    "type":"string",
                                    "format":"string-rlx",
                                    "minLength":1,
                                    "maxLength":127,
                                    "partition-visibility":"shared",
                                    "$ref":"/axapi/v3/slb/template/respmod-icap",
                                    "description":"respmod icap template (respmod icap Config name)"
                                }
                            }
                        },
                        "bad-uploads-action":{
                            "type":"string",
                            "format":"enum",
                            "partition-visibility":"shared",
                            "description":"'reset': Reset Connection; 'drop': Drop File; 'allow': Allow File; ",
                            "enum":[
                                "reset",
                                "drop",
                                "allow"
                            ],
                            "optional":true
                        },
                        "uploads-bad-log":{
                            "type":"string",
                            "format":"enum",
                            "default":"log",
                            "partition-visibility":"shared",
                            "description":"'log': Log event (default); 'no-log': Do not Log event; ",
                            "enum":[
                                "log",
                                "no-log"
                            ],
                            "optional":true
                        },
                        "good-uploads-action":{
                            "type":"string",
                            "format":"enum",
                            "partition-visibility":"shared",
                            "description":"'reset': Reset Connection; 'drop': Drop File; 'allow': Allow File; ",
                            "enum":[
                                "reset",
                                "drop",
                                "allow"
                            ],
                            "optional":true
                        },
                        "uploads-good-log":{
                            "type":"string",
                            "format":"enum",
                            "default":"log",
                            "partition-visibility":"shared",
                            "description":"'log': Log event (default); 'no-log': Do not Log event; ",
                            "enum":[
                                "log",
                                "no-log"
                            ],
                            "optional":true
                        },
                        "suspect-uploads-action":{
                            "type":"string",
                            "format":"enum",
                            "partition-visibility":"shared",
                            "not":"uploads-external-inspect",
                            "description":"'reset': Reset Connection; 'drop': Drop File; 'allow': Allow File; ",
                            "enum":[
                                "reset",
                                "drop",
                                "allow"
                            ],
                            "optional":true
                        },
                        "uploads-suspect-log":{
                            "type":"string",
                            "format":"enum",
                            "default":"log",
                            "partition-visibility":"shared",
                            "description":"'log': Log event (default); 'no-log': Do not Log event; ",
                            "enum":[
                                "log",
                                "no-log"
                            ],
                            "optional":true
                        },
                        "uploads-external-inspect":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":127,
                            "partition-visibility":"shared",
                            "$ref":"/axapi/v3/slb/template/reqmod-icap",
                            "not":"suspect-uploads-action",
                            "description":"reqmod template for external icap inspection",
                            "optional":true
                        },
                        "uploads-external-suspect-log":{
                            "type":"string",
                            "format":"enum",
                            "default":"log",
                            "partition-visibility":"shared",
                            "description":"'log': Log event (default); 'no-log': Do not Log event; ",
                            "enum":[
                                "log",
                                "no-log"
                            ],
                            "optional":true
                        },
                        "bad-downloads-action":{
                            "type":"string",
                            "format":"enum",
                            "default":"drop",
                            "partition-visibility":"shared",
                            "description":"'reset': Reset Connection; 'drop': Drop File (default); 'allow': Allow File; ",
                            "enum":[
                                "reset",
                                "drop",
                                "allow"
                            ],
                            "optional":true
                        },
                        "downloads-bad-log":{
                            "type":"string",
                            "format":"enum",
                            "default":"log",
                            "partition-visibility":"shared",
                            "description":"'log': Log event (default); 'no-log': Do not Log event; ",
                            "enum":[
                                "log",
                                "no-log"
                            ],
                            "optional":true
                        },
                        "good-downloads-action":{
                            "type":"string",
                            "format":"enum",
                            "default":"allow",
                            "partition-visibility":"shared",
                            "description":"'reset': Reset Connection; 'drop': Drop File; 'allow': Allow File (default); ",
                            "enum":[
                                "reset",
                                "drop",
                                "allow"
                            ],
                            "optional":true
                        },
                        "downloads-good-log":{
                            "type":"string",
                            "format":"enum",
                            "default":"log",
                            "partition-visibility":"shared",
                            "description":"'log': Log event (default); 'no-log': Do not Log event; ",
                            "enum":[
                                "log",
                                "no-log"
                            ],
                            "optional":true
                        },
                        "suspect-downloads-action":{
                            "type":"string",
                            "format":"enum",
                            "default":"allow",
                            "partition-visibility":"shared",
                            "not":"downloads-external-inspect",
                            "description":"'reset': Reset Connection; 'drop': Drop File; 'allow': Allow File (default); ",
                            "enum":[
                                "reset",
                                "drop",
                                "allow"
                            ],
                            "optional":true
                        },
                        "downloads-suspect-log":{
                            "type":"string",
                            "format":"enum",
                            "default":"log",
                            "partition-visibility":"shared",
                            "description":"'log': Log event (default); 'no-log': Do not Log event; ",
                            "enum":[
                                "log",
                                "no-log"
                            ],
                            "optional":true
                        },
                        "downloads-external-inspect":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":127,
                            "partition-visibility":"shared",
                            "$ref":"/axapi/v3/slb/template/respmod-icap",
                            "not":"suspect-downloads-action",
                            "description":"respmod template for external icap inspection",
                            "optional":true
                        },
                        "downloads-external-suspect-log":{
                            "type":"string",
                            "format":"enum",
                            "default":"log",
                            "partition-visibility":"shared",
                            "description":"'log': Log event (default); 'no-log': Do not Log event; ",
                            "enum":[
                                "log",
                                "no-log"
                            ],
                            "optional":true
                        },
                        "uuid":{
                            "type":"string",
                            "format":"string",
                            "minLength":1,
                            "maxLength":64,
                            "partition-visibility":"shared",
                            "modify-not-allowed":1,
                            "description":"uuid of the object",
                            "optional":true
                        },
                        "user-tag":{
                            "type":"string",
                            "format":"string-rlx",
                            "minLength":1,
                            "maxLength":127,
                            "partition-visibility":"shared",
                            "description":"Customized tag",
                            "optional":true
                        }
                    },
                    "required":[
                        "name"
                    ]
                }
            ]
        },
        "global-stat":{
            "type":"object",
            "$ref":"/axapi/v3/file-inspection/global-stat",
            "properties":{
                "uuid":{
                    "type":"string",
                    "format":"string",
                    "minLength":1,
                    "maxLength":64,
                    "partition-visibility":"shared",
                    "modify-not-allowed":1,
                    "description":"uuid of the object"
                },
                "sampling-enable":{
                    "type":"array",
                    "minItems":1,
                    "items":{
                        "type":"object"
                    },
                    "uniqueItems":true,
                    "array":[
                        {
                            "properties":{
                                "counters1":{
                                    "type":"string",
                                    "format":"enum",
                                    "partition-visibility":"shared",
                                    "description":"'all': all; 'download_bad_blocked': Download malware blocked; 'download_bad_allowed': Download malware allowed; 'download_bad_ext_inspect': Download malware extrnal inspect; 'download_suspect_blocked': Download suspect blocked; 'download_suspect_ext_inspect': Download suspect extrnal inspect; 'download_suspect_allowed': Download suspect allowed; 'download_good_blocked': Download safe blocked; 'download_good_allowed': Download safe external inspect; 'download_good_ext_inspect': Download safe allowed; 'upload_bad_blocked': Upload malware blocked; 'upload_bad_allowed': Upload malware allowed; 'upload_bad_ext_inspect': Upload malware extrnal inspect; 'upload_suspect_blocked': Upload suspect blocked; 'upload_suspect_ext_inspect': Upload suspect extrnal inspect; 'upload_suspect_allowed': Upload suspect allowed; 'upload_good_blocked': Upload safe blocked; 'upload_good_ext_inspect': Upload safe external inspect; 'upload_good_allowed': Upload safe allowed; 'icap_200': Receive icap status 200; 'icap_204': Receive icap status 204; 'icap_500': Receive icap status 500; 'icap_other_status_code': Receive icap other status code; 'icap_connect_fail': Icap connect fail; 'icap_connection_created': Icap connection created; 'icap_connection_established': Icap connection established; 'icap_connection_closed': Icap connection closed; 'icap_connection_rst': Icap connection rst; 'icap_bytes_sent': Icap bytes sent; 'icap_bytes_received': Icap bytes received; 'bypass_aflex': Bypassed by aflex; 'bypass_large_file': Bypassed - large file size; 'bypass_service_disabled': Bypassed - Internal service disabled; 'bypass_service_down': Bypassed - Internal service down; 'reset_service_down': Reset - Internal service down; 'bypass_max_concurrent_files_reached': Bypassed - max concurrent files on server reached; 'bypass_non_inspection': Bypassed non inspection data; 'non_supported_file': Non supported file type; 'transactions_alloc': Total transactions allocated; 'transactions_free': Total transactions freed; 'transactions_failure': Total transactions failure; 'transactions_aborted': Total transactions aborted; 'orig_conn_bytes_received': Original connection bytes received; 'orig_conn_bytes_sent': Original connection bytes sent; 'orig_conn_bytes_bypassed': Original connection bytes bypassed; 'bypass_buffered_overlimit': Total Bytes Buffered Overlimit; 'total_bandwidth': Total File Bytes; 'total_suspect_bandwidth': Total Suspected Files Bytes; 'total_bad_bandwidth': Total Bad Files Bytes; 'total_good_bandwidth': Total Good Files Bytes; 'total_file_size_less_1m': Total Files Less than 1Mb; 'total_file_size_1_5m': Total Files Between 1-5Mb; 'total_file_size_5_8m': Total Files Between 5-8Mb; 'total_file_size_8_32m': Total Files Between 8-32Mb; 'total_file_size_over_32m': Total Files over 32Mb; 'suspect_file_size_less_1m': Suspect Files Less than 1Mb; 'suspect_file_size_1_5m': Suspect Files Between 1-5Mb; 'suspect_file_size_5_8m': Suspect Files Between 5-8Mb; 'suspect_file_size_8_32m': Suspect Files Between 8-32Mb; 'suspect_file_size_over_32m': Suspect Files over 32Mb; 'good_file_size_less_1m': Good Files Less than 1Mb; 'good_file_size_1_5m': Good Files Between 1-5Mb; 'good_file_size_5_8m': Good Files Between 5-8Mb; 'good_file_size_8_32m': Good Files Between 8-32Mb; 'good_file_size_over_32m': Good Files over 32Mb; 'bad_file_size_less_1m': Bad Files Less than 1Mb; 'bad_file_size_1_5m': Bad Files Between 1-5Mb; 'bad_file_size_5_8m': Bad Files Between 5-8Mb; 'bad_file_size_8_32m': Bad Files Between 8-32Mb; 'bad_file_size_over_32m': Bad Files over 32Mb; ",
                                    "enum":[
                                        "all",
                                        "download_bad_blocked",
                                        "download_bad_allowed",
                                        "download_bad_ext_inspect",
                                        "download_suspect_blocked",
                                        "download_suspect_ext_inspect",
                                        "download_suspect_allowed",
                                        "download_good_blocked",
                                        "download_good_allowed",
                                        "download_good_ext_inspect",
                                        "upload_bad_blocked",
                                        "upload_bad_allowed",
                                        "upload_bad_ext_inspect",
                                        "upload_suspect_blocked",
                                        "upload_suspect_ext_inspect",
                                        "upload_suspect_allowed",
                                        "upload_good_blocked",
                                        "upload_good_ext_inspect",
                                        "upload_good_allowed",
                                        "icap_200",
                                        "icap_204",
                                        "icap_500",
                                        "icap_other_status_code",
                                        "icap_connect_fail",
                                        "icap_connection_created",
                                        "icap_connection_established",
                                        "icap_connection_closed",
                                        "icap_connection_rst",
                                        "icap_bytes_sent",
                                        "icap_bytes_received",
                                        "bypass_aflex",
                                        "bypass_large_file",
                                        "bypass_service_disabled",
                                        "bypass_service_down",
                                        "reset_service_down",
                                        "bypass_max_concurrent_files_reached",
                                        "bypass_non_inspection",
                                        "non_supported_file",
                                        "transactions_alloc",
                                        "transactions_free",
                                        "transactions_failure",
                                        "transactions_aborted",
                                        "orig_conn_bytes_received",
                                        "orig_conn_bytes_sent",
                                        "orig_conn_bytes_bypassed",
                                        "bypass_buffered_overlimit",
                                        "total_bandwidth",
                                        "total_suspect_bandwidth",
                                        "total_bad_bandwidth",
                                        "total_good_bandwidth",
                                        "total_file_size_less_1m",
                                        "total_file_size_1_5m",
                                        "total_file_size_5_8m",
                                        "total_file_size_8_32m",
                                        "total_file_size_over_32m",
                                        "suspect_file_size_less_1m",
                                        "suspect_file_size_1_5m",
                                        "suspect_file_size_5_8m",
                                        "suspect_file_size_8_32m",
                                        "suspect_file_size_over_32m",
                                        "good_file_size_less_1m",
                                        "good_file_size_1_5m",
                                        "good_file_size_5_8m",
                                        "good_file_size_8_32m",
                                        "good_file_size_over_32m",
                                        "bad_file_size_less_1m",
                                        "bad_file_size_1_5m",
                                        "bad_file_size_5_8m",
                                        "bad_file_size_8_32m",
                                        "bad_file_size_over_32m"
                                    ]
                                },
                                "optional":true
                            }
                        }
                    ]
                }
            }
        }
    }
}