From 39a602babdf025a08715af50c233be032083fc3c Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Wed, 13 Dec 2023 09:15:08 +0000 Subject: [PATCH] Regenerate client from commit 58625d67 of spec repo --- .apigentools-info | 8 +- .../v2/sensitive-data-scanner/examples.json | 15 +- .../request.CreateScanningRule.json | 3 +- .../request.UpdateScanningRule.json | 3 +- data/api/v2/full_spec.yaml | 13 ++ data/api/v2/full_spec_deref.json | 140 ++++++++++++++++++ static/resources/json/full_spec_v2.json | 140 ++++++++++++++++++ 7 files changed, 311 insertions(+), 11 deletions(-) diff --git a/.apigentools-info b/.apigentools-info index c91df9bbf3255..77f0ecd5ed0b3 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.6", - "regenerated": "2023-12-11 19:50:13.435061", - "spec_repo_commit": "5584abd0" + "regenerated": "2023-12-13 09:14:46.233655", + "spec_repo_commit": "58625d67" }, "v2": { "apigentools_version": "1.6.6", - "regenerated": "2023-12-11 19:50:24.076635", - "spec_repo_commit": "5584abd0" + "regenerated": "2023-12-13 09:14:56.653194", + "spec_repo_commit": "58625d67" } } } \ No newline at end of file diff --git a/content/en/api/v2/sensitive-data-scanner/examples.json b/content/en/api/v2/sensitive-data-scanner/examples.json index 9d7c7248d8d99..2fda3682c7255 100644 --- a/content/en/api/v2/sensitive-data-scanner/examples.json +++ b/content/en/api/v2/sensitive-data-scanner/examples.json @@ -31,6 +31,7 @@ "admin" ], "pattern": "string", + "priority": "integer", "tags": [], "text_replacement": { "number_of_chars": "integer", @@ -65,7 +66,7 @@ "version": 0 } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Response data related to the scanning groups.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Sensitive Data configuration.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the configuration.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the configuration.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

List of groups, ordered.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

List of groups. The order is important.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner configuration type. \nAllowed enum values: sensitive_data_scanner_configuration

default: sensitive_data_scanner_configuration

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included objects from relationships.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A Scanning Rule included item.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Sensitive Data Scanner rule.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the rule.

\n
\n \n
\n
\n
\n
\n
\n

excluded_namespaces

\n
\n

[string]

\n

Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.

\n
\n \n
\n
\n
\n
\n
\n

is_enabled

\n
\n

boolean

\n

Whether or not the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

namespaces

\n
\n

[string]

\n

Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned.\nIf both are missing the whole event is scanned.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Not included if there is a relationship to a standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags.

\n
\n \n
\n
\n
\n
\n
\n

text_replacement

\n
\n

object

\n

Object describing how the scanned event will be replaced.

\n
\n
\n
\n
\n
\n

number_of_chars

\n
\n

int64

\n

Required if type == 'partial_replacement_from_beginning'\nor 'partial_replacement_from_end'. It must be > 0.

\n
\n \n
\n
\n
\n
\n
\n

replacement_string

\n
\n

string

\n

Required if type == 'replacement_string'.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the replacement text. None means no replacement.\nhash means the data will be stubbed. replacement_string means that\none can chose a text to replace the data. partial_replacement_from_beginning\nallows a user to partially replace the data from the beginning, and\npartial_replacement_from_end on the other hand, allows to replace data from\nthe end. \nAllowed enum values: none,hash,replacement_string,partial_replacement_from_beginning,partial_replacement_from_end

default: none

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of a scanning rule.

\n
\n
\n
\n
\n
\n

group

\n
\n

object

\n

A scanning group data.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

A scanning group.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

standard_pattern

\n
\n

object

\n

A standard pattern.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data containing the standard pattern id.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner standard pattern type. \nAllowed enum values: sensitive_data_scanner_standard_pattern

default: sensitive_data_scanner_standard_pattern

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner rule type. \nAllowed enum values: sensitive_data_scanner_rule

default: sensitive_data_scanner_rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A Scanning Group included item.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Sensitive Data Scanner group.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the group.

