Get organization metrics | ClickHouse Docs

GET/v1/organizations/{organizationId}/prometheus

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.

Authorizations

Authorizationstringheaderrequired
Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Path parameters

organizationIdstringrequired
ID of the requested organization.

format: uuid

Query parameters

filtered_metricsoptionalstring
Return a filtered list of Prometheus metrics.

format: boolean

Response

PLAIN

200

Successful response

Get organization metrics

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/prometheus \
  --header 'Authorization: Basic <token>'

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/prometheus';
const options = {method: 'GET', headers: {Authorization: 'Basic <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/prometheus"

headers = {"Authorization": "Basic <token>"}

response = requests.get(url, headers=headers)

print(response.text)

Response example

string

{
  "status": 400,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}

{
  "status": 500,
  "error": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6"
}