Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CSM Agentless Read Endpoint #26834

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2024-12-18 19:25:02.274835",
"spec_repo_commit": "3f22290a"
"regenerated": "2024-12-19 11:47:21.950841",
"spec_repo_commit": "e2cc2df0"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-12-18 19:25:10.313331",
"spec_repo_commit": "3f22290a"
"regenerated": "2024-12-19 11:47:29.936490",
"spec_repo_commit": "e2cc2df0"
}
}
}
16 changes: 16 additions & 0 deletions config/_default/menus/api.en.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4503,6 +4503,22 @@ menu:
- ListApmRetentionFilters
unstable: []
order: 1
- name: Agentless Scanning
url: /api/latest/agentless-scanning/
identifier: agentless-scanning
generated: true
- name: Get AWS Scan Options
url: '#get-aws-scan-options'
identifier: agentless-scanning-get-aws-scan-options
parent: agentless-scanning
generated: true
params:
versions:
- v2
operationids:
- ListAwsScanOptions
unstable: []
order: 3
- name: Audit
url: /api/latest/audit/
identifier: audit
Expand Down
3 changes: 3 additions & 0 deletions content/en/api/latest/agentless-scanning/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Agentless Scanning
---
4 changes: 4 additions & 0 deletions content/en/api/v2/agentless-scanning/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Agentless Scanning
headless: true
---
44 changes: 44 additions & 0 deletions content/en/api/v2/agentless-scanning/examples.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
{
"ListAwsScanOptions": {
"responses": {
"200": {
"json": {
"data": [
{
"attributes": {
"lambda": true,
"sensitive_data": false,
"vuln_containers_os": true,
"vuln_host_os": true
},
"id": "184366314700",
"type": "aws_scan_options"
}
]
},
"html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> data</p>\n </div>\n <div class=\"col-2 column\"><p>[object]</p></div>\n <div class=\"col-6 column\"><p>A list of AWS scan options.</p></div>\n </div>\n <div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> attributes</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Attributes for the AWS scan options.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">lambda</p>\n </div>\n <div class=\"col-2 column\"><p>boolean</p></div>\n <div class=\"col-6 column\"><p>Indicates if scanning of Lambda functions is enabled.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">sensitive_data</p>\n </div>\n <div class=\"col-2 column\"><p>boolean</p></div>\n <div class=\"col-6 column\"><p>Indicates if scanning for sensitive data is enabled.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">vuln_containers_os</p>\n </div>\n <div class=\"col-2 column\"><p>boolean</p></div>\n <div class=\"col-6 column\"><p>Indicates if scanning for vulnerabilities in containers is enabled.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">vuln_host_os</p>\n </div>\n <div class=\"col-2 column\"><p>boolean</p></div>\n <div class=\"col-6 column\"><p>Indicates if scanning for vulnerabilities in hosts is enabled.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">id</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The ID of the AWS account.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>The type of the resource. The value should always be <code>aws_scan_options</code>. \nAllowed enum values: <code>aws_scan_options</code></p><p>default: <code>aws_scan_options</code></p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div></div>"
},
"403": {
"json": {
"errors": [
"Bad Request"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>"
},
"429": {
"json": {
"errors": [
"Bad Request"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors&nbsp;[<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>"
}
},
"request": {
"json_curl": {},
"json": {},
"html": ""
}
}
}
77 changes: 77 additions & 0 deletions data/api/v2/full_spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2525,6 +2525,57 @@ components:
$ref: '#/components/schemas/AwsCURConfig'
type: array
type: object
AwsScanOptionsAttributes:
description: Attributes for the AWS scan options.
properties:
lambda:
description: Indicates if scanning of Lambda functions is enabled.
example: true
type: boolean
sensitive_data:
description: Indicates if scanning for sensitive data is enabled.
example: false
type: boolean
vuln_containers_os:
description: Indicates if scanning for vulnerabilities in containers is
enabled.
example: true
type: boolean
vuln_host_os:
description: Indicates if scanning for vulnerabilities in hosts is enabled.
example: true
type: boolean
type: object
AwsScanOptionsData:
description: Single AWS Scan Options entry.
properties:
attributes:
$ref: '#/components/schemas/AwsScanOptionsAttributes'
id:
description: The ID of the AWS account.
example: '184366314700'
type: string
type:
$ref: '#/components/schemas/AwsScanOptionsType'
type: object
AwsScanOptionsResponse:
description: Response object that includes a list of AWS scan options.
properties:
data:
description: A list of AWS scan options.
items:
$ref: '#/components/schemas/AwsScanOptionsData'
type: array
type: object
AwsScanOptionsType:
default: aws_scan_options
description: The type of the resource. The value should always be `aws_scan_options`.
enum:
- aws_scan_options
example: aws_scan_options
type: string
x-enum-varnames:
- AWS_SCAN_OPTIONS
AzureUCConfig:
description: Azure config.
properties:
Expand Down Expand Up @@ -28696,6 +28747,27 @@ info:
version: '1.0'
openapi: 3.0.0
paths:
/api/v2/agentless_scanning/accounts/aws:
get:
description: Fetches the scan options configured for AWS accounts.
operationId: ListAwsScanOptions
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AwsScanOptionsResponse'
description: OK
'403':
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
summary: Get AWS Scan Options
tags:
- Agentless Scanning
x-menu-order: 3
x-undo:
type: safe
/api/v2/api_keys:
get:
description: List all API keys available for your account.
Expand Down Expand Up @@ -48613,6 +48685,11 @@ tags:
externalDocs:
url: https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection
name: AWS Logs Integration
- description: "Datadog Agentless Scanning provides visibility into risks and vulnerabilities\nwithin
your hosts, running containers, and serverless functions\u2014all without\nrequiring
teams to install Agents on every host or where Agents cannot be installed.\nGo
to https://www.datadoghq.com/blog/agentless-scanning/ to learn more"
name: Agentless Scanning
- description: Search your Audit Logs events over HTTP.
name: Audit
- description: '[The AuthN Mappings API](https://docs.datadoghq.com/account_management/authn_mapping/?tab=example)
Expand Down
Loading
Loading