OpenAPI Specification
openapi: 3.0.3
info:
title: StatsD Admin Interface Configuration Timers API
version: 1.0.0
description: OpenAPI projection of the StatsD admin/management interface. The native transport is a line-oriented plain-text protocol over TCP/8126 (default), not HTTP — but every supported command (`stats`, `counters`, `gauges`, `timers`, `delcounters`, `delgauges`, `deltimers`, `health [up|down]`, `config`, `quit`) is a self-contained request/response interaction with well-defined inputs and outputs and is therefore modeled here as a virtual `GET`/`POST` resource so that tools that consume OpenAPI (Spectral, MCP adapters, client generators) can reason about the surface.
contact:
name: StatsD Maintainers
url: https://github.com/statsd/statsd
license:
name: MIT
url: https://github.com/statsd/statsd/blob/master/LICENSE
servers:
- url: tcp://{host}:{port}
description: Native admin TCP interface
variables:
host:
default: 127.0.0.1
description: Address of the StatsD daemon
port:
default: '8126'
description: Default admin port (`mgmt_port`)
tags:
- name: Timers
description: Inspect Or Delete Timers
paths:
/timers:
get:
summary: List All Timers
description: Dump the raw value list collected for every in-memory timer since the last flush.
operationId: listTimers
tags:
- Timers
responses:
'200':
description: Current Timer Snapshot.
content:
text/plain:
schema:
$ref: '#/components/schemas/TimerMap'
/deltimers:
post:
summary: Delete Timers
description: Delete one or more timers by name; wildcards supported.
operationId: deleteTimers
tags:
- Timers
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeletePatterns'
responses:
'200':
description: Deletion Acknowledgement.
content:
text/plain:
schema:
type: string
components:
schemas:
TimerMap:
type: object
description: Map of timer bucket name to the raw observation list since the last flush.
additionalProperties:
type: array
items:
type: number
example:
request.duration:
- 12
- 14
- 19
- 320
DeletePatterns:
type: object
description: One or more bucket name patterns (wildcards permitted) to delete.
required:
- patterns
properties:
patterns:
type: array
items:
type: string
minItems: 1
example:
- sandbox.test.*