diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index d7b09e372dced..17a350ea671f7 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -5311,7 +5311,7 @@ menu: operationids: - GetAwsOnDemandTask unstable: [] - order: 7 + order: 18 - name: Post an AWS on demand task url: '#post-an-aws-on-demand-task' identifier: agentless-scanning-post-an-aws-on-demand-task @@ -5323,7 +5323,7 @@ menu: operationids: - CreateAwsOnDemandTask unstable: [] - order: 8 + order: 17 - name: Get AWS On Demand tasks url: '#get-aws-on-demand-tasks' identifier: agentless-scanning-get-aws-on-demand-tasks @@ -5335,7 +5335,67 @@ menu: operationids: - ListAwsOnDemandTasks unstable: [] - order: 6 + order: 16 + - name: Patch GCP Scan Options + url: '#patch-gcp-scan-options' + identifier: agentless-scanning-patch-gcp-scan-options + parent: agentless-scanning + generated: true + params: + versions: + - v2 + operationids: + - UpdateGcpScanOptions + unstable: [] + order: 14 + - name: Get GCP scan options + url: '#get-gcp-scan-options' + identifier: agentless-scanning-get-gcp-scan-options + parent: agentless-scanning + generated: true + params: + versions: + - v2 + operationids: + - GetGcpScanOptions + unstable: [] + order: 13 + - name: Delete GCP Scan Options + url: '#delete-gcp-scan-options' + identifier: agentless-scanning-delete-gcp-scan-options + parent: agentless-scanning + generated: true + params: + versions: + - v2 + operationids: + - DeleteGcpScanOptions + unstable: [] + order: 15 + - name: Post GCP Scan Options + url: '#post-gcp-scan-options' + identifier: agentless-scanning-post-gcp-scan-options + parent: agentless-scanning + generated: true + params: + versions: + - v2 + operationids: + - CreateGcpScanOptions + unstable: [] + order: 12 + - name: List GCP Scan Options + url: '#list-gcp-scan-options' + identifier: agentless-scanning-list-gcp-scan-options + parent: agentless-scanning + generated: true + params: + versions: + - v2 + operationids: + - ListGcpScanOptions + unstable: [] + order: 11 - name: Update azure scan options url: '#update-azure-scan-options' identifier: agentless-scanning-update-azure-scan-options @@ -5348,6 +5408,18 @@ menu: - UpdateAzureScanOptions unstable: [] order: 9 + - name: Get Azure scan options + url: '#get-azure-scan-options' + identifier: agentless-scanning-get-azure-scan-options + parent: agentless-scanning + generated: true + params: + versions: + - v2 + operationids: + - GetAzureScanOptions + unstable: [] + order: 8 - name: Delete azure scan options url: '#delete-azure-scan-options' identifier: agentless-scanning-delete-azure-scan-options @@ -5371,7 +5443,7 @@ menu: operationids: - CreateAzureScanOptions unstable: [] - order: 11 + order: 7 - name: List azure scan options url: '#list-azure-scan-options' identifier: agentless-scanning-list-azure-scan-options @@ -5383,7 +5455,7 @@ menu: operationids: - ListAzureScanOptions unstable: [] - order: 12 + order: 6 - name: Patch AWS Scan Options url: '#patch-aws-scan-options' identifier: agentless-scanning-patch-aws-scan-options @@ -5407,7 +5479,7 @@ menu: operationids: - GetAwsScanOptions unstable: [] - order: 2 + order: 3 - name: Delete AWS Scan Options url: '#delete-aws-scan-options' identifier: agentless-scanning-delete-aws-scan-options @@ -5431,7 +5503,7 @@ menu: operationids: - CreateAwsScanOptions unstable: [] - order: 3 + order: 2 - name: List AWS Scan Options url: '#list-aws-scan-options' identifier: agentless-scanning-list-aws-scan-options diff --git a/content/en/api/v2/agentless-scanning/examples.json b/content/en/api/v2/agentless-scanning/examples.json index f8337d99541d4..971d2afb1d251 100644 --- a/content/en/api/v2/agentless-scanning/examples.json +++ b/content/en/api/v2/agentless-scanning/examples.json @@ -289,7 +289,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The AzureScanOptionsArray data.

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

attributes

\n
\n

object

\n

The definition of AzureScanOptionsDataAttributes object.

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

vuln_containers_os

\n
\n

boolean

\n

The attributes vuln_containers_os.

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

vuln_host_os

\n
\n

boolean

\n

The attributes vuln_host_os.

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

id [required]

\n
\n

string

\n

The AzureScanOptionsData id.

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

type [required]

\n
\n

enum

\n

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

default: azure_scan_options

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

A list of Azure scan options.

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

attributes

\n
\n

object

\n

Attributes for Azure scan options configuration.

\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 [required]

\n
\n

string

\n

The Azure subscription ID.

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

type [required]

\n
\n

enum

\n

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

default: azure_scan_options

\n
\n \n
\n
\n
\n
" }, "429": { "json": { @@ -319,7 +319,7 @@ "type": "azure_scan_options" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of AzureScanOptionsData object.

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

attributes

\n
\n

object

\n

The definition of AzureScanOptionsDataAttributes object.

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

vuln_containers_os

\n
\n

boolean

\n

The attributes vuln_containers_os.

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

vuln_host_os

\n
\n

boolean

\n

The attributes vuln_host_os.

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

id [required]

\n
\n

string

\n

The AzureScanOptionsData id.

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

type [required]

\n
\n

enum

\n

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

default: azure_scan_options

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Single Azure scan options entry.

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

attributes

\n
\n

object

\n

Attributes for Azure scan options configuration.

\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 [required]

\n
\n

string

\n

The Azure subscription ID.

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

type [required]

\n
\n

enum

\n

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

default: azure_scan_options

\n
\n \n
\n
\n
\n
" }, "429": { "json": { @@ -347,7 +347,7 @@ "type": "azure_scan_options" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of AzureScanOptionsData object.

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

attributes

\n
\n

object

\n

The definition of AzureScanOptionsDataAttributes object.

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

vuln_containers_os

\n
\n

boolean

\n

The attributes vuln_containers_os.

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

vuln_host_os

\n
\n

boolean

\n

The attributes vuln_host_os.

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

id [required]

\n
\n

string

\n

The AzureScanOptionsData id.

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

type [required]

\n
\n

enum

\n

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

default: azure_scan_options

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Single Azure scan options entry.

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

attributes

\n
\n

object

\n

Attributes for Azure scan options configuration.

\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 [required]

\n
\n

string

\n

The Azure subscription ID.

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

type [required]

\n
\n

enum

\n

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

default: azure_scan_options

\n
\n \n
\n
\n
\n
" } }, "DeleteAzureScanOptions": { @@ -367,6 +367,60 @@ "html": "" } }, + "GetAzureScanOptions": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "12345678-90ab-cdef-1234-567890abcdef", + "type": "azure_scan_options" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Single Azure scan options entry.

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

attributes

\n
\n

object

\n

Attributes for Azure scan options configuration.

\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 [required]

\n
\n

string

\n

The Azure subscription ID.

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

type [required]

\n
\n

enum

\n

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

default: azure_scan_options

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\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
" + }, + "404": { + "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": "" + } + }, "UpdateAzureScanOptions": { "responses": { "200": { @@ -380,7 +434,7 @@ "type": "azure_scan_options" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of AzureScanOptionsData object.

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

attributes

\n
\n

object

\n

The definition of AzureScanOptionsDataAttributes object.

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

vuln_containers_os

\n
\n

boolean

\n

The attributes vuln_containers_os.

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

vuln_host_os

\n
\n

boolean

\n

The attributes vuln_host_os.

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

id [required]

\n
\n

string

\n

The AzureScanOptionsData id.

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

type [required]

\n
\n

enum

\n

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

default: azure_scan_options

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Single Azure scan options entry.

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

attributes

\n
\n

object

\n

Attributes for Azure scan options configuration.

\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 [required]

\n
\n

string

\n

The Azure subscription ID.

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

type [required]

\n
\n

enum

\n

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

default: azure_scan_options

\n
\n \n
\n
\n
\n
" }, "429": { "json": { @@ -394,7 +448,7 @@ "request": { "json_curl": { "data": { - "id": "", + "id": "12345678-90ab-cdef-1234-567890abcdef", "type": "azure_scan_options" } }, @@ -404,11 +458,282 @@ "vuln_containers_os": false, "vuln_host_os": false }, - "id": "", + "id": "12345678-90ab-cdef-1234-567890abcdef", "type": "azure_scan_options" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of AzureScanOptionsInputUpdateData object.

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

attributes

\n
\n

object

\n

The definition of AzureScanOptionsInputUpdateDataAttributes object.

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

vuln_containers_os

\n
\n

boolean

\n

The attributes vuln_containers_os.

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

vuln_host_os

\n
\n

boolean

\n

The attributes vuln_host_os.

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

id [required]

\n
\n

string

\n

The AzureScanOptionsInputUpdateData id.

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

type [required]

\n
\n

enum

\n

Azure scan options resource type. \nAllowed enum values: azure_scan_options

default: azure_scan_options

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data object for updating the scan options of a single Azure subscription.

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

attributes

\n
\n

object

\n

Attributes for updating Azure scan options configuration.

\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 [required]

\n
\n

string

\n

The Azure subscription ID.

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

type [required]

\n
\n

enum

\n

Azure scan options resource type. \nAllowed enum values: azure_scan_options

default: azure_scan_options

\n
\n \n
\n
\n
\n
" + } + }, + "ListGcpScanOptions": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "company-project-id", + "type": "gcp_scan_options" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

A list of GCP scan options.

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

attributes

\n
\n

object

\n

Attributes for GCP scan options configuration.

\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 [required]

\n
\n

string

\n

The GCP project ID.

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

type [required]

\n
\n

enum

\n

GCP scan options resource type. \nAllowed enum values: gcp_scan_options

default: gcp_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": "" + } + }, + "CreateGcpScanOptions": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "company-project-id", + "type": "gcp_scan_options" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Single GCP scan options entry.

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

attributes

\n
\n

object

\n

Attributes for GCP scan options configuration.

\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 [required]

\n
\n

string

\n

The GCP project ID.

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

type [required]

\n
\n

enum

\n

GCP scan options resource type. \nAllowed enum values: gcp_scan_options

default: gcp_scan_options

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\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
" + }, + "409": { + "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": { + "data": { + "id": "", + "type": "gcp_scan_options" + } + }, + "json": { + "data": { + "attributes": { + "vuln_containers_os": false, + "vuln_host_os": false + }, + "id": "", + "type": "gcp_scan_options" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Single GCP scan options entry.

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

