List Prometheus scrape targets

GET/v1/organizations/{organizationId}/prometheus/discovery

Returns one Prometheus scrape target per service in the organization, in the HTTP service discovery (http_sd) format. Only services the API key is authorized to view are included; services that are being deleted or have been deleted are omitted.

Point an http_sd_configs job at this endpoint to discover and scrape all services in the organization automatically. Prometheus refreshes the target list on every discovery poll, so newly created and deleted services are picked up without configuration changes.

Discovered targets scrape with filtered_metrics=true by default; pass ?filtered_metrics=false to this endpoint to discover unfiltered targets. See the Prometheus integration guide for more on the exported metrics.

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
Whether discovered targets scrape a filtered list of metrics. Sets the filtered_metrics parameter on each discovered target. Defaults to true.

format: boolean

Response

JSON

200

Successful response

JSON

targetsoptionalarray ofstring
Host (and port) of the ClickHouse Cloud API.
labelsoptionalobject
6 properties
- __scheme__optionalstring
  URL scheme Prometheus must scrape the target with.
- __metrics_path__optionalstring
  Path of the per-service Prometheus metrics endpoint.
- __param_filtered_metricsoptionalstring
  Value passed as the filtered_metrics query parameter on each scrape.
  
  format: boolean
- clickhouse_org_idoptionalstring
  Organization ID the service belongs to.
  
  format: uuid
- clickhouse_service_idoptionalstring
  Service ID.
  
  format: uuid
- clickhouse_discovery_service_nameoptionalstring
  Service name.

List Prometheus scrape targets

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

const url = 'https://api.clickhouse.cloud/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/prometheus/discovery';
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/discovery"

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

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

print(response.text)

Response example

[
  {
    "targets": [
      "string"
    ],
    "labels": {
      "__scheme__": "string",
      "__metrics_path__": "string",
      "__param_filtered_metrics": "string",
      "clickhouse_org_id": "d1d060e9-d26f-4d5c-983e-ef2c01a25981",
      "clickhouse_service_id": "35a53181-d48b-45f5-8b27-5e8a6bb1dbf7",
      "clickhouse_discovery_service_name": "string"
    }
  }
]

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

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