Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

KEDA Metrics API

External metrics API server that exposes event-driven metrics from configured scalers to the Kubernetes Horizontal Pod Autoscaler. It implements the Kubernetes external metrics API interface, allowing the HPA controller to query scaler-derived metrics when making scaling decisions.

KEDA Metrics API is one of 5 APIs that KEDA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include External Metrics, HPA, Kubernetes, and Metrics. The published artifact set on APIs.io includes API documentation, a getting-started guide, an API reference, and an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 2.x.

Requests are made against a single base URL, http://{host}:{port}.

1 operations 1 paths 1 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.x
Server
http://{host}:{port}
Authentication
HTTP Bearer, HTTP Basic, API Key
License
Resource Areas
1

Authentication & Security 3

KEDA Metrics API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP basic authentication (basicAuth). An API key is passed in the header as X-API-Key (apiKeyHeader).

  • bearerAuth — Bearer token authentication for secured metrics endpoints.
  • basicAuth — Basic authentication for secured metrics endpoints.
  • apiKeyHeader — API key authentication via header for secured metrics endpoints.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Metrics 1

Endpoint returning a numeric metric value that KEDA uses to drive autoscaling decisions via the Horizontal Pod Autoscaler.

GET
/{metricPath}
KEDA Get metric value
getMetricValue 1 param → 200401403404500

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. Each schema is shown below with its type and property counts.

MetricsResponse
object
Arbitrary JSON object returned by the external metrics endpoint. KEDA uses GJSON path notation (configured in valueLocation) to extract a single numeric metric…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keda-metrics-api-openapi.yml Raw ↑

Other APIs KEDA publishes across the network.

KEDA ScaledObject API
KEDA ScaledJob API
KEDA TriggerAuthentication API
KEDA CloudEventSource API