attributes

\n
\n

object

\n

Attributes for GCP scan options configuration.

\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 [required]

\n
\n

string

\n

The GCP project ID.

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

type [required]

\n
\n

enum

\n

GCP scan options resource type. \nAllowed enum values: gcp_scan_options

default: gcp_scan_options

\n
\n \n
\n
\n
\n
" + } + }, + "DeleteGcpScanOptions": { + "responses": { + "400": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\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
" + }, + "404": { + "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": "" + } + }, + "GetGcpScanOptions": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "company-project-id", + "type": "gcp_scan_options" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Single GCP scan options entry.

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

attributes

\n
\n

object

\n

Attributes for GCP scan options configuration.

\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 [required]

\n
\n

string

\n

The GCP project ID.

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

type [required]

\n
\n

enum

\n

GCP scan options resource type. \nAllowed enum values: gcp_scan_options

default: gcp_scan_options

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\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
" + }, + "404": { + "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": "" + } + }, + "UpdateGcpScanOptions": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "company-project-id", + "type": "gcp_scan_options" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Single GCP scan options entry.

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

attributes

\n
\n

object

\n

Attributes for GCP scan options configuration.

\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 [required]

\n
\n

string

\n

The GCP project ID.

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

type [required]

\n
\n

enum

\n

GCP scan options resource type. \nAllowed enum values: gcp_scan_options

default: gcp_scan_options

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

errors [required]

\n
\n

[string]

\n

A list of errors.

\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
" + }, + "404": { + "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": { + "data": { + "id": "", + "type": "gcp_scan_options" + } + }, + "json": { + "data": { + "attributes": { + "vuln_containers_os": false, + "vuln_host_os": false + }, + "id": "", + "type": "gcp_scan_options" + } + }, + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data object for updating the scan options of a single GCP project.

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

attributes

\n
\n

object

\n

Attributes for updating GCP scan options configuration.

\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 [required]

\n
\n

string

\n

The GCP project ID.

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

type [required]

\n
\n

enum

\n

GCP scan options resource type. \nAllowed enum values: gcp_scan_options

default: gcp_scan_options