\n
\n \n
\n
\n
\n
\n
\n

filter

\n
\n

object

\n

Filter for the Scanning Group.

\n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to filter the events.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

is_enabled

\n
\n

boolean

\n

Whether or not the group is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the group.

\n
\n \n
\n
\n
\n
\n
\n

product_list

\n
\n

[string]

\n

List of products the scanning group applies.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the group.

\n
\n
\n
\n
\n
\n

configuration

\n
\n

object

\n

A Sensitive Data Scanner configuration data.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

A Sensitive Data Scanner configuration.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the configuration.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner configuration type. \nAllowed enum values: sensitive_data_scanner_configuration

default: sensitive_data_scanner_configuration

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

rules

\n
\n

object

\n

Rules included in the group.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Rules included in the group. The order is important.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner rule type. \nAllowed enum values: sensitive_data_scanner_rule

default: sensitive_data_scanner_rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Meta response containing information about the API.

\n
\n
\n
\n
\n
\n

count_limit

\n
\n

int64

\n

Maximum number of scanning rules allowed for the org.

\n
\n \n
\n
\n
\n
\n
\n

group_count_limit

\n
\n

int64

\n

Maximum number of scanning groups allowed for the org.

\n
\n \n
\n
\n
\n
\n
\n

has_highlight_enabled

\n
\n

boolean

\n

Whether or not scanned events are highlighted in Logs or RUM for the org.

\n
\n \n
\n
\n
\n
\n
\n

has_multi_pass_enabled

\n
\n

boolean

\n

Whether or not scanned events have multi-pass enabled.

\n
\n \n
\n
\n
\n
\n
\n

is_pci_compliant

\n
\n

boolean

\n

Whether or not the org is compliant to the payment card industry standard.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

Version of the API.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Response data related to the scanning groups.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Sensitive Data configuration.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the configuration.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the configuration.

\n
\n
\n
\n
\n
\n

groups

\n
\n

object

\n

List of groups, ordered.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

List of groups. The order is important.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner configuration type. \nAllowed enum values: sensitive_data_scanner_configuration

default: sensitive_data_scanner_configuration

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

included

\n
\n

[ <oneOf>]

\n

Included objects from relationships.

\n
\n
\n
\n
\n
\n

Option 1

\n
\n

object

\n

A Scanning Rule included item.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Sensitive Data Scanner rule.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the rule.

\n
\n \n
\n
\n
\n
\n
\n

excluded_namespaces

\n
\n

[string]

\n

Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.

\n
\n \n
\n
\n
\n
\n
\n

is_enabled

\n
\n

boolean

\n

Whether or not the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

namespaces

\n
\n

[string]

\n

Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned.\nIf both are missing the whole event is scanned.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Not included if there is a relationship to a standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating rule issue severity.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags.

\n
\n \n
\n
\n
\n
\n
\n

text_replacement

\n
\n

object

\n

Object describing how the scanned event will be replaced.

\n
\n
\n
\n
\n
\n

number_of_chars

\n
\n

int64

\n

Required if type == 'partial_replacement_from_beginning'\nor 'partial_replacement_from_end'. It must be > 0.

\n
\n \n
\n
\n
\n
\n
\n

replacement_string

\n
\n

string

\n

Required if type == 'replacement_string'.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the replacement text. None means no replacement.\nhash means the data will be stubbed. replacement_string means that\none can chose a text to replace the data. partial_replacement_from_beginning\nallows a user to partially replace the data from the beginning, and\npartial_replacement_from_end on the other hand, allows to replace data from\nthe end. \nAllowed enum values: none,hash,replacement_string,partial_replacement_from_beginning,partial_replacement_from_end

default: none

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of a scanning rule.

\n
\n
\n
\n
\n
\n

group

\n
\n

object

\n

A scanning group data.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

A scanning group.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

standard_pattern

\n
\n

object

\n

A standard pattern.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data containing the standard pattern id.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner standard pattern type. \nAllowed enum values: sensitive_data_scanner_standard_pattern

default: sensitive_data_scanner_standard_pattern

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner rule type. \nAllowed enum values: sensitive_data_scanner_rule

