---
title: "Update a Datadog plugin"
method: PUT
path: "/{workspace}/plugins/{PluginId}#Datadog"
tags: ["Plugins"]
---

# Update a Datadog plugin

`PUT /{workspace}/plugins/{PluginId}#Datadog`

Update a Datadog plugin

## Request body

- DatadogPlugin — A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the [Kong Hub](https://docs.konghq.com/hub/). When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the `service` and `consumer` fields.
  - `condition` string, nullable — An expression used for conditional control over plugin execution. If the expression evaluates to `true` during the request flow, the plugin is executed; otherwise, it is skipped.
  - `created_at` integer, nullable — Unix epoch when the resource was created.
  - `enabled` boolean, nullable — Whether the plugin is applied.
  - `id` string, nullable — A string representing a UUID (universally unique identifier).
  - `instance_name` string, nullable — A unique string representing a UTF-8 encoded name.
  - `name` 'datadog', required — The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.
  - `ordering` object, nullable
    - `after` object
      - `access` string[]
    - `before` object
      - `access` string[]
  - `partials` object[] — A list of partials to be used by the plugin.
    - `id` string — A string representing a UUID (universally unique identifier).
    - `name` string — A unique string representing a UTF-8 encoded name.
    - `path` string
  - `tags` string[], nullable — An optional set of strings associated with the Plugin for grouping and filtering.
  - `updated_at` integer, nullable — Unix epoch when the resource was last updated.
  - `config` object
    - `consumer_tag` string — String to be attached as tag of the consumer.
    - `flush_timeout` number — Optional time in seconds. If `queue_size` > 1, this is the max idle time before sending a log with less than `queue_size` records.
    - `host` string — A string representing a host name, such as example.com.
    - `metrics` object[] — List of metrics to be logged.
      - `consumer_identifier` 'consumer_id' | 'custom_id' | 'username' — Authenticated user detail
      - `name` 'kong_latency' | 'latency' | 'request_count' | 'request_size' | 'response_size' | 'upstream_latency', required — Datadog metric’s name
      - `sample_rate` number — Sampling rate
      - `stat_type` 'counter' | 'distribution' | 'gauge' | 'histogram' | 'meter' | 'set' | 'timer', required — Determines what sort of event the metric represents
      - `tags` string[] — List of tags
    - `port` integer — An integer representing a port number between 0 and 65535, inclusive.
    - `prefix` string — String to be attached as a prefix to a metric's name.
    - `queue` object
      - `concurrency_limit` -1 | 1 — The number of of queue delivery timers. -1 indicates unlimited.
      - `initial_retry_delay` number — Time in seconds before the initial retry is made for a failing batch.
      - `max_batch_size` integer — Maximum number of entries that can be processed at a time.
      - `max_bytes` integer — Maximum number of bytes that can be waiting on a queue, requires string content.
      - `max_coalescing_delay` number — Maximum number of (fractional) seconds to elapse after the first entry was queued before the queue starts calling the handler.
      - `max_entries` integer — Maximum number of entries that can be waiting on the queue.
      - `max_retry_delay` number — Maximum time in seconds between retries, caps exponential backoff.
      - `max_retry_time` number — Time in seconds before the queue gives up calling a failed handler for a batch.
    - `queue_size` integer — Maximum number of log entries to be sent on each message to the upstream server.
    - `retry_count` integer — Number of times to retry when sending data to the upstream server.
    - `route_name_tag` string — String to be attached as tag of the route name or ID.
    - `service_name_tag` string — String to be attached as the name of the service.
    - `status_tag` string — String to be attached as the tag of the HTTP status.
  - `consumer` object — If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    - `id` string
  - `protocols` string[] — A set of strings representing protocols.
  - `route` object — If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
    - `id` string
  - `service` object — If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    - `id` string

## Response `200`

Datadog plugin

- DatadogPlugin — A Plugin entity represents a plugin configuration that will be executed during the HTTP request/response lifecycle. It is how you can add functionalities to Services that run behind Kong, like Authentication or Rate Limiting for example. You can find more information about how to install and what values each plugin takes by visiting the [Kong Hub](https://docs.konghq.com/hub/). When adding a Plugin Configuration to a Service, every request made by a client to that Service will run said Plugin. If a Plugin needs to be tuned to different values for some specific Consumers, you can do so by creating a separate plugin instance that specifies both the Service and the Consumer, through the `service` and `consumer` fields.
  - `condition` string, nullable — An expression used for conditional control over plugin execution. If the expression evaluates to `true` during the request flow, the plugin is executed; otherwise, it is skipped.
  - `created_at` integer, nullable — Unix epoch when the resource was created.
  - `enabled` boolean, nullable — Whether the plugin is applied.
  - `id` string, nullable — A string representing a UUID (universally unique identifier).
  - `instance_name` string, nullable — A unique string representing a UTF-8 encoded name.
  - `name` 'datadog', required — The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.
  - `ordering` object, nullable
    - `after` object
      - `access` string[]
    - `before` object
      - `access` string[]
  - `partials` object[] — A list of partials to be used by the plugin.
    - `id` string — A string representing a UUID (universally unique identifier).
    - `name` string — A unique string representing a UTF-8 encoded name.
    - `path` string
  - `tags` string[], nullable — An optional set of strings associated with the Plugin for grouping and filtering.
  - `updated_at` integer, nullable — Unix epoch when the resource was last updated.
  - `config` object
    - `consumer_tag` string — String to be attached as tag of the consumer.
    - `flush_timeout` number — Optional time in seconds. If `queue_size` > 1, this is the max idle time before sending a log with less than `queue_size` records.
    - `host` string — A string representing a host name, such as example.com.
    - `metrics` object[] — List of metrics to be logged.
      - `consumer_identifier` 'consumer_id' | 'custom_id' | 'username' — Authenticated user detail
      - `name` 'kong_latency' | 'latency' | 'request_count' | 'request_size' | 'response_size' | 'upstream_latency', required — Datadog metric’s name
      - `sample_rate` number — Sampling rate
      - `stat_type` 'counter' | 'distribution' | 'gauge' | 'histogram' | 'meter' | 'set' | 'timer', required — Determines what sort of event the metric represents
      - `tags` string[] — List of tags
    - `port` integer — An integer representing a port number between 0 and 65535, inclusive.
    - `prefix` string — String to be attached as a prefix to a metric's name.
    - `queue` object
      - `concurrency_limit` -1 | 1 — The number of of queue delivery timers. -1 indicates unlimited.
      - `initial_retry_delay` number — Time in seconds before the initial retry is made for a failing batch.
      - `max_batch_size` integer — Maximum number of entries that can be processed at a time.
      - `max_bytes` integer — Maximum number of bytes that can be waiting on a queue, requires string content.
      - `max_coalescing_delay` number — Maximum number of (fractional) seconds to elapse after the first entry was queued before the queue starts calling the handler.
      - `max_entries` integer — Maximum number of entries that can be waiting on the queue.
      - `max_retry_delay` number — Maximum time in seconds between retries, caps exponential backoff.
      - `max_retry_time` number — Time in seconds before the queue gives up calling a failed handler for a batch.
    - `queue_size` integer — Maximum number of log entries to be sent on each message to the upstream server.
    - `retry_count` integer — Number of times to retry when sending data to the upstream server.
    - `route_name_tag` string — String to be attached as tag of the route name or ID.
    - `service_name_tag` string — String to be attached as the name of the service.
    - `status_tag` string — String to be attached as the tag of the HTTP status.
  - `consumer` object — If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
    - `id` string
  - `protocols` string[] — A set of strings representing protocols.
  - `route` object — If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
    - `id` string
  - `service` object — If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
    - `id` string

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.net/kong/apis/kong-enterprise-admin-api.md) · [All operations](https://skmtc.net/kong/apis/kong-enterprise-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kong/kong-enterprise-admin-api/revisions/28b1f8a59cdc/schema)