\n
\n \n
\n
\n
\n
" } }, "ListAwsOnDemandTasks": { diff --git a/content/en/api/v2/agentless-scanning/request.CreateGcpScanOptions.json b/content/en/api/v2/agentless-scanning/request.CreateGcpScanOptions.json new file mode 100644 index 0000000000000..234ae994bad59 --- /dev/null +++ b/content/en/api/v2/agentless-scanning/request.CreateGcpScanOptions.json @@ -0,0 +1,10 @@ +{ + "data": { + "id": "new-project", + "type": "gcp_scan_options", + "attributes": { + "vuln_host_os": true, + "vuln_containers_os": true + } + } +} \ No newline at end of file diff --git a/content/en/api/v2/agentless-scanning/request.UpdateGcpScanOptions.json b/content/en/api/v2/agentless-scanning/request.UpdateGcpScanOptions.json new file mode 100644 index 0000000000000..8a441eefaac98 --- /dev/null +++ b/content/en/api/v2/agentless-scanning/request.UpdateGcpScanOptions.json @@ -0,0 +1,9 @@ +{ + "data": { + "id": "api-spec-test", + "type": "gcp_scan_options", + "attributes": { + "vuln_containers_os": false + } + } +} \ No newline at end of file diff --git a/data/api/v2/CodeExamples.json b/data/api/v2/CodeExamples.json index a5e4c11e49e64..714db289acdbf 100644 --- a/data/api/v2/CodeExamples.json +++ b/data/api/v2/CodeExamples.json @@ -119,6 +119,20 @@ "description": "Patch AWS Scan Options returns \"No Content\" response" } ], + "UpdateGcpScanOptions": [ + { + "group": "agentless_scanning", + "suffix": "", + "description": "Patch GCP Scan Options returns \"OK\" response" + } + ], + "CreateGcpScanOptions": [ + { + "group": "agentless_scanning", + "suffix": "", + "description": "Post GCP Scan Options returns \"Agentless scan options enabled successfully.\" response" + } + ], "CreateAwsOnDemandTask": [ { "group": "agentless_scanning", diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 7e22b6d67da5a..be6b1bebe58fc 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -6061,7 +6061,7 @@ components: - type type: object AzureScanOptions: - description: The definition of `AzureScanOptions` object. + description: Response object containing Azure scan options for a single subscription. example: data: attributes: @@ -6074,7 +6074,7 @@ components: $ref: '#/components/schemas/AzureScanOptionsData' type: object AzureScanOptionsArray: - description: The definition of `AzureScanOptionsArray` object. + description: Response object containing a list of Azure scan options. example: data: - attributes: @@ -6084,7 +6084,7 @@ components: type: azure_scan_options properties: data: - description: The `AzureScanOptionsArray` `data`. + description: A list of Azure scan options. items: $ref: '#/components/schemas/AzureScanOptionsData' type: array @@ -6092,12 +6092,12 @@ components: - data type: object AzureScanOptionsData: - description: The definition of `AzureScanOptionsData` object. + description: Single Azure scan options entry. properties: attributes: $ref: '#/components/schemas/AzureScanOptionsDataAttributes' id: - description: The `AzureScanOptionsData` `id`. + description: The Azure subscription ID. example: '' type: string type: @@ -6107,13 +6107,14 @@ components: - id type: object AzureScanOptionsDataAttributes: - description: The definition of `AzureScanOptionsDataAttributes` object. + description: Attributes for Azure scan options configuration. properties: vuln_containers_os: - description: The `attributes` `vuln_containers_os`. + description: Indicates if scanning for vulnerabilities in containers is + enabled. type: boolean vuln_host_os: - description: The `attributes` `vuln_host_os`. + description: Indicates if scanning for vulnerabilities in hosts is enabled. type: boolean type: object AzureScanOptionsDataType: @@ -6126,7 +6127,7 @@ components: x-enum-varnames: - AZURE_SCAN_OPTIONS AzureScanOptionsInputUpdate: - description: The definition of `AzureScanOptionsInputUpdate` object. + description: Request object for updating Azure scan options. example: data: id: 12345678-90ab-cdef-1234-567890abcdef @@ -6136,13 +6137,13 @@ components: $ref: '#/components/schemas/AzureScanOptionsInputUpdateData' type: object AzureScanOptionsInputUpdateData: - description: The definition of `AzureScanOptionsInputUpdateData` object. + description: Data object for updating the scan options of a single Azure subscription. properties: attributes: $ref: '#/components/schemas/AzureScanOptionsInputUpdateDataAttributes' id: - description: The `AzureScanOptionsInputUpdateData` `id`. - example: '' + description: The Azure subscription ID. + example: 12345678-90ab-cdef-1234-567890abcdef type: string type: $ref: '#/components/schemas/AzureScanOptionsInputUpdateDataType' @@ -6151,13 +6152,14 @@ components: - id type: object AzureScanOptionsInputUpdateDataAttributes: - description: The definition of `AzureScanOptionsInputUpdateDataAttributes` object. + description: Attributes for updating Azure scan options configuration. properties: vuln_containers_os: - description: The `attributes` `vuln_containers_os`. + description: Indicates if scanning for vulnerabilities in containers is + enabled. type: boolean vuln_host_os: - description: The `attributes` `vuln_host_os`. + description: Indicates if scanning for vulnerabilities in hosts is enabled. type: boolean type: object AzureScanOptionsInputUpdateDataType: @@ -20630,6 +20632,117 @@ components: required: - data type: object + GcpScanOptions: + description: Response object containing GCP scan options for a single project. + example: + data: + attributes: + vuln_containers_os: true + vuln_host_os: true + id: company-project-id + type: gcp_scan_options + properties: + data: + $ref: '#/components/schemas/GcpScanOptionsData' + type: object + GcpScanOptionsArray: + description: Response object containing a list of GCP scan options. + example: + data: + - attributes: + vuln_containers_os: true + vuln_host_os: true + id: company-project-id + type: gcp_scan_options + properties: + data: + description: A list of GCP scan options. + items: + $ref: '#/components/schemas/GcpScanOptionsData' + type: array + required: + - data + type: object + GcpScanOptionsData: + description: Single GCP scan options entry. + properties: + attributes: + $ref: '#/components/schemas/GcpScanOptionsDataAttributes' + id: + description: The GCP project ID. + example: '' + type: string + type: + $ref: '#/components/schemas/GcpScanOptionsDataType' + required: + - type + - id + type: object + GcpScanOptionsDataAttributes: + description: Attributes for GCP scan options configuration. + properties: + vuln_containers_os: + description: Indicates if scanning for vulnerabilities in containers is + enabled. + type: boolean + vuln_host_os: + description: Indicates if scanning for vulnerabilities in hosts is enabled. + type: boolean + type: object + GcpScanOptionsDataType: + default: gcp_scan_options + description: GCP scan options resource type. + enum: + - gcp_scan_options + example: gcp_scan_options + type: string + x-enum-varnames: + - GCP_SCAN_OPTIONS + GcpScanOptionsInputUpdate: + description: Request object for updating GCP scan options. + example: + data: + id: company-project-id + type: gcp_scan_options + properties: + data: + $ref: '#/components/schemas/GcpScanOptionsInputUpdateData' + type: object + GcpScanOptionsInputUpdateData: + description: Data object for updating the scan options of a single GCP project. + properties: + attributes: + $ref: '#/components/schemas/GcpScanOptionsInputUpdateDataAttributes' + id: + description: The GCP project ID. + example: '' + type: string + type: + $ref: '#/components/schemas/GcpScanOptionsInputUpdateDataType' + required: + - type + - id + type: object + GcpScanOptionsInputUpdateDataAttributes: + description: Attributes for updating GCP scan options configuration. + properties: + vuln_containers_os: + description: Indicates if scanning for vulnerabilities in containers is + enabled. + type: boolean + vuln_host_os: + description: Indicates if scanning for vulnerabilities in hosts is enabled. + type: boolean + type: object + GcpScanOptionsInputUpdateDataType: + default: gcp_scan_options + description: GCP scan options resource type. + enum: + - gcp_scan_options + example: gcp_scan_options + type: string + x-enum-varnames: + - GCP_SCAN_OPTIONS GcpUcConfigResponse: description: The definition of `GcpUcConfigResponse` object. example: @@ -53958,7 +54071,7 @@ paths: tags: - Agentless Scanning x-codegen-request-body-name: body - x-menu-order: 3 + x-menu-order: 2 x-undo: operationId: DeleteAwsScanOptions parameters: @@ -54021,7 +54134,7 @@ paths: summary: Get AWS scan options tags: - Agentless Scanning - x-menu-order: 2 + x-menu-order: 3 x-undo: type: safe patch: @@ -54080,7 +54193,7 @@ paths: summary: List azure scan options tags: - Agentless Scanning - x-menu-order: 12 + x-menu-order: 6 x-undo: type: safe post: @@ -54109,7 +54222,7 @@ paths: summary: Create azure scan options tags: - Agentless Scanning - x-menu-order: 11 + x-menu-order: 7 x-undo: operationId: DeleteAzureScanOptions parameters: @@ -54144,6 +54257,43 @@ paths: x-menu-order: 10 x-undo: type: idempotent + get: + description: Fetches the Agentless scan options for an activated subscription. + operationId: GetAzureScanOptions + parameters: + - description: The Azure subscription ID. + in: path + name: subscription_id + required: true + schema: + example: 12345678-90ab-cdef-1234-567890abcdef + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AzureScanOptions' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_findings_read + summary: Get Azure scan options + tags: + - Agentless Scanning + x-menu-order: 8 + x-undo: + type: safe patch: description: Update the Agentless scan options for an activated subscription. operationId: UpdateAzureScanOptions @@ -54181,6 +54331,193 @@ paths: x-menu-order: 9 x-undo: type: idempotent + /api/v2/agentless_scanning/accounts/gcp: + get: + description: Fetches the scan options configured for all GCP projects. + operationId: ListGcpScanOptions + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GcpScanOptionsArray' + description: OK + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_findings_read + summary: List GCP Scan Options + tags: + - Agentless Scanning + x-given: + gcp_scan_options: + source: data[0] + step: there is a valid "gcp_scan_options" in the system + x-menu-order: 11 + x-undo: + type: safe + post: + description: Activate Agentless scan options for a GCP project. + operationId: CreateGcpScanOptions + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GcpScanOptions' + description: The definition of the new scan options. + required: true + responses: + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/GcpScanOptions' + description: Agentless scan options enabled successfully. + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '409': + $ref: '#/components/responses/ConflictResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management + summary: Post GCP Scan Options + tags: + - Agentless Scanning + x-codegen-request-body-name: body + x-menu-order: 12 + x-undo: + operationId: DeleteGcpScanOptions + parameters: + - name: project_id + source: data.id + type: unsafe + /api/v2/agentless_scanning/accounts/gcp/{project_id}: + delete: + description: Delete Agentless scan options for a GCP project. + operationId: DeleteGcpScanOptions + parameters: + - description: The GCP project ID. + in: path + name: project_id + required: true + schema: + example: company-project-id + type: string + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management + summary: Delete GCP Scan Options + tags: + - Agentless Scanning + x-menu-order: 15 + x-undo: + type: idempotent + get: + description: Fetches the Agentless scan options for an activated GCP project. + operationId: GetGcpScanOptions + parameters: + - description: The GCP project ID. + in: path + name: project_id + required: true + schema: + example: company-project-id + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GcpScanOptions' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - security_monitoring_findings_read + summary: Get GCP scan options + tags: + - Agentless Scanning + x-menu-order: 13 + x-undo: + type: safe + patch: + description: Update the Agentless scan options for an activated GCP project. + operationId: UpdateGcpScanOptions + parameters: + - description: The GCP project ID. + in: path + name: project_id + required: true + schema: + example: company-project-id + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GcpScanOptionsInputUpdate' + description: New definition of the scan options. + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/GcpScanOptions' + description: OK + '400': + $ref: '#/components/responses/BadRequestResponse' + '403': + $ref: '#/components/responses/NotAuthorizedResponse' + '404': + $ref: '#/components/responses/NotFoundResponse' + '429': + $ref: '#/components/responses/TooManyRequestsResponse' + security: + - apiKeyAuth: [] + appKeyAuth: [] + - AuthZ: + - org_management + summary: Patch GCP Scan Options + tags: + - Agentless Scanning + x-codegen-request-body-name: body + x-menu-order: 14 + x-undo: + type: idempotent /api/v2/agentless_scanning/ondemand/aws: get: description: Fetches the most recent 1000 AWS on demand tasks. @@ -54204,7 +54541,7 @@ paths: summary: Get AWS On Demand tasks tags: - Agentless Scanning - x-menu-order: 6 + x-menu-order: 16 x-permission: operator: OR permissions: @@ -54245,7 +54582,7 @@ paths: tags: - Agentless Scanning x-codegen-request-body-name: body - x-menu-order: 8 + x-menu-order: 17 x-permission: operator: OR permissions: @@ -54281,7 +54618,7 @@ paths: summary: Get AWS On Demand task by id tags: - Agentless Scanning - x-menu-order: 7 + x-menu-order: 18 x-permission: operator: OR permissions: diff --git a/data/api/v2/full_spec_deref.json b/data/api/v2/full_spec_deref.json index 4ca1323c23e77..d2a7cef2ea406 100644 --- a/data/api/v2/full_spec_deref.json +++ b/data/api/v2/full_spec_deref.json @@ -36678,7 +36678,7 @@ "type": "object" }, "AzureScanOptions": { - "description": "The definition of `AzureScanOptions` object.", + "description": "Response object containing Azure scan options for a single subscription.", "example": { "data": { "attributes": { @@ -36691,24 +36691,24 @@ }, "properties": { "data": { - "description": "The definition of `AzureScanOptionsData` object.", + "description": "Single Azure scan options entry.", "properties": { "attributes": { - "description": "The definition of `AzureScanOptionsDataAttributes` object.", + "description": "Attributes for Azure scan options configuration.", "properties": { "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", "type": "boolean" }, "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", "type": "boolean" } }, "type": "object" }, "id": { - "description": "The `AzureScanOptionsData` `id`.", + "description": "The Azure subscription ID.", "example": "", "type": "string" }, @@ -36735,7 +36735,7 @@ "type": "object" }, "AzureScanOptionsArray": { - "description": "The definition of `AzureScanOptionsArray` object.", + "description": "Response object containing a list of Azure scan options.", "example": { "data": [ { @@ -36750,26 +36750,26 @@ }, "properties": { "data": { - "description": "The `AzureScanOptionsArray` `data`.", + "description": "A list of Azure scan options.", "items": { - "description": "The definition of `AzureScanOptionsData` object.", + "description": "Single Azure scan options entry.", "properties": { "attributes": { - "description": "The definition of `AzureScanOptionsDataAttributes` object.", + "description": "Attributes for Azure scan options configuration.", "properties": { "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", "type": "boolean" }, "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", "type": "boolean" } }, "type": "object" }, "id": { - "description": "The `AzureScanOptionsData` `id`.", + "description": "The Azure subscription ID.", "example": "", "type": "string" }, @@ -36801,24 +36801,24 @@ "type": "object" }, "AzureScanOptionsData": { - "description": "The definition of `AzureScanOptionsData` object.", + "description": "Single Azure scan options entry.", "properties": { "attributes": { - "description": "The definition of `AzureScanOptionsDataAttributes` object.", + "description": "Attributes for Azure scan options configuration.", "properties": { "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", "type": "boolean" }, "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", "type": "boolean" } }, "type": "object" }, "id": { - "description": "The `AzureScanOptionsData` `id`.", + "description": "The Azure subscription ID.", "example": "", "type": "string" }, @@ -36842,14 +36842,14 @@ "type": "object" }, "AzureScanOptionsDataAttributes": { - "description": "The definition of `AzureScanOptionsDataAttributes` object.", + "description": "Attributes for Azure scan options configuration.", "properties": { "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", "type": "boolean" }, "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", "type": "boolean" } }, @@ -36868,7 +36868,7 @@ ] }, "AzureScanOptionsInputUpdate": { - "description": "The definition of `AzureScanOptionsInputUpdate` object.", + "description": "Request object for updating Azure scan options.", "example": { "data": { "id": "12345678-90ab-cdef-1234-567890abcdef", @@ -36877,25 +36877,25 @@ }, "properties": { "data": { - "description": "The definition of `AzureScanOptionsInputUpdateData` object.", + "description": "Data object for updating the scan options of a single Azure subscription.", "properties": { "attributes": { - "description": "The definition of `AzureScanOptionsInputUpdateDataAttributes` object.", + "description": "Attributes for updating Azure scan options configuration.", "properties": { "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", "type": "boolean" }, "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", "type": "boolean" } }, "type": "object" }, "id": { - "description": "The `AzureScanOptionsInputUpdateData` `id`.", - "example": "", + "description": "The Azure subscription ID.", + "example": "12345678-90ab-cdef-1234-567890abcdef", "type": "string" }, "type": { @@ -36921,25 +36921,25 @@ "type": "object" }, "AzureScanOptionsInputUpdateData": { - "description": "The definition of `AzureScanOptionsInputUpdateData` object.", + "description": "Data object for updating the scan options of a single Azure subscription.", "properties": { "attributes": { - "description": "The definition of `AzureScanOptionsInputUpdateDataAttributes` object.", + "description": "Attributes for updating Azure scan options configuration.", "properties": { "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", "type": "boolean" }, "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", "type": "boolean" } }, "type": "object" }, "id": { - "description": "The `AzureScanOptionsInputUpdateData` `id`.", - "example": "", + "description": "The Azure subscription ID.", + "example": "12345678-90ab-cdef-1234-567890abcdef", "type": "string" }, "type": { @@ -36962,14 +36962,14 @@ "type": "object" }, "AzureScanOptionsInputUpdateDataAttributes": { - "description": "The definition of `AzureScanOptionsInputUpdateDataAttributes` object.", + "description": "Attributes for updating Azure scan options configuration.", "properties": { "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", "type": "boolean" }, "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", "type": "boolean" } }, @@ -125570,6 +125570,316 @@ ], "type": "object" }, + "GcpScanOptions": { + "description": "Response object containing GCP scan options for a single project.", + "example": { + "data": { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "company-project-id", + "type": "gcp_scan_options" + } + }, + "properties": { + "data": { + "description": "Single GCP scan options entry.", + "properties": { + "attributes": { + "description": "Attributes for GCP scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The GCP project ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", + "enum": [ + "gcp_scan_options" + ], + "example": "gcp_scan_options", + "type": "string", + "x-enum-varnames": [ + "GCP_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + } + }, + "type": "object" + }, + "GcpScanOptionsArray": { + "description": "Response object containing a list of GCP scan options.", + "example": { + "data": [ + { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "company-project-id", + "type": "gcp_scan_options" + } + ] + }, + "properties": { + "data": { + "description": "A list of GCP scan options.", + "items": { + "description": "Single GCP scan options entry.", + "properties": { + "attributes": { + "description": "Attributes for GCP scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The GCP project ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", + "enum": [ + "gcp_scan_options" + ], + "example": "gcp_scan_options", + "type": "string", + "x-enum-varnames": [ + "GCP_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "GcpScanOptionsData": { + "description": "Single GCP scan options entry.", + "properties": { + "attributes": { + "description": "Attributes for GCP scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The GCP project ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", + "enum": [ + "gcp_scan_options" + ], + "example": "gcp_scan_options", + "type": "string", + "x-enum-varnames": [ + "GCP_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + }, + "GcpScanOptionsDataAttributes": { + "description": "Attributes for GCP scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "GcpScanOptionsDataType": { + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", + "enum": [ + "gcp_scan_options" + ], + "example": "gcp_scan_options", + "type": "string", + "x-enum-varnames": [ + "GCP_SCAN_OPTIONS" + ] + }, + "GcpScanOptionsInputUpdate": { + "description": "Request object for updating GCP scan options.", + "example": { + "data": { + "id": "company-project-id", + "type": "gcp_scan_options" + } + }, + "properties": { + "data": { + "description": "Data object for updating the scan options of a single GCP project.", + "properties": { + "attributes": { + "description": "Attributes for updating GCP scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The GCP project ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", + "enum": [ + "gcp_scan_options" + ], + "example": "gcp_scan_options", + "type": "string", + "x-enum-varnames": [ + "GCP_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + } + }, + "type": "object" + }, + "GcpScanOptionsInputUpdateData": { + "description": "Data object for updating the scan options of a single GCP project.", + "properties": { + "attributes": { + "description": "Attributes for updating GCP scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The GCP project ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", + "enum": [ + "gcp_scan_options" + ], + "example": "gcp_scan_options", + "type": "string", + "x-enum-varnames": [ + "GCP_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + }, + "GcpScanOptionsInputUpdateDataAttributes": { + "description": "Attributes for updating GCP scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "GcpScanOptionsInputUpdateDataType": { + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", + "enum": [ + "gcp_scan_options" + ], + "example": "gcp_scan_options", + "type": "string", + "x-enum-varnames": [ + "GCP_SCAN_OPTIONS" + ] + }, "GcpUcConfigResponse": { "description": "The definition of `GcpUcConfigResponse` object.", "example": { @@ -411241,7 +411551,7 @@ "Agentless Scanning" ], "x-codegen-request-body-name": "body", - "x-menu-order": 3, + "x-menu-order": 2, "x-undo": { "operationId": "DeleteAwsScanOptions", "parameters": [ @@ -411613,7 +411923,7 @@ "tags": [ "Agentless Scanning" ], - "x-menu-order": 2, + "x-menu-order": 3, "x-undo": { "type": "safe" } @@ -411852,7 +412162,7 @@ "content": { "application/json": { "schema": { - "description": "The definition of `AzureScanOptionsArray` object.", + "description": "Response object containing a list of Azure scan options.", "example": { "data": [ { @@ -411867,26 +412177,26 @@ }, "properties": { "data": { - "description": "The `AzureScanOptionsArray` `data`.", + "description": "A list of Azure scan options.", "items": { - "description": "The definition of `AzureScanOptionsData` object.", + "description": "Single Azure scan options entry.", "properties": { "attributes": { - "description": "The definition of `AzureScanOptionsDataAttributes` object.", + "description": "Attributes for Azure scan options configuration.", "properties": { "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", "type": "boolean" }, "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", "type": "boolean" } }, "type": "object" }, "id": { - "description": "The `AzureScanOptionsData` `id`.", + "description": "The Azure subscription ID.", "example": "", "type": "string" }, @@ -411961,66 +412271,1537 @@ ] } ], - "summary": "List azure scan options", + "summary": "List azure scan options", + "tags": [ + "Agentless Scanning" + ], + "x-menu-order": 6, + "x-undo": { + "type": "safe" + } + }, + "post": { + "description": "Activate Agentless scan options for an Azure subscription.", + "operationId": "CreateAzureScanOptions", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Response object containing Azure scan options for a single subscription.", + "example": { + "data": { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "12345678-90ab-cdef-1234-567890abcdef", + "type": "azure_scan_options" + } + }, + "properties": { + "data": { + "description": "Single Azure scan options entry.", + "properties": { + "attributes": { + "description": "Attributes for Azure scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The Azure subscription ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "azure_scan_options", + "description": "The type of the resource. The value should always be `azure_scan_options`.", + "enum": [ + "azure_scan_options" + ], + "example": "azure_scan_options", + "type": "string", + "x-enum-varnames": [ + "AZURE_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Response object containing Azure scan options for a single subscription.", + "example": { + "data": { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "12345678-90ab-cdef-1234-567890abcdef", + "type": "azure_scan_options" + } + }, + "properties": { + "data": { + "description": "Single Azure scan options entry.", + "properties": { + "attributes": { + "description": "Attributes for Azure scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The Azure subscription ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "azure_scan_options", + "description": "The type of the resource. The value should always be `azure_scan_options`.", + "enum": [ + "azure_scan_options" + ], + "example": "azure_scan_options", + "type": "string", + "x-enum-varnames": [ + "AZURE_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Created" + }, + "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" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "org_management" + ] + } + ], + "summary": "Create azure scan options", + "tags": [ + "Agentless Scanning" + ], + "x-menu-order": 7, + "x-undo": { + "operationId": "DeleteAzureScanOptions", + "parameters": [ + { + "name": "subscription_id", + "source": "data.id" + } + ], + "type": "unsafe" + } + } + }, + "/api/v2/agentless_scanning/accounts/azure/{subscription_id}": { + "delete": { + "description": "Delete Agentless scan options for an Azure subscription.", + "operationId": "DeleteAzureScanOptions", + "parameters": [ + { + "description": "The Azure subscription ID.", + "in": "path", + "name": "subscription_id", + "required": true, + "schema": { + "example": "12345678-90ab-cdef-1234-567890abcdef", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "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" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "org_management" + ] + } + ], + "summary": "Delete azure scan options", + "tags": [ + "Agentless Scanning" + ], + "x-menu-order": 10, + "x-undo": { + "type": "idempotent" + } + }, + "get": { + "description": "Fetches the Agentless scan options for an activated subscription.", + "operationId": "GetAzureScanOptions", + "parameters": [ + { + "description": "The Azure subscription ID.", + "in": "path", + "name": "subscription_id", + "required": true, + "schema": { + "example": "12345678-90ab-cdef-1234-567890abcdef", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response object containing Azure scan options for a single subscription.", + "example": { + "data": { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "12345678-90ab-cdef-1234-567890abcdef", + "type": "azure_scan_options" + } + }, + "properties": { + "data": { + "description": "Single Azure scan options entry.", + "properties": { + "attributes": { + "description": "Attributes for Azure scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The Azure subscription ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "azure_scan_options", + "description": "The type of the resource. The value should always be `azure_scan_options`.", + "enum": [ + "azure_scan_options" + ], + "example": "azure_scan_options", + "type": "string", + "x-enum-varnames": [ + "AZURE_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "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" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "security_monitoring_findings_read" + ] + } + ], + "summary": "Get Azure scan options", + "tags": [ + "Agentless Scanning" + ], + "x-menu-order": 8, + "x-undo": { + "type": "safe" + } + }, + "patch": { + "description": "Update the Agentless scan options for an activated subscription.", + "operationId": "UpdateAzureScanOptions", + "parameters": [ + { + "description": "The Azure subscription ID.", + "in": "path", + "name": "subscription_id", + "required": true, + "schema": { + "example": "12345678-90ab-cdef-1234-567890abcdef", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request object for updating Azure scan options.", + "example": { + "data": { + "id": "12345678-90ab-cdef-1234-567890abcdef", + "type": "azure_scan_options" + } + }, + "properties": { + "data": { + "description": "Data object for updating the scan options of a single Azure subscription.", + "properties": { + "attributes": { + "description": "Attributes for updating Azure scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The Azure subscription ID.", + "example": "12345678-90ab-cdef-1234-567890abcdef", + "type": "string" + }, + "type": { + "default": "azure_scan_options", + "description": "Azure scan options resource type.", + "enum": [ + "azure_scan_options" + ], + "example": "azure_scan_options", + "type": "string", + "x-enum-varnames": [ + "AZURE_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response object containing Azure scan options for a single subscription.", + "example": { + "data": { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "12345678-90ab-cdef-1234-567890abcdef", + "type": "azure_scan_options" + } + }, + "properties": { + "data": { + "description": "Single Azure scan options entry.", + "properties": { + "attributes": { + "description": "Attributes for Azure scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The Azure subscription ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "azure_scan_options", + "description": "The type of the resource. The value should always be `azure_scan_options`.", + "enum": [ + "azure_scan_options" + ], + "example": "azure_scan_options", + "type": "string", + "x-enum-varnames": [ + "AZURE_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "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" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "org_management" + ] + } + ], + "summary": "Update azure scan options", + "tags": [ + "Agentless Scanning" + ], + "x-menu-order": 9, + "x-undo": { + "type": "idempotent" + } + } + }, + "/api/v2/agentless_scanning/accounts/gcp": { + "get": { + "description": "Fetches the scan options configured for all GCP projects.", + "operationId": "ListGcpScanOptions", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response object containing a list of GCP scan options.", + "example": { + "data": [ + { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "company-project-id", + "type": "gcp_scan_options" + } + ] + }, + "properties": { + "data": { + "description": "A list of GCP scan options.", + "items": { + "description": "Single GCP scan options entry.", + "properties": { + "attributes": { + "description": "Attributes for GCP scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The GCP project ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", + "enum": [ + "gcp_scan_options" + ], + "example": "gcp_scan_options", + "type": "string", + "x-enum-varnames": [ + "GCP_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "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" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "security_monitoring_findings_read" + ] + } + ], + "summary": "List GCP Scan Options", + "tags": [ + "Agentless Scanning" + ], + "x-given": { + "gcp_scan_options": { + "source": "data[0]", + "step": "there is a valid \"gcp_scan_options\" in the system" + } + }, + "x-menu-order": 11, + "x-undo": { + "type": "safe" + } + }, + "post": { + "description": "Activate Agentless scan options for a GCP project.", + "operationId": "CreateGcpScanOptions", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Response object containing GCP scan options for a single project.", + "example": { + "data": { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "company-project-id", + "type": "gcp_scan_options" + } + }, + "properties": { + "data": { + "description": "Single GCP scan options entry.", + "properties": { + "attributes": { + "description": "Attributes for GCP scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The GCP project ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", + "enum": [ + "gcp_scan_options" + ], + "example": "gcp_scan_options", + "type": "string", + "x-enum-varnames": [ + "GCP_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "The definition of the new scan options.", + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Response object containing GCP scan options for a single project.", + "example": { + "data": { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "company-project-id", + "type": "gcp_scan_options" + } + }, + "properties": { + "data": { + "description": "Single GCP scan options entry.", + "properties": { + "attributes": { + "description": "Attributes for GCP scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The GCP project ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", + "enum": [ + "gcp_scan_options" + ], + "example": "gcp_scan_options", + "type": "string", + "x-enum-varnames": [ + "GCP_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Agentless scan options enabled successfully." + }, + "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" + }, + "409": { + "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": "Conflict" + }, + "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" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "org_management" + ] + } + ], + "summary": "Post GCP Scan Options", + "tags": [ + "Agentless Scanning" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 12, + "x-undo": { + "operationId": "DeleteGcpScanOptions", + "parameters": [ + { + "name": "project_id", + "source": "data.id" + } + ], + "type": "unsafe" + } + } + }, + "/api/v2/agentless_scanning/accounts/gcp/{project_id}": { + "delete": { + "description": "Delete Agentless scan options for a GCP project.", + "operationId": "DeleteGcpScanOptions", + "parameters": [ + { + "description": "The GCP project ID.", + "in": "path", + "name": "project_id", + "required": true, + "schema": { + "example": "company-project-id", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "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" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "org_management" + ] + } + ], + "summary": "Delete GCP Scan Options", + "tags": [ + "Agentless Scanning" + ], + "x-menu-order": 15, + "x-undo": { + "type": "idempotent" + } + }, + "get": { + "description": "Fetches the Agentless scan options for an activated GCP project.", + "operationId": "GetGcpScanOptions", + "parameters": [ + { + "description": "The GCP project ID.", + "in": "path", + "name": "project_id", + "required": true, + "schema": { + "example": "company-project-id", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response object containing GCP scan options for a single project.", + "example": { + "data": { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "company-project-id", + "type": "gcp_scan_options" + } + }, + "properties": { + "data": { + "description": "Single GCP scan options entry.", + "properties": { + "attributes": { + "description": "Attributes for GCP scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The GCP project ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", + "enum": [ + "gcp_scan_options" + ], + "example": "gcp_scan_options", + "type": "string", + "x-enum-varnames": [ + "GCP_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "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" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "security_monitoring_findings_read" + ] + } + ], + "summary": "Get GCP scan options", "tags": [ "Agentless Scanning" ], - "x-menu-order": 12, + "x-menu-order": 13, "x-undo": { "type": "safe" } }, - "post": { - "description": "Activate Agentless scan options for an Azure subscription.", - "operationId": "CreateAzureScanOptions", + "patch": { + "description": "Update the Agentless scan options for an activated GCP project.", + "operationId": "UpdateGcpScanOptions", + "parameters": [ + { + "description": "The GCP project ID.", + "in": "path", + "name": "project_id", + "required": true, + "schema": { + "example": "company-project-id", + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "description": "The definition of `AzureScanOptions` object.", + "description": "Request object for updating GCP scan options.", "example": { "data": { - "attributes": { - "vuln_containers_os": true, - "vuln_host_os": true - }, - "id": "12345678-90ab-cdef-1234-567890abcdef", - "type": "azure_scan_options" + "id": "company-project-id", + "type": "gcp_scan_options" } }, "properties": { "data": { - "description": "The definition of `AzureScanOptionsData` object.", + "description": "Data object for updating the scan options of a single GCP project.", "properties": { "attributes": { - "description": "The definition of `AzureScanOptionsDataAttributes` object.", + "description": "Attributes for updating GCP scan options configuration.", "properties": { "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", "type": "boolean" }, "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", "type": "boolean" } }, "type": "object" }, "id": { - "description": "The `AzureScanOptionsData` `id`.", + "description": "The GCP project ID.", "example": "", "type": "string" }, "type": { - "default": "azure_scan_options", - "description": "The type of the resource. The value should always be `azure_scan_options`.", + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", "enum": [ - "azure_scan_options" + "gcp_scan_options" ], - "example": "azure_scan_options", + "example": "gcp_scan_options", "type": "string", "x-enum-varnames": [ - "AZURE_SCAN_OPTIONS" + "GCP_SCAN_OPTIONS" ] } }, @@ -412035,57 +413816,58 @@ } } }, + "description": "New definition of the scan options.", "required": true }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "description": "The definition of `AzureScanOptions` object.", + "description": "Response object containing GCP scan options for a single project.", "example": { "data": { "attributes": { "vuln_containers_os": true, "vuln_host_os": true }, - "id": "12345678-90ab-cdef-1234-567890abcdef", - "type": "azure_scan_options" + "id": "company-project-id", + "type": "gcp_scan_options" } }, "properties": { "data": { - "description": "The definition of `AzureScanOptionsData` object.", + "description": "Single GCP scan options entry.", "properties": { "attributes": { - "description": "The definition of `AzureScanOptionsDataAttributes` object.", + "description": "Attributes for GCP scan options configuration.", "properties": { "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", "type": "boolean" }, "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", "type": "boolean" } }, "type": "object" }, "id": { - "description": "The `AzureScanOptionsData` `id`.", + "description": "The GCP project ID.", "example": "", "type": "string" }, "type": { - "default": "azure_scan_options", - "description": "The type of the resource. The value should always be `azure_scan_options`.", + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", "enum": [ - "azure_scan_options" + "gcp_scan_options" ], - "example": "azure_scan_options", + "example": "gcp_scan_options", "type": "string", "x-enum-varnames": [ - "AZURE_SCAN_OPTIONS" + "GCP_SCAN_OPTIONS" ] } }, @@ -412100,9 +413882,9 @@ } } }, - "description": "Created" + "description": "OK" }, - "429": { + "400": { "content": { "application/json": { "schema": { @@ -412128,58 +413910,9 @@ } } }, - "description": "Too many requests" - } - }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "org_management" - ] - } - ], - "summary": "Create azure scan options", - "tags": [ - "Agentless Scanning" - ], - "x-menu-order": 11, - "x-undo": { - "operationId": "DeleteAzureScanOptions", - "parameters": [ - { - "name": "subscription_id", - "source": "data.id" - } - ], - "type": "unsafe" - } - } - }, - "/api/v2/agentless_scanning/accounts/azure/{subscription_id}": { - "delete": { - "description": "Delete Agentless scan options for an Azure subscription.", - "operationId": "DeleteAzureScanOptions", - "parameters": [ - { - "description": "The Azure subscription ID.", - "in": "path", - "name": "subscription_id", - "required": true, - "schema": { - "example": "12345678-90ab-cdef-1234-567890abcdef", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "No Content" + "description": "Bad Request" }, - "429": { + "403": { "content": { "application/json": { "schema": { @@ -412205,168 +413938,35 @@ } } }, - "description": "Too many requests" - } - }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "org_management" - ] - } - ], - "summary": "Delete azure scan options", - "tags": [ - "Agentless Scanning" - ], - "x-menu-order": 10, - "x-undo": { - "type": "idempotent" - } - }, - "patch": { - "description": "Update the Agentless scan options for an activated subscription.", - "operationId": "UpdateAzureScanOptions", - "parameters": [ - { - "description": "The Azure subscription ID.", - "in": "path", - "name": "subscription_id", - "required": true, - "schema": { - "example": "12345678-90ab-cdef-1234-567890abcdef", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "The definition of `AzureScanOptionsInputUpdate` object.", - "example": { - "data": { - "id": "12345678-90ab-cdef-1234-567890abcdef", - "type": "azure_scan_options" - } - }, - "properties": { - "data": { - "description": "The definition of `AzureScanOptionsInputUpdateData` object.", - "properties": { - "attributes": { - "description": "The definition of `AzureScanOptionsInputUpdateDataAttributes` object.", - "properties": { - "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", - "type": "boolean" - }, - "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", - "type": "boolean" - } - }, - "type": "object" - }, - "id": { - "description": "The `AzureScanOptionsInputUpdateData` `id`.", - "example": "", - "type": "string" - }, - "type": { - "default": "azure_scan_options", - "description": "Azure scan options resource type.", - "enum": [ - "azure_scan_options" - ], - "example": "azure_scan_options", - "type": "string", - "x-enum-varnames": [ - "AZURE_SCAN_OPTIONS" - ] - } - }, - "required": [ - "type", - "id" - ], - "type": "object" - } - }, - "type": "object" - } - } + "description": "Not Authorized" }, - "required": true - }, - "responses": { - "200": { + "404": { "content": { "application/json": { "schema": { - "description": "The definition of `AzureScanOptions` object.", - "example": { - "data": { - "attributes": { - "vuln_containers_os": true, - "vuln_host_os": true - }, - "id": "12345678-90ab-cdef-1234-567890abcdef", - "type": "azure_scan_options" - } - }, + "description": "API error response.", "properties": { - "data": { - "description": "The definition of `AzureScanOptionsData` object.", - "properties": { - "attributes": { - "description": "The definition of `AzureScanOptionsDataAttributes` object.", - "properties": { - "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", - "type": "boolean" - }, - "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", - "type": "boolean" - } - }, - "type": "object" - }, - "id": { - "description": "The `AzureScanOptionsData` `id`.", - "example": "", - "type": "string" - }, - "type": { - "default": "azure_scan_options", - "description": "The type of the resource. The value should always be `azure_scan_options`.", - "enum": [ - "azure_scan_options" - ], - "example": "azure_scan_options", - "type": "string", - "x-enum-varnames": [ - "AZURE_SCAN_OPTIONS" - ] - } - }, - "required": [ - "type", - "id" + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" ], - "type": "object" + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" } }, + "required": [ + "errors" + ], "type": "object" } } }, - "description": "OK" + "description": "Not Found" }, "429": { "content": { @@ -412408,11 +414008,12 @@ ] } ], - "summary": "Update azure scan options", + "summary": "Patch GCP Scan Options", "tags": [ "Agentless Scanning" ], - "x-menu-order": 9, + "x-codegen-request-body-name": "body", + "x-menu-order": 14, "x-undo": { "type": "idempotent" } @@ -412561,7 +414162,7 @@ "tags": [ "Agentless Scanning" ], - "x-menu-order": 6, + "x-menu-order": 16, "x-permission": { "operator": "OR", "permissions": [ @@ -412792,7 +414393,7 @@ "Agentless Scanning" ], "x-codegen-request-body-name": "body", - "x-menu-order": 8, + "x-menu-order": 17, "x-permission": { "operator": "OR", "permissions": [ @@ -413011,7 +414612,7 @@ "tags": [ "Agentless Scanning" ], - "x-menu-order": 7, + "x-menu-order": 18, "x-permission": { "operator": "OR", "permissions": [ diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index d6cc946d3f5f1..f39ecde57f022 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -119,17 +119,45 @@ "description": "Activate Agentless scan options for an Azure subscription.", "summary": "Create azure scan options", "request_description": "", - "request_schema_description": "The definition of `AzureScanOptions` object." + "request_schema_description": "Response object containing Azure scan options for a single subscription." }, "DeleteAzureScanOptions": { "description": "Delete Agentless scan options for an Azure subscription.", "summary": "Delete azure scan options" }, + "GetAzureScanOptions": { + "description": "Fetches the Agentless scan options for an activated subscription.", + "summary": "Get Azure scan options" + }, "UpdateAzureScanOptions": { "description": "Update the Agentless scan options for an activated subscription.", "summary": "Update azure scan options", "request_description": "", - "request_schema_description": "The definition of `AzureScanOptionsInputUpdate` object." + "request_schema_description": "Request object for updating Azure scan options." + }, + "ListGcpScanOptions": { + "description": "Fetches the scan options configured for all GCP projects.", + "summary": "List GCP Scan Options" + }, + "CreateGcpScanOptions": { + "description": "Activate Agentless scan options for a GCP project.", + "summary": "Post GCP Scan Options", + "request_description": "The definition of the new scan options.", + "request_schema_description": "Response object containing GCP scan options for a single project." + }, + "DeleteGcpScanOptions": { + "description": "Delete Agentless scan options for a GCP project.", + "summary": "Delete GCP Scan Options" + }, + "GetGcpScanOptions": { + "description": "Fetches the Agentless scan options for an activated GCP project.", + "summary": "Get GCP scan options" + }, + "UpdateGcpScanOptions": { + "description": "Update the Agentless scan options for an activated GCP project.", + "summary": "Patch GCP Scan Options", + "request_description": "New definition of the scan options.", + "request_schema_description": "Request object for updating GCP scan options." }, "ListAwsOnDemandTasks": { "description": "Fetches the most recent 1000 AWS on demand tasks.", diff --git a/static/resources/json/full_spec_v2.json b/static/resources/json/full_spec_v2.json index 4ca1323c23e77..d2a7cef2ea406 100644 --- a/static/resources/json/full_spec_v2.json +++ b/static/resources/json/full_spec_v2.json @@ -36678,7 +36678,7 @@ "type": "object" }, "AzureScanOptions": { - "description": "The definition of `AzureScanOptions` object.", + "description": "Response object containing Azure scan options for a single subscription.", "example": { "data": { "attributes": { @@ -36691,24 +36691,24 @@ }, "properties": { "data": { - "description": "The definition of `AzureScanOptionsData` object.", + "description": "Single Azure scan options entry.", "properties": { "attributes": { - "description": "The definition of `AzureScanOptionsDataAttributes` object.", + "description": "Attributes for Azure scan options configuration.", "properties": { "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", "type": "boolean" }, "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", "type": "boolean" } }, "type": "object" }, "id": { - "description": "The `AzureScanOptionsData` `id`.", + "description": "The Azure subscription ID.", "example": "", "type": "string" }, @@ -36735,7 +36735,7 @@ "type": "object" }, "AzureScanOptionsArray": { - "description": "The definition of `AzureScanOptionsArray` object.", + "description": "Response object containing a list of Azure scan options.", "example": { "data": [ { @@ -36750,26 +36750,26 @@ }, "properties": { "data": { - "description": "The `AzureScanOptionsArray` `data`.", + "description": "A list of Azure scan options.", "items": { - "description": "The definition of `AzureScanOptionsData` object.", + "description": "Single Azure scan options entry.", "properties": { "attributes": { - "description": "The definition of `AzureScanOptionsDataAttributes` object.", + "description": "Attributes for Azure scan options configuration.", "properties": { "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", "type": "boolean" }, "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", "type": "boolean" } }, "type": "object" }, "id": { - "description": "The `AzureScanOptionsData` `id`.", + "description": "The Azure subscription ID.", "example": "", "type": "string" }, @@ -36801,24 +36801,24 @@ "type": "object" }, "AzureScanOptionsData": { - "description": "The definition of `AzureScanOptionsData` object.", + "description": "Single Azure scan options entry.", "properties": { "attributes": { - "description": "The definition of `AzureScanOptionsDataAttributes` object.", + "description": "Attributes for Azure scan options configuration.", "properties": { "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", "type": "boolean" }, "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", "type": "boolean" } }, "type": "object" }, "id": { - "description": "The `AzureScanOptionsData` `id`.", + "description": "The Azure subscription ID.", "example": "", "type": "string" }, @@ -36842,14 +36842,14 @@ "type": "object" }, "AzureScanOptionsDataAttributes": { - "description": "The definition of `AzureScanOptionsDataAttributes` object.", + "description": "Attributes for Azure scan options configuration.", "properties": { "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", "type": "boolean" }, "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", "type": "boolean" } }, @@ -36868,7 +36868,7 @@ ] }, "AzureScanOptionsInputUpdate": { - "description": "The definition of `AzureScanOptionsInputUpdate` object.", + "description": "Request object for updating Azure scan options.", "example": { "data": { "id": "12345678-90ab-cdef-1234-567890abcdef", @@ -36877,25 +36877,25 @@ }, "properties": { "data": { - "description": "The definition of `AzureScanOptionsInputUpdateData` object.", + "description": "Data object for updating the scan options of a single Azure subscription.", "properties": { "attributes": { - "description": "The definition of `AzureScanOptionsInputUpdateDataAttributes` object.", + "description": "Attributes for updating Azure scan options configuration.", "properties": { "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", "type": "boolean" }, "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", "type": "boolean" } }, "type": "object" }, "id": { - "description": "The `AzureScanOptionsInputUpdateData` `id`.", - "example": "", + "description": "The Azure subscription ID.", + "example": "12345678-90ab-cdef-1234-567890abcdef", "type": "string" }, "type": { @@ -36921,25 +36921,25 @@ "type": "object" }, "AzureScanOptionsInputUpdateData": { - "description": "The definition of `AzureScanOptionsInputUpdateData` object.", + "description": "Data object for updating the scan options of a single Azure subscription.", "properties": { "attributes": { - "description": "The definition of `AzureScanOptionsInputUpdateDataAttributes` object.", + "description": "Attributes for updating Azure scan options configuration.", "properties": { "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", "type": "boolean" }, "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", "type": "boolean" } }, "type": "object" }, "id": { - "description": "The `AzureScanOptionsInputUpdateData` `id`.", - "example": "", + "description": "The Azure subscription ID.", + "example": "12345678-90ab-cdef-1234-567890abcdef", "type": "string" }, "type": { @@ -36962,14 +36962,14 @@ "type": "object" }, "AzureScanOptionsInputUpdateDataAttributes": { - "description": "The definition of `AzureScanOptionsInputUpdateDataAttributes` object.", + "description": "Attributes for updating Azure scan options configuration.", "properties": { "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", "type": "boolean" }, "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", "type": "boolean" } }, @@ -125570,6 +125570,316 @@ ], "type": "object" }, + "GcpScanOptions": { + "description": "Response object containing GCP scan options for a single project.", + "example": { + "data": { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "company-project-id", + "type": "gcp_scan_options" + } + }, + "properties": { + "data": { + "description": "Single GCP scan options entry.", + "properties": { + "attributes": { + "description": "Attributes for GCP scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The GCP project ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", + "enum": [ + "gcp_scan_options" + ], + "example": "gcp_scan_options", + "type": "string", + "x-enum-varnames": [ + "GCP_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + } + }, + "type": "object" + }, + "GcpScanOptionsArray": { + "description": "Response object containing a list of GCP scan options.", + "example": { + "data": [ + { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "company-project-id", + "type": "gcp_scan_options" + } + ] + }, + "properties": { + "data": { + "description": "A list of GCP scan options.", + "items": { + "description": "Single GCP scan options entry.", + "properties": { + "attributes": { + "description": "Attributes for GCP scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The GCP project ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", + "enum": [ + "gcp_scan_options" + ], + "example": "gcp_scan_options", + "type": "string", + "x-enum-varnames": [ + "GCP_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "type": "object" + }, + "GcpScanOptionsData": { + "description": "Single GCP scan options entry.", + "properties": { + "attributes": { + "description": "Attributes for GCP scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The GCP project ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", + "enum": [ + "gcp_scan_options" + ], + "example": "gcp_scan_options", + "type": "string", + "x-enum-varnames": [ + "GCP_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + }, + "GcpScanOptionsDataAttributes": { + "description": "Attributes for GCP scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "GcpScanOptionsDataType": { + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", + "enum": [ + "gcp_scan_options" + ], + "example": "gcp_scan_options", + "type": "string", + "x-enum-varnames": [ + "GCP_SCAN_OPTIONS" + ] + }, + "GcpScanOptionsInputUpdate": { + "description": "Request object for updating GCP scan options.", + "example": { + "data": { + "id": "company-project-id", + "type": "gcp_scan_options" + } + }, + "properties": { + "data": { + "description": "Data object for updating the scan options of a single GCP project.", + "properties": { + "attributes": { + "description": "Attributes for updating GCP scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The GCP project ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", + "enum": [ + "gcp_scan_options" + ], + "example": "gcp_scan_options", + "type": "string", + "x-enum-varnames": [ + "GCP_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + } + }, + "type": "object" + }, + "GcpScanOptionsInputUpdateData": { + "description": "Data object for updating the scan options of a single GCP project.", + "properties": { + "attributes": { + "description": "Attributes for updating GCP scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The GCP project ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", + "enum": [ + "gcp_scan_options" + ], + "example": "gcp_scan_options", + "type": "string", + "x-enum-varnames": [ + "GCP_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + }, + "GcpScanOptionsInputUpdateDataAttributes": { + "description": "Attributes for updating GCP scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "GcpScanOptionsInputUpdateDataType": { + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", + "enum": [ + "gcp_scan_options" + ], + "example": "gcp_scan_options", + "type": "string", + "x-enum-varnames": [ + "GCP_SCAN_OPTIONS" + ] + }, "GcpUcConfigResponse": { "description": "The definition of `GcpUcConfigResponse` object.", "example": { @@ -411241,7 +411551,7 @@ "Agentless Scanning" ], "x-codegen-request-body-name": "body", - "x-menu-order": 3, + "x-menu-order": 2, "x-undo": { "operationId": "DeleteAwsScanOptions", "parameters": [ @@ -411613,7 +411923,7 @@ "tags": [ "Agentless Scanning" ], - "x-menu-order": 2, + "x-menu-order": 3, "x-undo": { "type": "safe" } @@ -411852,7 +412162,7 @@ "content": { "application/json": { "schema": { - "description": "The definition of `AzureScanOptionsArray` object.", + "description": "Response object containing a list of Azure scan options.", "example": { "data": [ { @@ -411867,26 +412177,26 @@ }, "properties": { "data": { - "description": "The `AzureScanOptionsArray` `data`.", + "description": "A list of Azure scan options.", "items": { - "description": "The definition of `AzureScanOptionsData` object.", + "description": "Single Azure scan options entry.", "properties": { "attributes": { - "description": "The definition of `AzureScanOptionsDataAttributes` object.", + "description": "Attributes for Azure scan options configuration.", "properties": { "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", "type": "boolean" }, "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", "type": "boolean" } }, "type": "object" }, "id": { - "description": "The `AzureScanOptionsData` `id`.", + "description": "The Azure subscription ID.", "example": "", "type": "string" }, @@ -411961,66 +412271,1537 @@ ] } ], - "summary": "List azure scan options", + "summary": "List azure scan options", + "tags": [ + "Agentless Scanning" + ], + "x-menu-order": 6, + "x-undo": { + "type": "safe" + } + }, + "post": { + "description": "Activate Agentless scan options for an Azure subscription.", + "operationId": "CreateAzureScanOptions", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Response object containing Azure scan options for a single subscription.", + "example": { + "data": { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "12345678-90ab-cdef-1234-567890abcdef", + "type": "azure_scan_options" + } + }, + "properties": { + "data": { + "description": "Single Azure scan options entry.", + "properties": { + "attributes": { + "description": "Attributes for Azure scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The Azure subscription ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "azure_scan_options", + "description": "The type of the resource. The value should always be `azure_scan_options`.", + "enum": [ + "azure_scan_options" + ], + "example": "azure_scan_options", + "type": "string", + "x-enum-varnames": [ + "AZURE_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Response object containing Azure scan options for a single subscription.", + "example": { + "data": { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "12345678-90ab-cdef-1234-567890abcdef", + "type": "azure_scan_options" + } + }, + "properties": { + "data": { + "description": "Single Azure scan options entry.", + "properties": { + "attributes": { + "description": "Attributes for Azure scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The Azure subscription ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "azure_scan_options", + "description": "The type of the resource. The value should always be `azure_scan_options`.", + "enum": [ + "azure_scan_options" + ], + "example": "azure_scan_options", + "type": "string", + "x-enum-varnames": [ + "AZURE_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Created" + }, + "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" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "org_management" + ] + } + ], + "summary": "Create azure scan options", + "tags": [ + "Agentless Scanning" + ], + "x-menu-order": 7, + "x-undo": { + "operationId": "DeleteAzureScanOptions", + "parameters": [ + { + "name": "subscription_id", + "source": "data.id" + } + ], + "type": "unsafe" + } + } + }, + "/api/v2/agentless_scanning/accounts/azure/{subscription_id}": { + "delete": { + "description": "Delete Agentless scan options for an Azure subscription.", + "operationId": "DeleteAzureScanOptions", + "parameters": [ + { + "description": "The Azure subscription ID.", + "in": "path", + "name": "subscription_id", + "required": true, + "schema": { + "example": "12345678-90ab-cdef-1234-567890abcdef", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "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" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "org_management" + ] + } + ], + "summary": "Delete azure scan options", + "tags": [ + "Agentless Scanning" + ], + "x-menu-order": 10, + "x-undo": { + "type": "idempotent" + } + }, + "get": { + "description": "Fetches the Agentless scan options for an activated subscription.", + "operationId": "GetAzureScanOptions", + "parameters": [ + { + "description": "The Azure subscription ID.", + "in": "path", + "name": "subscription_id", + "required": true, + "schema": { + "example": "12345678-90ab-cdef-1234-567890abcdef", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response object containing Azure scan options for a single subscription.", + "example": { + "data": { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "12345678-90ab-cdef-1234-567890abcdef", + "type": "azure_scan_options" + } + }, + "properties": { + "data": { + "description": "Single Azure scan options entry.", + "properties": { + "attributes": { + "description": "Attributes for Azure scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The Azure subscription ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "azure_scan_options", + "description": "The type of the resource. The value should always be `azure_scan_options`.", + "enum": [ + "azure_scan_options" + ], + "example": "azure_scan_options", + "type": "string", + "x-enum-varnames": [ + "AZURE_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "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" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "security_monitoring_findings_read" + ] + } + ], + "summary": "Get Azure scan options", + "tags": [ + "Agentless Scanning" + ], + "x-menu-order": 8, + "x-undo": { + "type": "safe" + } + }, + "patch": { + "description": "Update the Agentless scan options for an activated subscription.", + "operationId": "UpdateAzureScanOptions", + "parameters": [ + { + "description": "The Azure subscription ID.", + "in": "path", + "name": "subscription_id", + "required": true, + "schema": { + "example": "12345678-90ab-cdef-1234-567890abcdef", + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Request object for updating Azure scan options.", + "example": { + "data": { + "id": "12345678-90ab-cdef-1234-567890abcdef", + "type": "azure_scan_options" + } + }, + "properties": { + "data": { + "description": "Data object for updating the scan options of a single Azure subscription.", + "properties": { + "attributes": { + "description": "Attributes for updating Azure scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The Azure subscription ID.", + "example": "12345678-90ab-cdef-1234-567890abcdef", + "type": "string" + }, + "type": { + "default": "azure_scan_options", + "description": "Azure scan options resource type.", + "enum": [ + "azure_scan_options" + ], + "example": "azure_scan_options", + "type": "string", + "x-enum-varnames": [ + "AZURE_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response object containing Azure scan options for a single subscription.", + "example": { + "data": { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "12345678-90ab-cdef-1234-567890abcdef", + "type": "azure_scan_options" + } + }, + "properties": { + "data": { + "description": "Single Azure scan options entry.", + "properties": { + "attributes": { + "description": "Attributes for Azure scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The Azure subscription ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "azure_scan_options", + "description": "The type of the resource. The value should always be `azure_scan_options`.", + "enum": [ + "azure_scan_options" + ], + "example": "azure_scan_options", + "type": "string", + "x-enum-varnames": [ + "AZURE_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "OK" + }, + "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" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "org_management" + ] + } + ], + "summary": "Update azure scan options", + "tags": [ + "Agentless Scanning" + ], + "x-menu-order": 9, + "x-undo": { + "type": "idempotent" + } + } + }, + "/api/v2/agentless_scanning/accounts/gcp": { + "get": { + "description": "Fetches the scan options configured for all GCP projects.", + "operationId": "ListGcpScanOptions", + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response object containing a list of GCP scan options.", + "example": { + "data": [ + { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "company-project-id", + "type": "gcp_scan_options" + } + ] + }, + "properties": { + "data": { + "description": "A list of GCP scan options.", + "items": { + "description": "Single GCP scan options entry.", + "properties": { + "attributes": { + "description": "Attributes for GCP scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The GCP project ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", + "enum": [ + "gcp_scan_options" + ], + "example": "gcp_scan_options", + "type": "string", + "x-enum-varnames": [ + "GCP_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + }, + "type": "array" + } + }, + "required": [ + "data" + ], + "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" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "security_monitoring_findings_read" + ] + } + ], + "summary": "List GCP Scan Options", + "tags": [ + "Agentless Scanning" + ], + "x-given": { + "gcp_scan_options": { + "source": "data[0]", + "step": "there is a valid \"gcp_scan_options\" in the system" + } + }, + "x-menu-order": 11, + "x-undo": { + "type": "safe" + } + }, + "post": { + "description": "Activate Agentless scan options for a GCP project.", + "operationId": "CreateGcpScanOptions", + "requestBody": { + "content": { + "application/json": { + "schema": { + "description": "Response object containing GCP scan options for a single project.", + "example": { + "data": { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "company-project-id", + "type": "gcp_scan_options" + } + }, + "properties": { + "data": { + "description": "Single GCP scan options entry.", + "properties": { + "attributes": { + "description": "Attributes for GCP scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The GCP project ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", + "enum": [ + "gcp_scan_options" + ], + "example": "gcp_scan_options", + "type": "string", + "x-enum-varnames": [ + "GCP_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "The definition of the new scan options.", + "required": true + }, + "responses": { + "201": { + "content": { + "application/json": { + "schema": { + "description": "Response object containing GCP scan options for a single project.", + "example": { + "data": { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "company-project-id", + "type": "gcp_scan_options" + } + }, + "properties": { + "data": { + "description": "Single GCP scan options entry.", + "properties": { + "attributes": { + "description": "Attributes for GCP scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The GCP project ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", + "enum": [ + "gcp_scan_options" + ], + "example": "gcp_scan_options", + "type": "string", + "x-enum-varnames": [ + "GCP_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "type": "object" + } + }, + "type": "object" + } + } + }, + "description": "Agentless scan options enabled successfully." + }, + "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" + }, + "409": { + "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": "Conflict" + }, + "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" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "org_management" + ] + } + ], + "summary": "Post GCP Scan Options", + "tags": [ + "Agentless Scanning" + ], + "x-codegen-request-body-name": "body", + "x-menu-order": 12, + "x-undo": { + "operationId": "DeleteGcpScanOptions", + "parameters": [ + { + "name": "project_id", + "source": "data.id" + } + ], + "type": "unsafe" + } + } + }, + "/api/v2/agentless_scanning/accounts/gcp/{project_id}": { + "delete": { + "description": "Delete Agentless scan options for a GCP project.", + "operationId": "DeleteGcpScanOptions", + "parameters": [ + { + "description": "The GCP project ID.", + "in": "path", + "name": "project_id", + "required": true, + "schema": { + "example": "company-project-id", + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "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" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "org_management" + ] + } + ], + "summary": "Delete GCP Scan Options", + "tags": [ + "Agentless Scanning" + ], + "x-menu-order": 15, + "x-undo": { + "type": "idempotent" + } + }, + "get": { + "description": "Fetches the Agentless scan options for an activated GCP project.", + "operationId": "GetGcpScanOptions", + "parameters": [ + { + "description": "The GCP project ID.", + "in": "path", + "name": "project_id", + "required": true, + "schema": { + "example": "company-project-id", + "type": "string" + } + } + ], + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "Response object containing GCP scan options for a single project.", + "example": { + "data": { + "attributes": { + "vuln_containers_os": true, + "vuln_host_os": true + }, + "id": "company-project-id", + "type": "gcp_scan_options" + } + }, + "properties": { + "data": { + "description": "Single GCP scan options entry.", + "properties": { + "attributes": { + "description": "Attributes for GCP scan options configuration.", + "properties": { + "vuln_containers_os": { + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", + "type": "boolean" + }, + "vuln_host_os": { + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "id": { + "description": "The GCP project ID.", + "example": "", + "type": "string" + }, + "type": { + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", + "enum": [ + "gcp_scan_options" + ], + "example": "gcp_scan_options", + "type": "string", + "x-enum-varnames": [ + "GCP_SCAN_OPTIONS" + ] + } + }, + "required": [ + "type", + "id" + ], + "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" + } + }, + "security": [ + { + "apiKeyAuth": [], + "appKeyAuth": [] + }, + { + "AuthZ": [ + "security_monitoring_findings_read" + ] + } + ], + "summary": "Get GCP scan options", "tags": [ "Agentless Scanning" ], - "x-menu-order": 12, + "x-menu-order": 13, "x-undo": { "type": "safe" } }, - "post": { - "description": "Activate Agentless scan options for an Azure subscription.", - "operationId": "CreateAzureScanOptions", + "patch": { + "description": "Update the Agentless scan options for an activated GCP project.", + "operationId": "UpdateGcpScanOptions", + "parameters": [ + { + "description": "The GCP project ID.", + "in": "path", + "name": "project_id", + "required": true, + "schema": { + "example": "company-project-id", + "type": "string" + } + } + ], "requestBody": { "content": { "application/json": { "schema": { - "description": "The definition of `AzureScanOptions` object.", + "description": "Request object for updating GCP scan options.", "example": { "data": { - "attributes": { - "vuln_containers_os": true, - "vuln_host_os": true - }, - "id": "12345678-90ab-cdef-1234-567890abcdef", - "type": "azure_scan_options" + "id": "company-project-id", + "type": "gcp_scan_options" } }, "properties": { "data": { - "description": "The definition of `AzureScanOptionsData` object.", + "description": "Data object for updating the scan options of a single GCP project.", "properties": { "attributes": { - "description": "The definition of `AzureScanOptionsDataAttributes` object.", + "description": "Attributes for updating GCP scan options configuration.", "properties": { "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", "type": "boolean" }, "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", "type": "boolean" } }, "type": "object" }, "id": { - "description": "The `AzureScanOptionsData` `id`.", + "description": "The GCP project ID.", "example": "", "type": "string" }, "type": { - "default": "azure_scan_options", - "description": "The type of the resource. The value should always be `azure_scan_options`.", + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", "enum": [ - "azure_scan_options" + "gcp_scan_options" ], - "example": "azure_scan_options", + "example": "gcp_scan_options", "type": "string", "x-enum-varnames": [ - "AZURE_SCAN_OPTIONS" + "GCP_SCAN_OPTIONS" ] } }, @@ -412035,57 +413816,58 @@ } } }, + "description": "New definition of the scan options.", "required": true }, "responses": { - "201": { + "200": { "content": { "application/json": { "schema": { - "description": "The definition of `AzureScanOptions` object.", + "description": "Response object containing GCP scan options for a single project.", "example": { "data": { "attributes": { "vuln_containers_os": true, "vuln_host_os": true }, - "id": "12345678-90ab-cdef-1234-567890abcdef", - "type": "azure_scan_options" + "id": "company-project-id", + "type": "gcp_scan_options" } }, "properties": { "data": { - "description": "The definition of `AzureScanOptionsData` object.", + "description": "Single GCP scan options entry.", "properties": { "attributes": { - "description": "The definition of `AzureScanOptionsDataAttributes` object.", + "description": "Attributes for GCP scan options configuration.", "properties": { "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", + "description": "Indicates if scanning for vulnerabilities in containers is enabled.", "type": "boolean" }, "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", + "description": "Indicates if scanning for vulnerabilities in hosts is enabled.", "type": "boolean" } }, "type": "object" }, "id": { - "description": "The `AzureScanOptionsData` `id`.", + "description": "The GCP project ID.", "example": "", "type": "string" }, "type": { - "default": "azure_scan_options", - "description": "The type of the resource. The value should always be `azure_scan_options`.", + "default": "gcp_scan_options", + "description": "GCP scan options resource type.", "enum": [ - "azure_scan_options" + "gcp_scan_options" ], - "example": "azure_scan_options", + "example": "gcp_scan_options", "type": "string", "x-enum-varnames": [ - "AZURE_SCAN_OPTIONS" + "GCP_SCAN_OPTIONS" ] } }, @@ -412100,9 +413882,9 @@ } } }, - "description": "Created" + "description": "OK" }, - "429": { + "400": { "content": { "application/json": { "schema": { @@ -412128,58 +413910,9 @@ } } }, - "description": "Too many requests" - } - }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "org_management" - ] - } - ], - "summary": "Create azure scan options", - "tags": [ - "Agentless Scanning" - ], - "x-menu-order": 11, - "x-undo": { - "operationId": "DeleteAzureScanOptions", - "parameters": [ - { - "name": "subscription_id", - "source": "data.id" - } - ], - "type": "unsafe" - } - } - }, - "/api/v2/agentless_scanning/accounts/azure/{subscription_id}": { - "delete": { - "description": "Delete Agentless scan options for an Azure subscription.", - "operationId": "DeleteAzureScanOptions", - "parameters": [ - { - "description": "The Azure subscription ID.", - "in": "path", - "name": "subscription_id", - "required": true, - "schema": { - "example": "12345678-90ab-cdef-1234-567890abcdef", - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "No Content" + "description": "Bad Request" }, - "429": { + "403": { "content": { "application/json": { "schema": { @@ -412205,168 +413938,35 @@ } } }, - "description": "Too many requests" - } - }, - "security": [ - { - "apiKeyAuth": [], - "appKeyAuth": [] - }, - { - "AuthZ": [ - "org_management" - ] - } - ], - "summary": "Delete azure scan options", - "tags": [ - "Agentless Scanning" - ], - "x-menu-order": 10, - "x-undo": { - "type": "idempotent" - } - }, - "patch": { - "description": "Update the Agentless scan options for an activated subscription.", - "operationId": "UpdateAzureScanOptions", - "parameters": [ - { - "description": "The Azure subscription ID.", - "in": "path", - "name": "subscription_id", - "required": true, - "schema": { - "example": "12345678-90ab-cdef-1234-567890abcdef", - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "description": "The definition of `AzureScanOptionsInputUpdate` object.", - "example": { - "data": { - "id": "12345678-90ab-cdef-1234-567890abcdef", - "type": "azure_scan_options" - } - }, - "properties": { - "data": { - "description": "The definition of `AzureScanOptionsInputUpdateData` object.", - "properties": { - "attributes": { - "description": "The definition of `AzureScanOptionsInputUpdateDataAttributes` object.", - "properties": { - "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", - "type": "boolean" - }, - "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", - "type": "boolean" - } - }, - "type": "object" - }, - "id": { - "description": "The `AzureScanOptionsInputUpdateData` `id`.", - "example": "", - "type": "string" - }, - "type": { - "default": "azure_scan_options", - "description": "Azure scan options resource type.", - "enum": [ - "azure_scan_options" - ], - "example": "azure_scan_options", - "type": "string", - "x-enum-varnames": [ - "AZURE_SCAN_OPTIONS" - ] - } - }, - "required": [ - "type", - "id" - ], - "type": "object" - } - }, - "type": "object" - } - } + "description": "Not Authorized" }, - "required": true - }, - "responses": { - "200": { + "404": { "content": { "application/json": { "schema": { - "description": "The definition of `AzureScanOptions` object.", - "example": { - "data": { - "attributes": { - "vuln_containers_os": true, - "vuln_host_os": true - }, - "id": "12345678-90ab-cdef-1234-567890abcdef", - "type": "azure_scan_options" - } - }, + "description": "API error response.", "properties": { - "data": { - "description": "The definition of `AzureScanOptionsData` object.", - "properties": { - "attributes": { - "description": "The definition of `AzureScanOptionsDataAttributes` object.", - "properties": { - "vuln_containers_os": { - "description": "The `attributes` `vuln_containers_os`.", - "type": "boolean" - }, - "vuln_host_os": { - "description": "The `attributes` `vuln_host_os`.", - "type": "boolean" - } - }, - "type": "object" - }, - "id": { - "description": "The `AzureScanOptionsData` `id`.", - "example": "", - "type": "string" - }, - "type": { - "default": "azure_scan_options", - "description": "The type of the resource. The value should always be `azure_scan_options`.", - "enum": [ - "azure_scan_options" - ], - "example": "azure_scan_options", - "type": "string", - "x-enum-varnames": [ - "AZURE_SCAN_OPTIONS" - ] - } - }, - "required": [ - "type", - "id" + "errors": { + "description": "A list of errors.", + "example": [ + "Bad Request" ], - "type": "object" + "items": { + "description": "A list of items.", + "example": "Bad Request", + "type": "string" + }, + "type": "array" } }, + "required": [ + "errors" + ], "type": "object" } } }, - "description": "OK" + "description": "Not Found" }, "429": { "content": { @@ -412408,11 +414008,12 @@ ] } ], - "summary": "Update azure scan options", + "summary": "Patch GCP Scan Options", "tags": [ "Agentless Scanning" ], - "x-menu-order": 9, + "x-codegen-request-body-name": "body", + "x-menu-order": 14, "x-undo": { "type": "idempotent" } @@ -412561,7 +414162,7 @@ "tags": [ "Agentless Scanning" ], - "x-menu-order": 6, + "x-menu-order": 16, "x-permission": { "operator": "OR", "permissions": [ @@ -412792,7 +414393,7 @@ "Agentless Scanning" ], "x-codegen-request-body-name": "body", - "x-menu-order": 8, + "x-menu-order": 17, "x-permission": { "operator": "OR", "permissions": [ @@ -413011,7 +414612,7 @@ "tags": [ "Agentless Scanning" ], - "x-menu-order": 7, + "x-menu-order": 18, "x-permission": { "operator": "OR", "permissions": [