From b35b5e6cd4b529b3d9583f57dd3be969cd6de05c Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Thu, 19 Dec 2024 11:47:40 +0000 Subject: [PATCH] Regenerate client from commit e2cc2df0 of spec repo --- .apigentools-info | 8 +- config/_default/menus/api.en.yaml | 16 + .../api/latest/agentless-scanning/_index.md | 3 + .../en/api/v2/agentless-scanning/_index.md | 4 + .../api/v2/agentless-scanning/examples.json | 44 +++ data/api/v2/full_spec.yaml | 77 +++++ data/api/v2/full_spec_deref.json | 288 ++++++++++++++++++ data/api/v2/translate_actions.json | 4 + data/api/v2/translate_tags.json | 4 + static/resources/json/full_spec_v2.json | 288 ++++++++++++++++++ 10 files changed, 732 insertions(+), 4 deletions(-) create mode 100644 content/en/api/latest/agentless-scanning/_index.md create mode 100644 content/en/api/v2/agentless-scanning/_index.md create mode 100644 content/en/api/v2/agentless-scanning/examples.json diff --git a/.apigentools-info b/.apigentools-info index d34818655d012..b82b0eebe80c4 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -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" } } } \ No newline at end of file diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 87f11e69a7abc..67410b80dcd00 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -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 diff --git a/content/en/api/latest/agentless-scanning/_index.md b/content/en/api/latest/agentless-scanning/_index.md new file mode 100644 index 0000000000000..24fe396979c17 --- /dev/null +++ b/content/en/api/latest/agentless-scanning/_index.md @@ -0,0 +1,3 @@ +--- +title: Agentless Scanning +--- diff --git a/content/en/api/v2/agentless-scanning/_index.md b/content/en/api/v2/agentless-scanning/_index.md new file mode 100644 index 0000000000000..ec1b1b73b89fe --- /dev/null +++ b/content/en/api/v2/agentless-scanning/_index.md @@ -0,0 +1,4 @@ +--- +title: Agentless Scanning +headless: true +--- diff --git a/content/en/api/v2/agentless-scanning/examples.json b/content/en/api/v2/agentless-scanning/examples.json new file mode 100644 index 0000000000000..17ee84caa423a --- /dev/null +++ b/content/en/api/v2/agentless-scanning/examples.json @@ -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": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

A list of AWS scan options.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

Attributes for the AWS scan options.

\n
\n
\n
\n
\n
\n

lambda

\n
\n

boolean

\n

Indicates if scanning of Lambda functions is enabled.

\n
\n \n
\n
\n
\n
\n
\n

sensitive_data

\n
\n

boolean

\n

Indicates if scanning for sensitive data is enabled.

\n
\n \n
\n
\n
\n
\n
\n

vuln_containers_os

\n
\n

boolean

\n

Indicates if scanning for vulnerabilities in containers is enabled.

\n
\n \n
\n
\n
\n
\n
\n

vuln_host_os

\n
\n

boolean

\n

Indicates if scanning for vulnerabilities in hosts is enabled.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the AWS account.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be aws_scan_options. \nAllowed enum values: aws_scan_options

