262 lines
10 KiB
JSON
262 lines
10 KiB
JSON
{
|
|
"name": "UpdateGcpScanOptions",
|
|
"fully_qualified_name": "DatadogApi.UpdateGcpScanOptions@0.1.0",
|
|
"description": "Update scan options for a GCP project in Datadog.\n\nUse this tool to update the agentless scanning options for an activated Google Cloud Platform project in Datadog. It should be called when changes to the existing scan configuration are needed.",
|
|
"toolkit": {
|
|
"name": "ArcadeDatadogApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "gcp_project_id",
|
|
"required": true,
|
|
"description": "The Google Cloud Platform project ID to update scan options for.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The GCP project ID."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "project_id"
|
|
},
|
|
{
|
|
"name": "google_cloud_project_id",
|
|
"required": false,
|
|
"description": "The ID of the GCP project to update scan options for, used as an identifier.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The GCP project ID."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "data.id"
|
|
},
|
|
{
|
|
"name": "gcp_scan_options_resource_type",
|
|
"required": false,
|
|
"description": "Specifies the GCP scan options resource type, typically set to 'gcp_scan_options'.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"gcp_scan_options"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "GCP scan options resource type."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "data.type"
|
|
},
|
|
{
|
|
"name": "enable_container_vulnerability_scanning",
|
|
"required": false,
|
|
"description": "Enable (True) or disable (False) scanning for vulnerabilities in containers.",
|
|
"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_host_vulnerability_scanning",
|
|
"required": false,
|
|
"description": "Indicate if scanning for vulnerabilities in host operating systems 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."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "data.attributes.vuln_host_os"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'UpdateGcpScanOptions'.",
|
|
"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/gcp/{project_id}",
|
|
"http_method": "PATCH",
|
|
"headers": {},
|
|
"parameters": [
|
|
{
|
|
"name": "project_id",
|
|
"tool_parameter_name": "gcp_project_id",
|
|
"description": "The GCP project ID.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The GCP project ID."
|
|
},
|
|
"accepted_as": "path",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "data.attributes.vuln_containers_os",
|
|
"tool_parameter_name": "enable_container_vulnerability_scanning",
|
|
"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_host_vulnerability_scanning",
|
|
"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": "google_cloud_project_id",
|
|
"description": "The GCP project ID.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The GCP project ID."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": null,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "data.type",
|
|
"tool_parameter_name": "gcp_scan_options_resource_type",
|
|
"description": "GCP scan options resource type.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"gcp_scan_options"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "GCP scan options resource type."
|
|
},
|
|
"accepted_as": "body",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"default": "gcp_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 for updating GCP scan options.\",\n \"example\": {\n \"data\": {\n \"id\": \"company-project-id\",\n \"type\": \"gcp_scan_options\"\n }\n },\n \"properties\": {\n \"data\": {\n \"description\": \"Data object for updating the scan options of a single GCP project.\",\n \"properties\": {\n \"attributes\": {\n \"description\": \"Attributes for updating GCP scan options configuration.\",\n \"properties\": {\n \"vuln_containers_os\": {\n \"description\": \"Indicates if scanning for vulnerabilities in containers is enabled.\",\n \"type\": \"boolean\"\n },\n \"vuln_host_os\": {\n \"description\": \"Indicates if scanning for vulnerabilities in hosts is enabled.\",\n \"type\": \"boolean\"\n }\n },\n \"type\": \"object\"\n },\n \"id\": {\n \"description\": \"The GCP project ID.\",\n \"example\": \"\",\n \"type\": \"string\"\n },\n \"type\": {\n \"default\": \"gcp_scan_options\",\n \"description\": \"GCP scan options resource type.\",\n \"enum\": [\n \"gcp_scan_options\"\n ],\n \"example\": \"gcp_scan_options\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"GCP_SCAN_OPTIONS\"\n ]\n }\n },\n \"required\": [\n \"type\",\n \"id\"\n ],\n \"type\": \"object\"\n }\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
|
|
}
|
|
}
|