Skip to content

Commit 43d74d4

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Document Agentless AWS scan options routes (#2077)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent d8fc554 commit 43d74d4

File tree

45 files changed

+2072
-30
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+2072
-30
lines changed

‎.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2025-02-28 17:49:21.359177",
8-
"spec_repo_commit": "59e6a448"
7+
"regenerated": "2025-03-03 16:04:31.676955",
8+
"spec_repo_commit": "c17ef1e9"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-02-28 17:49:21.374722",
13-
"spec_repo_commit": "59e6a448"
12+
"regenerated": "2025-03-03 16:04:31.692385",
13+
"spec_repo_commit": "c17ef1e9"
1414
}
1515
}
1616
}

‎.generator/schemas/v2/openapi.yaml

Lines changed: 165 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,14 @@ components:
162162
required: true
163163
schema:
164164
type: string
165+
AwsAccountId:
166+
description: The ID of an AWS account.
167+
example: '123456789012'
168+
in: path
169+
name: account_id
170+
required: true
171+
schema:
172+
type: string
165173
CaseIDPathParameter:
166174
description: Case's UUID or key
167175
example: f98a5a5b-e0ff-45d4-b2f5-afe6e74de504
@@ -1742,6 +1750,10 @@ components:
17421750
type: string
17431751
type: array
17441752
type: object
1753+
AccountId:
1754+
description: The ID of the AWS account.
1755+
example: '184366314700'
1756+
type: string
17451757
ActionConnectionAttributes:
17461758
description: The definition of `ActionConnectionAttributes` object.
17471759
properties:
@@ -2879,6 +2891,10 @@ components:
28792891
type: string
28802892
x-enum-varnames:
28812893
- AUTHN_MAPPINGS
2894+
AwsAccountId:
2895+
description: The ID of an AWS account.
2896+
example: '123456789012'
2897+
type: string
28822898
AwsCURConfig:
28832899
description: AWS CUR config.
28842900
properties:
@@ -3104,6 +3120,28 @@ components:
31043120
example: true
31053121
type: boolean
31063122
type: object
3123+
AwsScanOptionsCreateData:
3124+
description: Object for the scan options of a single AWS account.
3125+
properties:
3126+
attributes:
3127+
$ref: '#/components/schemas/AwsScanOptionsAttributes'
3128+
id:
3129+
$ref: '#/components/schemas/AwsAccountId'
3130+
type:
3131+
$ref: '#/components/schemas/AwsScanOptionsType'
3132+
required:
3133+
- id
3134+
- attributes
3135+
- type
3136+
type: object
3137+
AwsScanOptionsCreateRequest:
3138+
description: Request object that includes the scan options to create.
3139+
properties:
3140+
data:
3141+
$ref: '#/components/schemas/AwsScanOptionsCreateData'
3142+
required:
3143+
- data
3144+
type: object
31073145
AwsScanOptionsData:
31083146
description: Single AWS Scan Options entry.
31093147
properties:
@@ -3116,7 +3154,7 @@ components:
31163154
type:
31173155
$ref: '#/components/schemas/AwsScanOptionsType'
31183156
type: object
3119-
AwsScanOptionsResponse:
3157+
AwsScanOptionsListResponse:
31203158
description: Response object that includes a list of AWS scan options.
31213159
properties:
31223160
data:
@@ -3125,6 +3163,12 @@ components:
31253163
$ref: '#/components/schemas/AwsScanOptionsData'
31263164
type: array
31273165
type: object
3166+
AwsScanOptionsResponse:
3167+
description: Response object that includes the scan options of an AWS account.
3168+
properties:
3169+
data:
3170+
$ref: '#/components/schemas/AwsScanOptionsData'
3171+
type: object
31283172
AwsScanOptionsType:
31293173
default: aws_scan_options
31303174
description: The type of the resource. The value should always be `aws_scan_options`.
@@ -3134,6 +3178,48 @@ components:
31343178
type: string
31353179
x-enum-varnames:
31363180
- AWS_SCAN_OPTIONS
3181+
AwsScanOptionsUpdateAttributes:
3182+
description: Attributes for the AWS scan options to update.
3183+
properties:
3184+
lambda:
3185+
description: Indicates if scanning of Lambda functions is enabled.
3186+
example: true
3187+
type: boolean
3188+
sensitive_data:
3189+
description: Indicates if scanning for sensitive data is enabled.
3190+
example: false
3191+
type: boolean
3192+
vuln_containers_os:
3193+
description: Indicates if scanning for vulnerabilities in containers is
3194+
enabled.
3195+
example: true
3196+
type: boolean
3197+
vuln_host_os:
3198+
description: Indicates if scanning for vulnerabilities in hosts is enabled.
3199+
example: true
3200+
type: boolean
3201+
type: object
3202+
AwsScanOptionsUpdateData:
3203+
description: Object for the scan options of a single AWS account.
3204+
properties:
3205+
attributes:
3206+
$ref: '#/components/schemas/AwsScanOptionsUpdateAttributes'
3207+
id:
3208+
$ref: '#/components/schemas/AccountId'
3209+
type:
3210+
$ref: '#/components/schemas/AwsScanOptionsType'
3211+
required:
3212+
- attributes
3213+
- type
3214+
type: object
3215+
AwsScanOptionsUpdateRequest:
3216+
description: Request object that includes the scan options to update.
3217+
properties:
3218+
data:
3219+
$ref: '#/components/schemas/AwsScanOptionsUpdateData'
3220+
required:
3221+
- data
3222+
type: object
31373223
AzureUCConfig:
31383224
description: Azure config.
31393225
properties:
@@ -32639,7 +32725,7 @@ paths:
3263932725
content:
3264032726
application/json:
3264132727
schema:
32642-
$ref: '#/components/schemas/AwsScanOptionsResponse'
32728+
$ref: '#/components/schemas/AwsScanOptionsListResponse'
3264332729
description: OK
3264432730
'403':
3264532731
$ref: '#/components/responses/NotAuthorizedResponse'
@@ -32648,6 +32734,82 @@ paths:
3264832734
summary: Get AWS Scan Options
3264932735
tags:
3265032736
- Agentless Scanning
32737+
post:
32738+
description: Activate Agentless scan options for an AWS account.
32739+
operationId: CreateAwsScanOptions
32740+
requestBody:
32741+
content:
32742+
application/json:
32743+
schema:
32744+
$ref: '#/components/schemas/AwsScanOptionsCreateRequest'
32745+
description: The definition of the new scan options.
32746+
required: true
32747+
responses:
32748+
'201':
32749+
content:
32750+
application/json:
32751+
schema:
32752+
$ref: '#/components/schemas/AwsScanOptionsResponse'
32753+
description: Agentless scan options enabled successfully.
32754+
'400':
32755+
$ref: '#/components/responses/BadRequestResponse'
32756+
'403':
32757+
$ref: '#/components/responses/NotAuthorizedResponse'
32758+
'409':
32759+
$ref: '#/components/responses/ConflictResponse'
32760+
'429':
32761+
$ref: '#/components/responses/TooManyRequestsResponse'
32762+
summary: Post AWS Scan Options
32763+
tags:
32764+
- Agentless Scanning
32765+
x-codegen-request-body-name: body
32766+
/api/v2/agentless_scanning/accounts/aws/{account_id}:
32767+
delete:
32768+
description: Delete Agentless scan options for an AWS account.
32769+
operationId: DeleteAwsScanOptions
32770+
parameters:
32771+
- $ref: '#/components/parameters/AwsAccountId'
32772+
responses:
32773+
'204':
32774+
description: No Content
32775+
'400':
32776+
$ref: '#/components/responses/BadRequestResponse'
32777+
'403':
32778+
$ref: '#/components/responses/NotAuthorizedResponse'
32779+
'404':
32780+
$ref: '#/components/responses/NotFoundResponse'
32781+
'429':
32782+
$ref: '#/components/responses/TooManyRequestsResponse'
32783+
summary: Delete AWS Scan Options
32784+
tags:
32785+
- Agentless Scanning
32786+
patch:
32787+
description: Update the Agentless scan options for an activated account.
32788+
operationId: UpdateAwsScanOptions
32789+
parameters:
32790+
- $ref: '#/components/parameters/AwsAccountId'
32791+
requestBody:
32792+
content:
32793+
application/json:
32794+
schema:
32795+
$ref: '#/components/schemas/AwsScanOptionsUpdateRequest'
32796+
description: New definition of the scan options.
32797+
required: true
32798+
responses:
32799+
'204':
32800+
description: No Content
32801+
'400':
32802+
$ref: '#/components/responses/BadRequestResponse'
32803+
'403':
32804+
$ref: '#/components/responses/NotAuthorizedResponse'
32805+
'404':
32806+
$ref: '#/components/responses/NotFoundResponse'
32807+
'429':
32808+
$ref: '#/components/responses/TooManyRequestsResponse'
32809+
summary: Patch AWS Scan Options
32810+
tags:
32811+
- Agentless Scanning
32812+
x-codegen-request-body-name: body
3265132813
/api/v2/api_keys:
3265232814
get:
3265332815
description: List all API keys available for your account.
@@ -51408,7 +51570,7 @@ tags:
5140851570
- description: "Datadog Agentless Scanning provides visibility into risks and vulnerabilities\nwithin
5140951571
your hosts, running containers, and serverless functions\u2014all without\nrequiring
5141051572
teams to install Agents on every host or where Agents cannot be installed.\nGo
51411-
to https://www.datadoghq.com/blog/agentless-scanning/ to learn more"
51573+
to https://www.datadoghq.com/blog/agentless-scanning/ to learn more."
5141251574
name: Agentless Scanning
5141351575
- description: Datadog App Builder provides a low-code solution to rapidly develop
5141451576
and integrate secure, customized applications into your monitoring stack that

