--- title: "GET /api/clusters" method: GET path: "/api/clusters" --- # GET /api/clusters `GET /api/clusters` This will show all the available clusters ## Response `200` A Clusters is a collection of Cluster objects - Cluster[] - `activePassiveStatus` string - `agents` Agent[] - `cpuCores` integer - `cpuFreq` integer - `hostName` string - `id` string - `memBytes` integer - `memFreeBytes` integer - `osKernel` string - `osName` string - `status` string - `version` string - `apiUsers` object - `cleanReplication` boolean - `config` Config - `HostsDelayed` string - `HostsDelayedTime` integer - `alertScript` string - `alertSlackChannel` string - `alertSlackUrl` string - `alertSlackUser` string - `apiBind` string - `apiCredentials` string - `apiCredentialsACLAllow` string - `apiCredentialsACLDiscard` string - `apiCredentialsExternal` string - `apiCredentialsSecureConfig` boolean - `apiHttpsBind` boolean - `apiPort` string - `arbitrationExternal` boolean - `arbitrationExternalHosts` string - `arbitrationExternalSecret` string - `arbitrationExternalUniqueId` integer - `arbitrationFailedMasterScript` string - `arbitrationPeerHosts` string - `arbitrationReadTimout` integer - `arbitratorBindAddress` string - `arbitratorDriver` string - `autorejoin` boolean - `autorejoinBackupBinlog` boolean - `autorejoinFlashback` boolean - `autorejoinFlashbackOnSync` boolean - `autorejoinFlashbackOnUnsync` boolean - `autorejoinLogicalBackup` boolean - `autorejoinMysqldump` boolean - `autorejoinPhysicalBackup` boolean - `autorejoinScript` string - `autorejoinSlavePositionalHeartbeat` boolean - `autorejoinZfsFlashback` boolean - `autoseed` boolean - `backup` boolean - `backupBinlogs` boolean - `backupBinlogsKeep` integer - `backupKeepDaily` integer - `backupKeepHourly` integer - `backupKeepMonthly` integer - `backupKeepWeekly` integer - `backupKeepYearly` integer - `backupLockDDL` boolean - `backupLogicalDumpSystemTables` boolean - `backupLogicalDumpThreads` integer - `backupLogicalLoadThreads` integer - `backupLogicalType` string - `backupMydumperPath` string - `backupMyloaderPath` string - `backupMysqlbinlogPath` string - `backupMysqlclientgPath` string - `backupMysqldumpOptions` string - `backupMysqldumpPath` string - `backupPhysicalType` string - `backupRestic` boolean - `backupResticAws` boolean - `backupResticBinaryPath` string - `backupResticRepository` string - `backupStreaming` boolean - `backupStreamingBucket` string - `backupStreamingDebug` boolean - `backupStreamingEndpoint` string - `backupStreamingRegion` string - `checkBinlogFilters` boolean - `checkGrants` boolean - `checkReplicationFilters` boolean - `checkReplicationState` boolean - `checkType` string - `clusterHead` string - `dbServersBackupHosts` string - `dbServersConnectTimeout` integer - `dbServersCredential` string - `dbServersHosts` string - `dbServersIgnoredHosts` string - `dbServersIgnoredReadonly` string - `dbServersLocality` string - `dbServersPreferedMaster` string - `dbServersReadTimeout` integer - `dbServersTlsCaCert` string - `dbServersTlsClientCert` string - `dbServersTlsClientKey` string - `dbServersUseGeneratedCert` boolean - `eeplicationRestartOnSqlLErrorMatch` string - `enterprise` boolean - `extproxy` boolean - `extproxyAddress` string - `failoverAtSync` boolean - `failoverEventScheduler` boolean - `failoverEventStatus` boolean - `failoverFalsePositiveExternal` boolean - `failoverFalsePositiveExternalPort` integer - `failoverFalsePositiveHeartbeat` boolean - `failoverFalsePositiveHeartbeatTimeout` integer - `failoverFalsePositiveMaxscale` boolean - `failoverFalsePositiveMaxscaleTimeout` integer - `failoverFalsePositivePingCounter` integer - `failoverLimit` integer - `failoverLogFileKeep` integer - `failoverMaxSlaveDelay` integer - `failoverMode` string - `failoverPostScript` string - `failoverPreScript` string - `failoverReadOnlyState` boolean - `failoverResetTime` integer - `failoverRestartUnsafe` boolean - `failoverSuperReadOnlyState` boolean - `failoverSwithToPrefered` boolean - `failoverTimeLimit` integer - `forceBinlogAnnotate` boolean - `forceBinlogChecksum` boolean - `forceBinlogCompress` boolean - `forceBinlogRow` boolean - `forceBinlogSlowqueries` boolean - `forceDiskRelaylogSizeLimit` boolean - `forceDiskRelaylogSizeLimitSize` integer - `forceInmemoryBinlogCacheSize` boolean - `forceNoslaveBehind` boolean - `forceSlaveGtidMode` boolean - `forceSlaveGtidModeStrict` boolean - `forceSlaveHeartbeat` boolean - `forceSlaveHeartbeatRetry` integer - `forceSlaveHeartbeatTime` integer - `forceSlaveNoGtidMode` boolean - `forceSlaveReadonly` boolean - `forceSlaveSemisync` boolean - `forceSyncBinlog` boolean - `forceSyncInnodb` boolean - `graphiteCarbonApiPort` integer - `graphiteCarbonHost` string - `graphiteCarbonLinkPort` integer - `graphiteCarbonPicklePort` integer - `graphiteCarbonPort` integer - `graphiteCarbonPprofPort` integer - `graphiteCarbonServerPort` integer - `graphiteEmbedded` boolean - `graphiteMetrics` boolean - `haproxy` boolean - `haproxyAPIPort` integer - `haproxyAPIReadBackend` string - `haproxyAPIWriteBackend` string - `haproxyBinaryPath` string - `haproxyIpReadBind` string - `haproxyIpWriteBind` string - `haproxyMode` string - `haproxyPassword` string - `haproxyReadPort` integer - `haproxyServers` string - `haproxyServers-ipv6` string - `haproxyStatPort` integer - `haproxyWritePort` integer - `haproxylUser` string - `heartbeatTable` boolean - `httpAuth` boolean - `httpBindAdress` string - `httpBootstrapButton` boolean - `httpPort` string - `httpRefreshInterval` integer - `httpRoot` string - `httpServer` boolean - `httpSessionLifetime` integer - `interactive` boolean - `kubeConfig` string - `logFailedElection` boolean - `logFile` string - `logHeartbeat` boolean - `logLevel` integer - `logRotateMaxAge` integer - `logRotateMaxBackup` integer - `logRotateMaxSize` integer - `logSqlInMonitoring` boolean - `logSst` boolean - `logSyslog` boolean - `mailFrom` string - `mailSmtpAddr` string - `mailSmtpPassword` string - `mailSmtpTlsSkipVerify` boolean - `mailSmtpUser` string - `mailTo` string - `maxscale` boolean - `maxscaleBinlog` boolean - `maxscaleBinlogPort` integer - `maxscaleDisableMonitor` boolean - `maxscaleGetInfoMethod` string - `maxscaleMaxinfoPort` integer - `maxscalePass` string - `maxscalePort` string - `maxscaleReadPort` integer - `maxscaleReadWritePort` integer - `maxscaleServerMatchPort` boolean - `maxscaleServers` string - `maxscaleServers-ipv6` string - `maxscaleUser` string - `maxscaleWritePort` integer - `maxscalemBinaryPath` string - `monitoringAddress` string - `monitoringAlertTrigger` string - `monitoringBasedir` string - `monitoringCapture` boolean - `monitoringCaptureFileKeep` integer - `monitoringCaptureTrigger` string - `monitoringConfdir` string - `monitoringDatadir` string - `monitoringDiskUsage` boolean - `monitoringDiskUsagePct` integer - `monitoringErreurLogLength` integer - `monitoringIgnoreErrors` string - `monitoringInnoDBStatus` boolean - `monitoringKeyPath` string - `monitoringLongQueryLogLength` integer - `monitoringLongQueryScript` string - `monitoringLongQueryTime` integer - `monitoringLongQueryWithProcess` boolean - `monitoringLongQueryWithTable` boolean - `monitoringPause` boolean - `monitoringPerformanceSchema` boolean - `monitoringProcesslist` boolean - `monitoringQueries` boolean - `monitoringQueryRules` boolean - `monitoringSSLCert` string - `monitoringSSLKey` string - `monitoringSaveConfig` boolean - `monitoringScheduler` boolean - `monitoringSchemaChange` boolean - `monitoringSchemaChangeScript` string - `monitoringSharedir` string - `monitoringSocket` string - `monitoringTenant` string - `monitoringTicker` integer - `monitoringTunnelCredential` string - `monitoringTunnelHost` string - `monitoringTunnelKeyPath` string - `monitoringVariableDiff` boolean - `monitoringWaitRetry` integer - `monitoringWriteHeartbeat` boolean - `monitoringWriteHeartbeatCredential` string - `myproxy` boolean - `myproxyPassword` string - `myproxyPort` integer - `myproxyUser` string - `mysqlrouter` boolean - `mysqlrouterPass` string - `mysqlrouterPort` string - `mysqlrouterReadPort` integer - `mysqlrouterReadWritePort` integer - `mysqlrouterServers` string - `mysqlrouterUser` string - `mysqlrouterWritePort` integer - `onpremiseSsh` boolean - `onpremiseSshCredential` string - `onpremiseSshPort` integer - `opensvcAdminUser` string - `opensvcCodeapp` string - `opensvcHost` string - `opensvcP12Certificate` string - `opensvcP12Secret` string - `opensvcRegister` boolean - `opensvcUseCollectorApi` boolean - `opensvcUser` string - `provDBApplyDynamicConfig` boolean - `provDbAgents` string - `provDbBinaryBasedir` string - `provDbBinaryInTarball` boolean - `provDbBinaryTarballName` string - `provDbBootstrapScript` string - `provDbCleanupScript` string - `provDbClientBasedir` string - `provDbCpuCores` string - `provDbDatadirVersion` string - `provDbDiskDevice` string - `provDbDiskDockerSize` string - `provDbDiskFs` string - `provDbDiskFsCompress` string - `provDbDiskIops` string - `provDbDiskIopsLatency` string - `provDbDiskPool` string - `provDbDiskSize` string - `provDbDiskSnapshotKeep` integer - `provDbDiskSnapshotPreferedMaster` boolean - `provDbDiskSystemSize` string - `provDbDiskTempSize` string - `provDbDiskType` string - `provDbDockerImg` string - `provDbDomain` string - `provDbExpireLogDays` integer - `provDbLoadCsv` string - `provDbLoadSql` string - `provDbMaxConnections` integer - `provDbMemory` string - `provDbMemorySharedPct` string - `provDbMemoryThreadedPct` string - `provDbNetGateway` string - `provDbNetIface` string - `provDbNetMask` string - `provDbServiceType` string - `provDbStartScript` string - `provDbStopScript` string - `provDbTags` string - `provDbVolumeData` string - `provDbVolumeDocker` string - `provDockerDaemonPrivate` boolean - `provNetCni` boolean - `provNetCniCluster` string - `provOrchestrator` string - `provOrchestratorCluster` string - `provOrchestratorEnable` string - `provProxyAgents` string - `provProxyAgentsFailover` string - `provProxyBootstrapScript` string - `provProxyCleanupScript` string - `provProxyCpuCores` string - `provProxyDiskDevice` string - `provProxyDiskFs` string - `provProxyDiskPool` string - `provProxyDiskSize` string - `provProxyDiskType` string - `provProxyDockerHaproxyImg` string - `provProxyDockerMaxscaleImg` string - `provProxyDockerMysqlrouterImg` string - `provProxyDockerProxysqlImg` string - `provProxyDockerShardproxyImg` string - `provProxyMemory` string - `provProxyNetGateway` string - `provProxyNetIface` string - `provProxyNetMask` string - `provProxyRouteAddr` string - `provProxyRouteMask` string - `provProxyRoutePolicy` string - `provProxyRoutePort` string - `provProxyServiceType` string - `provProxyStartScript` string - `provProxyStopScript` string - `provProxyTags` string - `provProxyVolumeData` string - `provServicePlan` string - `provServicePlanRegistry` string - `provSphinxAgents` string - `provSphinxCpuCores` string - `provSphinxDiskDevice` string - `provSphinxDiskFs` string - `provSphinxDiskPool` string - `provSphinxDiskSize` string - `provSphinxDiskType` string - `provSphinxDockerImg` string - `provSphinxMaxChildrens` string - `provSphinxMemory` string - `provSphinxReindexSchedule` string - `provSphinxServiceType` string - `provSphinxTags` string - `provTlsServerCa` string - `provTlsServerCert` string - `provTlsServerKey` string - `proxyServersBackendCompression` boolean - `proxyServersBackendMaxConnections` integer - `proxyServersBackendMaxReplicationLag` integer - `proxyServersReadOnMaster` boolean - `proxysql` boolean - `proxysqlAdminPort` string - `proxysqlBinaryPath` string - `proxysqlBootstrap` boolean - `proxysqlBootstrapHostgroups` boolean - `proxysqlBootstrapQueryRules` boolean - `proxysqlBootstrapVariables` boolean - `proxysqlBootstrapyUsers` boolean - `proxysqlMasterIsReader` boolean - `proxysqlMultiplexing` boolean - `proxysqlPassword` string - `proxysqlPort` string - `proxysqlReaderHostgroup` string - `proxysqlSaveToDisk` boolean - `proxysqlServers` string - `proxysqlServers-ipv6` string - `proxysqlUser` string - `proxysqlWriterHostgroup` string - `registryConsul` boolean - `registryServers` string - `replicationCredential` string - `replicationErrorScript` string - `replicationMasterConnectRetry` integer - `replicationMasterSlaveNeverRelay` boolean - `replicationMasterSlavePgLogical` boolean - `replicationMasterSlavePgStream` boolean - `replicationMultiMaster` boolean - `replicationMultiMasterRing` boolean - `replicationMultiMasterWsrep` boolean - `replicationMultiMasterWsrepSSTMethod` string - `replicationMultiTierSlave` boolean - `replicationMultisourceHeadClusters` string - `replicationSourceName` string - `replicationUseSsl` boolean - `schedulerDatabaseLogsTableKeep` integer - `schedulerDbServersLogicalBackup` boolean - `schedulerDbServersLogicalBackupCron` string - `schedulerDbServersLogs` boolean - `schedulerDbServersLogsCron` string - `schedulerDbServersLogsTableRotate` boolean - `schedulerDbServersLogsTableRotateCron` string - `schedulerDbServersOptimize` boolean - `schedulerDbServersOptimizeCron` string - `schedulerDbServersPhysicalBackup` boolean - `schedulerDbServersPhysicalBackupCron` string - `schedulerDbServersReceiverPorts` string - `schedulerJobsSsh` boolean - `schedulerJobsSshCron` string - `schedulerRollingReprov` boolean - `schedulerRollingReprovCron` string - `schedulerRollingRestart` boolean - `schedulerRollingRestartCron` string - `schedulerSlaRotateCron` string - `shardproxy` boolean - `shardproxyCopyGrants` boolean - `shardproxyCredential` string - `shardproxyIgnoreTables` string - `shardproxyLoadSystem` boolean - `shardproxyServers` string - `shardproxyServers-ipv6` string - `shardproxyUniversalTables` string - `slaposConfig` string - `slaposDbPartitions` string - `slaposHaproxyPartitions` string - `slaposMaxscalePartitions` string - `slaposProxysqlPartitions` string - `slaposShardproxyPartitions` string - `slaposSphinxPartitions` string - `sphinx` boolean - `sphinxConfig` string - `sphinxPort` string - `sphinxServers` string - `sphinxServers-ipv6` string - `sphinxSqlPort` string - `switchoverAtEqualGtid` boolean - `switchoverAtSync` boolean - `switchoverDecreaseMaxConn` boolean - `switchoverDecreaseMaxConnValue` integer - `switchoverMaxSlaveDelay` integer - `switchoverSlaveWaitCatch` boolean - `switchoverWaitKill` integer - `switchoverWaitRouteChange` integer - `switchoverWaitTrx` integer - `switchoverWaitWriteQuery` integer - `sysbenchBinaryPath` string - `sysbenchThreads` integer - `sysbenchTime` integer - `sysbenchV1` boolean - `test` boolean - `testInjectTraffic` boolean - `verbose` boolean - `configPrxTags` Tag[] - `category` string - `id` integer - `name` string - `configTags` Tag[] - `category` string - `id` integer - `name` string - `connections` integer - `dbIndexSize` integer - `dbServers` string[] - `dbServersCrashes` Crash[] — Collection of Crash reports - `ElectedMasterURL` string - `FailoverIOGtid` Gtid[] — List defines a slice of GTIDs - `domainId` integer - `seqNo` integer - `serverId` integer - `FailoverMasterLogFile` string - `FailoverMasterLogPos` string - `FailoverSemiSyncSlaveStatus` boolean - `NewMasterLogFile` string - `NewMasterLogPos` string - `URL` string - `dbServersTags` string[] - `dbTableSize` integer - `diskType` object - `failoverCounter` integer - `failoverLastTime` integer - `fsType` object - `haveDBTLSCert` boolean - `haveDBTLSOldCert` boolean - `isAllDbUp` boolean - `isCapturing` boolean - `isClusterDown` boolean - `isDown` boolean - `isFailable` boolean - `isFailedArbitrator` boolean - `isLostMajority` boolean - `isNeedDatabasesReprov` boolean - `isNeedDatabasesRestart` boolean - `isNeedDatabasesRollingReprov` boolean - `isNeedDatabasesRollingRestart` boolean - `isNeedProxiesRestart` boolean - `isNeedProxyRestart` boolean - `isNotMonitoring` boolean - `isPostgres` boolean - `isProvision` boolean - `isSplitBrain` boolean - `jobResults` object - `log` HttpLog — Collection of log messages - `buffer` HttpMessage[] - `group` string - `level` string - `text` string - `timestamp` string - `len` integer - `line` integer - `monitorSpin` string - `monitorType` object - `name` string - `proxyServers` string[] - `proxyServersTags` string[] - `qps` integer - `slaHistory` Sla[] - `firsttime` integer - `lasttime` integer - `uptime` integer - `uptimeFailable` integer - `uptimeSemisync` integer - `sqlErrorLog` HttpLog — Collection of log messages - `buffer` HttpMessage[] - `group` string - `level` string - `text` string - `timestamp` string - `len` integer - `line` integer - `sqlGeneralLog` HttpLog — Collection of log messages - `buffer` HttpMessage[] - `group` string - `level` string - `text` string - `timestamp` string - `len` integer - `line` integer - `tenant` string - `topology` string - `topologyType` object - `uptime` string - `uptimeFailable` string - `uptimeSemisync` string - `vmType` object - `waitingFailover` integer - `waitingRejoin` integer - `waitingSwitchover` integer - `workingDir` string ## Changes - **2023-03-31** `b57fc7b9446e` — 1 warning, 4 info - deleted the `header` request parameter `Authorization` - api operation id `clusters` was added - api tag `Cluster` removed - removed the non-success response with the status `401` - …1 more [Change history](https://skmtc.dev/signal18/apis/untitled-api/changes/api/clusters/get.md) --- [API](https://skmtc.dev/signal18/apis/untitled-api.md) · [All operations](https://skmtc.dev/signal18/apis/untitled-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/signal18/untitled-api/revisions/b57fc7b9446e/schema)