How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Datadog Scanning API

The Scanning API from Datadog — 5 operation(s) for scanning.

Datadog Scanning API is one of 290 APIs that Datadog publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include Scanning. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an API reference, and 4 JSON Schemas.

This API exposes 7 operations across 5 paths, and defines 51 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against 3 base URLs: https://{subdomain}.{site}, {protocol}://{name}, https://{subdomain}.{site}.

7 operations 5 paths 51 schemas 2 DELETE1 GET2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://api.datadoghq.com
Authentication
OAuth 2.0, API Key, API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 4

Datadog Scanning API declares 4 security schemes for authenticating requests. It supports OAuth 2.0 (AuthZ) using the authorizationCode flow, exposing 68 scopes. An API key is passed in the header as DD-API-KEY (apiKeyAuth). An API key is passed in the header as DD-APPLICATION-KEY (appKeyAuth). It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • AuthZ — This API uses OAuth 2 with the implicit grant flow.
  • apiKeyAuth — Your Datadog API Key.
  • appKeyAuth — Your Datadog APP Key.

Paths & Operations 7

Across 5 paths, the API surfaces 7 operations — 2 DELETE, 1 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Scanning 7
GET
/api/v2/sensitive-data-scanner/config
Datadog List Scanning Groups
ListScanningGroups → 200400403429
POST
/api/v2/sensitive-data-scanner/config/groups
Datadog Create Scanning Group
CreateScanningGroup body → 200400403429
DELETE
/api/v2/sensitive-data-scanner/config/groups/{group_id}
Datadog Delete Scanning Group
DeleteScanningGroup 1 param body → 200400403404429
PATCH
/api/v2/sensitive-data-scanner/config/groups/{group_id}
Datadog Update Scanning Group
UpdateScanningGroup 1 param body → 200400403404429
POST
/api/v2/sensitive-data-scanner/config/rules
Datadog Create Scanning Rule
CreateScanningRule body → 200400403429
DELETE
/api/v2/sensitive-data-scanner/config/rules/{rule_id}
Datadog Delete Scanning Rule
DeleteScanningRule 1 param body → 200400403404429
PATCH
/api/v2/sensitive-data-scanner/config/rules/{rule_id}
Datadog Update Scanning Rule
UpdateScanningRule 1 param body → 200400403404429

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are SensitiveDataScannerRuleAttributes (10 properties), SensitiveDataScannerMeta (6 properties), SensitiveDataScannerGroupAttributes (5 properties), SensitiveDataScannerRuleIncludedItem (4 properties). Each schema is shown below with its type and property counts.