‎cassettes/v2/Agentless-Scanning_730042230/Create-AWS-Scan-Options-returns-Bad-Request-response_2511578425/frozen.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2025-02-27T17:01:48.802Z"

‎cassettes/v2/Agentless-Scanning_730042230/Create-AWS-Scan-Options-returns-Bad-Request-response_2511578425/recording.har

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
{
2+
"log": {
3+
"_recordingName": "Agentless Scanning/Create AWS Scan Options returns \"Bad Request\" response",
4+
"creator": {
5+
"comment": "persister:fs",
6+
"name": "Polly.JS",
7+
"version": "6.0.5"
8+
},
9+
"entries": [
10+
{
11+
"_id": "cda837416ea852c80a5c04b219ec4b12",
12+
"_order": 0,
13+
"cache": {},
14+
"request": {
15+
"bodySize": 152,
16+
"cookies": [],
17+
"headers": [
18+
{
19+
"_fromType": "array",
20+
"name": "accept",
21+
"value": "application/json"
22+
},
23+
{
24+
"_fromType": "array",
25+
"name": "content-type",
26+
"value": "application/json"
27+
}
28+
],
29+
"headersSize": 586,
30+
"httpVersion": "HTTP/1.1",
31+
"method": "POST",
32+
"postData": {
33+
"mimeType": "application/json",
34+
"params": [],
35+
"text": "{\"data\":{\"attributes\":{\"lambda\":true,\"sensitive_data\":false,\"vuln_containers_os\":true,\"vuln_host_os\":true},\"id\":\"184366314700\",\"type\":\"incorrect_type\"}}"
36+
},
37+
"queryString": [],
38+
"url": "https://api.datadoghq.com/api/v2/agentless_scanning/accounts/aws"
39+
},
40+
"response": {
41+
"bodySize": 127,
42+
"content": {
43+
"mimeType": "application/vnd.api+json",
44+
"size": 127,
45+
"text": "{\"errors\":[{\"status\":\"400\",\"title\":\"Bad Request\",\"detail\":\"got type \\\"incorrect_type\\\" expected one of \\\"aws_scan_options\\\"\"}]}"
46+
},
47+
"cookies": [],
48+
"headers": [
49+
{
50+
"name": "content-type",
51+
"value": "application/vnd.api+json"
52+
}
53+
],
54+
"headersSize": 525,
55+
"httpVersion": "HTTP/1.1",
56+
"redirectURL": "",
57+
"status": 400,
58+
"statusText": "Bad Request"
59+
},
60+
"startedDateTime": "2025-02-27T17:01:48.815Z",
61+
"time": 402
62+
}
63+
],
64+
"pages": [],
65+
"version": "1.2"
66+
}
67+
}

