Metrics

Validate an external impact-metrics source URL.

Changed on

Enterprise feature

Tests an external impact-metrics source URL on the fly without persisting it. Returns the list of metric names found at the URL on success, or an error string explaining what went wrong. Always responds with 200; failures are reported in the body.

post/api/admin/impact-metrics/external-source/validate

Request

  • Base URL
    https://app.unleash-instance.example.com
  • URL
    https://app.unleash-instance.example.com/api/admin/impact-metrics/external-source/validate
  • Auth
    • API key in header Authorization
    • or HTTP bearer

Request body

urlstring required

Base URL of the external impact-metrics source to test. 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.

Example request

{
  "url": "https://metrics.example.com"
}

Response

validateExternalImpactMetricsSourceResultSchema

metricsstring[] required

List of metric names discovered at the supplied URL. Empty when the URL could not be validated.

errorstring

Human-readable explanation of why the URL could not be validated. Omitted on success.

Example response

{
  "metrics": [
    "http_requests_total",
    "process_cpu_seconds_total"
  ],
  "error": "External source returned HTTP 401"
}

Changes