Admin APIMetrics

[BETA] Set the external impact-metrics source.

View as Markdown

Enterprise feature

[BETA] This API is in beta state, which means it may change or be removed in the future.

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

Authentication

Authorizationstring
API key needed to access this API
OR
AuthorizationBearer
API key needed to access this API, in Bearer token format

Request

setExternalImpactMetricsSourceSchema
enabledbooleanRequired

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

urlstringOptional

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.

Response

This response has no body.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
415
Unsupported Media Type Error