default: aws_scan_options

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + } +} \ No newline at end of file diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index b6aa21a697afb..a8e42cb3e87c8 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -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: @@ -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. @@ -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) diff --git a/data/api/v2/full_spec_deref.json b/data/api/v2/full_spec_deref.json index 8346f32612283..a672a34b27192 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -12868,6 +12868,152 @@ }, "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": { + "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" + }, + "id": { + "description": "The ID of the AWS account.", + "example": "184366314700", + "type": "string" + }, + "type": { + "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" + ] + } + }, + "type": "object" + }, + "AwsScanOptionsResponse": { + "description": "Response object that includes a list of AWS scan options.", + "properties": { + "data": { + "description": "A list of AWS scan options.", + "items": { + "description": "Single AWS Scan Options entry.", + "properties": { + "attributes": { + "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" + }, + "id": { + "description": "The ID of the AWS account.", + "example": "184366314700", + "type": "string" + }, + "type": { + "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" + ] + } + }, + "type": "object" + }, + "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": { @@ -187392,6 +187538,144 @@ }, "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": { + "description": "Response object that includes a list of AWS scan options.", + "properties": { + "data": { + "description": "A list of AWS scan options.", + "items": { + "description": "Single AWS Scan Options entry.", + "properties": { + "attributes": { + "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" + }, + "id": { + "description": "The ID of the AWS account.", + "example": "184366314700", + "type": "string" + }, + "type": { + "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" + ] + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "403": { + "content": { + "application/json": { + "schema": { + "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" + } + } + }, + "description": "Not Authorized" + }, + "429": { + "content": { + "application/json": { + "schema": { + "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" + } + } + }, + "description": "Too many requests" + } + }, + "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.", @@ -363988,6 +364272,10 @@ }, "name": "AWS Logs Integration" }, + { + "description": "Datadog Agentless Scanning provides visibility into risks and vulnerabilities\nwithin your hosts, running containers, and serverless functions—all 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" diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index bc14264f87c55..a01b32a7c960b 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -1,4 +1,8 @@ { + "ListAwsScanOptions": { + "description": "Fetches the scan options configured for AWS accounts.", + "summary": "Get AWS Scan Options" + }, "ListAPIKeys": { "description": "List all API keys available for your account.", "summary": "Get all API keys" diff --git a/data/api/v2/translate_tags.json b/data/api/v2/translate_tags.json index 40a8ed3dcdd78..d0cc253e00e94 100644 --- a/data/api/v2/translate_tags.json +++ b/data/api/v2/translate_tags.json @@ -15,6 +15,10 @@ "name": "AWS Logs Integration", "description": "Configure your Datadog-AWS-Logs integration directly through Datadog API.\nFor more information, see the [AWS integration page](https://docs.datadoghq.com/integrations/amazon_web_services/#log-collection)." }, + "agentless-scanning": { + "name": "Agentless Scanning", + "description": "Datadog Agentless Scanning provides visibility into risks and vulnerabilities\nwithin your hosts, running containers, and serverless functions—all 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" + }, "audit": { "name": "Audit", "description": "Search your Audit Logs events over HTTP." diff --git a/static/resources/json/full_spec_v2.json b/static/resources/json/full_spec_v2.json index 8346f32612283..a672a34b27192 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -12868,6 +12868,152 @@ }, "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": { + "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" + }, + "id": { + "description": "The ID of the AWS account.", + "example": "184366314700", + "type": "string" + }, + "type": { + "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" + ] + } + }, + "type": "object" + }, + "AwsScanOptionsResponse": { + "description": "Response object that includes a list of AWS scan options.", + "properties": { + "data": { + "description": "A list of AWS scan options.", + "items": { + "description": "Single AWS Scan Options entry.", + "properties": { + "attributes": { + "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" + }, + "id": { + "description": "The ID of the AWS account.", + "example": "184366314700", + "type": "string" + }, + "type": { + "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" + ] + } + }, + "type": "object" + }, + "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": { @@ -187392,6 +187538,144 @@ }, "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": { + "description": "Response object that includes a list of AWS scan options.", + "properties": { + "data": { + "description": "A list of AWS scan options.", + "items": { + "description": "Single AWS Scan Options entry.", + "properties": { + "attributes": { + "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" + }, + "id": { + "description": "The ID of the AWS account.", + "example": "184366314700", + "type": "string" + }, + "type": { + "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" + ] + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "403": { + "content": { + "application/json": { + "schema": { + "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" + } + } + }, + "description": "Not Authorized" + }, + "429": { + "content": { + "application/json": { + "schema": { + "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" + } + } + }, + "description": "Too many requests" + } + }, + "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.", @@ -363988,6 +364272,10 @@ }, "name": "AWS Logs Integration" }, + { + "description": "Datadog Agentless Scanning provides visibility into risks and vulnerabilities\nwithin your hosts, running containers, and serverless functions—all 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"