# Instaclustr Monitoring API - Cluster API

**Canonical:** https://apis.io/apis/instaclustr/instaclustr-monitoring-api-cluster-api/  
**Provider:** Instaclustr — https://apis.io/providers/instaclustr/  
**Base URL:** https://api.instaclustr.com  
**Documentation:** https://instaclustr.redoc.ly/Current/

Instaclustr Monitoring API - Cluster API is one of 93 APIs that [Instaclustr](https://apis.io/providers/instaclustr/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 12 JSON Schema definitions. Tagged areas include Monitoring API - Cluster. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 12 JSON Schemas.

Operations related to monitoring provisioned clusters

## Operations (18)

| Method | Path | Summary |
|---|---|---|
| GET | `/monitoring/v1/clusters/{clusterId}` | Retrieve monitoring metrics |
| GET | `/monitoring/v1/clusters/{clusterId}/cadence/domains` | Cadence - Retrieve list of domains |
| GET | `/monitoring/v1/clusters/{clusterId}/cadence/tags` | Cadence - Retrieve list of tags |
| GET | `/monitoring/v1/clusters/{clusterId}/columnFamilies` | Cassandra - Retrieve list of monitored tables |
| GET | `/monitoring/v1/clusters/{clusterId}/elasticsearchIndexNames` | Elasticsearch - Retrieve list of index names (For Legacy Support Only) |
| GET | `/monitoring/v1/clusters/{clusterId}/indicators` | Retrieve health indicators |
| GET | `/monitoring/v1/clusters/{clusterId}/kafka/consumerGroupClientMetrics` | Kafka - Retrieve consumer group client metrics |
| GET | `/monitoring/v1/clusters/{clusterId}/kafka/consumerGroupMetrics` | Kafka - Retrieve consumer group metrics |
| GET | `/monitoring/v1/clusters/{clusterId}/kafka/consumerGroupState` | Kafka - Retrieve consumer group state |
| GET | `/monitoring/v1/clusters/{clusterId}/kafka/consumerGroupStateV2` | Kafka - Retrieve consumer group state - version 2 |
| GET | `/monitoring/v1/clusters/{clusterId}/kafka/consumerGroups` | Kafka - List consumer groups |
| GET | `/monitoring/v1/clusters/{clusterId}/kafka/topics` | Kafka - Retrieve topic level metrics for all topics |
| GET | `/monitoring/v1/clusters/{clusterId}/kafka/topics/{topicName}` | Kafka - Retrieve topic metrics for a specific topic |
| GET | `/monitoring/v1/clusters/{clusterId}/openSearchIndexNames` | OpenSearch - Retrieve list of index names |
| GET | `/monitoring/v1/clusters/{clusterId}/pagedMetrics` | Retrieve paged monitoring metrics |
| GET | `/monitoring/v1/clusters/{clusterId}/pgbouncer/pools` | PgBouncer - Retrieve PgBouncer connection pool schemas |
| GET | `/monitoring/v1/clusters/{clusterId}/postgresql/schema` | PostgreSQL - Retrieve PostgreSQL schema definition |
| GET | `/monitoring/v1/clusters/{clusterId}/topics` | Kafka - Retrieve list of topics |

## Machine-readable artifacts (14)

- **OpenAPI** — https://artifacts.apis.io/instaclustr/openapi/instaclustr-monitoring-api-cluster-api-openapi.yml
- **Documentation** — https://www.instaclustr.com/support/documentation/
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-open-search-cluster-v2-schema.json
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-kafka-cluster-v3-schema.json
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-cadence-cluster-v2-schema.json
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-cassandra-cluster-v2-schema.json
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-postgresql-cluster-v2-schema.json
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-click-house-integration-s3-fsxn-schema.json
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-cluster-provisioning-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-data-centre-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-kafka-cluster-v2-schema.json
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-cluster-details-response-for-terraform-import-schema.json
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-bundle-compatibility-response-schema-schema.json
- **JSONSchema** — https://artifacts.apis.io/instaclustr/json-schema/instaclustr-kafka-topic-v2-schema.json

## Other Instaclustr APIs (12)

- [Instaclustr Account Cluster List V2 API](https://apis.io/apis/instaclustr/instaclustr-account-cluster-list-v2-api/)
- [Instaclustr Apache Cassandra Provisioning V2 API](https://apis.io/apis/instaclustr/instaclustr-apache-cassandra-provisioning-v2-api/)
- [Instaclustr Apache Kafka ACL V2 API](https://apis.io/apis/instaclustr/instaclustr-apache-kafka-acl-v2-api/)
- [Instaclustr Apache Kafka ACL V3 API](https://apis.io/apis/instaclustr/instaclustr-apache-kafka-acl-v3-api/)
- [Instaclustr Apache Kafka Connect Mirror V2 API](https://apis.io/apis/instaclustr/instaclustr-apache-kafka-connect-mirror-v2-api/)
- [Instaclustr Apache Kafka Connect Provisioning V2 API](https://apis.io/apis/instaclustr/instaclustr-apache-kafka-connect-provisioning-v2-api/)
- [Instaclustr Apache Kafka Provisioning V2 API](https://apis.io/apis/instaclustr/instaclustr-apache-kafka-provisioning-v2-api/)
- [Instaclustr Apache Kafka Provisioning V3 API](https://apis.io/apis/instaclustr/instaclustr-apache-kafka-provisioning-v3-api/)
- [Instaclustr Apache Kafka Rest Proxy User API](https://apis.io/apis/instaclustr/instaclustr-apache-kafka-rest-proxy-user-api/)
- [Instaclustr Apache Kafka Schema Registry User API](https://apis.io/apis/instaclustr/instaclustr-apache-kafka-schema-registry-user-api/)
- [Instaclustr Apache Kafka Tiered Storage API](https://apis.io/apis/instaclustr/instaclustr-apache-kafka-tiered-storage-api/)
- [Instaclustr Apache Kafka Topic V2 API](https://apis.io/apis/instaclustr/instaclustr-apache-kafka-topic-v2-api/)

## Tags

Monitoring API - Cluster

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/instaclustr/instaclustr-monitoring-api-cluster-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/instaclustr/.