.generator/schemas/v2/openapi.yaml in datadog_api_client-2.4.0 vs .generator/schemas/v2/openapi.yaml in datadog_api_client-2.5.0

- old
+ new

@@ -284,11 +284,11 @@ default: 0 example: 0 format: int64 type: integer PageSize: - description: Size for a given page. + description: Size for a given page. The maximum allowed value is 5000. in: query name: page[size] required: false schema: default: 10 @@ -314,10 +314,24 @@ in: path name: rule_id required: true schema: type: string + SensitiveDataScannerGroupID: + description: The ID of a group of rules. + in: path + name: group_id + required: true + schema: + type: string + SensitiveDataScannerRuleID: + description: The ID of the rule. + in: path + name: rule_id + required: true + schema: + type: string ServiceAccountID: description: The ID of the service account. in: path name: service_account_id required: true @@ -781,12 +795,12 @@ description: Time offset (in seconds) to apply to the query. format: int64 type: integer timezone: default: UTC - description: 'Timezone code. Can be specified as an offset, for example: - "UTC+03:00".' + description: The timezone can be specified as GMT, UTC, an offset from UTC + (like UTC+1), or as a Timezone Database identifier (like America/New_York). example: GMT type: string type: object AuditLogsQueryPageOptions: description: Paging attributes for listing events. @@ -1180,10 +1194,14 @@ - sum - min - max - avg - median + - latest + - earliest + - most_frequent + - delta example: pc90 type: string x-enum-varnames: - COUNT - CARDINALITY @@ -1195,10 +1213,14 @@ - SUM - MIN - MAX - AVG - MEDIAN + - LATEST + - EARLIEST + - MOST_FREQUENT + - DELTA CIAppCompute: description: A compute rule to compute metrics or timeseries. properties: aggregation: $ref: '#/components/schemas/CIAppAggregationFunction' @@ -1474,12 +1496,12 @@ description: The time offset (in seconds) to apply to the query. format: int64 type: integer timezone: default: UTC - description: 'The timezone can be specified both as an offset, for example: - "UTC+03:00".' + description: The timezone can be specified as GMT, UTC, an offset from UTC + (like UTC+1), or as a Timezone Database identifier (like America/New_York). example: GMT type: string type: object CIAppQueryPageOptions: description: Paging attributes for listing events. @@ -1751,10 +1773,160 @@ product_name: description: The product for which cost is being reported. example: infra_host type: string type: object + CloudConfigurationComplianceRuleOptions: + description: Options for cloud_configuration rules. + properties: + complexRule: + description: 'Whether the rule is a complex one. + + Must be set to true if `regoRule.resourceTypes` contains more than one + item. Defaults to false. + + ' + type: boolean + regoRule: + $ref: '#/components/schemas/CloudConfigurationRegoRule' + resourceType: + description: 'Main resource type to be checked by the rule. It should be + specified again in `regoRule.resourceTypes`. + + ' + example: aws_acm + type: string + required: + - resourceType + - regoRule + type: object + CloudConfigurationRegoRule: + description: Rule details. + properties: + policy: + description: 'The policy written in `rego`, see: https://www.openpolicyagent.org/docs/latest/policy-language/' + example: "package datadog\n\nimport data.datadog.output as dd_output\nimport + future.keywords.contains\nimport future.keywords.if\nimport future.keywords.in\n\neval(resource) + = \"skip\" if {\n # Logic that evaluates to true if the resource should + be skipped\n true\n} else = \"pass\" {\n # Logic that evaluates to true + if the resource is compliant\n true\n} else = \"fail\" {\n # Logic that + evaluates to true if the resource is not compliant\n true\n}\n\n# This + part remains unchanged for all rules\nresults contains result if {\n some + resource in input.resources[input.main_resource_type]\n result := dd_output.format(resource, + eval(resource))\n}\n" + type: string + resourceTypes: + description: List of resource types that will be evaluated upon. Must have + at least one element. + example: + - gcp_iam_service_account + - gcp_iam_policy + items: + type: string + type: array + required: + - policy + - resourceTypes + type: object + CloudConfigurationRuleCaseCreate: + description: Description of signals. + properties: + notifications: + description: Notification targets for each rule case. + items: + description: Notification. + type: string + type: array + status: + $ref: '#/components/schemas/SecurityMonitoringRuleSeverity' + required: + - status + type: object + CloudConfigurationRuleComplianceSignalOptions: + description: How to generate compliance signals. Useful for cloud_configuration + rules only. + properties: + userActivationStatus: + description: Whether signals will be sent. + type: boolean + userGroupByFields: + description: Fields to use to group findings by when sending signals. + items: + type: string + type: array + type: object + CloudConfigurationRuleCreatePayload: + description: Create a new cloud configuration rule. + properties: + cases: + description: 'Description of generated findings and signals (severity and + channels to be notified in case of a signal). Must contain exactly one + item. + + ' + items: + $ref: '#/components/schemas/CloudConfigurationRuleCaseCreate' + type: array + complianceSignalOptions: + $ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions' + isEnabled: + description: Whether the rule is enabled. + example: true + type: boolean + message: + description: Message in markdown format for generated findings and signals. + example: '#Description + + Explanation of the rule. + + + #Remediation + + How to fix the security issue. + + ' + type: string + name: + description: The name of the rule. + example: My security monitoring rule. + type: string + options: + $ref: '#/components/schemas/CloudConfigurationRuleOptions' + tags: + description: Tags for generated findings and signals. + example: + - env:prod + - team:security + items: + description: Tag. + type: string + type: array + type: + $ref: '#/components/schemas/CloudConfigurationRuleType' + required: + - name + - isEnabled + - options + - complianceSignalOptions + - cases + - message + type: object + CloudConfigurationRuleOptions: + description: Options on cloud configuration rules. + properties: + complianceRuleOptions: + $ref: '#/components/schemas/CloudConfigurationComplianceRuleOptions' + required: + - complianceRuleOptions + type: object + CloudConfigurationRuleType: + description: The rule type. + enum: + - cloud_configuration + type: string + x-enum-varnames: + - CLOUD_CONFIGURATION CloudWorkloadSecurityAgentRuleAttributes: description: A Cloud Workload Security Agent rule returned by the API. properties: category: description: The category of the Agent rule. @@ -2720,11 +2892,12 @@ description: The time offset to apply to the query in seconds. format: int64 type: integer timezone: default: UTC - description: 'The timezone can be specified as an offset, for example: `UTC+03:00`.' + description: The timezone can be specified as GMT, UTC, an offset from UTC + (like UTC+1), or as a Timezone Database identifier (like America/New_York). example: GMT type: string type: object EventsRequestPage: description: Pagination settings. @@ -5001,10 +5174,12 @@ LogsMetricCompute: description: The compute rule to compute the log-based metric. properties: aggregation_type: $ref: '#/components/schemas/LogsMetricComputeAggregationType' + include_percentiles: + $ref: '#/components/schemas/LogsMetricComputeIncludePercentiles' path: description: The path to the value the log-based metric will aggregate on (only used if the aggregation type is a "distribution"). example: '@duration' type: string @@ -5019,10 +5194,17 @@ example: distribution type: string x-enum-varnames: - COUNT - DISTRIBUTION + LogsMetricComputeIncludePercentiles: + description: 'Toggle to include or exclude percentile aggregations for distribution + metrics. + + Only present when the `aggregation_type` is `distribution`.' + example: true + type: boolean LogsMetricCreateAttributes: description: The object describing the Datadog log-based metric to create. properties: compute: $ref: '#/components/schemas/LogsMetricCompute' @@ -5110,10 +5292,12 @@ LogsMetricResponseCompute: description: The compute rule to compute the log-based metric. properties: aggregation_type: $ref: '#/components/schemas/LogsMetricResponseComputeAggregationType' + include_percentiles: + $ref: '#/components/schemas/LogsMetricComputeIncludePercentiles' path: description: The path to the value the log-based metric will aggregate on (only used if the aggregation type is a "distribution"). example: '@duration' type: string @@ -5171,18 +5355,26 @@ x-enum-varnames: - LOGS_METRICS LogsMetricUpdateAttributes: description: The log-based metric properties that will be updated. properties: + compute: + $ref: '#/components/schemas/LogsMetricUpdateCompute' filter: $ref: '#/components/schemas/LogsMetricFilter' group_by: description: The rules for the group by. items: $ref: '#/components/schemas/LogsMetricGroupBy' type: array type: object + LogsMetricUpdateCompute: + description: The compute rule to compute the log-based metric. + properties: + include_percentiles: + $ref: '#/components/schemas/LogsMetricComputeIncludePercentiles' + type: object LogsMetricUpdateData: description: The new log-based metric properties. properties: attributes: $ref: '#/components/schemas/LogsMetricUpdateAttributes' @@ -5254,12 +5446,12 @@ description: The time offset (in seconds) to apply to the query. format: int64 type: integer timezone: default: UTC - description: 'The timezone can be specified both as an offset, for example: - "UTC+03:00".' + description: The timezone can be specified as GMT, UTC, an offset from UTC + (like UTC+1), or as a Timezone Database identifier (like America/New_York). example: GMT type: string type: object LogsResponseMetadata: description: The metadata associated with a request @@ -5967,11 +6159,11 @@ description: Timestamp when the tag configuration was created. example: '2020-03-25T09:48:37.463835Z' format: date-time type: string include_percentiles: - description: 'Toggle to turn on/off percentile aggregations for distribution + description: 'Toggle to include or exclude percentile aggregations for distribution metrics. Only present when the `metric_type` is `distribution`.' example: true type: boolean @@ -6883,23 +7075,30 @@ properties: application_id: description: ID of the RUM application. example: abcd1234-0000-0000-abcd-1234abcd5678 type: string + client_token: + description: Client token of the RUM application. + example: abcd1234efgh5678ijkl90abcd1234efgh0 + type: string created_at: description: Timestamp in ms of the creation date. example: 1659479836169 format: int64 type: integer created_by_handle: description: Handle of the creator user. example: john.doe type: string hash: - description: Client token of the RUM application. - example: abcd1234efgh5678ijkl90abcd1234efgh0 + description: Hash of the RUM application. Optional. type: string + is_active: + description: Indicates if the RUM application is active. + example: true + type: boolean name: description: Name of the RUM application. example: my_rum_application type: string org_id: @@ -6922,10 +7121,11 @@ description: Handle of the updater user. example: jane.doe type: string required: - application_id + - client_token - created_at - created_by_handle - name - org_id - type @@ -6973,10 +7173,87 @@ - rum_application_create example: rum_application_create type: string x-enum-varnames: - RUM_APPLICATION_CREATE + RUMApplicationList: + description: RUM application list. + properties: + attributes: + $ref: '#/components/schemas/RUMApplicationListAttributes' + type: + $ref: '#/components/schemas/RUMApplicationListType' + required: + - attributes + - type + type: object + RUMApplicationListAttributes: + description: RUM application list attributes. + properties: + application_id: + description: ID of the RUM application. + example: abcd1234-0000-0000-abcd-1234abcd5678 + type: string + created_at: + description: Timestamp in ms of the creation date. + example: 1659479836169 + format: int64 + type: integer + created_by_handle: + description: Handle of the creator user. + example: john.doe + type: string + hash: + description: Hash of the RUM application. Optional. + type: string + is_active: + description: Indicates if the RUM application is active. + example: true + type: boolean + name: + description: Name of the RUM application. + example: my_rum_application + type: string + org_id: + description: Org ID of the RUM application. + example: 999 + format: int32 + maximum: 2147483647 + type: integer + type: + description: Type of the RUM application. Supported values are `browser`, + `ios`, `android`, `react-native`, `flutter`. + example: browser + type: string + updated_at: + description: Timestamp in ms of the last update date. + example: 1659479836169 + format: int64 + type: integer + updated_by_handle: + description: Handle of the updater user. + example: jane.doe + type: string + required: + - application_id + - created_at + - created_by_handle + - name + - org_id + - type + - updated_at + - updated_by_handle + type: object + RUMApplicationListType: + default: rum_application + description: RUM application list type. + enum: + - rum_application + example: rum_application + type: string + x-enum-varnames: + - RUM_APPLICATION RUMApplicationResponse: description: RUM application response. properties: data: $ref: '#/components/schemas/RUMApplication' @@ -7039,11 +7316,11 @@ description: RUM applications response. properties: data: description: RUM applications array response. items: - $ref: '#/components/schemas/RUMApplication' + $ref: '#/components/schemas/RUMApplicationList' type: array type: object RUMBucketResponse: description: Bucket values. properties: @@ -7280,12 +7557,12 @@ description: The time offset (in seconds) to apply to the query. format: int64 type: integer timezone: default: UTC - description: 'The timezone can be specified both as an offset, for example: - "UTC+03:00".' + description: The timezone can be specified as GMT, UTC, an offset from UTC + (like UTC+1), or as a Timezone Database identifier (like America/New_York). example: GMT type: string type: object RUMQueryPageOptions: description: Paging attributes for listing events. @@ -8229,10 +8506,11 @@ SecurityMonitoringRuleCreatePayload: description: Create a new rule. oneOf: - $ref: '#/components/schemas/SecurityMonitoringStandardRuleCreatePayload' - $ref: '#/components/schemas/SecurityMonitoringSignalRuleCreatePayload' + - $ref: '#/components/schemas/CloudConfigurationRuleCreatePayload' type: object SecurityMonitoringRuleDecreaseCriticalityBasedOnEnv: description: 'If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise. @@ -8434,10 +8712,12 @@ - ZERO_OCCURRENCES - ONE_OCCURRENCE SecurityMonitoringRuleOptions: description: Options on rules. properties: + complianceRuleOptions: + $ref: '#/components/schemas/CloudConfigurationComplianceRuleOptions' decreaseCriticalityBasedOnEnv: $ref: '#/components/schemas/SecurityMonitoringRuleDecreaseCriticalityBasedOnEnv' detectionMethod: $ref: '#/components/schemas/SecurityMonitoringRuleDetectionMethod' evaluationWindow: @@ -8528,10 +8808,12 @@ cases: description: Cases for generating signals. items: $ref: '#/components/schemas/SecurityMonitoringRuleCase' type: array + complianceSignalOptions: + $ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions' filters: description: Additional queries to filter matched events before they are processed. items: $ref: '#/components/schemas/SecurityMonitoringFilter' @@ -9208,10 +9490,12 @@ cases: description: Cases for generating signals. items: $ref: '#/components/schemas/SecurityMonitoringRuleCase' type: array + complianceSignalOptions: + $ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions' createdAt: description: When the rule was created, timestamp in milliseconds. format: int64 type: integer creationAuthorId: @@ -9287,10 +9571,597 @@ example: 773b045d-ccf8-4808-bd3b-955ef6a8c940 type: string required: - uuid type: object + SensitiveDataScannerConfigRequest: + description: Group reorder request. + properties: + data: + $ref: '#/components/schemas/SensitiveDataScannerReorderConfig' + meta: + $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + required: + - data + - meta + type: object + SensitiveDataScannerConfiguration: + description: A Sensitive Data Scanner configuration. + properties: + id: + description: ID of the configuration. + type: string + type: + $ref: '#/components/schemas/SensitiveDataScannerConfigurationType' + type: object + SensitiveDataScannerConfigurationData: + description: A Sensitive Data Scanner configuration data. + properties: + data: + $ref: '#/components/schemas/SensitiveDataScannerConfiguration' + type: object + SensitiveDataScannerConfigurationRelationships: + description: Relationships of the configuration. + properties: + groups: + $ref: '#/components/schemas/SensitiveDataScannerGroupList' + type: object + SensitiveDataScannerConfigurationType: + default: sensitive_data_scanner_configuration + description: Sensitive Data Scanner configuration type. + enum: + - sensitive_data_scanner_configuration + example: sensitive_data_scanner_configuration + type: string + x-enum-varnames: + - SENSITIVE_DATA_SCANNER_CONFIGURATIONS + SensitiveDataScannerCreateGroupResponse: + description: Create group response. + properties: + data: + $ref: '#/components/schemas/SensitiveDataScannerGroupResponse' + meta: + $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + type: object + SensitiveDataScannerCreateRuleResponse: + description: Create rule response. + properties: + data: + $ref: '#/components/schemas/SensitiveDataScannerRuleResponse' + meta: + $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + type: object + SensitiveDataScannerFilter: + description: Filter for the Scanning Group. + properties: + query: + description: Query to filter the events. + type: string + type: object + SensitiveDataScannerGetConfigIncludedArray: + description: Included objects from relationships. + items: + $ref: '#/components/schemas/SensitiveDataScannerGetConfigIncludedItem' + type: array + SensitiveDataScannerGetConfigIncludedItem: + description: An object related to the configuration. + oneOf: + - $ref: '#/components/schemas/SensitiveDataScannerRuleIncludedItem' + - $ref: '#/components/schemas/SensitiveDataScannerGroupIncludedItem' + type: object + SensitiveDataScannerGetConfigResponse: + description: Get all groups response. + properties: + data: + $ref: '#/components/schemas/SensitiveDataScannerGetConfigResponseData' + included: + $ref: '#/components/schemas/SensitiveDataScannerGetConfigIncludedArray' + meta: + $ref: '#/components/schemas/SensitiveDataScannerMeta' + type: object + SensitiveDataScannerGetConfigResponseData: + description: Response data related to the scanning groups. + properties: + id: + description: ID of the configuration. + type: string + relationships: + $ref: '#/components/schemas/SensitiveDataScannerConfigurationRelationships' + type: + $ref: '#/components/schemas/SensitiveDataScannerConfigurationType' + type: object + SensitiveDataScannerGroup: + description: A scanning group. + properties: + id: + description: ID of the group. + type: string + type: + $ref: '#/components/schemas/SensitiveDataScannerGroupType' + type: object + SensitiveDataScannerGroupAttributes: + description: Attributes of the Sensitive Data Scanner group. + properties: + description: + description: Description of the group. + type: string + filter: + $ref: '#/components/schemas/SensitiveDataScannerFilter' + is_enabled: + description: Whether or not the group is enabled. + type: boolean + name: + description: Name of the group. + type: string + product_list: + description: List of products the scanning group applies. + items: + $ref: '#/components/schemas/SensitiveDataScannerProduct' + type: array + type: object + SensitiveDataScannerGroupCreate: + description: Data related to the creation of a group. + properties: + attributes: + $ref: '#/components/schemas/SensitiveDataScannerGroupAttributes' + relationships: + $ref: '#/components/schemas/SensitiveDataScannerGroupRelationships' + type: + $ref: '#/components/schemas/SensitiveDataScannerGroupType' + required: + - type + - attributes + type: object + SensitiveDataScannerGroupCreateRequest: + description: Create group request. + properties: + data: + $ref: '#/components/schemas/SensitiveDataScannerGroupCreate' + meta: + $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + type: object + SensitiveDataScannerGroupData: + description: A scanning group data. + properties: + data: + $ref: '#/components/schemas/SensitiveDataScannerGroup' + type: object + SensitiveDataScannerGroupDeleteRequest: + description: Delete group request. + properties: + meta: + $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + required: + - meta + type: object + SensitiveDataScannerGroupDeleteResponse: + description: Delete group response. + properties: + meta: + $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + type: object + SensitiveDataScannerGroupIncludedItem: + description: A Scanning Group included item. + properties: + attributes: + $ref: '#/components/schemas/SensitiveDataScannerGroupAttributes' + id: + description: ID of the group. + type: string + relationships: + $ref: '#/components/schemas/SensitiveDataScannerGroupRelationships' + type: + $ref: '#/components/schemas/SensitiveDataScannerGroupType' + type: object + SensitiveDataScannerGroupItem: + description: Data related to a Sensitive Data Scanner Group. + properties: + id: + description: ID of the group. + type: string + type: + $ref: '#/components/schemas/SensitiveDataScannerGroupType' + type: object + SensitiveDataScannerGroupList: + description: List of groups, ordered. + properties: + data: + description: List of groups. The order is important. + items: + $ref: '#/components/schemas/SensitiveDataScannerGroupItem' + type: array + type: object + SensitiveDataScannerGroupRelationships: + description: Relationships of the group. + properties: + configuration: + $ref: '#/components/schemas/SensitiveDataScannerConfigurationData' + rules: + $ref: '#/components/schemas/SensitiveDataScannerRuleData' + type: object + SensitiveDataScannerGroupResponse: + description: Response data related to the creation of a group. + properties: + attributes: + $ref: '#/components/schemas/SensitiveDataScannerGroupAttributes' + id: + description: ID of the group. + type: string + relationships: + $ref: '#/components/schemas/SensitiveDataScannerGroupRelationships' + type: + $ref: '#/components/schemas/SensitiveDataScannerGroupType' + type: object + SensitiveDataScannerGroupType: + default: sensitive_data_scanner_group + description: Sensitive Data Scanner group type. + enum: + - sensitive_data_scanner_group + example: sensitive_data_scanner_group + type: string + x-enum-varnames: + - SENSITIVE_DATA_SCANNER_GROUP + SensitiveDataScannerGroupUpdate: + description: Data related to the update of a group. + properties: + attributes: + $ref: '#/components/schemas/SensitiveDataScannerGroupAttributes' + id: + description: ID of the group. + type: string + relationships: + $ref: '#/components/schemas/SensitiveDataScannerGroupRelationships' + type: + $ref: '#/components/schemas/SensitiveDataScannerGroupType' + type: object + SensitiveDataScannerGroupUpdateRequest: + description: Update group request. + properties: + data: + $ref: '#/components/schemas/SensitiveDataScannerGroupUpdate' + meta: + $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + required: + - data + - meta + type: object + SensitiveDataScannerGroupUpdateResponse: + description: Update group response. + properties: + meta: + $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + type: object + SensitiveDataScannerMeta: + description: Meta response containing information about the API. + properties: + count_limit: + description: Maximum number of scanning rules allowed for the org. + format: int64 + type: integer + group_count_limit: + description: Maximum number of scanning groups allowed for the org. + format: int64 + type: integer + has_highlight_enabled: + description: Whether or not scanned events are highlighted in Logs or RUM + for the org. + type: boolean + is_pci_compliant: + description: Whether or not the org is compliant to the payment card industry + standard. + type: boolean + version: + description: Version of the API. + example: 0 + format: int64 + minimum: 0 + type: integer + type: object + SensitiveDataScannerMetaVersionOnly: + description: Meta payload containing information about the API. + properties: + version: + description: Version of the API (optional). + example: 0 + format: int64 + minimum: 0 + type: integer + type: object + SensitiveDataScannerProduct: + default: logs + description: Datadog product onto which Sensitive Data Scanner can be activated. + enum: + - logs + - rum + - events + - apm + type: string + x-enum-varnames: + - LOGS + - RUM + - EVENTS + - APM + SensitiveDataScannerReorderConfig: + description: Data related to the reordering of scanning groups. + properties: + id: + description: ID of the configuration. + type: string + relationships: + $ref: '#/components/schemas/SensitiveDataScannerConfigurationRelationships' + type: + $ref: '#/components/schemas/SensitiveDataScannerConfigurationType' + type: object + SensitiveDataScannerReorderGroupsResponse: + description: Group reorder response. + properties: + meta: + $ref: '#/components/schemas/SensitiveDataScannerMeta' + type: object + SensitiveDataScannerRule: + description: Rule item included in the group. + properties: + id: + description: ID of the rule. + type: string + type: + $ref: '#/components/schemas/SensitiveDataScannerRuleType' + type: object + SensitiveDataScannerRuleAttributes: + description: Attributes of the Sensitive Data Scanner rule. + properties: + description: + description: Description of the rule. + type: string + excluded_attributes: + description: Attributes excluded from the scan. + example: + - username + items: + type: string + type: array + is_enabled: + description: Whether or not the rule is enabled. + type: boolean + name: + description: Name of the rule. + type: string + pattern: + description: Not included if there is a relationship to a standard pattern. + type: string + tags: + description: List of tags. + items: + type: string + type: array + text_replacement: + $ref: '#/components/schemas/SensitiveDataScannerTextReplacement' + type: object + SensitiveDataScannerRuleCreate: + description: Data related to the creation of a rule. + properties: + attributes: + $ref: '#/components/schemas/SensitiveDataScannerRuleAttributes' + relationships: + $ref: '#/components/schemas/SensitiveDataScannerRuleRelationships' + type: + $ref: '#/components/schemas/SensitiveDataScannerRuleType' + required: + - type + - attributes + - relationships + type: object + SensitiveDataScannerRuleCreateRequest: + description: Create rule request. + properties: + data: + $ref: '#/components/schemas/SensitiveDataScannerRuleCreate' + meta: + $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + required: + - data + - meta + type: object + SensitiveDataScannerRuleData: + description: Rules included in the group. + properties: + data: + description: Rules included in the group. The order is important. + items: + $ref: '#/components/schemas/SensitiveDataScannerRule' + type: array + type: object + SensitiveDataScannerRuleDeleteRequest: + description: Delete rule request. + properties: + meta: + $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + required: + - meta + type: object + SensitiveDataScannerRuleDeleteResponse: + description: Delete rule response. + properties: + meta: + $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + type: object + SensitiveDataScannerRuleIncludedItem: + description: A Scanning Rule included item. + properties: + attributes: + $ref: '#/components/schemas/SensitiveDataScannerRuleAttributes' + id: + description: ID of the rule. + type: string + relationships: + $ref: '#/components/schemas/SensitiveDataScannerRuleRelationships' + type: + $ref: '#/components/schemas/SensitiveDataScannerRuleType' + type: object + SensitiveDataScannerRuleRelationships: + description: Relationships of a scanning rule. + properties: + group: + $ref: '#/components/schemas/SensitiveDataScannerGroupData' + standard_pattern: + $ref: '#/components/schemas/SensitiveDataScannerStandardPatternData' + type: object + SensitiveDataScannerRuleResponse: + description: Response data related to the creation of a rule. + properties: + attributes: + $ref: '#/components/schemas/SensitiveDataScannerRuleAttributes' + id: + description: ID of the rule. + type: string + relationships: + $ref: '#/components/schemas/SensitiveDataScannerRuleRelationships' + type: + $ref: '#/components/schemas/SensitiveDataScannerRuleType' + type: object + SensitiveDataScannerRuleType: + default: sensitive_data_scanner_rule + description: Sensitive Data Scanner rule type. + enum: + - sensitive_data_scanner_rule + example: sensitive_data_scanner_rule + type: string + x-enum-varnames: + - SENSITIVE_DATA_SCANNER_RULE + SensitiveDataScannerRuleUpdate: + description: Data related to the update of a rule. + properties: + attributes: + $ref: '#/components/schemas/SensitiveDataScannerRuleAttributes' + id: + description: ID of the rule. + type: string + relationships: + $ref: '#/components/schemas/SensitiveDataScannerRuleRelationships' + type: + $ref: '#/components/schemas/SensitiveDataScannerRuleType' + type: object + SensitiveDataScannerRuleUpdateRequest: + description: Update rule request. + properties: + data: + $ref: '#/components/schemas/SensitiveDataScannerRuleUpdate' + meta: + $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + required: + - data + - meta + type: object + SensitiveDataScannerRuleUpdateResponse: + description: Update rule response. + properties: + meta: + $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' + type: object + SensitiveDataScannerStandardPattern: + description: Data containing the standard pattern id. + properties: + id: + description: ID of the standard pattern. + type: string + type: + $ref: '#/components/schemas/SensitiveDataScannerStandardPatternType' + type: object + SensitiveDataScannerStandardPatternAttributes: + description: Attributes of the Sensitive Data Scanner standard pattern. + properties: + name: + description: Name of the standard pattern. + type: string + pattern: + description: Regex to match. + type: string + tags: + description: List of tags. + items: + type: string + type: array + type: object + SensitiveDataScannerStandardPatternData: + description: A standard pattern. + properties: + data: + $ref: '#/components/schemas/SensitiveDataScannerStandardPattern' + type: object + SensitiveDataScannerStandardPatternType: + default: sensitive_data_scanner_standard_pattern + description: Sensitive Data Scanner standard pattern type. + enum: + - sensitive_data_scanner_standard_pattern + example: sensitive_data_scanner_standard_pattern + type: string + x-enum-varnames: + - SENSITIVE_DATA_SCANNER_STANDARD_PATTERN + SensitiveDataScannerStandardPatternsResponse: + description: List Standard patterns response. + items: + $ref: '#/components/schemas/SensitiveDataScannerStandardPatternsResponseItem' + type: array + SensitiveDataScannerStandardPatternsResponseData: + description: List Standard patterns response data. + properties: + data: + $ref: '#/components/schemas/SensitiveDataScannerStandardPatternsResponse' + type: object + SensitiveDataScannerStandardPatternsResponseItem: + description: Standard pattern item. + properties: + attributes: + $ref: '#/components/schemas/SensitiveDataScannerStandardPatternAttributes' + id: + description: ID of the standard pattern. + type: string + type: + $ref: '#/components/schemas/SensitiveDataScannerStandardPatternType' + type: object + SensitiveDataScannerTextReplacement: + description: Object describing how the scanned event will be replaced. + properties: + number_of_chars: + description: 'Required if type == ''partial_replacement_from_beginning'' + + or ''partial_replacement_from_end''. It must be > 0.' + format: int64 + minimum: 0 + type: integer + replacement_string: + description: Required if type == 'replacement_string'. + type: string + type: + $ref: '#/components/schemas/SensitiveDataScannerTextReplacementType' + type: object + SensitiveDataScannerTextReplacementType: + default: none + description: 'Type of the replacement text. None means no replacement. + + hash means the data will be stubbed. replacement_string means that + + one can chose a text to replace the data. partial_replacement_from_beginning + + allows a user to partially replace the data from the beginning, and + + partial_replacement_from_end on the other hand, allows to replace data from + + the end.' + enum: + - none + - hash + - replacement_string + - partial_replacement_from_beginning + - partial_replacement_from_end + type: string + x-enum-varnames: + - NONE + - HASH + - REPLACEMENT_STRING + - PARTIAL_REPLACEMENT_FROM_BEGINNING + - PARTIAL_REPLACEMENT_FROM_END ServiceAccountCreateAttributes: description: Attributes of the created user. properties: email: description: The email of the user. @@ -15585,10 +16456,350 @@ $ref: '#/components/responses/TooManyRequestsResponse' summary: Change the triage state of a security signal tags: - Security Monitoring x-codegen-request-body-name: body + /api/v2/sensitive-data-scanner/config: + get: + description: List all the Scanning groups in your organization. + operationId: ListScanningGroups + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SensitiveDataScannerGetConfigResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Bad Request + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Authentication Error + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: List Scanning Groups + tags: + - Sensitive Data Scanner + patch: + description: Reorder the list of groups. + operationId: ReorderScanningGroups + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SensitiveDataScannerConfigRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SensitiveDataScannerReorderGroupsResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Bad Request + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Authentication Error + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Reorder Groups + tags: + - Sensitive Data Scanner + x-codegen-request-body-name: body + /api/v2/sensitive-data-scanner/config/groups: + post: + description: 'Create a scanning group. + + The request MAY include a configuration relationship. + + A rules relationship can be omitted entirely, but if it is included it MUST + be + + null or an empty array (rules cannot be created at the same time). + + The new group will be ordered last within the configuration.' + operationId: CreateScanningGroup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SensitiveDataScannerGroupCreateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SensitiveDataScannerCreateGroupResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Bad Request + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Authentication Error + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Create Scanning Group + tags: + - Sensitive Data Scanner + x-codegen-request-body-name: body + /api/v2/sensitive-data-scanner/config/groups/{group_id}: + delete: + description: Delete a given group. + operationId: DeleteScanningGroup + parameters: + - $ref: '#/components/parameters/SensitiveDataScannerGroupID' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SensitiveDataScannerGroupDeleteRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SensitiveDataScannerGroupDeleteResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Bad Request + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Authentication Error + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Delete Scanning Group + tags: + - Sensitive Data Scanner + x-codegen-request-body-name: body + patch: + description: 'Update a group, including the order of the rules. + + Rules within the group are reordered by including a rules relationship. If + the rules + + relationship is present, its data section MUST contain linkages for all of + the rules + + currently in the group, and MUST NOT contain any others.' + operationId: UpdateScanningGroup + parameters: + - $ref: '#/components/parameters/SensitiveDataScannerGroupID' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SensitiveDataScannerGroupUpdateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SensitiveDataScannerGroupUpdateResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Bad Request + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Authentication Error + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Update Scanning Group + tags: + - Sensitive Data Scanner + x-codegen-request-body-name: body + /api/v2/sensitive-data-scanner/config/rules: + post: + description: '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 standard_pattern relationship or a regex attribute, + but not both. + + If included_attributes is empty or missing, we will scan all attributes except + + excluded_attributes. If both are missing, we will scan the whole event.' + operationId: CreateScanningRule + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SensitiveDataScannerRuleCreateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SensitiveDataScannerCreateRuleResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Bad Request + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Authentication Error + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Create Scanning Rule + tags: + - Sensitive Data Scanner + x-codegen-request-body-name: body + /api/v2/sensitive-data-scanner/config/rules/{rule_id}: + delete: + description: Delete a given rule. + operationId: DeleteScanningRule + parameters: + - $ref: '#/components/parameters/SensitiveDataScannerRuleID' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SensitiveDataScannerRuleDeleteRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SensitiveDataScannerRuleDeleteResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Bad Request + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Authentication Error + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Delete Scanning Rule + tags: + - Sensitive Data Scanner + x-codegen-request-body-name: body + patch: + description: 'Update a scanning rule. + + The request body MUST NOT include a standard_pattern relationship, as that + relationship + + is non-editable. Trying to edit the regex attribute of a rule with a standard_pattern + + relationship will also result in an error.' + operationId: UpdateScanningRule + parameters: + - $ref: '#/components/parameters/SensitiveDataScannerRuleID' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SensitiveDataScannerRuleUpdateRequest' + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SensitiveDataScannerRuleUpdateResponse' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Bad Request + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Authentication Error + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: Update Scanning Rule + tags: + - Sensitive Data Scanner + x-codegen-request-body-name: body + /api/v2/sensitive-data-scanner/config/standard-patterns: + get: + description: Returns all standard patterns. + operationId: ListStandardPatterns + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/SensitiveDataScannerStandardPatternsResponseData' + description: OK + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Bad Request + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/APIErrorResponse' + description: Authentication Error + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + summary: List standard patterns + tags: + - Sensitive Data Scanner /api/v2/series: post: description: "The metrics end-point allows you to post time-series data that can be graphed on Datadog\u2019s dashboards.\nThe maximum payload size is 500 kilobytes (512000 bytes). Compressed payloads must have a decompressed @@ -16647,11 +17858,12 @@ `lambda_traced_invocations`, `logs`, `network_flows`, `network_hosts`, `observability_pipelines`, `online_archive`, `profiling`, `rum`, `rum_browser_sessions`, `rum_mobile_sessions`, `sds`, `snmp`, - `synthetics_api`, `synthetics_browser`, and `timeseries`.' + `synthetics_api`, `synthetics_browser`, `synthetics_parallel_testing`, and + `timeseries`.' in: query name: filter[product_families] required: true schema: type: string @@ -17388,9 +18600,12 @@ name: Roles - description: 'Detection rules for generating signals and listing of generated signals.' name: Security Monitoring +- description: Create, update, delete, and retrieve sensitive data scanner groups + and rules. + name: Sensitive Data Scanner - description: Create, edit, and disable service accounts. name: Service Accounts - description: API to create, update, retrieve and delete service definitions. externalDocs: url: https://docs.datadoghq.com/tracing/service_catalog/