Get Content Inspection Engine Configuration

Get Content Inspection Engine Configuration

Get CWS Content Inspection Engine configuration for an Enterprise

Request
URI
GET
https://{api_host}/api/cws/v1/enterprises/{enterpriseLogicalId}/contentInspectionEngines
COPY
Path Parameters
string
enterpriseLogicalId
Required

Enterprise Logical ID


Responses
200

CWS Content Inspection Engine configuration

Returns getContentInspectionEngineConfiguration of type(s) application/json
{
    "hash": {
        "desc": "Multi-Engine Hash Check for Virus",
        "name": "File Hash Check",
        "transferTypes": [
            "downloads",
            "uploads"
        ],
        "enabled": false,
        "onError": "block",
        "documentActionOnUnknown": "allow",
        "fileActionOnUnknown": "allow"
    },
    "avScan": {
        "desc": "Anti-Virus Scan",
        "name": "Full File Scan",
        "transferTypes": [
            "downloads",
            "uploads"
        ],
        "enabled": true,
        "onError": "allow",
        "passwordPrompt": true,
        "onEncSubfile": "block"
    },
    "sandbox": {
        "desc": "Cloud-Based SandBox Inspection",
        "name": "SandBox Inspection",
        "enabled": true,
        "onError": "allow",
        "transferTypes": [
            "downloads",
            "uploads"
        ],
        "keepScreenshots": false
    }
}
object
hash
Required

hash

object
avScan
Required

avScan

object
sandbox
Required

sandbox


400

Invalid Input

Returns httpResponseError of type(s) application/json
{
    "code": "error code",
    "errors": [
        {
            "message": "error message",
            "path": "object.path"
        }
    ]
}
string
code
Required

code

Possible values are : INTERNAL_ERROR, INVALID_PARAMS, INVALID_QUERY_PARAMS, INVALID_LICENSE,
array of object
errors
Required

errors


404

CWS Content Inspection Engine configuration not found

Returns httpResponseError of type(s) application/json
{
    "code": "error code",
    "errors": [
        {
            "message": "error message",
            "path": "object.path"
        }
    ]
}
string
code
Required

code

Possible values are : INTERNAL_ERROR, INVALID_PARAMS, INVALID_QUERY_PARAMS, INVALID_LICENSE,
array of object
errors
Required

errors


500

Internal Server Error

Returns httpResponseError of type(s) application/json
{
    "code": "error code",
    "errors": [
        {
            "message": "error message",
            "path": "object.path"
        }
    ]
}
string
code
Required

code

Possible values are : INTERNAL_ERROR, INVALID_PARAMS, INVALID_QUERY_PARAMS, INVALID_LICENSE,
array of object
errors
Required

errors