--- title: Datadog slug: connectors/datadog docTags: createdAt: 2026-06-09T16:29:40.167Z --- Datadog is a monitoring and analytics platform that provides insights into the performance of your infrastructure and applications. Datadog is a comprehensive monitoring and analytics platform for cloud-scale applications. It provides real-time visibility into the performance of your infrastructure, applications, and logs. The integration with Swimlane Turbine allows users to automate the management of events, metrics, and tags in Datadog, enhancing security operations by providing actionable insights and streamlining workflows. This connector enables security teams to efficiently monitor and respond to incidents, ensuring a robust security posture. ## Prerequisites Before you can use the Datadog connector for Turbine, you'll need access to the Datadog API. This requires the following: - an API key authentication using the following parameters: - API Key: A unique key provided by Datadog for accessing its API. - URL: The endpoint URL for connecting to the Datadog API. ## Capabilities This connector provides the following capabilities: Create Events List Events Get Events Create Host Tag Get Host Tag List Tags Update Host Tags Delete Host Tags Get Metric Metadata Search Metrics Update Metric Metadata List Active Metrics ### Limitations Currently no limitations on the Datadog integration and API. ## Asset Setup Datadog requires both an API key and an application key for full access to Datadog's programmatic API. Thus without both keys this integration will not connect successfully. ## Task Setup - Get Event In order to get target event ID you can use the Query Events task. - Query Events Start and End fields can take date/time inputs (ex. 2020-03-12T00:00:00Z) according to ISO8601 ## Notes For more information on Datadog: [Datadog API Documentation](https://docs.datadoghq.com/api/?lang=bash#api-reference) [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value/) ## Additional Documentation - [Datadog Connector Documentation](https://docs.swimlane.com/connectors/datadog) - [Datadog API Documentation](https://docs.datadoghq.com/api/?lang=bash#api-reference) # Configurations ## API Key Authentication Authenticates using an API Key ### Configuration Parameters | **Parameter** | **Description** | **Type** | **Required** | | ------------------ | ---------------------------------- | -------- | ------------ | | url | A URL to the target host. | string | Required | | DD-API-KEY | API key | string | Required | | verify\_ssl | Verify SSL certificate | boolean | Optional | | http\_proxy | A proxy to route requests through. | string | Optional | | DD-APPLICATION-KEY | Application Key | string | Optional | # Actions ## Create Event Post events to the Datadog stream with options to tag, set priority, and aggregate them with other events. Requires 'text' and 'title' in the JSON body. ### Endpoint - **URL:** `api/v1/events` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ------------------ | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `aggregation_key` | string | Optional | An arbitrary string to use for aggregation. Limited to 100 characters. If you specify a key, all events using that key are grouped together in the Event Stream | | `alert_type` | string | Optional | If an alert event is enabled, set its type. For example, error, warning, info, success, user\_update, recommendation, and snapshot | | `date_happened` | number | Optional | POSIX timestamp of the event. Must be sent as an integer (that is no quotes). Limited to events no older than 18 hours | | `device_name` | string | Optional | A device name. | | `host` | string | Optional | Host name to associate with the event. Any tags associated with the host are also applied to this event. | | `priority` | string | Optional | The priority of the event. Allowed enum values are normal,low | | `related_event_id` | number | Optional | ID of the parent event. Must be sent as an integer (that is no quotes). | | `source_type_name` | string | Optional | The type of event being posted. Option examples include nagios, hudson, jenkins, my\_apps, chef, puppet, git, bitbucket, etc | | `tags` | array | Optional | A list of tags to apply to the event. | | `text` | string | Optional | The body of the event. Limited to 4000 characters. The text supports markdown. To use markdown in the event text, start the text block with %%% \n and end the text block with \n %%% | | `title` | string | Optional | The event title. | ### Input Example `{"aggregation_key":"string","alert_type":"string","date_happened":123,"device_name":"Example Name","host":"string","priority":"string","related_event_id":123,"source_type_name":"Example Name","tags":["string"],"text":"string","title":"string"}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `status` | string | A status. | | `event` | object | Object representing an event. | | `event.id` | number | Integer ID of the event. | | `event.alert_type` | string | If an alert event is enabled, set its type. For example, error, warning, info, success, user\_update, recommendation, and snapshot. | | `event.device_name` | string | A device name. | | `event.host` | string | Host name to associate with the event. Any tags associated with the host are also applied to this event. | | `event.payload` | string | Payload of the event. | | `event.source_type_name` | string | The type of event being posted. Option examples include nagios, hudson, jenkins, my\_apps, chef, puppet, git, bitbucket, etc. | | `event.id_str` | string | Handling IDs as large 64-bit numbers can cause loss of accuracy issues with some programming languages. Instead, use the string representation of the Event ID to avoid losing accuracy. | | `event.title` | string | The event title. | | `event.text` | string | The body of the event. Limited to 4000 characters. The text supports markdown. To use markdown in the event text, start the text block with %%% \n and end the text block with \n %%%. | | `event.date_happened` | number | POSIX timestamp of the event. Must be sent as an integer (that is no quotes). Limited to events no older than 18 hours. | | `event.handle` | object | Output field: event.handle | | `event.priority` | string | The priority of the event. For example, normal or low. Allowed enum values are normal,low | | `event.related_event_id` | number | Unique identifier | | `event.tags` | array | A list of tags to apply to the event. | | `event.url` | string | URL of the event. | ### Output Example `{"status":"active","event":{"id":123,"alert_type":"string","device_name":"Example Name","host":"string","payload":"string","source_type_name":"Example Name","id_str":"string","title":"string","text":"string","date_happened":123,"handle":{},"priority":"string","related_event_id":123,"tags":["string"],"url":"https://example.com/api/resource"}}` ## Create Host Tag Add new tags to a host in Datadog, specifying the source if needed. Requires the host name as a path parameter. ### Endpoint - **URL:** `api/v1/tags/hosts/{{host_name}}` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | --------------------------- | -------- | ------------ | --------------------------------------------------------------------------------------------------- | | `path_parameters.host_name` | string | Required | This endpoint allows you to add new tags to a host, optionally specifying where the tags came from. | | `parameters.source` | string | Optional | The source of the tags. | | `host` | string | Optional | Your host name. | | `tags` | array | Optional | A list of tags to apply to the host. | ### Input Example `{"path_parameters":{"host_name":"Example Name"},"parameters":{"source":"string"},"host":"string","tags":["string"]}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | ------------------------------------ | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `host` | string | Your host name. | | `tags` | array | A list of tags to apply to the host. | ### Output Example `{"host":"string","tags":["string"]}` ## Delete Host Tags Remove all user-assigned tags for a specified host in Datadog. Requires the host\_name as a path parameter. ### Endpoint - **URL:** `api/v1/tags/hosts/{{host_name}}` - **Method:** `DELETE` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | --------------------------- | -------- | ------------ | ---------------------------------------------------------------------------- | | `path_parameters.host_name` | string | Required | This endpoint allows you to remove all user-assigned tags for a single host. | | `parameters.source` | string | Optional | The source of the tags (for example chef, puppet). | ### Input Example `{"parameters":{"source":"jenkins"},"path_parameters":{"host_name":"test"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":204,"response_headers":{"Date":"Tue, 05 Sep 2023 13:02:46 GMT","Content-Type":"application/json","Content-Length":"12","Connection":"keep-alive","x-frame-options":"SAMEORIGIN","content-security-policy":"frame-ancestors 'self'; report-uri https://logs.browser-intake-datadoghq.com/api...","x-content-type-options":"nosniff","strict-transport-security":"max-age=31536000; includeSubDomains; preload"},"reason":"OK"}` ## Get Event Query Datadog for specific event details using the event\_id as a path parameter. ### Endpoint - **URL:** `api/v1/events/{{event_id}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | -------------------------- | -------- | ------------ | -------------------- | | `path_parameters.event_id` | string | Required | The ID of the event. | ### Input Example `{"path_parameters":{"event_id":"00000000-0000-0000-1234-000000000000"}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `json_data` | object | Response data | | `json_data.event` | object | Object representing an event. | | `json_data.event.alert_type` | string | If an alert event is enabled, set its type. For example, error, warning, info, success, user\_update, recommendation, and snapshot. Allowed enum values are error,warning,info,success,user\_update,recommendation,snapshot | | `json_data.event.date_happened` | string | POSIX timestamp of the event. Must be sent as an integer (that is no quotes). Limited to events no older than 18 hours | | `json_data.event.device_name` | string | A device name. | | `json_data.event.host` | string | Host name to associate with the event. Any tags associated with the host are also applied to this event. | | `json_data.event.id` | string | Integer ID of the event. | | `json_data.event.id_str` | string | Handling IDs as large 64-bit numbers can cause loss of accuracy issues with some programming languages. Instead, use the string representation of the Event ID to avoid losing accuracy. | | `json_data.event.payload` | string | Payload of the event. | | `json_data.event.priority` | string | The priority of the event. For example, normal or low. Allowed enum values are normal,low | | `json_data.event.source_type_name` | string | The type of event being posted. Option examples include nagios, hudson, jenkins, my\_apps, chef, puppet, git, bitbucket, etc | | `json_data.event.tags` | array | A list of tags to apply to the event. | | `json_data.event.text` | string | The body of the event. Limited to 4000 characters. The text supports markdown. To use markdown in the event text, start the text block with %%% \n and end the text block with \n %%% | | `json_data.event.title` | string | The event title. | | `json_data.event.url` | string | URL of the event. | | `json_data.status` | string | A status. | ### Output Example `{"status_code":200,"response_headers":{"Date":"Thu, 07 Sep 2023 09:21:26 GMT","Content-Type":"text/html","Transfer-Encoding":"chunked","Connection":"keep-alive","x-frame-options":"SAMEORIGIN","content-security-policy":"frame-ancestors 'self'; report-uri https://logs.browser-intake-datadoghq.com/api...","vary":"Accept-Encoding","content-encoding":"gzip","x-ratelimit-limit":"12000","x-ratelimit-period":"60","x-ratelimit-remaining":"11999","x-ratelimit-reset":"34","x-ratelimit-name":"event_get_by_i...` ## Get Host Tags Return the list of tags associated with a specified host in Datadog. Requires the host\_name as a path parameter. ### Endpoint - **URL:** `api/v1/tags/hosts/{{host_name}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | --------------------------- | -------- | ------------ | ----------------------------------------------------------------------------- | | `path_parameters.host_name` | string | Required | When specified, filters list of tags to those tags with the specified source. | | `parameters.source` | string | Optional | Source to filter. | ### Input Example `{"parameters":{"source":"jenkins"},"path_parameters":{"host_name":"test"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | ------------------------------------ | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `host` | string | Your host name. | | `tags` | array | A list of tags to apply to the host. | ### Output Example `{"status_code":200,"response_headers":{"Date":"Tue, 05 Sep 2023 13:02:46 GMT","Content-Type":"application/json","Content-Length":"12","Connection":"keep-alive","x-frame-options":"SAMEORIGIN","content-security-policy":"frame-ancestors 'self'; report-uri https://logs.browser-intake-datadoghq.com/api...","x-content-type-options":"nosniff","strict-transport-security":"max-age=31536000; includeSubDomains; preload"},"reason":"OK","json_body":{"host":"TestHost2","tags":["role:database","team:infra","re...` ## Get Metric Metadata Get metadata about a specific metric in Datadog using the metric name as a path parameter. ### Endpoint - **URL:** `api/v1/metrics/{{metric_name}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------------------- | -------- | ------------ | --------------------------------------------- | | `path_parameters.metric_name` | string | Required | Name of the metric for which to get metadata. | ### Input Example `{"path_parameters":{"metric_name":"datadog.agent.python.version"}}` ### Output | **Parameter** | **Type** | **Description** | | ----------------- | -------- | ----------------------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `description` | string | Metric description | | `short_name` | string | A more human-readable and abbreviated version of the metric name. | | `type` | string | Metric type such as gauge or rate. | | `unit` | string | Primary unit of the metric such as byte or operation | | `per_unit` | string | Per unit of the metric such as second in bytes per second | | `statsd_interval` | number | StatsD flush interval of the metric in seconds if applicable. | | `integration` | string | Name of the integration that sent the metric if applicable. | ### Output Example `{"status_code":200,"response_headers":{"Date":"Wed, 06 Sep 2023 10:44:59 GMT","Content-Type":"application/json","Transfer-Encoding":"chunked","Connection":"keep-alive","x-frame-options":"SAMEORIGIN","content-security-policy":"frame-ancestors 'self'; report-uri https://logs.browser-intake-datadoghq.com/api...","vary":"Accept-Encoding","content-encoding":"gzip","x-ratelimit-limit":"6000","x-ratelimit-period":"60","x-ratelimit-remaining":"5999","x-ratelimit-reset":"1","x-ratelimit-name":"v1_get_met...` ## List Active Metrics Retrieve actively reporting metrics from a specified time to the present in Datadog. Requires 'from' parameter and metrics\_read authorization scope. ### Endpoint - **URL:** `api/v1/metrics` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------------- | -------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------- | | `parameters.from` | number | Required | Seconds since the Unix epoch. | | `parameters.host` | string | Optional | Hostname for filtering the list of metrics returned. If set, metrics retrieved are those with the corresponding hostname tag. | | `parameters.tag_filter` | string | Optional | Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters | ### Input Example `{"parameters":{"from":6235723,"host":"test","tag_filter":"tags"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | ---------------------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `metrics` | array | List of metric names. | | `from` | string | Time when the metrics were active, seconds since the Unix epoch. | ### Output Example `{"status_code":200,"response_headers":{"Date":"Tue, 05 Sep 2023 13:59:23 GMT","Content-Type":"application/json","Transfer-Encoding":"chunked","Connection":"keep-alive","x-frame-options":"SAMEORIGIN","content-security-policy":"frame-ancestors 'self'; report-uri https://logs.browser-intake-datadoghq.com/api...","vary":"Accept-Encoding","content-encoding":"gzip","x-ratelimit-limit":"100","x-ratelimit-period":"60","x-ratelimit-remaining":"99","x-ratelimit-reset":"37","x-ratelimit-name":"metrics_list...` ## List Event Query and filter the Datadog event stream by time, priority, sources, and tags. Requires start and end parameters to define the time range. ### Endpoint - **URL:** `api/v1/events` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ------------------------------ | -------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `parameters.start` | number | Required | POSIX timestamp. | | `parameters.end` | number | Required | POSIX timestamp. | | `parameters.priority` | string | Optional | Priority of your events, either low or normal. Allowed enum values are normal, low | | `parameters.sources` | string | Optional | A comma separated string of sources. | | `parameters.tags` | string | Optional | A comma separated list indicating what tags, if any, should be used to filter the list of events. | | `parameters.unaggregated` | boolean | Optional | Set unaggregated to true to return all events within the specified \[start,end] timeframe. Otherwise if an event is aggregated to a parent event with a timestamp outside of the timeframe, it won’t be available in the output. Aggregated events with is\_aggregate=true in the response will still be returned unless exclude\_aggregate is set to true. | | `parameters.exclude_aggregate` | boolean | Optional | Set exclude\_aggregate to true to only return unaggregated events where is\_aggregate=false in the response. If the exclude\_aggregate parameter is set to true, then the unaggregated parameter is ignored and will be true by default. | | `parameters.page` | number | Optional | By default 1000 results are returned per request. Set page to the number of the page to return with 0 being the first page. The page parameter can only be used when either unaggregated or exclude\_aggregate is set to true. | ### Input Example `{"parameters":{"start":123,"end":123,"priority":"string","sources":"string","tags":"string","unaggregated":true,"exclude_aggregate":true,"page":123}}` ### Output | **Parameter** | **Type** | **Description** | | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `status` | string | A status | | `events` | array | An array of events. | | `events.alert_type` | string | If an alert event is enabled, set its type. For example, error, warning, info, success, user\_update, recommendation, and snapshot. Allowed enum values are error,warning,info,success,user\_update,recommendation,snapshot | | `events.date_happened` | number | POSIX timestamp of the event. Must be sent as an integer (that is no quotes). Limited to events no older than 18 hours. | | `events.device_name` | string | A device name. | | `events.host` | string | Host name to associate with the event. Any tags associated with the host are also applied to this event | | `events.id` | string | Integer ID of the event. | | `events.id_str` | string | Handling IDs as large 64-bit numbers can cause loss of accuracy issues with some programming languages. Instead, use the string representation of the Event ID to avoid losing accuracy. | | `events.payload` | string | Payload of the event. | | `events.priority` | string | The priority of the event. For example, normal or low. Allowed enum values are normal,low | | `events.source_type_name` | string | The type of event being posted. Option examples include nagios, hudson, jenkins, my\_apps, chef, puppet, git, bitbucket, etc | | `events.tags` | array | A list of tags to apply to the event. | | `events.text` | string | The body of the event. Limited to 4000 characters. The text supports markdown. To use markdown in the event text, start the text block with %%% \n and end the text block with \n %%% | | `events.title` | string | The event title. | | `events.url` | string | URL of the event. | ### Output Example `{"status_code":200,"response_headers":{"Date":"Mon, 04 Sep 2023 17:40:53 GMT","Content-Type":"application/json","Content-Length":"14","Connection":"keep-alive","x-frame-options":"SAMEORIGIN","content-security-policy":"frame-ancestors 'self'; report-uri https://logs.browser-intake-datadoghq.com/api...","x-ratelimit-limit":"600","x-ratelimit-period":"60","x-ratelimit-remaining":"599","x-ratelimit-reset":"7","x-ratelimit-name":"event_stream_api","x-content-type-options":"nosniff","strict-transport-...` ## List Tags Return a mapping of tags to hosts for your entire infrastructure in Datadog. ### Endpoint - **URL:** `api/v1/tags/hosts` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ------------------- | -------- | ------------ | -------------------------------------------------------------------------- | | `parameters.source` | string | Optional | When specified, filters host list to those tags with the specified source. | ### Input Example `{"parameters":{"source":"source-host"}}` ### Output | **Parameter** | **Type** | **Description** | | ---------------- | -------- | ----------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `tags` | object | A list of tags to apply to the host. | | `tags.` | array | A list of additional properties for tags. | ### Output Example `{"status_code":200,"response_headers":{"Date":"Tue, 05 Sep 2023 13:02:46 GMT","Content-Type":"application/json","Content-Length":"12","Connection":"keep-alive","x-frame-options":"SAMEORIGIN","content-security-policy":"frame-ancestors 'self'; report-uri https://logs.browser-intake-datadoghq.com/api...","x-content-type-options":"nosniff","strict-transport-security":"max-age=31536000; includeSubDomains; preload"},"reason":"OK","json_body":{"tags":{"":[]}}}` ## Search Metrics Search for metrics from the last 24 hours in Datadog using query parameters. ### Endpoint - **URL:** `api/v1/search` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------- | -------- | ------------ | ---------------------------------------- | | `parameters.q` | string | Required | Parameters for the Search Metrics action | ### Input Example `{"parameters":{"q":"metrics:datadog.agent.python.version"}}` ### Output | **Parameter** | **Type** | **Description** | | ----------------- | -------- | -------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `results` | object | Search result. | | `results.metrics` | array | List of metrics that match the search query. | ### Output Example `{"status_code":200,"response_headers":{"Date":"Tue, 05 Sep 2023 14:09:14 GMT","Content-Type":"application/json","Content-Length":"27","Connection":"keep-alive","x-frame-options":"SAMEORIGIN","content-security-policy":"frame-ancestors 'self'; report-uri https://logs.browser-intake-datadoghq.com/api...","x-ratelimit-limit":"12000","x-ratelimit-period":"60","x-ratelimit-remaining":"11999","x-ratelimit-reset":"46","x-ratelimit-name":"ci_dog_search","x-content-type-options":"nosniff","strict-transpor...` ## Update Host Tags Update or replace all tags for a specified host in Datadog using the provided integration source and request details. ### Endpoint - **URL:** `api/v1/tags/hosts/{{host_name}}` - **Method:** `PUT` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | --------------------------- | -------- | ------------ | -------------------------------------------------- | | `path_parameters.host_name` | string | Required | Parameters for the Update Host Tags action | | `parameters.source` | string | Optional | The source of the tags (for example chef, puppet). | | `host` | string | Optional | Your host name. | | `tags` | array | Optional | A list of tags to apply to the host. | ### Input Example `{"parameters":{"source":"jenkins"},"json_body":{"host":"test.host","tags":["environment:production"]},"path_parameters":{"host_name":"test"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | ------------------------------------ | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `host` | string | Your host name. | | `tags` | array | A list of tags to apply to the host. | ### Output Example `{"status_code":200,"response_headers":{"Date":"Tue, 05 Sep 2023 13:02:46 GMT","Content-Type":"application/json","Content-Length":"12","Connection":"keep-alive","x-frame-options":"SAMEORIGIN","content-security-policy":"frame-ancestors 'self'; report-uri https://logs.browser-intake-datadoghq.com/api...","x-content-type-options":"nosniff","strict-transport-security":"max-age=31536000; includeSubDomains; preload"},"reason":"OK","json_body":{"host":"test.host","tags":["environment:production"]}}` ## Update Metric Metadata Edit metadata of a specific metric in Datadog using the metric name as a path parameter and additional details in the JSON body. ### Endpoint - **URL:** `api/v1/metrics/{{metric_name}}` - **Method:** `PUT` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ----------------------------- | -------- | ------------ | ----------------------------------------------------------------- | | `path_parameters.metric_name` | string | Required | Name of the metric for which to edit metadata. | | `description` | string | Optional | Metric description. | | `per_unit` | string | Optional | Per unit of the metric such as second in bytes per second | | `short_name` | string | Optional | A more human-readable and abbreviated version of the metric name. | | `statsd_interval` | number | Optional | StatsD flush interval of the metric in seconds if applicable. | | `type` | string | Optional | Metric type such as gauge or rate | | `unit` | string | Optional | Primary unit of the metric such as byte or operation. | ### Input Example `{"json_body":{"description":"Python Version","per_unit":"second","short_name":"py -version","statsd_interval":65777565675,"type":"gauge","unit":"byte"},"path_parameters":{"metric_name":"datadog.agent.python.version"}}` ### Output | **Parameter** | **Type** | **Description** | | ----------------- | -------- | ----------------------------------------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | | `description` | string | Metric description. | | `integration` | string | Name of the integration that sent the metric if applicable. | | `per_unit` | string | Per unit of the metric such as second in bytes per second | | `short_name` | string | A more human-readable and abbreviated version of the metric name. | | `statsd_interval` | number | StatsD flush interval of the metric in seconds if applicable. | | `type` | string | Metric type such as gauge or rate | | `unit` | string | Primary unit of the metric such as byte or operation. | ### Output Example `{"status_code":200,"response_headers":{"Date":"Wed, 06 Sep 2023 17:26:45 GMT","Content-Type":"application/json","Transfer-Encoding":"chunked","Connection":"keep-alive","x-frame-options":"SAMEORIGIN","content-security-policy":"frame-ancestors 'self'; report-uri https://logs.browser-intake-datadoghq.com/api...","vary":"Accept-Encoding","content-encoding":"gzip","x-ratelimit-limit":"2000","x-ratelimit-period":"60","x-ratelimit-remaining":"1999","x-ratelimit-reset":"15","x-ratelimit-name":"update_me...` # Response Headers | **Header** | **Description** | **Example** | | ------------------------- | ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Connection | HTTP response header: Connection | keep-alive | | content-encoding | HTTP response header: content-encoding | gzip | | Content-Length | The length of the response body in bytes | 12 | | content-security-policy | HTTP response header: content-security-policy | frame-ancestors 'self'; report-uri [https://logs.browser-intake-datadoghq.com/api/v2/logs?dd-api-key=pube4f163c23bbf91c16b8f57f56af9fc58\&dd-evp-origin=content-security-policy\&ddsource=csp-report\&ddtags=site%3Adatadoghq.com](https://logs.browser-intake-datadoghq.com/api/v2/logs?dd-api-key=pube4f163c23bbf91c16b8f57f56af9fc58\&dd-evp-origin=content-security-policy\&ddsource=csp-report\&ddtags=site%3Adatadoghq.com) | | Content-Type | The media type of the resource | text/html | | Date | The date and time at which the message was originated | Wed, 06 Sep 2023 17:26:45 GMT | | strict-transport-security | HTTP response header: strict-transport-security | max-age=31536000; includeSubDomains; preload | | Transfer-Encoding | HTTP response header: Transfer-Encoding | chunked | | vary | HTTP response header: vary | Accept-Encoding | | x-content-type-options | HTTP response header: x-content-type-options | nosniff | | x-frame-options | HTTP response header: x-frame-options | SAMEORIGIN | | x-ratelimit-limit | The number of requests allowed in the current rate limit window | 6000 | | x-ratelimit-name | HTTP response header: x-ratelimit-name | event\_get\_by\_id | | x-ratelimit-period | HTTP response header: x-ratelimit-period | 60 | | x-ratelimit-remaining | The number of requests remaining in the current rate limit window | 1999 | | x-ratelimit-reset | The time at which the current rate limit window resets | 46 |