default: sensitive_data_scanner_rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Option 2

\n
\n

object

\n

A Scanning Group included item.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Sensitive Data Scanner group.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the group.

\n
\n \n
\n
\n
\n
\n
\n

filter

\n
\n

object

\n

Filter for the Scanning Group.

\n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Query to filter the events.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

is_enabled

\n
\n

boolean

\n

Whether or not the group is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the group.

\n
\n \n
\n
\n
\n
\n
\n

product_list

\n
\n

[string]

\n

List of products the scanning group applies.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of the group.

\n
\n
\n
\n
\n
\n

configuration

\n
\n

object

\n

A Sensitive Data Scanner configuration data.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

A Sensitive Data Scanner configuration.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the configuration.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner configuration type. \nAllowed enum values: sensitive_data_scanner_configuration

default: sensitive_data_scanner_configuration

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

rules

\n
\n

object

\n

Rules included in the group.

\n
\n
\n
\n
\n
\n

data

\n
\n

[object]

\n

Rules included in the group. The order is important.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner rule type. \nAllowed enum values: sensitive_data_scanner_rule

default: sensitive_data_scanner_rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Meta response containing information about the API.

\n
\n
\n
\n
\n
\n

count_limit

\n
\n

int64

\n

Maximum number of scanning rules allowed for the org.

\n
\n \n
\n
\n
\n
\n
\n

group_count_limit

\n
\n

int64

\n

Maximum number of scanning groups allowed for the org.

\n
\n \n
\n
\n
\n
\n
\n

has_highlight_enabled

\n
\n

boolean

\n

Whether or not scanned events are highlighted in Logs or RUM for the org.

\n
\n \n
\n
\n
\n
\n
\n

has_multi_pass_enabled

\n
\n

boolean

\n

Whether or not scanned events have multi-pass enabled.

\n
\n \n
\n
\n
\n
\n
\n

is_pci_compliant

\n
\n

boolean

\n

Whether or not the org is compliant to the payment card industry standard.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

Version of the API.

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -428,6 +429,7 @@ "admin" ], "pattern": "string", + "priority": "integer", "tags": [], "text_replacement": { "number_of_chars": "integer", @@ -456,7 +458,7 @@ "version": 0 } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Response data related to the creation of a rule.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Sensitive Data Scanner rule.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the rule.

\n
\n \n
\n
\n
\n
\n
\n

excluded_namespaces

\n
\n

[string]

\n

Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.

\n
\n \n
\n
\n
\n
\n
\n

is_enabled

\n
\n

boolean

\n

Whether or not the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

namespaces

\n
\n

[string]

\n

Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned.\nIf both are missing the whole event is scanned.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Not included if there is a relationship to a standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags.

\n
\n \n
\n
\n
\n
\n
\n

text_replacement

\n
\n

object

\n

Object describing how the scanned event will be replaced.

\n
\n
\n
\n
\n
\n

number_of_chars

\n
\n

int64

\n

Required if type == 'partial_replacement_from_beginning'\nor 'partial_replacement_from_end'. It must be > 0.

\n
\n \n
\n
\n
\n
\n
\n

replacement_string

\n
\n

string

\n

Required if type == 'replacement_string'.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the replacement text. None means no replacement.\nhash means the data will be stubbed. replacement_string means that\none can chose a text to replace the data. partial_replacement_from_beginning\nallows a user to partially replace the data from the beginning, and\npartial_replacement_from_end on the other hand, allows to replace data from\nthe end. \nAllowed enum values: none,hash,replacement_string,partial_replacement_from_beginning,partial_replacement_from_end

default: none

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of a scanning rule.

\n
\n
\n
\n
\n
\n

group

\n
\n

object

\n

A scanning group data.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

A scanning group.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

standard_pattern

\n
\n

object

\n

A standard pattern.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data containing the standard pattern id.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner standard pattern type. \nAllowed enum values: sensitive_data_scanner_standard_pattern

default: sensitive_data_scanner_standard_pattern

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner rule type. \nAllowed enum values: sensitive_data_scanner_rule

default: sensitive_data_scanner_rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Meta payload containing information about the API.

