Discover Prometheus scrape targets for an organization

Disclaimer: This beta endpoint is evolving; the API contract may change.

Returns one Prometheus scrape target per service in the organization that the caller is authorized to view, in HTTP service discovery (http_sd) format. Services the caller lacks view access to, and services in a terminated, terminating, or (soft-)deleted state, are omitted — the response can have fewer groups than the organization has services. Point a Prometheus http_sd_configs job at this endpoint to discover and scrape all services automatically; targets are refreshed on every discovery poll, so created and deleted services are picked up without reconfiguration. Targets scrape with filtered_metrics=true by default; pass ?filtered_metrics=false to this endpoint to discover unfiltered targets.

Sample Prometheus scrape config:

scrape_configs:
  - job_name: clickhouse-cloud
    http_sd_configs:
      - url: https://api.clickhouse.cloud/v1/organizations/<organizationId>/prometheus/discovery
        refresh_interval: 60s
        basic_auth:
          username: <key-id>
          password: <key-secret>
    basic_auth:
      username: <key-id>
      password: <key-secret>

The basic_auth block must be set both under http_sd_configs (used to authenticate discovery polls against this endpoint) and on the scrape job itself (used to authenticate the actual per-service scrapes) — omitting either one is the most common misconfiguration.

GET

organizations

{organizationId}

prometheus

discovery

Discover Prometheus scrape targets for an organization

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery"

headers = {"Authorization": "Basic <encoded-value>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

[
  {
    "targets": [
      "<string>"
    ],
    "labels": {
      "__scheme__": "<string>",
      "__metrics_path__": "<string>",
      "__param_filtered_metrics": "<string>",
      "clickhouse_org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "clickhouse_service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "clickhouse_discovery_service_name": "<string>"
    }
  }
]

{
  "status": 400,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "status": 500,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Beta Disclaimer: This beta endpoint is evolving; the API contract may change.

Returns one Prometheus scrape target per service in the organization that the caller is authorized to view, in HTTP service discovery (http_sd) format. Services the caller lacks view access to, and services in a terminated, terminating, or (soft-)deleted state, are omitted — the response can have fewer groups than the organization has services. Point a Prometheus http_sd_configs job at this endpoint to discover and scrape all services automatically; targets are refreshed on every discovery poll, so created and deleted services are picked up without reconfiguration. Targets scrape with filtered_metrics=true by default; pass ?filtered_metrics=false to this endpoint to discover unfiltered targets. Sample Prometheus scrape config:

scrape_configs:
  - job_name: clickhouse-cloud
    http_sd_configs:
      - url: https://api.clickhouse.cloud/v1/organizations/<organizationId>/prometheus/discovery
        refresh_interval: 60s
        basic_auth:
          username: <key-id>
          password: <key-secret>
    basic_auth:
      username: <key-id>
      password: <key-secret>

Authorizations

Authorization

string

header

required

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

Path Parameters

organizationId

string<uuid>

required

ID of the requested organization.

Query Parameters

filtered_metrics

string<boolean>

Whether discovered targets carry filtered_metrics=true or =false as a scrape param. Accepts true or false; defaults to true — the opposite default from the per-service prometheus endpoint.

Response

Successful response

targets

string[]

Host (and port) of the ClickHouse Cloud API.

labels

object

Show child attributes

Last modified on August 14, 2026

Discover Prometheus scrape targets for an organization

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery"

headers = {"Authorization": "Basic <encoded-value>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/prometheus/discovery")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

[
  {
    "targets": [
      "<string>"
    ],
    "labels": {
      "__scheme__": "<string>",
      "__metrics_path__": "<string>",
      "__param_filtered_metrics": "<string>",
      "clickhouse_org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "clickhouse_service_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "clickhouse_discovery_service_name": "<string>"
    }
  }
]

{
  "status": 400,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "status": 500,
  "error": "<string>",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

ClickHouse Cloud

Bring Your Own Cloud

ClickHouse Private

Discover Prometheus scrape targets for an organization

Authorizations

Path Parameters

Query Parameters

Response