API Reference

List metrics configs

View Markdown

GET /api/metrics/config

Operation IDlistMetricsConfigs

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Success response body

200List of metrics backend configurations

List of metrics backend configurations

Content typeapplication/json

responseobject

4 properties

resultarray<unknown>required

Array items

itemunknown

nextCursorstring

prevCursorstring

totalinteger

Total number of records matching the current filters

Code examples

curl --request GET \
  --url 'https://your-envoy.example.com/api/metrics/config' \
  --header 'Authorization: Bearer $API_KEY'

const response = await fetch("https://your-envoy.example.com/api/metrics/config", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);