Prometheus metrics

GET

/metrics

const url = 'https://example.com/api/v1/metrics';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/metrics

Prometheus text exposition (format 0.0.4) covering job runs, sync outcomes, drift, config health, security posture, parser availability, notification delivery, PCD cache state and build info. Labels never include Arr URLs or API keys. Authenticate with an API token (prx_…) carrying the read scope in the X-Api-Key header; tokens work under AUTH=on, AUTH=oidc, and for remote clients under AUTH=local. A token without the read scope gets 403 { "error": "Forbidden", "requiredScope": "read" }. Disabled (404) unless METRICS_ENABLED is on.

Parameters

Header Parameters

X-Api-Key

string

Praxrr API token (prx_…) with the read scope. Required for non-browser clients under AUTH=on and AUTH=oidc, and for remote clients under AUTH=local.

Responses

200

Metrics in Prometheus text exposition format.

text/plain

string

401

Unauthenticated (missing, invalid, revoked, or expired API token).

application/json

object

error

required

Error message

string

code

Stable machine-readable code present on 5xx responses; error is a fixed user-safe message, raw detail is logged server-side only

string

Allowed values: cleanup_failed library_fetch_failed episodes_fetch_failed releases_fetch_failed

Example

{
  "code": "cleanup_failed"
}

403

The API token lacks the read scope.

application/json

An authenticated API token lacks the scope the requested route requires.

object

error

required

Always Forbidden.

string

requiredScope

required

The API token scope this request requires.

string

Allowed values: read mcp sync:apply admin

Example

{
  "requiredScope": "read"
}

404

The metrics endpoint is disabled (METRICS_ENABLED is off).