\n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

Version of the API (optional).

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Response data related to the creation of a rule.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Sensitive Data Scanner rule.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the rule.

\n
\n \n
\n
\n
\n
\n
\n

excluded_namespaces

\n
\n

[string]

\n

Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.

\n
\n \n
\n
\n
\n
\n
\n

is_enabled

\n
\n

boolean

\n

Whether or not the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

namespaces

\n
\n

[string]

\n

Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned.\nIf both are missing the whole event is scanned.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Not included if there is a relationship to a standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating rule issue severity.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags.

\n
\n \n
\n
\n
\n
\n
\n

text_replacement

\n
\n

object

\n

Object describing how the scanned event will be replaced.

\n
\n
\n
\n
\n
\n

number_of_chars

\n
\n

int64

\n

Required if type == 'partial_replacement_from_beginning'\nor 'partial_replacement_from_end'. It must be > 0.

\n
\n \n
\n
\n
\n
\n
\n

replacement_string

\n
\n

string

\n

Required if type == 'replacement_string'.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the replacement text. None means no replacement.\nhash means the data will be stubbed. replacement_string means that\none can chose a text to replace the data. partial_replacement_from_beginning\nallows a user to partially replace the data from the beginning, and\npartial_replacement_from_end on the other hand, allows to replace data from\nthe end. \nAllowed enum values: none,hash,replacement_string,partial_replacement_from_beginning,partial_replacement_from_end

default: none

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of a scanning rule.

\n
\n
\n
\n
\n
\n

group

\n
\n

object

\n

A scanning group data.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

A scanning group.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

standard_pattern

\n
\n

object

\n

A standard pattern.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data containing the standard pattern id.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner standard pattern type. \nAllowed enum values: sensitive_data_scanner_standard_pattern

default: sensitive_data_scanner_standard_pattern

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner rule type. \nAllowed enum values: sensitive_data_scanner_rule

default: sensitive_data_scanner_rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Meta payload containing information about the API.

\n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

Version of the API (optional).

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -505,6 +507,7 @@ "admin" ], "pattern": "string", + "priority": "integer", "tags": [], "text_replacement": { "number_of_chars": "integer", @@ -532,7 +535,7 @@ "version": 0 } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data related to the creation of a rule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of the Sensitive Data Scanner rule.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the rule.

\n
\n \n
\n
\n
\n
\n
\n

excluded_namespaces

\n
\n

[string]

\n

Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.

\n
\n \n
\n
\n
\n
\n
\n

is_enabled

\n
\n

boolean

\n

Whether or not the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

namespaces

\n
\n

[string]

\n

Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned.\nIf both are missing the whole event is scanned.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Not included if there is a relationship to a standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags.

\n
\n \n
\n
\n
\n
\n
\n

text_replacement

\n
\n

object

\n

Object describing how the scanned event will be replaced.

\n
\n
\n
\n
\n
\n

number_of_chars

\n
\n

int64

\n

Required if type == 'partial_replacement_from_beginning'\nor 'partial_replacement_from_end'. It must be > 0.

\n
\n \n
\n
\n
\n
\n
\n

replacement_string

\n
\n

string

\n

Required if type == 'replacement_string'.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the replacement text. None means no replacement.\nhash means the data will be stubbed. replacement_string means that\none can chose a text to replace the data. partial_replacement_from_beginning\nallows a user to partially replace the data from the beginning, and\npartial_replacement_from_end on the other hand, allows to replace data from\nthe end. \nAllowed enum values: none,hash,replacement_string,partial_replacement_from_beginning,partial_replacement_from_end

default: none

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships of a scanning rule.

\n
\n
\n
\n
\n
\n

group

\n
\n

object

\n

A scanning group data.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

A scanning group.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

standard_pattern

\n
\n

object

\n

A standard pattern.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data containing the standard pattern id.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner standard pattern type. \nAllowed enum values: sensitive_data_scanner_standard_pattern

default: sensitive_data_scanner_standard_pattern

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Sensitive Data Scanner rule type. \nAllowed enum values: sensitive_data_scanner_rule