SensitiveDataScannerStandardPatternData
object
A standard pattern.
1 property
SensitiveDataScannerGroupUpdateResponse
object
Update group response.
1 property
SensitiveDataScannerStandardPattern
object
Data containing the standard pattern id.
2 properties
SensitiveDataScannerConfiguration
object
A Sensitive Data Scanner configuration.
2 properties
SensitiveDataScannerConfigurationData
object
A Sensitive Data Scanner configuration data.
1 property
SensitiveDataScannerGroupData
object
A scanning group data.
1 property
SensitiveDataScannerGroupDeleteResponse
object
Delete group response.
1 property
SensitiveDataScannerRuleDeleteResponse
object
Delete rule response.
1 property
SensitiveDataScannerGroupList
object
List of groups, ordered.
1 property
SensitiveDataScannerRuleUpdate
object
Data related to the update of a rule.
4 properties
SensitiveDataScannerMetaVersionOnly
object
Meta payload containing information about the API.
1 property
SensitiveDataScannerGroupUpdateRequest
object
Update group request.
2 properties 2 required
SensitiveDataScannerRuleCreate
object
Data related to the creation of a rule.
3 properties 3 required
SensitiveDataScannerMeta
object
Meta response containing information about the API.
6 properties
SensitiveDataScannerGroupIncludedItem
object
A Scanning Group included item.
4 properties
SensitiveDataScannerRuleData
object
Rules included in the group.
1 property
SensitiveDataScannerCreateGroupResponse
object
Create group response.
2 properties
SensitiveDataScannerGroupAttributes
object
Attributes of the Sensitive Data Scanner group.
5 properties
APIErrorResponse
object
API error response.
1 property 1 required
SensitiveDataScannerRuleDeleteRequest
object
Delete rule request.
1 property 1 required
SensitiveDataScannerRuleAttributes
object
Attributes of the Sensitive Data Scanner rule.
10 properties
SensitiveDataScannerTextReplacementType
string
Type of the replacement text. None means no replacement. hash means the data will be stubbed. replacementstring means that one can chose a text to replace the…
SensitiveDataScannerRuleRelationships
object
Relationships of a scanning rule.
2 properties
SensitiveDataScannerStandardPatternType
string
Sensitive Data Scanner standard pattern type.
SensitiveDataScannerGroupType
string
Sensitive Data Scanner group type.
SensitiveDataScannerGroupRelationships
object
Relationships of the group.
2 properties
SensitiveDataScannerGroupResponse
object
Response data related to the creation of a group.
4 properties
SensitiveDataScannerCreateRuleResponse
object
Create rule response.
2 properties
SensitiveDataScannerRuleResponse
object
Response data related to the creation of a rule.
4 properties
SensitiveDataScannerIncludedKeywordConfiguration
object
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 define…
3 properties 2 required
SensitiveDataScannerGetConfigResponse
object
Get all groups response.
3 properties
SensitiveDataScannerRuleCreateRequest
object
Create rule request.
2 properties 2 required
SensitiveDataScannerConfigurationType
string
Sensitive Data Scanner configuration type.
SensitiveDataScannerRuleUpdateResponse
object
Update rule response.
1 property
SensitiveDataScannerGroupCreateRequest
object
Create group request.
2 properties
SensitiveDataScannerGetConfigResponseData
object
Response data related to the scanning groups.
4 properties
SensitiveDataScannerGroupCreate
object
Data related to the creation of a group.
3 properties 2 required
SensitiveDataScannerProduct
string
Datadog product onto which Sensitive Data Scanner can be activated.
SensitiveDataScannerGroup
object
A scanning group.
2 properties
SensitiveDataScannerGetConfigIncludedItem
An object related to the configuration.
SensitiveDataScannerRule
object
Rule item included in the group.
2 properties
SensitiveDataScannerGroupItem
object
Data related to a Sensitive Data Scanner Group.
2 properties
SensitiveDataScannerGroupDeleteRequest
object
Delete group request.
1 property 1 required
SensitiveDataScannerRuleIncludedItem
object
A Scanning Rule included item.
4 properties
SensitiveDataScannerConfigurationRelationships
object
Relationships of the configuration.
1 property
SensitiveDataScannerRuleUpdateRequest
object
Update rule request.
2 properties 2 required
SensitiveDataScannerRuleType
string
Sensitive Data Scanner rule type.
SensitiveDataScannerTextReplacement
object
Object describing how the scanned event will be replaced.
3 properties
SensitiveDataScannerFilter
object
Filter for the Scanning Group.
1 property
SensitiveDataScannerGetConfigIncludedArray
array
Included objects from relationships.
SensitiveDataScannerGroupUpdate
object
Data related to the update of a group.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

datadog-scanning-api-openapi.yml Raw ↑

Other APIs Datadog publishes across the network.

Datadog Dashboards API
Datadog Synthetics API
Datadog Service Level Objectives API
Datadog Security Monitoring API
Datadog Service Definition API
Datadog Software Catalog API
Datadog Users API
Datadog Roles API
Datadog Key Management API
Datadog Organizations API
Datadog Downtimes API
Datadog RUM API
Where this information came from

This is an independent, third-party profile of Datadog Scanning API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.