ClickHouse

ClickHouse Replicas Status API

The Replicas Status API from ClickHouse — 1 operation(s) for replicas status.

GitHub OpenAPI

Documentation

📖
Documentation
https://clickhouse.com/docs/en/cloud/manage/api/api-overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/clickhouse/refs/heads/main/openapi/clickhouse-replicas-status-api-openapi.yml

Other Resources

🔗
Swagger
https://clickhouse.com/docs/cloud/manage/api/swagger

OpenAPI Specification

clickhouse-replicas-status-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: ClickHouse HTTP Interface Replicas Status API
  description: 'ClickHouse HTTP interface for executing SQL queries, inserting data, and

    monitoring server health. Authentication is performed with HTTP Basic, URL

    parameters, or the X-ClickHouse-User / X-ClickHouse-Key headers.

    '
  version: 1.0.0
servers:
- url: http://localhost:8123
  description: Default local ClickHouse HTTP listener
security:
- basicAuth: []
tags:
- name: Replicas Status
paths:
  /replicas_status:
    get:
      summary: Get replica status
      description: Returns replica delay information across the cluster.
      responses:
        '200':
          description: Replica status report
          content:
            text/plain:
              schema:
                type: string
      tags:
      - Replicas Status
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    clickhouseHeaders:
      type: apiKey
      in: header
      name: X-ClickHouse-User