default: sensitive_data_scanner_rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta [required]

\n
\n

object

\n

Meta payload containing information about the API.

\n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

Version of the API (optional).

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data related to the creation of a rule.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of the Sensitive Data Scanner rule.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the rule.

\n
\n \n
\n
\n
\n
\n
\n

excluded_namespaces

\n
\n

[string]

\n

Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.

\n
\n \n
\n
\n
\n
\n
\n

is_enabled

\n
\n

boolean

\n

Whether or not the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

namespaces

\n
\n

[string]

\n

Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned.\nIf both are missing the whole event is scanned.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Not included if there is a relationship to a standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating rule issue severity.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags.

\n
\n \n
\n
\n
\n
\n
\n

text_replacement

\n
\n

object

\n

Object describing how the scanned event will be replaced.

\n
\n
\n
\n
\n
\n

number_of_chars

\n
\n

int64

\n

Required if type == 'partial_replacement_from_beginning'\nor 'partial_replacement_from_end'. It must be > 0.

\n
\n \n
\n
\n
\n
\n
\n

replacement_string

\n
\n

string

\n

Required if type == 'replacement_string'.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the replacement text. None means no replacement.\nhash means the data will be stubbed. replacement_string means that\none can chose a text to replace the data. partial_replacement_from_beginning\nallows a user to partially replace the data from the beginning, and\npartial_replacement_from_end on the other hand, allows to replace data from\nthe end. \nAllowed enum values: none,hash,replacement_string,partial_replacement_from_beginning,partial_replacement_from_end

default: none

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

relationships [required]

\n
\n

object

\n

Relationships of a scanning rule.

\n
\n
\n
\n
\n
\n

group

\n
\n

object

\n

A scanning group data.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

A scanning group.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

standard_pattern

\n
\n

object

\n

A standard pattern.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data containing the standard pattern id.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner standard pattern type. \nAllowed enum values: sensitive_data_scanner_standard_pattern

default: sensitive_data_scanner_standard_pattern

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Sensitive Data Scanner rule type. \nAllowed enum values: sensitive_data_scanner_rule

default: sensitive_data_scanner_rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta [required]

\n
\n

object

\n

Meta payload containing information about the API.

\n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

Version of the API (optional).

\n
\n \n
\n
\n
\n
" } }, "DeleteScanningRule": { @@ -651,6 +654,7 @@ "admin" ], "pattern": "string", + "priority": "integer", "tags": [], "text_replacement": { "number_of_chars": "integer", @@ -679,7 +683,7 @@ "version": 0 } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data related to the update of a rule.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Sensitive Data Scanner rule.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the rule.

\n
\n \n
\n
\n
\n
\n
\n

excluded_namespaces

\n
\n

[string]

\n

Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.

\n
\n \n
\n
\n
\n
\n
\n

is_enabled

\n
\n

boolean

\n

Whether or not the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

namespaces

\n
\n

[string]

\n

Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned.\nIf both are missing the whole event is scanned.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Not included if there is a relationship to a standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags.

\n
\n \n
\n
\n
\n
\n
\n

text_replacement

\n
\n

object

\n

Object describing how the scanned event will be replaced.

\n
\n
\n
\n
\n
\n

number_of_chars

\n
\n

int64

\n

Required if type == 'partial_replacement_from_beginning'\nor 'partial_replacement_from_end'. It must be > 0.

\n
\n \n
\n
\n
\n
\n
\n

replacement_string

\n
\n

string

\n

Required if type == 'replacement_string'.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the replacement text. None means no replacement.\nhash means the data will be stubbed. replacement_string means that\none can chose a text to replace the data. partial_replacement_from_beginning\nallows a user to partially replace the data from the beginning, and\npartial_replacement_from_end on the other hand, allows to replace data from\nthe end. \nAllowed enum values: none,hash,replacement_string,partial_replacement_from_beginning,partial_replacement_from_end

default: none

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of a scanning rule.

\n
\n
\n
\n
\n
\n

group

\n
\n

object

\n

A scanning group data.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

A scanning group.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

standard_pattern

\n
\n

object

\n

