diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml
index 57debb432d49d..96b4ba5901d1d 100644
--- a/config/_default/menus/api.en.yaml
+++ b/config/_default/menus/api.en.yaml
@@ -5083,7 +5083,7 @@ menu:
operationids:
- GetAwsOnDemandTask
unstable: []
- order: 6
+ order: 7
- name: Post an AWS on demand task
url: '#post-an-aws-on-demand-task'
identifier: agentless-scanning-post-an-aws-on-demand-task
@@ -5095,7 +5095,7 @@ menu:
operationids:
- CreateAwsOnDemandTask
unstable: []
- order: 7
+ order: 8
- name: Get AWS On Demand tasks
url: '#get-aws-on-demand-tasks'
identifier: agentless-scanning-get-aws-on-demand-tasks
@@ -5107,7 +5107,7 @@ menu:
operationids:
- ListAwsOnDemandTasks
unstable: []
- order: 5
+ order: 6
- name: Patch AWS Scan Options
url: '#patch-aws-scan-options'
identifier: agentless-scanning-patch-aws-scan-options
@@ -5119,7 +5119,19 @@ menu:
operationids:
- UpdateAwsScanOptions
unstable: []
- order: 3
+ order: 4
+ - 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:
+ - GetAwsScanOptions
+ unstable: []
+ order: 2
- name: Delete AWS Scan Options
url: '#delete-aws-scan-options'
identifier: agentless-scanning-delete-aws-scan-options
@@ -5131,7 +5143,7 @@ menu:
operationids:
- DeleteAwsScanOptions
unstable: []
- order: 4
+ order: 5
- name: Post AWS Scan Options
url: '#post-aws-scan-options'
identifier: agentless-scanning-post-aws-scan-options
@@ -5143,10 +5155,10 @@ menu:
operationids:
- CreateAwsScanOptions
unstable: []
- order: 2
- - name: Get AWS Scan Options
- url: '#get-aws-scan-options'
- identifier: agentless-scanning-get-aws-scan-options
+ order: 3
+ - name: List AWS Scan Options
+ url: '#list-aws-scan-options'
+ identifier: agentless-scanning-list-aws-scan-options
parent: agentless-scanning
generated: true
params:
diff --git a/content/en/api/v2/agentless-scanning/examples.json b/content/en/api/v2/agentless-scanning/examples.json
index d1fffbb943fc3..c0019fb3d88d6 100644
--- a/content/en/api/v2/agentless-scanning/examples.json
+++ b/content/en/api/v2/agentless-scanning/examples.json
@@ -160,6 +160,62 @@
"html": ""
}
},
+ "GetAwsScanOptions": {
+ "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
\n
Single AWS Scan Options entry.
\n
\n
\n
\n
\n
\n
\n
Attributes for the AWS scan options.
\n
\n
\n
\n
\n
\n
\n
Indicates if scanning of Lambda functions is enabled.
\n
\n \n
\n
\n
\n
\n
\n
\n
Indicates if scanning for sensitive data is enabled.
\n
\n \n
\n
\n
\n
\n
\n
\n
Indicates if scanning for vulnerabilities in containers is enabled.
\n
\n \n
\n
\n
\n
\n
\n
\n
Indicates if scanning for vulnerabilities in hosts is enabled.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
The ID of the AWS account.
\n
\n \n
\n
\n
\n
\n
\n
\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
"
+ },
+ "400": {
+ "json": {
+ "errors": [
+ "Bad Request"
+ ]
+ },
+ "html": ""
+ },
+ "403": {
+ "json": {
+ "errors": [
+ "Bad Request"
+ ]
+ },
+ "html": ""
+ },
+ "404": {
+ "json": {
+ "errors": [
+ "Bad Request"
+ ]
+ },
+ "html": ""
+ },
+ "429": {
+ "json": {
+ "errors": [
+ "Bad Request"
+ ]
+ },
+ "html": ""
+ }
+ },
+ "request": {
+ "json_curl": {},
+ "json": {},
+ "html": ""
+ }
+ },
"UpdateAwsScanOptions": {
"responses": {
"400": {
diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml
index a7a9cf9639bde..fa7600025c472 100644
--- a/data/api/v2/full_spec.yaml
+++ b/data/api/v2/full_spec.yaml
@@ -46889,9 +46889,13 @@ paths:
$ref: '#/components/responses/NotAuthorizedResponse'
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
- summary: Get AWS Scan Options
+ summary: List AWS Scan Options
tags:
- Agentless Scanning
+ x-given:
+ aws_scan_options:
+ source: data[0]
+ step: there is a valid "aws_scan_options" in the system
x-menu-order: 1
x-undo:
type: safe
@@ -46924,7 +46928,7 @@ paths:
tags:
- Agentless Scanning
x-codegen-request-body-name: body
- x-menu-order: 2
+ x-menu-order: 3
x-undo:
operationId: DeleteAwsScanOptions
parameters:
@@ -46951,9 +46955,35 @@ paths:
summary: Delete AWS Scan Options
tags:
- Agentless Scanning
- x-menu-order: 4
+ x-menu-order: 5
x-undo:
type: idempotent
+ get:
+ description: Fetches the Agentless scan options for an activated account.
+ operationId: GetAwsScanOptions
+ parameters:
+ - $ref: '#/components/parameters/AwsAccountId'
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AwsScanOptionsResponse'
+ description: OK
+ '400':
+ $ref: '#/components/responses/BadRequestResponse'
+ '403':
+ $ref: '#/components/responses/NotAuthorizedResponse'
+ '404':
+ $ref: '#/components/responses/NotFoundResponse'
+ '429':
+ $ref: '#/components/responses/TooManyRequestsResponse'
+ summary: Get AWS scan options
+ tags:
+ - Agentless Scanning
+ x-menu-order: 2
+ x-undo:
+ type: safe
patch:
description: Update the Agentless scan options for an activated account.
operationId: UpdateAwsScanOptions
@@ -46981,7 +47011,7 @@ paths:
tags:
- Agentless Scanning
x-codegen-request-body-name: body
- x-menu-order: 3
+ x-menu-order: 4
x-undo:
type: idempotent
/api/v2/agentless_scanning/ondemand/aws:
@@ -47002,7 +47032,7 @@ paths:
summary: Get AWS On Demand tasks
tags:
- Agentless Scanning
- x-menu-order: 5
+ x-menu-order: 6
x-permission:
operator: OR
permissions:
@@ -47038,7 +47068,7 @@ paths:
tags:
- Agentless Scanning
x-codegen-request-body-name: body
- x-menu-order: 7
+ x-menu-order: 8
x-permission:
operator: OR
permissions:
@@ -47069,7 +47099,7 @@ paths:
summary: Get AWS On Demand task by id
tags:
- Agentless Scanning
- x-menu-order: 6
+ x-menu-order: 7
x-permission:
operator: OR
permissions:
diff --git a/data/api/v2/full_spec_deref.json b/data/api/v2/full_spec_deref.json
index 251d585468501..588cae00adb86 100644
--- a/data/api/v2/full_spec_deref.json
+++ b/data/api/v2/full_spec_deref.json
@@ -359863,10 +359863,16 @@
"description": "Too many requests"
}
},
- "summary": "Get AWS Scan Options",
+ "summary": "List AWS Scan Options",
"tags": [
"Agentless Scanning"
],
+ "x-given": {
+ "aws_scan_options": {
+ "source": "data[0]",
+ "step": "there is a valid \"aws_scan_options\" in the system"
+ }
+ },
"x-menu-order": 1,
"x-undo": {
"type": "safe"
@@ -360133,7 +360139,7 @@
"Agentless Scanning"
],
"x-codegen-request-body-name": "body",
- "x-menu-order": 2,
+ "x-menu-order": 3,
"x-undo": {
"operationId": "DeleteAwsScanOptions",
"parameters": [
@@ -360283,11 +360289,211 @@
"tags": [
"Agentless Scanning"
],
- "x-menu-order": 4,
+ "x-menu-order": 5,
"x-undo": {
"type": "idempotent"
}
},
+ "get": {
+ "description": "Fetches the Agentless scan options for an activated account.",
+ "operationId": "GetAwsScanOptions",
+ "parameters": [
+ {
+ "description": "The ID of an AWS account.",
+ "example": "123456789012",
+ "in": "path",
+ "name": "account_id",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "description": "Response object that includes the scan options of an AWS account.",
+ "properties": {
+ "data": {
+ "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": "object"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "400": {
+ "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": "Bad Request"
+ },
+ "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"
+ },
+ "404": {
+ "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 Found"
+ },
+ "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": 2,
+ "x-undo": {
+ "type": "safe"
+ }
+ },
"patch": {
"description": "Update the Agentless scan options for an activated account.",
"operationId": "UpdateAwsScanOptions",
@@ -360496,7 +360702,7 @@
"Agentless Scanning"
],
"x-codegen-request-body-name": "body",
- "x-menu-order": 3,
+ "x-menu-order": 4,
"x-undo": {
"type": "idempotent"
}
@@ -360634,7 +360840,7 @@
"tags": [
"Agentless Scanning"
],
- "x-menu-order": 5,
+ "x-menu-order": 6,
"x-permission": {
"operator": "OR",
"permissions": [
@@ -360854,7 +361060,7 @@
"Agentless Scanning"
],
"x-codegen-request-body-name": "body",
- "x-menu-order": 7,
+ "x-menu-order": 8,
"x-permission": {
"operator": "OR",
"permissions": [
@@ -361062,7 +361268,7 @@
"tags": [
"Agentless Scanning"
],
- "x-menu-order": 6,
+ "x-menu-order": 7,
"x-permission": {
"operator": "OR",
"permissions": [
diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json
index eaa7cbee81550..c657d5a8185d0 100644
--- a/data/api/v2/translate_actions.json
+++ b/data/api/v2/translate_actions.json
@@ -37,7 +37,7 @@
},
"ListAwsScanOptions": {
"description": "Fetches the scan options configured for AWS accounts.",
- "summary": "Get AWS Scan Options"
+ "summary": "List AWS Scan Options"
},
"CreateAwsScanOptions": {
"description": "Activate Agentless scan options for an AWS account.",
@@ -49,6 +49,10 @@
"description": "Delete Agentless scan options for an AWS account.",
"summary": "Delete AWS Scan Options"
},
+ "GetAwsScanOptions": {
+ "description": "Fetches the Agentless scan options for an activated account.",
+ "summary": "Get AWS scan options"
+ },
"UpdateAwsScanOptions": {
"description": "Update the Agentless scan options for an activated account.",
"summary": "Patch AWS Scan Options",
diff --git a/static/resources/json/full_spec_v2.json b/static/resources/json/full_spec_v2.json
index 251d585468501..588cae00adb86 100644
--- a/static/resources/json/full_spec_v2.json
+++ b/static/resources/json/full_spec_v2.json
@@ -359863,10 +359863,16 @@
"description": "Too many requests"
}
},
- "summary": "Get AWS Scan Options",
+ "summary": "List AWS Scan Options",
"tags": [
"Agentless Scanning"
],
+ "x-given": {
+ "aws_scan_options": {
+ "source": "data[0]",
+ "step": "there is a valid \"aws_scan_options\" in the system"
+ }
+ },
"x-menu-order": 1,
"x-undo": {
"type": "safe"
@@ -360133,7 +360139,7 @@
"Agentless Scanning"
],
"x-codegen-request-body-name": "body",
- "x-menu-order": 2,
+ "x-menu-order": 3,
"x-undo": {
"operationId": "DeleteAwsScanOptions",
"parameters": [
@@ -360283,11 +360289,211 @@
"tags": [
"Agentless Scanning"
],
- "x-menu-order": 4,
+ "x-menu-order": 5,
"x-undo": {
"type": "idempotent"
}
},
+ "get": {
+ "description": "Fetches the Agentless scan options for an activated account.",
+ "operationId": "GetAwsScanOptions",
+ "parameters": [
+ {
+ "description": "The ID of an AWS account.",
+ "example": "123456789012",
+ "in": "path",
+ "name": "account_id",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "description": "Response object that includes the scan options of an AWS account.",
+ "properties": {
+ "data": {
+ "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": "object"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "400": {
+ "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": "Bad Request"
+ },
+ "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"
+ },
+ "404": {
+ "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 Found"
+ },
+ "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": 2,
+ "x-undo": {
+ "type": "safe"
+ }
+ },
"patch": {
"description": "Update the Agentless scan options for an activated account.",
"operationId": "UpdateAwsScanOptions",
@@ -360496,7 +360702,7 @@
"Agentless Scanning"
],
"x-codegen-request-body-name": "body",
- "x-menu-order": 3,
+ "x-menu-order": 4,
"x-undo": {
"type": "idempotent"
}
@@ -360634,7 +360840,7 @@
"tags": [
"Agentless Scanning"
],
- "x-menu-order": 5,
+ "x-menu-order": 6,
"x-permission": {
"operator": "OR",
"permissions": [
@@ -360854,7 +361060,7 @@
"Agentless Scanning"
],
"x-codegen-request-body-name": "body",
- "x-menu-order": 7,
+ "x-menu-order": 8,
"x-permission": {
"operator": "OR",
"permissions": [
@@ -361062,7 +361268,7 @@
"tags": [
"Agentless Scanning"
],
- "x-menu-order": 6,
+ "x-menu-order": 7,
"x-permission": {
"operator": "OR",
"permissions": [