Prometheus

Get organization metrics

Deprecated. This endpoint is disabled on 1 January 2027. It is already disabled for new organizations.

Migrate before then to the service discovery endpoint, GET /v1/organizations/{organizationId}/prometheus/discovery. It returns one scrape target per service in the http_sd format, and Prometheus picks up new and deleted services automatically. The Prometheus integration guide has a prometheus.yml example.

If you need this endpoint after 1 January 2027, contact ClickHouse support to have it enabled for your organization.

Returns Prometheus metrics for the services in the organization. Only services the API key is authorized to view are included.

get/v1/organizations/{organizationId}/prometheus

Request

  • Base URL: https://api.clickhouse.cloud
  • URL: https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus
  • Auth: HTTP basic

Path parameters

organizationIdstring uuid required

ID of the requested organization.

Query parameters

filtered_metricsstring boolean

Return a filtered list of Prometheus metrics.

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.