Get

/metrics/names

Query parameters

search

string

Filter metric names containing this string (case-insensitive substring match)

pipeline

string

Filter metrics by pipeline name

function

string

Filter metrics by function name

metric_type

string

Filter metrics by type (Counter, Histogram, Gauge, UpDownCounter)

Valid values[ "Counter", "Histogram", "Gauge", "UpDownCounter" ]

Responses

200

List of discovered metric names with metadata

Expand All

object

items

Array of object (MetricNameInfo)

List of discovered metrics with their metadata

object

name

string

Name of the metric

scope

string | null

OpenTelemetry scope name (e.g., "vast-runtime", "user")

unit

string | null

Unit of the metric (ms, bytes, percent, etc.)

type

string

Type of metric (Counter, Histogram, Gauge, UpDownCounter)

description

string | null

Human-readable description of the metric

500

Internal Server Error

Expand All

object

detail

string

source

object (ErrorSource)

Represents the underlying problem that made Data Engine raise the error

source_type

string

The component where the error happened

Examplekubernetes | vms | vdb | registry

source_name

string

The name of the source compoenent

Examplemy-cluster

inner_error

string

The error message from the source component

ExampleFailed to connect to the cluster

code

string

Optional machine-readable error code for clients to branch on instead of parsing detail.

Discover available metric names