Skip to content

Add spec for Agentless GetAwsScanOptions #31286

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Aug 28, 2025
Merged

Add spec for Agentless GetAwsScanOptions #31286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 21 additions & 9 deletions config/_default/menus/api.en.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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:
Expand Down
56 changes: 56 additions & 0 deletions content/en/api/v2/agentless-scanning/examples.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": "<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>Single AWS Scan Options entry.</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>"
},
"400": {
"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>"
},
"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>"
},
"404": {
"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": ""
}
},
"UpdateAwsScanOptions": {
"responses": {
"400": {
Expand Down
44 changes: 37 additions & 7 deletions data/api/v2/full_spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand All @@ -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
Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
Loading
Loading