arcade-mcp/toolkits/datadog_api/arcade_datadog_api/wrapper_tools/CreateIncidentImpact.json
jottakka f05560bbf4
[MOAR][DATADOG] Adding DataDog starter toolkit (+590) (#633)
Co-authored-by: Francisco Liberal <francisco@arcade.dev>
2025-10-20 15:49:48 -03:00

314 lines
13 KiB
JSON

{
"name": "CreateIncidentImpact",
"fully_qualified_name": "DatadogApi.CreateIncidentImpact@0.1.0",
"description": "Create an impact for a specific incident.\n\nThis tool is used to create an impact for a specified incident. It should be called when there is a need to log or document the impact details of an ongoing or past incident.",
"toolkit": {
"name": "ArcadeDatadogApi",
"description": null,
"version": "0.1.0"
},
"input": {
"parameters": [
{
"name": "incident_uuid",
"required": true,
"description": "The unique identifier (UUID) for the incident. This is required to log impact details for the specified incident.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The UUID of the incident."
},
"inferrable": true,
"http_endpoint_parameter_name": "incident_id"
},
{
"name": "incident_impact_payload",
"required": true,
"description": "A JSON object detailing the impact, including 'attributes' with 'description', 'start_at', 'end_at', 'fields', and 'type' as 'incident_impacts'.",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"data": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"attributes": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"description": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Description of the impact."
},
"end_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Timestamp when the impact ended."
},
"fields": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "An object mapping impact field names to field values."
},
"start_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Timestamp when the impact started."
}
},
"inner_properties": null,
"description": "The incident impact's attributes for a create request."
},
"type": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"incident_impacts"
],
"properties": null,
"inner_properties": null,
"description": "Incident impact resource type."
}
},
"inner_properties": null,
"description": "Incident impact data for a create request."
}
},
"inner_properties": null,
"description": "Incident impact payload."
},
"inferrable": true,
"http_endpoint_parameter_name": "requestBody"
},
{
"name": "included_resources",
"required": false,
"description": "List of related resources to include in the response, such as 'users' or 'details'.",
"value_schema": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Specifies which related resources should be included in the response."
},
"inferrable": true,
"http_endpoint_parameter_name": "include"
}
]
},
"output": {
"description": "Response from the API endpoint 'CreateIncidentImpact'.",
"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/incidents/{incident_id}/impacts",
"http_method": "POST",
"headers": {},
"parameters": [
{
"name": "include",
"tool_parameter_name": "included_resources",
"description": "Specifies which related resources should be included in the response.",
"value_schema": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Specifies which related resources should be included in the response."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "incident_id",
"tool_parameter_name": "incident_uuid",
"description": "The UUID of the incident.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The UUID of the incident."
},
"accepted_as": "path",
"required": true,
"deprecated": false,
"default": null,
"documentation_urls": []
},
{
"name": "requestBody",
"tool_parameter_name": "incident_impact_payload",
"description": "Incident impact payload.",
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"data": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"attributes": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": {
"description": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Description of the impact."
},
"end_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Timestamp when the impact ended."
},
"fields": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "An object mapping impact field names to field values."
},
"start_at": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Timestamp when the impact started."
}
},
"inner_properties": null,
"description": "The incident impact's attributes for a create request."
},
"type": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"incident_impacts"
],
"properties": null,
"inner_properties": null,
"description": "Incident impact resource type."
}
},
"inner_properties": null,
"description": "Incident impact data for a create request."
}
},
"inner_properties": null,
"description": "Incident impact payload."
},
"accepted_as": "body",
"required": true,
"deprecated": false,
"default": null,
"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\": \"Create request for an incident impact.\",\n \"properties\": {\n \"data\": {\n \"description\": \"Incident impact data for a create request.\",\n \"properties\": {\n \"attributes\": {\n \"description\": \"The incident impact's attributes for a create request.\",\n \"properties\": {\n \"description\": {\n \"description\": \"Description of the impact.\",\n \"example\": \"Service was unavailable for external users\",\n \"type\": \"string\"\n },\n \"end_at\": {\n \"description\": \"Timestamp when the impact ended.\",\n \"example\": \"2025-08-29T13:17:00Z\",\n \"format\": \"date-time\",\n \"nullable\": true,\n \"type\": \"string\"\n },\n \"fields\": {\n \"additionalProperties\": {},\n \"description\": \"An object mapping impact field names to field values.\",\n \"example\": {\n \"customers_impacted\": \"all\",\n \"products_impacted\": [\n \"shopping\",\n \"marketing\"\n ]\n },\n \"nullable\": true,\n \"type\": \"object\"\n },\n \"start_at\": {\n \"description\": \"Timestamp when the impact started.\",\n \"example\": \"2025-08-28T13:17:00Z\",\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"description\",\n \"start_at\"\n ],\n \"type\": \"object\"\n },\n \"type\": {\n \"default\": \"incident_impacts\",\n \"description\": \"Incident impact resource type.\",\n \"enum\": [\n \"incident_impacts\"\n ],\n \"example\": \"incident_impacts\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"INCIDENT_IMPACTS\"\n ]\n }\n },\n \"required\": [\n \"type\",\n \"attributes\"\n ],\n \"type\": \"object\"\n }\n },\n \"required\": [\n \"data\"\n ],\n \"type\": \"object\"\n }\n }\n },\n \"description\": \"Incident impact payload.\",\n \"required\": true\n}",
"use_request_body_schema_mode": true,
"validate_request_body_schema": true
}
}