Sign in
Metrics

Get the external impact-metrics source.

Enterprise feature

Returns the current configuration of the external impact-metrics source (any Prometheus-compatible endpoint).

get/api/admin/impact-metrics/external-source

Response

externalImpactMetricsSourceSchema

enabledboolean required

Whether the external impact-metrics source is active. When true, url must be a valid non-empty URL.

urlstring

Base URL of the external impact-metrics source. Basic-Auth credentials may be embedded in the URL (e.g. https://user:pass@metrics.example.com); they are extracted into an Authorization header on outbound requests. Required (non-empty, valid URL) when enabled is true; an empty string is discarded when enabled is false.

Example response

{
  "enabled": true,
  "url": "https://metrics.example.com"
}

Changes

Changed in 1 of the 7 revisions of this API.1