- Usage Instructions
- Authentication & Rate Limit
- Account Cluster List V2
- AWS Encryption Key V2
- AWS Endpoint Service Principals V2
- AWS Security Group Firewall Rule V2
- AWS Security Group Firewall Rules V2
- AWS VPC Peer V2
- Apache Cassandra Provisioning V2
- Apache Kafka ACL V2
- Apache Kafka ACL V3
- Apache Kafka Connect Mirror V2
- Apache Kafka Connect Provisioning V2
- Apache Kafka Provisioning V2
- Apache Kafka Provisioning V3
- Apache Kafka Rest Proxy User
- Apache Kafka Schema Registry User
- Apache Kafka Topic V2
- Apache Kafka Topic V3
- Apache Kafka User
- Apache Zookeeper Provisioning V2
- Azure Private Link Service Subscriptions
- Azure Vnet Peer V2
- Cadence Provisioning V2
- ClickHouse Provisioning
- Cloud Provider Details V2
- Cluster Exclusion Window V2
- Cluster Maintenance Events V2
- Cluster Network Firewall Rule V2
- Cluster Network Firewall Rules V2
- Cluster Non Recurring Exclusion Window V2
- Cluster Settings V2
- GCP VPC Peer V2
- Karapace Rest Proxy User
- Karapace Schema Registry User
- OpenSearch Egress Rules V2
- OpenSearch Provisioning V2
- PostgreSQL Configuration V2
- PostgreSQL Operations
- PostgreSQL Provisioning V2
- Redis Provisioning V2
- Redis User V2
- Resize Operations V2
- Terraform Import V2
- User Actions
- Valkey Provisioning V2
- Valkey User V2
- Authentication & Rate Limit
- Monitoring API
- Monitoring API - Cluster
- getRetrieve monitoring metrics
- getCadence - Retrieve list of domains
- getCadence - Retrieve list of tags
- getCassandra - Retrieve list of monitored tables
- getElasticsearch - Retrieve list of index names (For Legacy Support Only)
- getRetrieve health indicators
- getKafka - Retrieve consumer group client metrics
- getKafka - Retrieve consumer group metrics
- getKafka - Retrieve consumer group state
- getKafka - Retrieve consumer group state - version 2
- getKafka - List consumer groups
- getKafka - Retrieve topic level metrics for all topics
- getKafka - Retrieve topic metrics for a specific topic
- getOpenSearch - Retrieve list of index names
- getRetrieve paged monitoring metrics
- getPgBouncer - Retrieve PgBouncer connection pool schemas
- getPostgreSQL - Retrieve PostgreSQL schema definition
- getKafka - Retrieve list of topics
- Monitoring API - Data Centre
- getRetrieve monitoring metrics
- getCadence - Retrieve list of domains
- getCadence - Retrieve list of tags
- getCassandra - Retrieve list of monitored tables
- getElasticsearch - Retrieve list of index names (For Legacy Support Only)
- getRetrieve health indicators
- getOpenSearch - Retrieve list of index names
- getRetrieve paged monitoring metrics
- getPostgreSQL - Retrieve PostgreSQL schema definition
- getKafka - Retrieve list of topics
- Monitoring API - Node
- getRetrieve monitoring metrics
- getCadence - Retrieve list of domains
- getCadence - Retrieve list of tags
- getCassandra - Retrieve list of monitored tables
- getElasticsearch - Retrieve list of index names (For Legacy Support Only)
- getRetrieve health indicators
- getOpenSearch - Retrieve list of index names
- getRetrieve paged monitoring metrics
- getPostgreSQL - Retrieve PostgreSQL schema definition
- getKafka - Retrieve list of topics
- Authentication & Rate Limit
- Service User Management API
- User Management and SCIM 2.0 API
- getGet groups (SCIM 2.0)
- getGet single group (SCIM 2.0)
- patchUpdate group membership (SCIM 2.0)
- getGet users (SCIM 2.0)
- postCreate a user (SCIM 2.0)
- getGet single user (SCIM 2.0)
- putUpdate a user (SCIM 2.0)
- patchPatch a user (SCIM 2.0)
- getGet the details of the current user
- postRotate the requesting user's API key
- putUpdate the role of a user
Operations related to monitoring clusters, data centres and nodes.
Authentication - These requests require the Monitoring API Key.
Account API keys can be retrieved any time from the console by going to gear icon to the top right > Account Settings > API Keys.
Rate Limit - Requests to the Monitoring endpoints are rate limited to 35 requests per second. Exceeding this rate will return a 429 error code until that user’s request threshold falls below this limit. The rate limit can be increased from the default by contacting the Instaclustr support team.