---
title: "GET /v1/orchestrator/metrics"
method: GET
path: "/v1/orchestrator/metrics"
tags: ["Orchestrator"]
---

# GET /v1/orchestrator/metrics

`GET /v1/orchestrator/metrics`

List all metrics provided by the metric catalog

## Query parameters

- `filter.includeDeprecated` boolean
- `pageSize` integer
- `pageToken` string
- `orderBy` string
- `asc` boolean

## Response `200`

OK

- ListMetricsResponse
  - `metrics` Metric[], required
    - `id` string, required — Required. The unique identifier of the metric.
    - `name` string, required — Required. The name of the metric.
    - `description` string, required — The description of the metric
    - `version` string, required — The version of this metric
    - `comments` string — Optional comments that describe the purpose of this metric. They may also describe a scenario in which the metric can be useful.
    - `category` string, required — Semantically, the reference to control catalog category or domain; it must conform to the directory structure of the security-metrics respository
    - `implementation` MetricImplementation — MetricImplementation defines the implementation of an individual metric.
      - `metricId` string, required — The metric which is implemented
      - `lang` 'LANGUAGE_UNSPECIFIED' | 'LANGUAGE_REGO', enum — The language this metric is implemented in
      - `code` string, required — The actual implementation
      - `updatedAt` string, date-time — The last time of update
    - `deprecatedSince` string, date-time — Optional, but required if the metric is removed. The metric is not deleted for backward compatibility and the timestamp is set to the time of removal.
  - `nextPageToken` string

## Other responses

- `default` — Default error response

## Changes

- **2026-03-04** `97c4541f02f0` — 1 info
  - added the required property `metrics/items/name` to the response with the `200` status
- **2025-07-21** `48f235df8ac6` — 1 breaking, 3 warning, 4 info
  - removed the required property `metrics/items/name` from the response with the `200` status
  - removed the optional property `metrics/items/interval` from the response with the `200` status
  - removed the optional property `metrics/items/range` from the response with the `200` status
  - removed the optional property `metrics/items/scale` from the response with the `200` status
  - …4 more
- **2025-01-08** `2b79660c20a0` — 4 info
  - the response property `metrics/items/id` became required for the status `200`
  - the response property `metrics/items/implementation/allOf[#/components/schemas/MetricImplementation]/code` became required for the status `200`
  - the response property `metrics/items/implementation/allOf[#/components/schemas/MetricImplementation]/metricId` became required for the status `200`
  - the response property `metrics/items/name` became required for the status `200`
- **2024-09-17** `c04ff2fe305c` — 1 info
  - the response property `metrics` became required for the status `200`
- **2024-04-16** `7ea70d31170c` — 1 info
  - the `metrics/items/interval` response's property pattern `^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$` was added for the status `200`

[Full history](https://skmtc.dev/clouditor/apis/orchestrator-api/changes/v1/orchestrator/metrics/get.md)

---

[API](https://skmtc.dev/clouditor/apis/orchestrator-api.md) · [All operations](https://skmtc.dev/clouditor/apis/orchestrator-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/clouditor/orchestrator-api/revisions/6f8ae69f4eb5/schema)
