Create Scanning Rule

POST {{baseUrl}}/api/v2/sensitive-data-scanner/config/rules

Create a scanning rule in a sensitive data scanner group, ordered last. The posted rule MUST include a group relationship. It MUST include either a standardpattern relationship or a regex attribute, but not both. If includedattributes is empty or missing, we will scan all attributes except excluded_attributes. If both are missing, we will scan the whole event.

Request Body

{"data"=>{"type"=>"sensitive_data_scanner_rule", "attributes"=>{"description"=>"occaecat exercitation aute", "excluded_namespaces"=>["admin.name"], "included_keyword_configuration"=>{"keywords"=>["credit card", "cc"], "character_count"=>30}, "is_enabled"=>false, "name"=>"aliqua veniam", "namespaces"=>["admin"], "pattern"=>"est exercitation nisi mollit", "priority"=>3, "tags"=>["aute consequat", "eu nulla sit"], "text_replacement"=>{"number_of_chars"=>60483918, "replacement_string"=>"dolore ut enim", "type"=>"none"}}, "relationships"=>{"group"=>{"data"=>{"id"=>"et esse officia nulla aute", "type"=>"sensitive_data_scanner_group"}}, "standard_pattern"=>{"data"=>{"id"=>"aliqua", "type"=>"sensitive_data_scanner_standard_pattern"}}}}, "meta"=>{"version"=>0}}

HEADERS

RESPONSES

status: OK

{"data":{"attributes":{"description":"dolor labore non Ut","excluded_namespaces":["admin.name"],"included_keyword_configuration":{"keywords":["credit card","cc"],"character_count":30},"is_enabled":true,"name":"consequat mollit pariatur dolore","namespaces":["admin"],"pattern":"commodo","priority":2,"tags":["reprehenderit irur","in aliqua"],"text_replacement":{"number_of_chars":30989080,"replacement_string":"elit proident officia dolore","type":"none"}},"id":"et nulla aliquip dolore Ut","relationships":{"group":{"data":{"id":"cillum","type":"sensitive_data_scanner_group"}},"standard_pattern":{"data":{"id":"velit Lorem consequat nisi","type":"sensitive_data_scanner_standard_pattern"}}},"type":"sensitive_data_scanner_rule"},"meta":{"version":0}}