Prometheus

List Prometheus scrape targets

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.

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

Request

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

Path parameters

organizationIdstring uuid required

ID of the requested organization.

Query parameters

filtered_metricsstring boolean

Whether discovered targets scrape a filtered list of metrics. Sets the filtered_metrics parameter on each discovered target. Defaults to true.

Response

Successful response

targetsstring[]

Host (and port) of the ClickHouse Cloud API.

Changes

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