A standard pattern.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data containing the standard pattern id.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner standard pattern type. \nAllowed enum values: sensitive_data_scanner_standard_pattern

default: sensitive_data_scanner_standard_pattern

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner rule type. \nAllowed enum values: sensitive_data_scanner_rule

default: sensitive_data_scanner_rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta [required]

\n
\n

object

\n

Meta payload containing information about the API.

\n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

Version of the API (optional).

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data related to the update of a rule.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Sensitive Data Scanner rule.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the rule.

\n
\n \n
\n
\n
\n
\n
\n

excluded_namespaces

\n
\n

[string]

\n

Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.

\n
\n \n
\n
\n
\n
\n
\n

is_enabled

\n
\n

boolean

\n

Whether or not the rule is enabled.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the rule.

\n
\n \n
\n
\n
\n
\n
\n

namespaces

\n
\n

[string]

\n

Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned.\nIf both are missing the whole event is scanned.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Not included if there is a relationship to a standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating rule issue severity.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags.

\n
\n \n
\n
\n
\n
\n
\n

text_replacement

\n
\n

object

\n

Object describing how the scanned event will be replaced.

\n
\n
\n
\n
\n
\n

number_of_chars

\n
\n

int64

\n

Required if type == 'partial_replacement_from_beginning'\nor 'partial_replacement_from_end'. It must be > 0.

\n
\n \n
\n
\n
\n
\n
\n

replacement_string

\n
\n

string

\n

Required if type == 'replacement_string'.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Type of the replacement text. None means no replacement.\nhash means the data will be stubbed. replacement_string means that\none can chose a text to replace the data. partial_replacement_from_beginning\nallows a user to partially replace the data from the beginning, and\npartial_replacement_from_end on the other hand, allows to replace data from\nthe end. \nAllowed enum values: none,hash,replacement_string,partial_replacement_from_beginning,partial_replacement_from_end

default: none

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the rule.

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

Relationships of a scanning rule.

\n
\n
\n
\n
\n
\n

group

\n
\n

object

\n

A scanning group data.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

A scanning group.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the group.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner group type. \nAllowed enum values: sensitive_data_scanner_group

default: sensitive_data_scanner_group

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

standard_pattern

\n
\n

object

\n

A standard pattern.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

Data containing the standard pattern id.

\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner standard pattern type. \nAllowed enum values: sensitive_data_scanner_standard_pattern

default: sensitive_data_scanner_standard_pattern

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner rule type. \nAllowed enum values: sensitive_data_scanner_rule

default: sensitive_data_scanner_rule

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta [required]

\n
\n

object

\n

Meta payload containing information about the API.

\n
\n
\n
\n
\n
\n

version

\n
\n

int64

\n

Version of the API (optional).

\n
\n \n
\n
\n
\n
" } }, "ListStandardPatterns": { @@ -693,6 +697,7 @@ "included_keywords": [], "name": "string", "pattern": "string", + "priority": "integer", "tags": [] }, "id": "string", @@ -700,7 +705,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

List Standard patterns response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Sensitive Data Scanner standard pattern.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

included_keywords

\n
\n

[string]

\n

List of included keywords.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Regex to match.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner standard pattern type. \nAllowed enum values: sensitive_data_scanner_standard_pattern

default: sensitive_data_scanner_standard_pattern

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

List Standard patterns response.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes of the Sensitive Data Scanner standard pattern.

\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

included_keywords

\n
\n

[string]

\n

List of included keywords.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

pattern

\n
\n

string

\n

Regex to match.

\n
\n \n
\n
\n
\n
\n
\n

priority

\n
\n

int64

\n

Integer from 1 (high) to 5 (low) indicating standard pattern issue severity.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

List of tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

ID of the standard pattern.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

Sensitive Data Scanner standard pattern type. \nAllowed enum values: sensitive_data_scanner_standard_pattern

default: sensitive_data_scanner_standard_pattern

