API Reference

Update a metrics config

View Markdown

PUT /api/metrics/config/{id}

Operation IDupdateMetricsConfig

Authentication

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

Path parameters

idintegerrequired

Resource ID

Request body

This request body is required.

Content typeapplication/json

requestobject

3 properties

backendstring

configobject

Additional properties are allowed.

enabledboolean

Success response body

200Config updated

Config updated

Content typeapplication/json

responseobject

Error responses

404Resource not found

Resource not found

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}

Code examples

curl --request PUT \
  --url 'https://your-envoy.example.com/api/metrics/config/YOUR_ID' \
  --header 'Authorization: Bearer $API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "backend": "string",
  "config": {},
  "enabled": true
}'

const response = await fetch("https://your-envoy.example.com/api/metrics/config/YOUR_ID", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "backend": "string",
    "config": {},
    "enabled": true
  }),
});

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