‎cassettes/v2/Agentless-Scanning_730042230/Delete-AWS-Scan-Options-returns-Bad-Request-response_1307074554/frozen.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2025-03-01T20:02:07.570Z"

‎cassettes/v2/Agentless-Scanning_730042230/Delete-AWS-Scan-Options-returns-Bad-Request-response_1307074554/recording.har

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
{
2+
"log": {
3+
"_recordingName": "Agentless Scanning/Delete AWS Scan Options returns \"Bad Request\" response",
4+
"creator": {
5+
"comment": "persister:fs",
6+
"name": "Polly.JS",
7+
"version": "6.0.5"
8+
},
9+
"entries": [
10+
{
11+
"_id": "d3b4d0d95fe695978cf77021c515a8c1",
12+
"_order": 0,
13+
"cache": {},
14+
"request": {
15+
"bodySize": 0,
16+
"cookies": [],
17+
"headers": [
18+
{
19+
"_fromType": "array",
20+
"name": "accept",
21+
"value": "*/*"
22+
}
23+
],
24+
"headersSize": 534,
25+
"httpVersion": "HTTP/1.1",
26+
"method": "DELETE",
27+
"queryString": [],
28+
"url": "https://api.datadoghq.com/api/v2/agentless_scanning/accounts/aws/incorrectId"
29+
},
30+
"response": {
31+
"bodySize": 131,
32+
"content": {
33+
"mimeType": "application/vnd.api+json",
34+
"size": 131,
35+
"text": "{\"errors\":[{\"title\":\"Generic Error\",\"detail\":\"missing or invalid url parameter 'accountId', expected uuid format '123456789012'\"}]}"
36+
},
37+
"cookies": [],
38+
"headers": [
39+
{
40+
"name": "content-type",
41+
"value": "application/vnd.api+json"
42+
}
43+
],
44+
"headersSize": 525,
45+
"httpVersion": "HTTP/1.1",
46+
"redirectURL": "",
47+
"status": 400,
48+
"statusText": "Bad Request"
49+
},
50+
"startedDateTime": "2025-03-01T20:02:07.578Z",
51+
"time": 497
52+
}
53+
],
54+
"pages": [],
55+
"version": "1.2"
56+
}
57+
}

‎cassettes/v2/Agentless-Scanning_730042230/Delete-AWS-Scan-Options-returns-Not-Found-response_173237737/frozen.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2025-03-01T20:02:08.096Z"

0 commit comments

Comments
 (0)