\n
\n \n
\n
\n
\n
" }, "400": { "json": { diff --git a/content/en/api/v2/sensitive-data-scanner/request.CreateScanningRule.json b/content/en/api/v2/sensitive-data-scanner/request.CreateScanningRule.json index a2f2991a5b2ce..f68f7e405c355 100644 --- a/content/en/api/v2/sensitive-data-scanner/request.CreateScanningRule.json +++ b/content/en/api/v2/sensitive-data-scanner/request.CreateScanningRule.json @@ -17,7 +17,8 @@ "tags": [ "sensitive_data:true" ], - "is_enabled": true + "is_enabled": true, + "priority": 1 }, "relationships": { "group": { diff --git a/content/en/api/v2/sensitive-data-scanner/request.UpdateScanningRule.json b/content/en/api/v2/sensitive-data-scanner/request.UpdateScanningRule.json index a3717c1638639..b9d8e4af4659e 100644 --- a/content/en/api/v2/sensitive-data-scanner/request.UpdateScanningRule.json +++ b/content/en/api/v2/sensitive-data-scanner/request.UpdateScanningRule.json @@ -12,7 +12,8 @@ "tags": [ "sensitive_data:true" ], - "is_enabled": true + "is_enabled": true, + "priority": 5 }, "relationships": { "group": { diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 36cd7990119ee..ffd546da89fbe 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -16526,6 +16526,12 @@ components: pattern: description: Not included if there is a relationship to a standard pattern. type: string + priority: + description: Integer from 1 (high) to 5 (low) indicating rule issue severity. + format: int64 + maximum: 5 + minimum: 1 + type: integer tags: description: List of tags. items: @@ -16681,6 +16687,13 @@ components: pattern: description: Regex to match. type: string + priority: + description: Integer from 1 (high) to 5 (low) indicating standard pattern + issue severity. + format: int64 + maximum: 5 + minimum: 1 + type: integer tags: description: List of tags. items: diff --git a/data/api/v2/full_spec_deref.json b/data/api/v2/full_spec_deref.json index ad82ad7d3d4e5..5955014f920f7 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -93047,6 +93047,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -93246,6 +93253,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -93558,6 +93572,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -93938,6 +93959,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -95690,6 +95718,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -95777,6 +95812,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -95949,6 +95991,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -96211,6 +96260,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -96441,6 +96497,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -96621,6 +96684,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -96792,6 +96862,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -97001,6 +97078,13 @@ "description": "Regex to match.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating standard pattern issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -97078,6 +97162,13 @@ "description": "Regex to match.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating standard pattern issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -97139,6 +97230,13 @@ "description": "Regex to match.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating standard pattern issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -97198,6 +97296,13 @@ "description": "Regex to match.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating standard pattern issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -208198,6 +208303,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -209820,6 +209932,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -210020,6 +210139,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -210519,6 +210645,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -210846,6 +210979,13 @@ "description": "Regex to match.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating standard pattern issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { diff --git a/static/resources/json/full_spec_v2.json b/static/resources/json/full_spec_v2.json index ad82ad7d3d4e5..5955014f920f7 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -93047,6 +93047,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -93246,6 +93253,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -93558,6 +93572,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -93938,6 +93959,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -95690,6 +95718,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -95777,6 +95812,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -95949,6 +95991,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -96211,6 +96260,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -96441,6 +96497,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -96621,6 +96684,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -96792,6 +96862,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -97001,6 +97078,13 @@ "description": "Regex to match.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating standard pattern issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -97078,6 +97162,13 @@ "description": "Regex to match.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating standard pattern issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -97139,6 +97230,13 @@ "description": "Regex to match.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating standard pattern issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -97198,6 +97296,13 @@ "description": "Regex to match.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating standard pattern issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -208198,6 +208303,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -209820,6 +209932,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -210020,6 +210139,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -210519,6 +210645,13 @@ "description": "Not included if there is a relationship to a standard pattern.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating rule issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": { @@ -210846,6 +210979,13 @@ "description": "Regex to match.", "type": "string" }, + "priority": { + "description": "Integer from 1 (high) to 5 (low) indicating standard pattern issue severity.", + "format": "int64", + "maximum": 5, + "minimum": 1, + "type": "integer" + }, "tags": { "description": "List of tags.", "items": {