---
title: "Create a StatsdAdvanced plugin"
method: POST
path: "/plugins#StatsdAdvanced"
tags: ["Plugins"]
---

# Create a StatsdAdvanced plugin

`POST /plugins#StatsdAdvanced`

Create a StatsdAdvanced plugin

## Request body

- CreateStatsdAdvancedPlugin
  - `config` object — The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).
    - `allow_status_codes` string[] — List of status code ranges that are allowed to be logged in metrics.
    - `consumer_identifier_default` 'consumer_id' | 'custom_id' | 'username' — The default consumer identifier for metrics. This will take effect when a metric's consumer identifier is omitted. Allowed values are `custom_id`, `consumer_id`, `username`.
    - `host` string — A string representing a host name, such as example.com.
    - `hostname_in_prefix` boolean — Include the `hostname` in the `prefix` for each metric name.
    - `metrics` object[] — List of Metrics to be logged.
      - `consumer_identifier` 'consumer_id' | 'custom_id' | 'username'
      - `name` 'kong_latency' | 'latency' | 'request_count' | 'request_per_user' | 'request_size' | 'response_size' | 'status_count' | 'status_count_per_user' | 'unique_users' | 'upstream_latency' | 'status_count_per_workspace' | 'status_count_per_user_per_route' | 'shdict_usage' | 'cache_datastore_hits_total' | 'cache_datastore_misses_total', required
      - `sample_rate` number
      - `service_identifier` 'service_id' | 'service_name' | 'service_host' | 'service_name_or_host'
      - `stat_type` 'counter' | 'gauge' | 'histogram' | 'meter' | 'set' | 'timer', required
      - `workspace_identifier` 'workspace_id' | 'workspace_name'
    - `port` integer — An integer representing a port number between 0 and 65535, inclusive.
    - `prefix` string — String to prefix to each 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.
    - `service_identifier_default` 'service_id' | 'service_name' | 'service_host' | 'service_name_or_host' — The default service identifier for metrics. This will take effect when a metric's service identifier is omitted. Allowed values are `service_name_or_host`, `service_id`, `service_name`, `service_host`.
    - `udp_packet_size` number — Combine UDP packet up to the size configured. If zero (0), don't combine the UDP packet. Must be a number between 0 and 65507 (inclusive).
    - `use_tcp` boolean — Use TCP instead of UDP.
    - `workspace_identifier_default` 'workspace_id' | 'workspace_name' — The default workspace identifier for metrics. This will take effect when a metric's workspace identifier is omitted. Allowed values are `workspace_id`, `workspace_name`.
  - `created_at` integer — Unix epoch when the resource was created.
  - `enabled` boolean — Whether the plugin is applied.
  - `id` string
  - `instance_name` string
  - `name` 'statsd-advanced' — The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.
  - `ordering` object
    - `after` object
      - `access` string[]
    - `before` object
      - `access` string[]
  - `protocols` string[] — A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support `"tcp"` and `"tls"`.
  - `tags` string[] — An optional set of strings associated with the Plugin for grouping and filtering.
  - `updated_at` integer — Unix epoch when the resource was last updated.
  - `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
  - `consumer_group` object
    - `id` string
  - `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 `201`

Created StatsdAdvanced plugin

- StatsdAdvancedPlugin
  - `config` object — The configuration properties for the Plugin which can be found on the plugins documentation page in the [Kong Hub](https://docs.konghq.com/hub/).
    - `allow_status_codes` string[] — List of status code ranges that are allowed to be logged in metrics.
    - `consumer_identifier_default` 'consumer_id' | 'custom_id' | 'username' — The default consumer identifier for metrics. This will take effect when a metric's consumer identifier is omitted. Allowed values are `custom_id`, `consumer_id`, `username`.
    - `host` string — A string representing a host name, such as example.com.
    - `hostname_in_prefix` boolean — Include the `hostname` in the `prefix` for each metric name.
    - `metrics` object[] — List of Metrics to be logged.
      - `consumer_identifier` 'consumer_id' | 'custom_id' | 'username'
      - `name` 'kong_latency' | 'latency' | 'request_count' | 'request_per_user' | 'request_size' | 'response_size' | 'status_count' | 'status_count_per_user' | 'unique_users' | 'upstream_latency' | 'status_count_per_workspace' | 'status_count_per_user_per_route' | 'shdict_usage' | 'cache_datastore_hits_total' | 'cache_datastore_misses_total', required
      - `sample_rate` number
      - `service_identifier` 'service_id' | 'service_name' | 'service_host' | 'service_name_or_host'
      - `stat_type` 'counter' | 'gauge' | 'histogram' | 'meter' | 'set' | 'timer', required
      - `workspace_identifier` 'workspace_id' | 'workspace_name'
    - `port` integer — An integer representing a port number between 0 and 65535, inclusive.
    - `prefix` string — String to prefix to each 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.
    - `service_identifier_default` 'service_id' | 'service_name' | 'service_host' | 'service_name_or_host' — The default service identifier for metrics. This will take effect when a metric's service identifier is omitted. Allowed values are `service_name_or_host`, `service_id`, `service_name`, `service_host`.
    - `udp_packet_size` number — Combine UDP packet up to the size configured. If zero (0), don't combine the UDP packet. Must be a number between 0 and 65507 (inclusive).
    - `use_tcp` boolean — Use TCP instead of UDP.
    - `workspace_identifier_default` 'workspace_id' | 'workspace_name' — The default workspace identifier for metrics. This will take effect when a metric's workspace identifier is omitted. Allowed values are `workspace_id`, `workspace_name`.
  - `created_at` integer — Unix epoch when the resource was created.
  - `enabled` boolean — Whether the plugin is applied.
  - `id` string
  - `instance_name` string
  - `name` 'statsd-advanced' — The name of the Plugin that's going to be added. Currently, the Plugin must be installed in every Kong instance separately.
  - `ordering` object
    - `after` object
      - `access` string[]
    - `before` object
      - `access` string[]
  - `protocols` string[] — A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support `"tcp"` and `"tls"`.
  - `tags` string[] — An optional set of strings associated with the Plugin for grouping and filtering.
  - `updated_at` integer — Unix epoch when the resource was last updated.
  - `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
  - `consumer_group` object
    - `id` string
  - `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

## Changes

> 3 revisions in range; 1 not diffed.

- **2024-09-11** `5bd52189d290` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/kong/apis/kong-enterprise-admin-api/changes/plugins#StatsdAdvanced/post.md)

---

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