436 lines
30 KiB
JSON
436 lines
30 KiB
JSON
{
|
|
"name": "CreateIncident",
|
|
"fully_qualified_name": "DatadogApi.CreateIncident@0.1.0",
|
|
"description": "Create a new incident in Datadog.\n\nThis tool is used to create a new incident within Datadog's incident management system. Trigger this tool when there is a need to report or manage an incident requiring attention.",
|
|
"toolkit": {
|
|
"name": "ArcadeDatadogApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "incident_payload",
|
|
"required": true,
|
|
"description": "A JSON object containing incident attributes like title, impact scope, and more. Include relationships and type as defined in the schema.",
|
|
"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": {
|
|
"customer_impact_scope": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Required if `customer_impacted:\"true\"`. A summary of the impact customers experienced during the incident."
|
|
},
|
|
"customer_impacted": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A flag indicating whether the incident caused customer impact."
|
|
},
|
|
"fields": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A condensed view of the user-defined fields for which to create initial selections."
|
|
},
|
|
"incident_type_uuid": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A unique identifier that represents an incident type. The default incident type will be used if this property is not provided."
|
|
},
|
|
"initial_cells": {
|
|
"val_type": "array",
|
|
"inner_val_type": "json",
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": {},
|
|
"description": "An array of initial timeline cells to be placed at the beginning of the incident timeline."
|
|
},
|
|
"is_test": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A flag indicating whether the incident is a test incident."
|
|
},
|
|
"notification_handles": {
|
|
"val_type": "array",
|
|
"inner_val_type": "json",
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": {
|
|
"display_name": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The name of the notified handle."
|
|
},
|
|
"handle": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The handle used for the notification. This includes an email address, Slack channel, or workflow."
|
|
}
|
|
},
|
|
"description": "Notification handles that will be notified of the incident at creation."
|
|
},
|
|
"title": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The title of the incident, which summarizes what happened."
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": "The incident's attributes for a create request."
|
|
},
|
|
"relationships": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": {
|
|
"commander_user": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": {
|
|
"data": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": {
|
|
"id": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A unique identifier that represents the user."
|
|
},
|
|
"type": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"users"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Users resource type."
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": "Relationship to user object."
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": "Relationship to user."
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": "The relationships the incident will have with other resources once created."
|
|
},
|
|
"type": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"incidents"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Incident resource type."
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": "Incident data for a create request."
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": "Incident payload."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "requestBody"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'CreateIncident'.",
|
|
"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",
|
|
"http_method": "POST",
|
|
"headers": {},
|
|
"parameters": [
|
|
{
|
|
"name": "requestBody",
|
|
"tool_parameter_name": "incident_payload",
|
|
"description": "Incident 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": {
|
|
"customer_impact_scope": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Required if `customer_impacted:\"true\"`. A summary of the impact customers experienced during the incident."
|
|
},
|
|
"customer_impacted": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A flag indicating whether the incident caused customer impact."
|
|
},
|
|
"fields": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A condensed view of the user-defined fields for which to create initial selections."
|
|
},
|
|
"incident_type_uuid": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A unique identifier that represents an incident type. The default incident type will be used if this property is not provided."
|
|
},
|
|
"initial_cells": {
|
|
"val_type": "array",
|
|
"inner_val_type": "json",
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": {},
|
|
"description": "An array of initial timeline cells to be placed at the beginning of the incident timeline."
|
|
},
|
|
"is_test": {
|
|
"val_type": "boolean",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A flag indicating whether the incident is a test incident."
|
|
},
|
|
"notification_handles": {
|
|
"val_type": "array",
|
|
"inner_val_type": "json",
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": {
|
|
"display_name": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The name of the notified handle."
|
|
},
|
|
"handle": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The handle used for the notification. This includes an email address, Slack channel, or workflow."
|
|
}
|
|
},
|
|
"description": "Notification handles that will be notified of the incident at creation."
|
|
},
|
|
"title": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The title of the incident, which summarizes what happened."
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": "The incident's attributes for a create request."
|
|
},
|
|
"relationships": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": {
|
|
"commander_user": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": {
|
|
"data": {
|
|
"val_type": "json",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": {
|
|
"id": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "A unique identifier that represents the user."
|
|
},
|
|
"type": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"users"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Users resource type."
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": "Relationship to user object."
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": "Relationship to user."
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": "The relationships the incident will have with other resources once created."
|
|
},
|
|
"type": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"incidents"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Incident resource type."
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": "Incident data for a create request."
|
|
}
|
|
},
|
|
"inner_properties": null,
|
|
"description": "Incident 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.\",\n \"properties\": {\n \"data\": {\n \"description\": \"Incident data for a create request.\",\n \"properties\": {\n \"attributes\": {\n \"description\": \"The incident's attributes for a create request.\",\n \"properties\": {\n \"customer_impact_scope\": {\n \"description\": \"Required if `customer_impacted:\\\"true\\\"`. A summary of the impact customers experienced during the incident.\",\n \"example\": \"Example customer impact scope\",\n \"type\": \"string\"\n },\n \"customer_impacted\": {\n \"description\": \"A flag indicating whether the incident caused customer impact.\",\n \"example\": false,\n \"type\": \"boolean\"\n },\n \"fields\": {\n \"additionalProperties\": {\n \"description\": \"Dynamic fields for which selections can be made, with field names as keys.\",\n \"oneOf\": [\n {\n \"description\": \"A field with a single value selected.\",\n \"properties\": {\n \"type\": {\n \"default\": \"dropdown\",\n \"description\": \"Type of the single value field definitions.\",\n \"enum\": [\n \"dropdown\",\n \"textbox\"\n ],\n \"example\": \"dropdown\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"DROPDOWN\",\n \"TEXTBOX\"\n ]\n },\n \"value\": {\n \"description\": \"The single value selected for this field.\",\n \"example\": \"SEV-1\",\n \"nullable\": true,\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n {\n \"description\": \"A field with potentially multiple values selected.\",\n \"properties\": {\n \"type\": {\n \"default\": \"multiselect\",\n \"description\": \"Type of the multiple value field definitions.\",\n \"enum\": [\n \"multiselect\",\n \"textarray\",\n \"metrictag\",\n \"autocomplete\"\n ],\n \"example\": \"multiselect\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"MULTISELECT\",\n \"TEXTARRAY\",\n \"METRICTAG\",\n \"AUTOCOMPLETE\"\n ]\n },\n \"value\": {\n \"description\": \"The multiple values selected for this field.\",\n \"example\": [\n \"1.0\",\n \"1.1\"\n ],\n \"items\": {\n \"description\": \"A value which has been selected for the parent field.\",\n \"example\": \"1.1\",\n \"type\": \"string\"\n },\n \"nullable\": true,\n \"type\": \"array\"\n }\n },\n \"type\": \"object\"\n }\n ]\n },\n \"description\": \"A condensed view of the user-defined fields for which to create initial selections.\",\n \"example\": {\n \"severity\": {\n \"type\": \"dropdown\",\n \"value\": \"SEV-5\"\n }\n },\n \"type\": \"object\"\n },\n \"incident_type_uuid\": {\n \"description\": \"A unique identifier that represents an incident type. The default incident type will be used if this property is not provided.\",\n \"example\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"string\"\n },\n \"initial_cells\": {\n \"description\": \"An array of initial timeline cells to be placed at the beginning of the incident timeline.\",\n \"items\": {\n \"description\": \"The timeline cell's attributes for a create request.\",\n \"oneOf\": [\n {\n \"description\": \"Timeline cell data for Markdown timeline cells for a create request.\",\n \"properties\": {\n \"cell_type\": {\n \"default\": \"markdown\",\n \"description\": \"Type of the Markdown timeline cell.\",\n \"enum\": [\n \"markdown\"\n ],\n \"example\": \"markdown\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"MARKDOWN\"\n ]\n },\n \"content\": {\n \"description\": \"The Markdown timeline cell contents.\",\n \"properties\": {\n \"content\": {\n \"description\": \"The Markdown content of the cell.\",\n \"example\": \"An example timeline cell message.\",\n \"nullable\": false,\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"important\": {\n \"default\": false,\n \"description\": \"A flag indicating whether the timeline cell is important and should be highlighted.\",\n \"example\": false,\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"content\",\n \"cell_type\"\n ],\n \"type\": \"object\"\n }\n ]\n },\n \"type\": \"array\"\n },\n \"is_test\": {\n \"description\": \"A flag indicating whether the incident is a test incident.\",\n \"example\": false,\n \"type\": \"boolean\"\n },\n \"notification_handles\": {\n \"description\": \"Notification handles that will be notified of the incident at creation.\",\n \"example\": [\n {\n \"display_name\": \"Jane Doe\",\n \"handle\": \"@user@email.com\"\n },\n {\n \"display_name\": \"Slack Channel\",\n \"handle\": \"@slack-channel\"\n },\n {\n \"display_name\": \"Incident Workflow\",\n \"handle\": \"@workflow-from-incident\"\n }\n ],\n \"items\": {\n \"description\": \"A notification handle that will be notified at incident creation.\",\n \"properties\": {\n \"display_name\": {\n \"description\": \"The name of the notified handle.\",\n \"example\": \"Jane Doe\",\n \"type\": \"string\"\n },\n \"handle\": {\n \"description\": \"The handle used for the notification. This includes an email address, Slack channel, or workflow.\",\n \"example\": \"@test.user@test.com\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"type\": \"array\"\n },\n \"title\": {\n \"description\": \"The title of the incident, which summarizes what happened.\",\n \"example\": \"A test incident title\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"title\",\n \"customer_impacted\"\n ],\n \"type\": \"object\"\n },\n \"relationships\": {\n \"description\": \"The relationships the incident will have with other resources once created.\",\n \"properties\": {\n \"commander_user\": {\n \"description\": \"Relationship to user.\",\n \"nullable\": true,\n \"properties\": {\n \"data\": {\n \"description\": \"Relationship to user object.\",\n \"nullable\": true,\n \"properties\": {\n \"id\": {\n \"description\": \"A unique identifier that represents the user.\",\n \"example\": \"00000000-0000-0000-0000-000000000000\",\n \"type\": \"string\"\n },\n \"type\": {\n \"default\": \"users\",\n \"description\": \"Users resource type.\",\n \"enum\": [\n \"users\"\n ],\n \"example\": \"users\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"USERS\"\n ]\n }\n },\n \"required\": [\n \"id\",\n \"type\"\n ],\n \"type\": \"object\"\n }\n },\n \"required\": [\n \"data\"\n ],\n \"type\": \"object\"\n }\n },\n \"required\": [\n \"commander_user\"\n ],\n \"type\": \"object\"\n },\n \"type\": {\n \"default\": \"incidents\",\n \"description\": \"Incident resource type.\",\n \"enum\": [\n \"incidents\"\n ],\n \"example\": \"incidents\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"INCIDENTS\"\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 payload.\",\n \"required\": true\n}",
|
|
"use_request_body_schema_mode": true,
|
|
"validate_request_body_schema": true
|
|
}
|
|
}
|