Get Dlp Security Rules

Get Dlp Security Rules

Get DLP rule for a CWS Security policy

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

Enterprise ID

string
policyId
Required

CWS Policy ID

Query Parameters
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 DLP Rules

Returns getDlpRulesResponse 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/dlpRules",
    "data": [
        {
            "name": "sample-policy",
            "enabled": false,
            "logicalId": "ac611099-9872-4b29-bd87-8c2ba8b62c81",
            "version": "ac611099-9872-4b29-bd87-8c2ba8b62c81",
            "_href": "/enterprise/1/cwsPolicies/7e5b6baa-e5fa-4272-ba4c-5f1941235584/dlpRules/70844bf9-3b75-4a04-9c4d-83046ee52dc0",
            "attributes": {
                "userEntity": {
                    "all": false,
                    "users": [
                        "string"
                    ],
                    "userGroups": [
                        "string"
                    ]
                },
                "notification": "string",
                "desc": "string",
                "tags": [
                    "string"
                ],
                "reason": "string"
            },
            "action": {
                "action": "string",
                "categories": [
                    "string"
                ],
                "dlpDicts": [
                    "string"
                ],
                "dlpGroups": [
                    "string"
                ],
                "docTypes": [
                    {
                        "name": "Visio",
                        "fileType": "Engineering Applications"
                    }
                ],
                "domains": [
                    "string"
                ],
                "inspectInputs": false,
                "maxFileSize": "number",
                "maxFileSizeUnit": "string",
                "protocols": [
                    "string"
                ],
                "sessionType": "string"
            }
        }
    ]
}
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