openapi: 3.0.0 info: contact: email: support@datadoghq.com name: Datadog Support url: https://www.datadoghq.com/support/ description: The Datadog API is an HTTP REST API. The API uses resource-oriented URLs to call the API, uses status codes to indicate the success or failure of requests, returns JSON from all requests, and uses standard HTTP response codes. Use the Datadog API to access the Datadog platform programmatically. title: Datadog Account Scanning API version: '1.0' servers: - url: https://{subdomain}.{site} variables: site: default: datadoghq.com description: The regional site for Datadog customers. enum: - datadoghq.com - us3.datadoghq.com - us5.datadoghq.com - ap1.datadoghq.com - datadoghq.eu - ddog-gov.com subdomain: default: api description: The subdomain where the API is deployed. - url: '{protocol}://{name}' variables: name: default: api.datadoghq.com description: Full site DNS name. protocol: default: https description: The protocol for accessing the API. - url: https://{subdomain}.{site} variables: site: default: datadoghq.com description: Any Datadog deployment. subdomain: default: api description: The subdomain where the API is deployed. security: - apiKeyAuth: [] appKeyAuth: [] tags: - name: Scanning paths: /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: Datadog List Scanning Groups tags: - Scanning x-given: configuration: step: a valid "configuration" in the system x-menu-order: 1 x-permission: operator: OR permissions: - data_scanner_read x-undo: type: safe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /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: Datadog Create Scanning Group tags: - Scanning x-codegen-request-body-name: body x-given: group: parameters: - name: body value: "{\n \"data\": {\n \"type\": \"sensitive_data_scanner_group\",\n \"attributes\": {\n \"name\": \"my-test-group\",\n \"is_enabled\": false,\n \"product_list\": [\n \"logs\"\n ],\n \"filter\": {\n \"query\": \"*\"\n }\n },\n \"relationships\": {\n \"configuration\": {\n \"data\": {\n \"id\": \"{{ configuration.data.id }}\",\n \"type\": \"{{ configuration.data.type }}\"\n }\n },\n \"rules\": {\n \"data\": []\n }\n }\n },\n \"meta\": {}\n}" step: there is a valid "scanning_group" in the system x-menu-order: 4 x-permission: operator: OR permissions: - data_scanner_write x-undo: operationId: DeleteScanningGroup parameters: - name: group_id source: data.id - name: body template: "{\n \"meta\": {}\n}" type: unsafe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /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 '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Delete Scanning Group tags: - Scanning x-codegen-request-body-name: body x-menu-order: 6 x-permission: operator: OR permissions: - data_scanner_write x-undo: type: idempotent x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK 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 '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Update Scanning Group tags: - Scanning x-codegen-request-body-name: body x-menu-order: 5 x-permission: operator: OR permissions: - data_scanner_write x-undo: type: idempotent x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /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: Datadog Create Scanning Rule tags: - Scanning x-codegen-request-body-name: body x-given: rule: parameters: - name: body value: "{\n \"data\": {\n \"type\": \"sensitive_data_scanner_rule\",\n \"attributes\": {\n \"name\": \"{{ unique }}\",\n \"pattern\": \"pattern\",\n \"namespaces\": [\"admin.email\"],\n \"text_replacement\": {\n \"type\": \"none\"\n },\n \"tags\":[\n \"sensitive_data:true\"\n ],\n \"is_enabled\":true\n },\n \"relationships\": {\n \"group\": {\n \"data\": {\n \"id\": \"{{ group.data.id }}\",\n \"type\": \"{{ group.data.type }}\"\n }\n }\n }\n },\n \"meta\": {}\n}" step: the "scanning_group" has a "scanning_rule" x-menu-order: 7 x-permission: operator: OR permissions: - data_scanner_write x-undo: operationId: DeleteScanningRule parameters: - name: rule_id source: data.id - name: body template: "{\n \"meta\": {}\n}" type: unsafe x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /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 '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Delete Scanning Rule tags: - Scanning x-codegen-request-body-name: body x-menu-order: 9 x-permission: operator: OR permissions: - data_scanner_write x-undo: type: idempotent x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK 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 '404': $ref: '#/components/responses/NotFoundResponse' '429': $ref: '#/components/responses/TooManyRequestsResponse' summary: Datadog Update Scanning Rule tags: - Scanning x-codegen-request-body-name: body x-menu-order: 8 x-permission: operator: OR permissions: - data_scanner_write x-undo: type: idempotent x-api-evangelist-processing: PascalCaseOperationSummaries: true ChooseTags: true x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: SensitiveDataScannerStandardPatternData: description: A standard pattern. properties: data: $ref: '#/components/schemas/SensitiveDataScannerStandardPattern' type: object SensitiveDataScannerGroupUpdateResponse: description: Update group 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 example: abc-123-def type: $ref: '#/components/schemas/SensitiveDataScannerStandardPatternType' type: object SensitiveDataScannerConfiguration: description: A Sensitive Data Scanner configuration. properties: id: description: ID of the configuration. type: string example: abc-123-def type: $ref: '#/components/schemas/SensitiveDataScannerConfigurationType' type: object SensitiveDataScannerConfigurationData: description: A Sensitive Data Scanner configuration data. properties: data: $ref: '#/components/schemas/SensitiveDataScannerConfiguration' type: object SensitiveDataScannerGroupData: description: A scanning group data. properties: data: $ref: '#/components/schemas/SensitiveDataScannerGroup' type: object SensitiveDataScannerGroupDeleteResponse: description: Delete group response. properties: meta: $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' type: object SensitiveDataScannerRuleDeleteResponse: description: Delete rule response. properties: meta: $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' 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 SensitiveDataScannerRuleUpdate: description: Data related to the update of a rule. properties: attributes: $ref: '#/components/schemas/SensitiveDataScannerRuleAttributes' id: description: ID of the rule. type: string example: abc-123-def relationships: $ref: '#/components/schemas/SensitiveDataScannerRuleRelationships' type: $ref: '#/components/schemas/SensitiveDataScannerRuleType' 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 SensitiveDataScannerGroupUpdateRequest: description: Update group request. properties: data: $ref: '#/components/schemas/SensitiveDataScannerGroupUpdate' meta: $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' required: - data - meta 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 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 example: 42 group_count_limit: description: Maximum number of scanning groups allowed for the org. format: int64 type: integer example: 42 has_highlight_enabled: default: true deprecated: true description: (Deprecated) Whether or not scanned events are highlighted in Logs or RUM for the org. type: boolean example: true has_multi_pass_enabled: deprecated: true description: (Deprecated) Whether or not scanned events have multi-pass enabled. type: boolean example: true is_pci_compliant: description: Whether or not the org is compliant to the payment card industry standard. type: boolean example: true version: description: Version of the API. example: 0 format: int64 minimum: 0 type: integer type: object SensitiveDataScannerGroupIncludedItem: description: A Scanning Group included item. properties: attributes: $ref: '#/components/schemas/SensitiveDataScannerGroupAttributes' id: description: ID of the group. type: string example: abc-123-def relationships: $ref: '#/components/schemas/SensitiveDataScannerGroupRelationships' type: $ref: '#/components/schemas/SensitiveDataScannerGroupType' 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 SensitiveDataScannerCreateGroupResponse: description: Create group response. properties: data: $ref: '#/components/schemas/SensitiveDataScannerGroupResponse' meta: $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' type: object SensitiveDataScannerGroupAttributes: description: Attributes of the Sensitive Data Scanner group. properties: description: description: Description of the group. type: string example: example_value filter: $ref: '#/components/schemas/SensitiveDataScannerFilter' is_enabled: description: Whether or not the group is enabled. type: boolean example: true name: description: Name of the group. type: string example: Example Monitor product_list: description: List of products the scanning group applies. items: $ref: '#/components/schemas/SensitiveDataScannerProduct' type: array type: object APIErrorResponse: description: API error response. properties: errors: description: A list of errors. example: - Bad Request items: description: A list of items. example: Bad Request type: string type: array required: - errors type: object SensitiveDataScannerRuleDeleteRequest: description: Delete rule request. properties: meta: $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' required: - meta type: object SensitiveDataScannerRuleAttributes: description: Attributes of the Sensitive Data Scanner rule. properties: description: description: Description of the rule. type: string example: example_value excluded_namespaces: description: Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array. example: - admin.name items: type: string type: array included_keyword_configuration: $ref: '#/components/schemas/SensitiveDataScannerIncludedKeywordConfiguration' is_enabled: description: Whether or not the rule is enabled. type: boolean example: true name: description: Name of the rule. type: string example: Example Monitor namespaces: description: 'Attributes included in the scan. If namespaces is empty or missing, all attributes except excluded_namespaces are scanned. If both are missing the whole event is scanned.' example: - admin items: type: string type: array pattern: description: Not included if there is a relationship to a standard pattern. type: string example: example_value priority: description: Integer from 1 (high) to 5 (low) indicating rule issue severity. format: int64 maximum: 5 minimum: 1 type: integer example: 42 tags: description: List of tags. items: type: string type: array text_replacement: $ref: '#/components/schemas/SensitiveDataScannerTextReplacement' 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 SensitiveDataScannerRuleRelationships: description: Relationships of a scanning rule. properties: group: $ref: '#/components/schemas/SensitiveDataScannerGroupData' standard_pattern: $ref: '#/components/schemas/SensitiveDataScannerStandardPatternData' 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 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 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 example: abc-123-def relationships: $ref: '#/components/schemas/SensitiveDataScannerGroupRelationships' type: $ref: '#/components/schemas/SensitiveDataScannerGroupType' type: object SensitiveDataScannerCreateRuleResponse: description: Create rule response. properties: data: $ref: '#/components/schemas/SensitiveDataScannerRuleResponse' meta: $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' 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 example: abc-123-def relationships: $ref: '#/components/schemas/SensitiveDataScannerRuleRelationships' type: $ref: '#/components/schemas/SensitiveDataScannerRuleType' type: object SensitiveDataScannerIncludedKeywordConfiguration: description: 'Object defining a set of keywords and a number of characters that help reduce noise. You can provide a list of keywords you would like to check within a defined proximity of the matching pattern. If any of the keywords are found within the proximity check, the match is kept. If none are found, the match is discarded.' properties: character_count: description: 'The number of characters behind a match detected by Sensitive Data Scanner to look for the keywords defined. `character_count` should be greater than the maximum length of a keyword defined for a rule.' example: 30 format: int64 maximum: 50 minimum: 1 type: integer keywords: description: 'Keyword list that will be checked during scanning in order to validate a match. The number of keywords in the list must be less than or equal to 30.' example: - credit card - cc items: type: string type: array use_recommended_keywords: description: 'Should the rule use the underlying standard pattern keyword configuration. If set to `true`, the rule must be tied to a standard pattern. If set to `false`, the specified keywords and `character_count` are applied.' type: boolean example: true required: - keywords - character_count 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 SensitiveDataScannerRuleCreateRequest: description: Create rule request. properties: data: $ref: '#/components/schemas/SensitiveDataScannerRuleCreate' meta: $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' required: - data - meta 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 SensitiveDataScannerRuleUpdateResponse: description: Update rule response. properties: meta: $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' type: object SensitiveDataScannerGroupCreateRequest: description: Create group request. properties: data: $ref: '#/components/schemas/SensitiveDataScannerGroupCreate' meta: $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' type: object SensitiveDataScannerGetConfigResponseData: description: Response data related to the scanning groups. properties: attributes: additionalProperties: {} description: Attributes of the Sensitive Data configuration. type: object id: description: ID of the configuration. type: string example: abc-123-def relationships: $ref: '#/components/schemas/SensitiveDataScannerConfigurationRelationships' type: $ref: '#/components/schemas/SensitiveDataScannerConfigurationType' 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 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 SensitiveDataScannerGroup: description: A scanning group. properties: id: description: ID of the group. type: string example: abc-123-def type: $ref: '#/components/schemas/SensitiveDataScannerGroupType' type: object SensitiveDataScannerGetConfigIncludedItem: description: An object related to the configuration. oneOf: - $ref: '#/components/schemas/SensitiveDataScannerRuleIncludedItem' - $ref: '#/components/schemas/SensitiveDataScannerGroupIncludedItem' SensitiveDataScannerRule: description: Rule item included in the group. properties: id: description: ID of the rule. type: string example: abc-123-def type: $ref: '#/components/schemas/SensitiveDataScannerRuleType' type: object SensitiveDataScannerGroupItem: description: Data related to a Sensitive Data Scanner Group. properties: id: description: ID of the group. type: string example: abc-123-def type: $ref: '#/components/schemas/SensitiveDataScannerGroupType' type: object SensitiveDataScannerGroupDeleteRequest: description: Delete group request. properties: meta: $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' required: - meta type: object SensitiveDataScannerRuleIncludedItem: description: A Scanning Rule included item. properties: attributes: $ref: '#/components/schemas/SensitiveDataScannerRuleAttributes' id: description: ID of the rule. type: string example: abc-123-def relationships: $ref: '#/components/schemas/SensitiveDataScannerRuleRelationships' type: $ref: '#/components/schemas/SensitiveDataScannerRuleType' type: object SensitiveDataScannerConfigurationRelationships: description: Relationships of the configuration. properties: groups: $ref: '#/components/schemas/SensitiveDataScannerGroupList' type: object SensitiveDataScannerRuleUpdateRequest: description: Update rule request. properties: data: $ref: '#/components/schemas/SensitiveDataScannerRuleUpdate' meta: $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly' required: - data - meta 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 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 example: 42 replacement_string: description: Required if type == 'replacement_string'. type: string example: example_value type: $ref: '#/components/schemas/SensitiveDataScannerTextReplacementType' type: object SensitiveDataScannerFilter: description: Filter for the Scanning Group. properties: query: description: Query to filter the events. type: string example: avg:system.cpu.user{*} type: object SensitiveDataScannerGetConfigIncludedArray: description: Included objects from relationships. items: $ref: '#/components/schemas/SensitiveDataScannerGetConfigIncludedItem' type: array SensitiveDataScannerGroupUpdate: description: Data related to the update of a group. properties: attributes: $ref: '#/components/schemas/SensitiveDataScannerGroupAttributes' id: description: ID of the group. type: string example: abc-123-def relationships: $ref: '#/components/schemas/SensitiveDataScannerGroupRelationships' type: $ref: '#/components/schemas/SensitiveDataScannerGroupType' type: object parameters: SensitiveDataScannerRuleID: description: The ID of the rule. 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 responses: TooManyRequestsResponse: content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Too many requests NotFoundResponse: content: application/json: schema: $ref: '#/components/schemas/APIErrorResponse' description: Not Found securitySchemes: AuthZ: description: This API uses OAuth 2 with the implicit grant flow. flows: authorizationCode: authorizationUrl: /oauth2/v1/authorize scopes: apm_api_catalog_read: View API catalog and API definitions. apm_api_catalog_write: Add, modify, and delete API catalog definitions. apm_read: Read and query APM and Trace Analytics. apm_service_catalog_read: View service catalog and service definitions. apm_service_catalog_write: Add, modify, and delete service catalog definitions when those definitions are maintained by Datadog. appsec_vm_read: View infrastructure, application code, and library vulnerabilities. This does not restrict API or inventory SQL access to the vulnerability data source. cases_read: View Cases. cases_write: Create and update cases. ci_visibility_pipelines_write: Create CI Visibility pipeline spans using the API. ci_visibility_read: View CI Visibility. cloud_cost_management_read: View Cloud Cost pages and the cloud cost data source in dashboards and notebooks. For more details, see the Cloud Cost Management docs. cloud_cost_management_write: Configure cloud cost accounts and global customizations. For more details, see the Cloud Cost Management docs. code_analysis_read: View Code Analysis. continuous_profiler_pgo_read: Read and query Continuous Profiler data for Profile-Guided Optimization (PGO). create_webhooks: Create webhooks integrations. dashboards_embed_share: Create, modify, and delete shared dashboards with share type 'embed'. dashboards_invite_share: Create, modify, and delete shared dashboards with share type 'invite'. dashboards_public_share: Generate public and authenticated links to share dashboards or embeddable graphs externally. dashboards_read: View dashboards. dashboards_write: Create and change dashboards. data_scanner_read: View Data Scanner configurations. data_scanner_write: Edit Data Scanner configurations. embeddable_graphs_share: Generate public links to share embeddable graphs externally. events_read: Read Events data. hosts_read: List hosts and their attributes. incident_notification_settings_write: Configure Incidents Notification settings. incident_read: View incidents in Datadog. incident_settings_write: Configure Incident Settings. incident_write: Create, view, and manage incidents in Datadog. metrics_read: View custom metrics. monitor_config_policy_write: Edit and delete monitor configuration. monitors_downtime: Set downtimes to suppress alerts from any monitor in an organization. Mute and unmute monitors. The ability to write monitors is not required to set downtimes. monitors_read: View monitors. monitors_write: Edit, delete, and resolve individual monitors. org_management: Edit org configurations, including authentication and certain security preferences such as configuring SAML, renaming an org, configuring allowed login methods, creating child orgs, subscribing & unsubscribing from apps in the marketplace, and enabling & disabling Remote Configuration for the entire organization. security_comments_read: Read comments of vulnerabilities. security_monitoring_filters_read: Read Security Filters. security_monitoring_filters_write: Create, edit, and delete Security Filters. security_monitoring_findings_read: View a list of findings that include both misconfigurations and identity risks. security_monitoring_notification_profiles_read: View Rule Security Notification rules. security_monitoring_notification_profiles_write: Create, edit, and delete Security Notification rules. security_monitoring_rules_read: Read Detection Rules. security_monitoring_rules_write: Create and edit Detection Rules. security_monitoring_signals_read: View Security Signals. security_monitoring_suppressions_read: Read Rule Suppressions. security_monitoring_suppressions_write: Write Rule Suppressions. security_pipelines_read: View Security Pipelines. security_pipelines_write: Create, edit, and delete CSM Security Pipelines. slos_corrections: Apply, edit, and delete SLO status corrections. A user with this permission can make status corrections, even if they do not have permission to edit those SLOs. slos_read: View SLOs and status corrections. slos_write: Create, edit, and delete SLOs. synthetics_global_variable_read: View, search, and use Synthetics global variables. synthetics_global_variable_write: Create, edit, and delete global variables for Synthetics. synthetics_private_location_read: View, search, and use Synthetics private locations. synthetics_private_location_write: Create and delete private locations in addition to having access to the associated installation guidelines. synthetics_read: List and view configured Synthetic tests and test results. synthetics_write: Create, edit, and delete Synthetic tests. teams_manage: Manage Teams. Create, delete, rename, and edit metadata of all Teams. To control Team membership across all Teams, use the User Access Manage permission. teams_read: Read Teams data. A User with this permission can view Team names, metadata, and which Users are on each Team. test_optimization_read: View Test Optimization. timeseries_query: Query Timeseries data. usage_read: View your organization's usage and usage attribution. user_access_invite: Invite other users to your organization. user_access_manage: Disable users, manage user roles, manage SAML-to-role mappings, and configure logs restriction queries. user_access_read: View users and their roles and settings. workflows_read: View workflows. workflows_run: Run workflows. workflows_write: Create, edit, and delete workflows. tokenUrl: /oauth2/v1/token type: oauth2 apiKeyAuth: description: Your Datadog API Key. in: header name: DD-API-KEY type: apiKey x-env-name: DD_API_KEY appKeyAuth: description: Your Datadog APP Key. in: header name: DD-APPLICATION-KEY type: apiKey x-env-name: DD_APP_KEY bearerAuth: scheme: bearer type: http x-env-name: DD_BEARER_TOKEN x-group-parameters: true x-merge-override: paths: false