{ "name": "CreateOrUpdateServiceDefinitions", "fully_qualified_name": "DatadogApi.CreateOrUpdateServiceDefinitions@0.1.0", "description": "Create or update service definitions in Datadog.\n\nUse this tool to create a new service definition or update an existing one in the Datadog Service Catalog. Call this when needing to manage service details within Datadog.", "toolkit": { "name": "ArcadeDatadogApi", "description": null, "version": "0.1.0" }, "input": { "parameters": [ { "name": "service_definition_yaml_json", "required": true, "description": "Provide the service definition in YAML or JSON format for creating or updating a service in Datadog.", "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Service Definition YAML/JSON." }, "inferrable": true, "http_endpoint_parameter_name": "requestBody" } ] }, "output": { "description": "Response from the API endpoint 'CreateOrUpdateServiceDefinitions'.", "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/services/definitions", "http_method": "POST", "headers": {}, "parameters": [ { "name": "requestBody", "tool_parameter_name": "service_definition_yaml_json", "description": "Service Definition YAML/JSON.", "value_schema": { "val_type": "json", "inner_val_type": null, "enum": null, "properties": null, "inner_properties": null, "description": "Service Definition YAML/JSON." }, "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 service definitions request.\",\n \"oneOf\": [\n {\n \"description\": \"Service definition v2.2 for providing service metadata and integrations.\",\n \"properties\": {\n \"application\": {\n \"description\": \"Identifier for a group of related services serving a product feature, which the service is a part of.\",\n \"example\": \"my-app\",\n \"type\": \"string\"\n },\n \"ci-pipeline-fingerprints\": {\n \"description\": \"A set of CI fingerprints.\",\n \"example\": [\n \"j88xdEy0J5lc\",\n \"eZ7LMljCk8vo\"\n ],\n \"items\": {\n \"type\": \"string\"\n },\n \"type\": \"array\"\n },\n \"contacts\": {\n \"description\": \"A list of contacts related to the services.\",\n \"items\": {\n \"description\": \"Service owner's contacts information.\",\n \"properties\": {\n \"contact\": {\n \"description\": \"Contact value.\",\n \"example\": \"https://teams.microsoft.com/myteam\",\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"Contact Name.\",\n \"example\": \"My team channel\",\n \"type\": \"string\"\n },\n \"type\": {\n \"description\": \"Contact type. Datadog recognizes the following types: `email`, `slack`, and `microsoft-teams`.\",\n \"example\": \"slack\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"type\",\n \"contact\"\n ],\n \"type\": \"object\"\n },\n \"type\": \"array\"\n },\n \"dd-service\": {\n \"description\": \"Unique identifier of the service. Must be unique across all services and is used to match with a service in Datadog.\",\n \"example\": \"my-service\",\n \"type\": \"string\"\n },\n \"description\": {\n \"description\": \"A short description of the service.\",\n \"example\": \"My service description\",\n \"type\": \"string\"\n },\n \"extensions\": {\n \"additionalProperties\": {},\n \"description\": \"Extensions to v2.2 schema.\",\n \"example\": {\n \"myorg/extension\": \"extensionValue\"\n },\n \"type\": \"object\"\n },\n \"integrations\": {\n \"description\": \"Third party integrations that Datadog supports.\",\n \"properties\": {\n \"opsgenie\": {\n \"description\": \"Opsgenie integration for the service.\",\n \"properties\": {\n \"region\": {\n \"description\": \"Opsgenie instance region.\",\n \"enum\": [\n \"US\",\n \"EU\"\n ],\n \"example\": \"US\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"US\",\n \"EU\"\n ]\n },\n \"service-url\": {\n \"description\": \"Opsgenie service url.\",\n \"example\": \"https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"service-url\"\n ],\n \"type\": \"object\"\n },\n \"pagerduty\": {\n \"description\": \"PagerDuty integration for the service.\",\n \"properties\": {\n \"service-url\": {\n \"description\": \"PagerDuty service url.\",\n \"example\": \"https://my-org.pagerduty.com/service-directory/PMyService\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n }\n },\n \"type\": \"object\"\n },\n \"languages\": {\n \"description\": \"The service's programming language. Datadog recognizes the following languages: `dotnet`, `go`, `java`, `js`, `php`, `python`, `ruby`, and `c++`.\",\n \"example\": [\n \"dotnet\",\n \"go\",\n \"java\",\n \"js\",\n \"php\",\n \"python\",\n \"ruby\",\n \"c++\"\n ],\n \"items\": {\n \"type\": \"string\"\n },\n \"type\": \"array\"\n },\n \"lifecycle\": {\n \"description\": \"The current life cycle phase of the service.\",\n \"example\": \"sandbox\",\n \"type\": \"string\"\n },\n \"links\": {\n \"description\": \"A list of links related to the services.\",\n \"items\": {\n \"description\": \"Service's external links.\",\n \"properties\": {\n \"name\": {\n \"description\": \"Link name.\",\n \"example\": \"Runbook\",\n \"type\": \"string\"\n },\n \"provider\": {\n \"description\": \"Link provider.\",\n \"example\": \"Github\",\n \"type\": \"string\"\n },\n \"type\": {\n \"description\": \"Link type. Datadog recognizes the following types: `runbook`, `doc`, `repo`, `dashboard`, and `other`.\",\n \"example\": \"runbook\",\n \"type\": \"string\"\n },\n \"url\": {\n \"description\": \"Link URL.\",\n \"example\": \"https://my-runbook\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"type\",\n \"url\"\n ],\n \"type\": \"object\"\n },\n \"type\": \"array\"\n },\n \"schema-version\": {\n \"default\": \"v2.2\",\n \"description\": \"Schema version being used.\",\n \"enum\": [\n \"v2.2\"\n ],\n \"example\": \"v2.2\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"V2_2\"\n ]\n },\n \"tags\": {\n \"description\": \"A set of custom tags.\",\n \"example\": [\n \"my:tag\",\n \"service:tag\"\n ],\n \"items\": {\n \"type\": \"string\"\n },\n \"type\": \"array\"\n },\n \"team\": {\n \"description\": \"Team that owns the service. It is used to locate a team defined in Datadog Teams if it exists.\",\n \"example\": \"my-team\",\n \"type\": \"string\"\n },\n \"tier\": {\n \"description\": \"Importance of the service.\",\n \"example\": \"High\",\n \"type\": \"string\"\n },\n \"type\": {\n \"description\": \"The type of service.\",\n \"example\": \"web\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"schema-version\",\n \"dd-service\"\n ],\n \"type\": \"object\"\n },\n {\n \"description\": \"Service definition v2.1 for providing service metadata and integrations.\",\n \"properties\": {\n \"application\": {\n \"description\": \"Identifier for a group of related services serving a product feature, which the service is a part of.\",\n \"example\": \"my-app\",\n \"type\": \"string\"\n },\n \"contacts\": {\n \"description\": \"A list of contacts related to the services.\",\n \"items\": {\n \"description\": \"Service owner's contacts information.\",\n \"oneOf\": [\n {\n \"description\": \"Service owner's email.\",\n \"properties\": {\n \"contact\": {\n \"description\": \"Contact value.\",\n \"example\": \"contact@datadoghq.com\",\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"Contact email.\",\n \"example\": \"Team Email\",\n \"type\": \"string\"\n },\n \"type\": {\n \"description\": \"Contact type.\",\n \"enum\": [\n \"email\"\n ],\n \"example\": \"email\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"EMAIL\"\n ]\n }\n },\n \"required\": [\n \"type\",\n \"contact\"\n ],\n \"type\": \"object\"\n },\n {\n \"description\": \"Service owner's Slack channel.\",\n \"properties\": {\n \"contact\": {\n \"description\": \"Slack Channel.\",\n \"example\": \"https://yourcompany.slack.com/archives/channel123\",\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"Contact Slack.\",\n \"example\": \"Team Slack\",\n \"type\": \"string\"\n },\n \"type\": {\n \"description\": \"Contact type.\",\n \"enum\": [\n \"slack\"\n ],\n \"example\": \"slack\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"SLACK\"\n ]\n }\n },\n \"required\": [\n \"type\",\n \"contact\"\n ],\n \"type\": \"object\"\n },\n {\n \"description\": \"Service owner's Microsoft Teams.\",\n \"properties\": {\n \"contact\": {\n \"description\": \"Contact value.\",\n \"example\": \"https://teams.microsoft.com/myteam\",\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"Contact Microsoft Teams.\",\n \"example\": \"My team channel\",\n \"type\": \"string\"\n },\n \"type\": {\n \"description\": \"Contact type.\",\n \"enum\": [\n \"microsoft-teams\"\n ],\n \"example\": \"microsoft-teams\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"MICROSOFT_TEAMS\"\n ]\n }\n },\n \"required\": [\n \"type\",\n \"contact\"\n ],\n \"type\": \"object\"\n }\n ]\n },\n \"type\": \"array\"\n },\n \"dd-service\": {\n \"description\": \"Unique identifier of the service. Must be unique across all services and is used to match with a service in Datadog.\",\n \"example\": \"my-service\",\n \"type\": \"string\"\n },\n \"description\": {\n \"description\": \"A short description of the service.\",\n \"example\": \"My service description\",\n \"type\": \"string\"\n },\n \"extensions\": {\n \"additionalProperties\": {},\n \"description\": \"Extensions to v2.1 schema.\",\n \"example\": {\n \"myorg/extension\": \"extensionValue\"\n },\n \"type\": \"object\"\n },\n \"integrations\": {\n \"description\": \"Third party integrations that Datadog supports.\",\n \"properties\": {\n \"opsgenie\": {\n \"description\": \"Opsgenie integration for the service.\",\n \"properties\": {\n \"region\": {\n \"description\": \"Opsgenie instance region.\",\n \"enum\": [\n \"US\",\n \"EU\"\n ],\n \"example\": \"US\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"US\",\n \"EU\"\n ]\n },\n \"service-url\": {\n \"description\": \"Opsgenie service url.\",\n \"example\": \"https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"service-url\"\n ],\n \"type\": \"object\"\n },\n \"pagerduty\": {\n \"description\": \"PagerDuty integration for the service.\",\n \"properties\": {\n \"service-url\": {\n \"description\": \"PagerDuty service url.\",\n \"example\": \"https://my-org.pagerduty.com/service-directory/PMyService\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n }\n },\n \"type\": \"object\"\n },\n \"lifecycle\": {\n \"description\": \"The current life cycle phase of the service.\",\n \"example\": \"sandbox\",\n \"type\": \"string\"\n },\n \"links\": {\n \"description\": \"A list of links related to the services.\",\n \"items\": {\n \"description\": \"Service's external links.\",\n \"properties\": {\n \"name\": {\n \"description\": \"Link name.\",\n \"example\": \"Runbook\",\n \"type\": \"string\"\n },\n \"provider\": {\n \"description\": \"Link provider.\",\n \"example\": \"Github\",\n \"type\": \"string\"\n },\n \"type\": {\n \"description\": \"Link type.\",\n \"enum\": [\n \"doc\",\n \"repo\",\n \"runbook\",\n \"dashboard\",\n \"other\"\n ],\n \"example\": \"runbook\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"DOC\",\n \"REPO\",\n \"RUNBOOK\",\n \"DASHBOARD\",\n \"OTHER\"\n ]\n },\n \"url\": {\n \"description\": \"Link URL.\",\n \"example\": \"https://my-runbook\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"type\",\n \"url\"\n ],\n \"type\": \"object\"\n },\n \"type\": \"array\"\n },\n \"schema-version\": {\n \"default\": \"v2.1\",\n \"description\": \"Schema version being used.\",\n \"enum\": [\n \"v2.1\"\n ],\n \"example\": \"v2.1\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"V2_1\"\n ]\n },\n \"tags\": {\n \"description\": \"A set of custom tags.\",\n \"example\": [\n \"my:tag\",\n \"service:tag\"\n ],\n \"items\": {\n \"type\": \"string\"\n },\n \"type\": \"array\"\n },\n \"team\": {\n \"description\": \"Team that owns the service. It is used to locate a team defined in Datadog Teams if it exists.\",\n \"example\": \"my-team\",\n \"type\": \"string\"\n },\n \"tier\": {\n \"description\": \"Importance of the service.\",\n \"example\": \"High\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"schema-version\",\n \"dd-service\"\n ],\n \"type\": \"object\"\n },\n {\n \"description\": \"Service definition V2 for providing service metadata and integrations.\",\n \"properties\": {\n \"contacts\": {\n \"description\": \"A list of contacts related to the services.\",\n \"items\": {\n \"description\": \"Service owner's contacts information.\",\n \"oneOf\": [\n {\n \"description\": \"Service owner's email.\",\n \"properties\": {\n \"contact\": {\n \"description\": \"Contact value.\",\n \"example\": \"contact@datadoghq.com\",\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"Contact email.\",\n \"example\": \"Team Email\",\n \"type\": \"string\"\n },\n \"type\": {\n \"description\": \"Contact type.\",\n \"enum\": [\n \"email\"\n ],\n \"example\": \"email\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"EMAIL\"\n ]\n }\n },\n \"required\": [\n \"type\",\n \"contact\"\n ],\n \"type\": \"object\"\n },\n {\n \"description\": \"Service owner's Slack channel.\",\n \"properties\": {\n \"contact\": {\n \"description\": \"Slack Channel.\",\n \"example\": \"https://yourcompany.slack.com/archives/channel123\",\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"Contact Slack.\",\n \"example\": \"Team Slack\",\n \"type\": \"string\"\n },\n \"type\": {\n \"description\": \"Contact type.\",\n \"enum\": [\n \"slack\"\n ],\n \"example\": \"slack\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"SLACK\"\n ]\n }\n },\n \"required\": [\n \"type\",\n \"contact\"\n ],\n \"type\": \"object\"\n },\n {\n \"description\": \"Service owner's Microsoft Teams.\",\n \"properties\": {\n \"contact\": {\n \"description\": \"Contact value.\",\n \"example\": \"https://teams.microsoft.com/myteam\",\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"Contact Microsoft Teams.\",\n \"example\": \"My team channel\",\n \"type\": \"string\"\n },\n \"type\": {\n \"description\": \"Contact type.\",\n \"enum\": [\n \"microsoft-teams\"\n ],\n \"example\": \"microsoft-teams\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"MICROSOFT_TEAMS\"\n ]\n }\n },\n \"required\": [\n \"type\",\n \"contact\"\n ],\n \"type\": \"object\"\n }\n ]\n },\n \"type\": \"array\"\n },\n \"dd-service\": {\n \"description\": \"Unique identifier of the service. Must be unique across all services and is used to match with a service in Datadog.\",\n \"example\": \"my-service\",\n \"type\": \"string\"\n },\n \"dd-team\": {\n \"description\": \"Experimental feature. A Team handle that matches a Team in the Datadog Teams product.\",\n \"example\": \"my-team\",\n \"type\": \"string\"\n },\n \"docs\": {\n \"description\": \"A list of documentation related to the services.\",\n \"items\": {\n \"description\": \"Service documents.\",\n \"properties\": {\n \"name\": {\n \"description\": \"Document name.\",\n \"example\": \"Architecture\",\n \"type\": \"string\"\n },\n \"provider\": {\n \"description\": \"Document provider.\",\n \"example\": \"google drive\",\n \"type\": \"string\"\n },\n \"url\": {\n \"description\": \"Document URL.\",\n \"example\": \"https://gdrive/mydoc\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"url\"\n ],\n \"type\": \"object\"\n },\n \"type\": \"array\"\n },\n \"extensions\": {\n \"additionalProperties\": {},\n \"description\": \"Extensions to V2 schema.\",\n \"example\": {\n \"myorg/extension\": \"extensionValue\"\n },\n \"type\": \"object\"\n },\n \"integrations\": {\n \"description\": \"Third party integrations that Datadog supports.\",\n \"properties\": {\n \"opsgenie\": {\n \"description\": \"Opsgenie integration for the service.\",\n \"properties\": {\n \"region\": {\n \"description\": \"Opsgenie instance region.\",\n \"enum\": [\n \"US\",\n \"EU\"\n ],\n \"example\": \"US\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"US\",\n \"EU\"\n ]\n },\n \"service-url\": {\n \"description\": \"Opsgenie service url.\",\n \"example\": \"https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"service-url\"\n ],\n \"type\": \"object\"\n },\n \"pagerduty\": {\n \"description\": \"PagerDuty service URL for the service.\",\n \"example\": \"https://my-org.pagerduty.com/service-directory/PMyService\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n },\n \"links\": {\n \"description\": \"A list of links related to the services.\",\n \"items\": {\n \"description\": \"Service's external links.\",\n \"properties\": {\n \"name\": {\n \"description\": \"Link name.\",\n \"example\": \"Runbook\",\n \"type\": \"string\"\n },\n \"type\": {\n \"description\": \"Link type.\",\n \"enum\": [\n \"doc\",\n \"wiki\",\n \"runbook\",\n \"url\",\n \"repo\",\n \"dashboard\",\n \"oncall\",\n \"code\",\n \"link\"\n ],\n \"example\": \"runbook\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"DOC\",\n \"WIKI\",\n \"RUNBOOK\",\n \"URL\",\n \"REPO\",\n \"DASHBOARD\",\n \"ONCALL\",\n \"CODE\",\n \"LINK\"\n ]\n },\n \"url\": {\n \"description\": \"Link URL.\",\n \"example\": \"https://my-runbook\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"type\",\n \"url\"\n ],\n \"type\": \"object\"\n },\n \"type\": \"array\"\n },\n \"repos\": {\n \"description\": \"A list of code repositories related to the services.\",\n \"items\": {\n \"description\": \"Service code repositories.\",\n \"properties\": {\n \"name\": {\n \"description\": \"Repository name.\",\n \"example\": \"Source Code\",\n \"type\": \"string\"\n },\n \"provider\": {\n \"description\": \"Repository provider.\",\n \"example\": \"GitHub\",\n \"type\": \"string\"\n },\n \"url\": {\n \"description\": \"Repository URL.\",\n \"example\": \"https://github.com/DataDog/schema\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"name\",\n \"url\"\n ],\n \"type\": \"object\"\n },\n \"type\": \"array\"\n },\n \"schema-version\": {\n \"default\": \"v2\",\n \"description\": \"Schema version being used.\",\n \"enum\": [\n \"v2\"\n ],\n \"example\": \"v2\",\n \"type\": \"string\",\n \"x-enum-varnames\": [\n \"V2\"\n ]\n },\n \"tags\": {\n \"description\": \"A set of custom tags.\",\n \"example\": [\n \"my:tag\",\n \"service:tag\"\n ],\n \"items\": {\n \"type\": \"string\"\n },\n \"type\": \"array\"\n },\n \"team\": {\n \"description\": \"Team that owns the service.\",\n \"example\": \"my-team\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"schema-version\",\n \"dd-service\"\n ],\n \"type\": \"object\"\n },\n {\n \"description\": \"Service Definition in raw JSON/YAML representation.\",\n \"example\": \"---\\nschema-version: v2\\ndd-service: my-service\",\n \"type\": \"string\"\n }\n ]\n }\n }\n },\n \"description\": \"Service Definition YAML/JSON.\",\n \"required\": true\n}", "use_request_body_schema_mode": true, "validate_request_body_schema": true } }