> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-parallel-read-in-order-multi-part.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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`](https://prometheus.io/docs/prometheus/latest/http_sd/) format, and Prometheus picks up new and deleted services automatically. The [Prometheus integration guide](https://clickhouse.com/docs/integrations/prometheus) 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.

**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`](https://prometheus.io/docs/prometheus/latest/http_sd/) format, and Prometheus picks up new and deleted services automatically. The [Prometheus integration guide](https://clickhouse.com/docs/integrations/prometheus) 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.


## OpenAPI

````yaml _specs/cloud-openapi.json GET /v1/organizations/{organizationId}/prometheus
openapi: 3.1.1
info:
  title: OpenAPI spec for ClickHouse Cloud
  version: '1.0'
  contact:
    name: ClickHouse Support
    url: >-
      https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-1222280
    email: support@clickhouse.com
servers:
  - url: https://api.clickhouse.cloud
security:
  - basicAuth: []
tags:
  - name: Organization
  - name: Notifications
  - name: User management
  - name: Billing
  - name: Role Management
  - name: Service
  - name: Backup
  - name: Snapshot
  - name: API keys
  - name: Prometheus
  - name: ClickPipes
  - name: ClickStack
  - name: Postgres
  - name: UDF
  - name: Query API endpoints
  - name: Saved queries
paths:
  /v1/organizations/{organizationId}/prometheus:
    get:
      tags:
        - Prometheus
      summary: Get organization metrics
      description: >-
        **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`](https://prometheus.io/docs/prometheus/latest/http_sd/)
        format, and Prometheus picks up new and deleted services automatically.
        The [Prometheus integration
        guide](https://clickhouse.com/docs/integrations/prometheus) 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.
      operationId: organizationPrometheusGet
      parameters:
        - in: path
          name: organizationId
          description: ID of the requested organization.
          required: true
          schema:
            type: string
            format: uuid
        - in: query
          name: filtered_metrics
          description: Return a filtered list of Prometheus metrics.
          schema:
            type: string
            format: boolean
      responses:
        '200':
          description: Successful response
          content:
            text/plain:
              schema:
                type: string
        '400':
          description: >-
            The request cannot be processed due to a client error. Please verify
            your request parameters and try again.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 400
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
        '500':
          description: >-
            An internal server error has occurred. If this issue persists,
            please contact ClickHouse Cloud support for assistance.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    example: 500
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
      deprecated: true
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: >-
        Use key ID and key secret obtained in ClickHouse Cloud console:
        https://clickhouse.com/docs/cloud/manage/openapi
      x-permission-scopes: >-
        The scope list of a `security` requirement holds ClickHouse Cloud API
        key permission ids (for example `control-plane:organization:view`), not
        OAuth scopes. OpenAPI has no field for API key permissions, so this is
        the closest available place. A key must hold every permission listed on
        an operation to call it; an operation with no scopes needs none beyond a
        valid key. Every operation declares at most one requirement object,
        always for this scheme, so the list is only ever conjunctive —
        alternative sets of permissions are never expressed.

````