Update Scanning Rule

PATCH {{baseUrl}}/api/v2/sensitive-data-scanner/config/rules/:rule_id

Update a scanning rule. The request body MUST NOT include a standardpattern relationship, as that relationship is non-editable. Trying to edit the regex attribute of a rule with a standardpattern relationship will also result in an error.

Request Body

{"data"=>{"attributes"=>{"description"=>"<string>", "excluded_namespaces"=>["<string>", "<string>"], "is_enabled"=>"<boolean>", "name"=>"<string>", "namespaces"=>["<string>", "<string>"], "pattern"=>"<string>", "tags"=>["<string>", "<string>"], "text_replacement"=>{"number_of_chars"=>"<long>", "replacement_string"=>"<string>", "type"=>"none"}}, "id"=>"<string>", "relationships"=>{"group"=>{"data"=>{"id"=>"<string>", "type"=>"sensitive_data_scanner_group"}}, "standard_pattern"=>{"data"=>{"id"=>"<string>", "type"=>"sensitive_data_scanner_standard_pattern"}}}, "type"=>"sensitive_data_scanner_rule"}, "meta"=>{"version"=>"<long>"}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;meta&quot;:{&quot;version&quot;:&quot;\u003clong\u003e&quot;}}