328 lines
13 KiB
JSON
328 lines
13 KiB
JSON
{
|
|
"name": "UpdateAwsScanOptions",
|
|
"fully_qualified_name": "DatadogApi.UpdateAwsScanOptions@0.1.0",
|
|
"description": "Update Agentless scan options for an AWS account.\n\nThis tool updates the Agentless scan settings for a specified AWS account. It should be called when modifications to scan options are needed for security or compliance purposes.",
|
|
"toolkit": {
|
|
"name": "ArcadeDatadogApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "aws_account_id",
|
|
"required": true,
|
|
"description": "The ID of the AWS account for which to update scan options.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The ID of an AWS account."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "account_id"
|
|
},
|
|
{
|
|
"name": "account_identifier",
|
|
"required": true,
|
|
"description": "The ID of the AWS account that needs scan options updated.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The ID of the AWS account."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "data.id"
|
|
},
|
|
{
|
|
"name": "resource_type",
|
|
"required": true,
|
|
"description": "Specifies the resource type. Must be set to `aws_scan_options`.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"aws_scan_options"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The type of the resource. The value should always be `aws_scan_options`."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "data.type"
|
|
},
|
|
{
|
|
"name": "enable_lambda_scanning",
|
|
"required": false,
|
|
"description": "Set to true to enable scanning of AWS Lambda functions.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Indicates if scanning of Lambda functions is enabled."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "data.attributes.lambda"
|
|
},
|
|
{
|
|
"name": "enable_sensitive_data_scanning",
|
|
"required": false,
|
|
"description": "Enable scanning for sensitive data in the AWS account. Set to true to enable.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Indicates if scanning for sensitive data is enabled."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "data.attributes.sensitive_data"
|
|
},
|
|
{
|
|
"name": "enable_vulnerability_scanning_for_containers",
|
|
"required": false,
|
|
"description": "Set to true to enable scanning for container vulnerabilities.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Indicates if scanning for vulnerabilities in containers is enabled."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "data.attributes.vuln_containers_os"
|
|
},
|
|
{
|
|
"name": "enable_vulnerability_scanning_in_hosts",
|
|
"required": false,
|
|
"description": "Enable scanning for vulnerabilities in hosts. Set to true to enable, false to disable.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Indicates if scanning for vulnerabilities in hosts is enabled."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "data.attributes.vuln_host_os"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'UpdateAwsScanOptions'.",
|
|
"available_modes": [
|
|
"value",
|
|
"error",
|
|
"null"
|
|
],
|
|
"value_schema": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": null
|
|
}
|
|
},
|
|
"requirements": {
|
|
"authorization": null,
|
|
"secrets": [
|
|
{
|
|
"key": "DATADOG_API_KEY"
|
|
},
|
|
{
|
|
"key": "DATADOG_APPLICATION_KEY"
|
|
},
|
|
{
|
|
"key": "DATADOG_BASE_URL"
|
|
}
|
|
],
|
|
"metadata": null
|
|
},
|
|
"deprecation_message": null,
|
|
"metadata": {
|
|
"object_type": "api_wrapper_tool",
|
|
"version": "1.1.0",
|
|
"description": "Tools that enable LLMs to interact directly with the Datadog API."
|
|
},
|
|
"http_endpoint": {
|
|
"metadata": {
|
|
"object_type": "http_endpoint",
|
|
"version": "1.2.0",
|
|
"description": ""
|
|
},
|
|
"url": "https://{datadog_base_url}/api/v2/agentless_scanning/accounts/aws/{account_id}",
|
|
"http_method": "PATCH",
|
|
"headers": {},
|
|
"parameters": [
|
|
{
|
|
"name": "account_id",
|
|
"tool_parameter_name": "aws_account_id",
|
|
"description": "The ID of an AWS account.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The ID of an AWS account."
|
|
},
|
|
"accepted_as": "path",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "data.attributes.lambda",
|
|
"tool_parameter_name": "enable_lambda_scanning",
|
|
"description": "Indicates if scanning of Lambda functions is enabled.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Indicates if scanning of Lambda functions is enabled."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "data.attributes.sensitive_data",
|
|
"tool_parameter_name": "enable_sensitive_data_scanning",
|
|
"description": "Indicates if scanning for sensitive data is enabled.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Indicates if scanning for sensitive data is enabled."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "data.attributes.vuln_containers_os",
|
|
"tool_parameter_name": "enable_vulnerability_scanning_for_containers",
|
|
"description": "Indicates if scanning for vulnerabilities in containers is enabled.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Indicates if scanning for vulnerabilities in containers is enabled."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "data.attributes.vuln_host_os",
|
|
"tool_parameter_name": "enable_vulnerability_scanning_in_hosts",
|
|
"description": "Indicates if scanning for vulnerabilities in hosts is enabled.",
|
|
"value_schema": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Indicates if scanning for vulnerabilities in hosts is enabled."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "data.id",
|
|
"tool_parameter_name": "account_identifier",
|
|
"description": "The ID of the AWS account.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The ID of the AWS account."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "data.type",
|
|
"tool_parameter_name": "resource_type",
|
|
"description": "The type of the resource. The value should always be `aws_scan_options`.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"aws_scan_options"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The type of the resource. The value should always be `aws_scan_options`."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": "aws_scan_options",
|
|
"documentation_urls": []
|
|
}
|
|
],
|
|
"documentation_urls": [],
|
|
"secrets": [
|
|
{
|
|
"arcade_key": "DATADOG_API_KEY",
|
|
"parameter_name": "DD-API-KEY",
|
|
"accepted_as": "header",
|
|
"formatted_value": null,
|
|
"description": "",
|
|
"is_auth_token": false
|
|
},
|
|
{
|
|
"arcade_key": "DATADOG_APPLICATION_KEY",
|
|
"parameter_name": "DD-APPLICATION-KEY",
|
|
"accepted_as": "header",
|
|
"formatted_value": null,
|
|
"description": "",
|
|
"is_auth_token": false
|
|
},
|
|
{
|
|
"arcade_key": "DATADOG_BASE_URL",
|
|
"parameter_name": "datadog_base_url",
|
|
"accepted_as": "path",
|
|
"formatted_value": null,
|
|
"description": "",
|
|
"is_auth_token": false
|
|
}
|
|
],
|
|
"request_body_spec": "{\n \"content\": {\n \"application/json\": {\n \"schema\": {\n \"description\": \"Request object that includes the scan options to update.\",\n \"properties\": {\n \"data\": {\n \"description\": \"Object for the scan options of a single AWS account.\",\n \"properties\": {\n \"attributes\": {\n \"description\": \"Attributes for the AWS scan options to update.\",\n \"properties\": {\n \"lambda\": {\n \"description\": \"Indicates if scanning of Lambda functions is enabled.\",\n \"example\": true,\n \"type\": \"boolean\"\n },\n \"sensitive_data\": {\n \"description\": \"Indicates if scanning for sensitive data is enabled.\",\n \"example\": false,\n \"type\": \"boolean\"\n },\n \"vuln_containers_os\": {\n \"description\": \"Indicates if scanning for vulnerabilities in containers is enabled.\",\n \"example\": true,\n \"type\": \"boolean\"\n },\n \"vuln_host_os\": {\n \"description\": \"Indicates if scanning for vulnerabilities in hosts is enabled.\",\n \"example\": true,\n \"type\": \"boolean\"\n }\n },\n \"type\": \"object\"\n },\n \"id\": {\n \"description\": \"The ID of the AWS account.\",\n \"example\": \"123456789012\",\n \"type\": \"string\"\n },\n \"type\": {\n \"default\": \"aws_scan_options\",\n \"description\": \"The type of the resource. The value should always be `aws_scan_options`.\",\n \"enum\": [\n \"aws_scan_options\"\n ],\n \"example\": \"aws_scan_options\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"AWS_SCAN_OPTIONS\"\n ]\n }\n },\n \"required\": [\n \"id\",\n \"type\",\n \"attributes\"\n ],\n \"type\": \"object\"\n }\n },\n \"required\": [\n \"data\"\n ],\n \"type\": \"object\"\n }\n }\n },\n \"description\": \"New definition of the scan options.\",\n \"required\": true\n}",
|
|
"use_request_body_schema_mode": false,
|
|
"validate_request_body_schema": false
|
|
}
|
|
}
|