Get Security Rules

Get Security Rules

Get CWS Content Inspection rules for a Security Policy

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

Enterprise ID

string
policyId
Required

CWS Policy ID

Query Parameters
SecurityRuleFilterFields
fields
Optional

return fields

string
quickSearch
Optional

quick search string

number
limit
Optional

response data max count

string
prevPageLink
Optional

previous page link

string
nextPageLink
Optional

next page link

boolean
_count
Optional

return total count or not

Responses
200

CWS Content Inspection Rules

Returns getContentInspectionRulesResponse of type(s) application/json 
{
    "metaData": {
        "limit": 10,
        "count": 10,
        "nextPageLink": "b2Zmc2V0PTQ=",
        "previousPageLink": "b2Zmc2V0PTA=",
        "defaultRulesCount": "number"
    },
    "_href": "/enterprise/1/cwsPolicies/7e5b6baa-e5fa-4272-ba4c-5f1941235584/contentFilteringRules",
    "data": [
        {
            "name": "sample-policy",
            "enabled": false,
            "action": {
                "value": "string"
            },
            "logicalId": "ac611099-9872-4b29-bd87-8c2ba8b62c81",
            "version": "ac611099-9872-4b29-bd87-8c2ba8b62c81",
            "_href": "/enterprise/1/cwsPolicies/7e5b6baa-e5fa-4272-ba4c-5f1941235584/contentFilteringRules/70844bf9-3b75-4a04-9c4d-83046ee52dc0",
            "attributes": {
                "contentType": "FILE",
                "transferType": [
                    "DOWNLOAD",
                    "UPLOAD"
                ],
                "fileType": "Multimedia",
                "fileValues": [
                    "AUDIO",
                    "VIDEO"
                ],
                "modules": [
                    "ALL"
                ],
                "userEntity": {
                    "users": [
                        "[email protected]"
                    ]
                }
            }
        }
    ]
}
object
metaData
Optional

metaData

string
_href
Optional

_href

array of object
data
Optional

data


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


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


On This Page
Cws Content Inspection Rules Operations
POST
Add Security Rules
DELETE
Delete Security Rule By Id
GET
Get Security Rule By Id
GET
Get Security Rules
PATCH
Update Security Rule By Id
PATCH
Update Security Rules