List metrics configs

GET /api/metrics/config

List metrics configs

Operation ID: listMetricsConfigs

Authentication

Option 1

• BearerAuth (http bearer) API key token. Create via POST /api/api-keys. Format: envoy_<hex>

Option 2

• CookieAuth (apiKey) Session cookie set after login + TOTP verification

Success responses

200

List of metrics backend configurations

Content type: application/json

• Reference: PaginatedResult
  • Type: object
  • Properties:
    • result (array<unknown>)
      • Items:
        • Type: unknown
    • nextCursor (string | null)
      • Nullable: yes
    • prevCursor (string | null)
      • Nullable: yes
    • total (integer) — Total number of records matching the current filters

Examples

cURL

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

JavaScript (fetch)

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);