Enable / disable the periodic cluster health check task. Note that this setting isn't persisted across controller restarts and /cluster/configs should be used to disable it permanently

Error

A valid request URL is required to generate request examples

{
  "status": "<string>"
}

PUT

clusterHealth

Error

A valid request URL is required to generate request examples

{
  "status": "<string>"
}

Authorizations

Authorization

string

header

required

The format of the key is "Basic <token>" or "Bearer <token>"

Query Parameters

state

enum<string>

required

ENABLE|DISABLE

Available options:

ENABLE,

DISABLE

Response

200 - application/json

successful operation

status

string

API Documentation

Broker APIs

Table

BatchRestart

ClusterHealth

Connection

ConsistentPush

DedupSnapshot

PerfAdvisor

RateLimiter

AtomicIngestion

Restream

Tuner

AlterTable

UpsertSnapshot

Cluster

User

Application

Broker

AppConfigs

Auth

Health

Logger

PeriodicTask

Database

Instance

Leader

Query

Schema

Segment

Task

Tenant

Upsert

Version

Zookeeper

Enable / disable the periodic cluster health check task. Note that this setting isn't persisted across controller restarts and /cluster/configs should be used to disable it permanently

Authorizations

Query Parameters

Response