From 59a1bc40ec529bea6173c9ce0c574b219fd0548f Mon Sep 17 00:00:00 2001 From: caffeinated92 Date: Thu, 9 Jan 2025 17:07:19 +0700 Subject: [PATCH 1/4] Add API usage documentation and restructure existing content --- 03.usage/03.api/00.overview/docs.md | 59 + 03.usage/03.api/01.latest/docs.md | 12255 ++++++++++++++++ .../03.api/{ => 02.previous-versions}/docs.md | 56 +- 03.usage/03.api/chapter.md | 8 + 4 files changed, 12323 insertions(+), 55 deletions(-) create mode 100644 03.usage/03.api/00.overview/docs.md create mode 100644 03.usage/03.api/01.latest/docs.md rename 03.usage/03.api/{ => 02.previous-versions}/docs.md (87%) create mode 100644 03.usage/03.api/chapter.md diff --git a/03.usage/03.api/00.overview/docs.md b/03.usage/03.api/00.overview/docs.md new file mode 100644 index 0000000..6068dab --- /dev/null +++ b/03.usage/03.api/00.overview/docs.md @@ -0,0 +1,59 @@ +--- +title: API Client Usage +taxonomy: + category: docs +--- + +## API Client Usage + +The rest API is using JWT TLS and is served by default on port 10005 by the replication-manager monitor/ + +Credentials can be customized by setting your own user and password in configuration file. + +``` +api-port ="10005" +api-credential = "admin:repman" +``` + +At startup of the monitor, X509 certificates are loaded from the replication-manager share directory or from keys defined from config files to ensure TLS https secure communication. + +Replace those files with your own certificate signed or self signed to make sure your deployment is secured. + +``` +# Key considerations for algorithm "RSA" ≥ 2048-bit +openssl genrsa -out server.key 2048 + +# Key considerations for algorithm "ECDSA" ≥ secp384r1 +# List ECDSA the supported curves (openssl ecparam -list_curves) +openssl ecparam -genkey -name secp384r1 -out server.key +openssl req -new -x509 -sha256 -key server.key -out server.crt -days 3650 +``` + +At startup **replication-manager** monitor will generate in memory extra self-signed RSA certificate to ensure later token encryption exchange for JWT. + +# Calling API via the client + +API can be called via command line client to simplify curl syntax with JWT token. + +``` +./replication-manager-cli api --url="https://127.0.0.1:10005/api/clusters/ux_dck_zpool_loop/servers/actions/add/192.168.1.73/3306" --cluster="ux_dck_zpool_loop" +``` + +# Calling API via curl or wget + +TOKEN=$(curl -s -k -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' --data '{"username":"admin","password":"repman"}' https://demo.signal18.io/api/login | jq -r '.token') + +or without json response + +TOKEN=$(curl -s -k -X POST -H 'Accept: text/html' -H 'Content-Type: application/json' --data '{"username":"admin","password":"repman"}' https://127.0.0.1:10005/api/login) + + +follow by your request: + +curl -k -H 'Accept: application/json' -H "Authorization: Bearer ${TOKEN}" https://demo.signal18.io/api/clusters + +Or via wget + +TOKEN=$(wget -qO- --no-check-certificate --post-data '{"username":"admin","password":"repman"}' --header 'Accept: text/html' --header 'Content-Type: application/json' https://127.0.0.1:10005/api/login) + +wget -qO- --no-check-certificate --header 'Accept: application/json' --header "Authorization: Bearer ${TOKEN}" https://127.0.0.1:10005/api/clusters \ No newline at end of file diff --git a/03.usage/03.api/01.latest/docs.md b/03.usage/03.api/01.latest/docs.md new file mode 100644 index 0000000..56dc0bc --- /dev/null +++ b/03.usage/03.api/01.latest/docs.md @@ -0,0 +1,12255 @@ +--- +title: API Client Usage (v3) +taxonomy: + category: docs +--- + +## All endpoints + +### auth + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| POST | /api/login | [post API login](#post-api-login) | User login | + + + +### cloud18 + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| GET | /api/clusters/for-sale | [get API clusters for sale](#get-api-clusters-for-sale) | Retrieve peer clusters for sale | +| GET | /api/clusters/peers | [get API clusters peers](#get-api-clusters-peers) | Retrieve peer clusters for a user | +| GET | /api/terms | [get API terms](#get-api-terms) | Retrieves terms | +| POST | /api/clusters/{clusterName}/sales/accept-subscription | [post API clusters cluster name sales accept subscription](#post-api-clusters-cluster-name-sales-accept-subscription) | Accept a subscription for a specific cluster | +| POST | /api/clusters/{clusterName}/sales/end-subscription | [post API clusters cluster name sales end subscription](#post-api-clusters-cluster-name-sales-end-subscription) | Remove a sponsor from a specific cluster | +| POST | /api/clusters/{clusterName}/sales/refuse-subscription | [post API clusters cluster name sales refuse subscription](#post-api-clusters-cluster-name-sales-refuse-subscription) | Reject a subscription for a specific cluster | +| POST | /api/clusters/{clusterName}/subscribe | [post API clusters cluster name subscribe](#post-api-clusters-cluster-name-subscribe) | Subscribe a user to a cluster | + + + +### cluster + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| DELETE | /api/clusters/actions/delete/{clusterName} | [delete API clusters actions delete cluster name](#delete-api-clusters-actions-delete-cluster-name) | Delete a cluster | +| GET | /api/clusters | [get API clusters](#get-api-clusters) | Fetch clusters | +| GET | /api/clusters/{clusterName} | [get API clusters cluster name](#get-api-clusters-cluster-name) | Retrieve details of a cluster | +| GET | /api/clusters/{clusterName}/diffvariables | [get API clusters cluster name diffvariables](#get-api-clusters-cluster-name-diffvariables) | Retrieve variable differences for a specific cluster | +| GET | /api/clusters/{clusterName}/jobs | [get API clusters cluster name jobs](#get-api-clusters-cluster-name-jobs) | Retrieve job entries for a specific cluster | +| GET | /api/clusters/{clusterName}/queryrules | [get API clusters cluster name queryrules](#get-api-clusters-cluster-name-queryrules) | Retrieve query rules for a specific cluster | +| GET | /api/clusters/{clusterName}/status | [get API clusters cluster name status](#get-api-clusters-cluster-name-status) | Retrieve status of a cluster | +| GET | /api/clusters/{clusterName}/top | [get API clusters cluster name top](#get-api-clusters-cluster-name-top) | Retrieve top metrics for a specific cluster | +| GET | /api/clusters/{clusterName}/topology/crashes | [get API clusters cluster name topology crashes](#get-api-clusters-cluster-name-topology-crashes) | Retrieve crashes for a specific cluster | +| POST | /api/clusters/actions/add/{clusterName} | [post API clusters actions add cluster name](#post-api-clusters-actions-add-cluster-name) | Add a new cluster | +| POST | /api/clusters/{clusterName}/actions/waitdatabases | [post API clusters cluster name actions waitdatabases](#post-api-clusters-cluster-name-actions-waitdatabases) | Wait for databases to be ready for a specific cluster | + + + +### cluster_actions + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| POST | /api/clusters/{clusterName}/actions/failover | [post API clusters cluster name actions failover](#post-api-clusters-cluster-name-actions-failover) | Handles the failover process for a given cluster. | +| POST | /api/clusters/{clusterName}/actions/optimize | [post API clusters cluster name actions optimize](#post-api-clusters-cluster-name-actions-optimize) | Optimize a specific cluster | +| POST | /api/clusters/{clusterName}/actions/reset-failover-control | [post API clusters cluster name actions reset failover control](#post-api-clusters-cluster-name-actions-reset-failover-control) | Reset failover control for a specific cluster | +| POST | /api/clusters/{clusterName}/actions/reset-sla | [post API clusters cluster name actions reset SLA](#post-api-clusters-cluster-name-actions-reset-sla) | Reset SLA for a specific cluster | +| POST | /api/clusters/{clusterName}/actions/rotate-passwords | [post API clusters cluster name actions rotate passwords](#post-api-clusters-cluster-name-actions-rotate-passwords) | Rotate passwords for a specific cluster | +| POST | /api/clusters/{clusterName}/actions/switchover | [post API clusters cluster name actions switchover](#post-api-clusters-cluster-name-actions-switchover) | Handles the switchover process for a given cluster. | +| POST | /api/clusters/settings/actions/reload-clusters-plans | [post API clusters settings actions reload clusters plans](#post-api-clusters-settings-actions-reload-clusters-plans) | Reload cluster plans | + + + +### cluster_backup + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| POST | /api/clusters/{clusterName}/actions/master-physical-backup | [post API clusters cluster name actions master physical backup](#post-api-clusters-cluster-name-actions-master-physical-backup) | Perform a physical backup for the master of a specific cluster | + + + +### cluster_backups + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| GET | /api/clusters/{clusterName}/backups | [get API clusters cluster name backups](#get-api-clusters-cluster-name-backups) | Retrieve backups for a specific cluster | + + + +### cluster_certificates + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| GET | /api/clusters/{clusterName}/certificates | [get API clusters cluster name certificates](#get-api-clusters-cluster-name-certificates) | Retrieve client certificates for a specific cluster | +| POST | /api/clusters/{clusterName}/actions/certificates-rotate | [post API clusters cluster name actions certificates rotate](#post-api-clusters-cluster-name-actions-certificates-rotate) | Rotate keys for a specific cluster | + + + +### cluster_graphite + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| GET | /api/clusters/{clusterName}/graphite-filterlist | [get API clusters cluster name graphite filterlist](#get-api-clusters-cluster-name-graphite-filterlist) | Retrieve Graphite filter list for a specific cluster | +| POST | /api/clusters/{clusterName}/settings/actions/reload-graphite-filterlist | [post API clusters cluster name settings actions reload graphite filterlist](#post-api-clusters-cluster-name-settings-actions-reload-graphite-filterlist) | Reload Graphite filter list for a specific cluster | +| POST | /api/clusters/{clusterName}/settings/actions/reset-graphite-filterlist/{template} | [post API clusters cluster name settings actions reset graphite filterlist template](#post-api-clusters-cluster-name-settings-actions-reset-graphite-filterlist-template) | Reset Graphite filter list for a specific cluster | +| POST | /api/clusters/{clusterName}/settings/actions/set-graphite-filterlist/{filterType} | [post API clusters cluster name settings actions set graphite filterlist filter type](#post-api-clusters-cluster-name-settings-actions-set-graphite-filterlist-filter-type) | Set Graphite filter list for a specific cluster | + + + +### cluster_maintenance + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| POST | /api/clusters/{clusterName}/actions/cancel-rolling-restart | [post API clusters cluster name actions cancel rolling restart](#post-api-clusters-cluster-name-actions-cancel-rolling-restart) | Cancel rolling restart for a specific cluster | +| POST | /api/clusters/{clusterName}/actions/rolling | [post API clusters cluster name actions rolling](#post-api-clusters-cluster-name-actions-rolling) | Handles the rolling restart process for a given cluster. | + + + +### cluster_monitor + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| POST | /api/clusters/{clusterName}/actions/addserver/{host}/{port} | [post API clusters cluster name actions addserver host port](#post-api-clusters-cluster-name-actions-addserver-host-port) | Add a server to a specific cluster | +| POST | /api/clusters/{clusterName}/actions/addserver/{host}/{port}/{type} | [post API clusters cluster name actions addserver host port type](#post-api-clusters-cluster-name-actions-addserver-host-port-type) | Add a server to a specific cluster | +| POST | /cluster/{clusterName}/actions/dropserver/{host}/{port} | [post cluster cluster name actions dropserver host port](#post-cluster-cluster-name-actions-dropserver-host-port) | Drop a server monitor from a cluster | +| POST | /cluster/{clusterName}/actions/dropserver/{host}/{port}/{type} | [post cluster cluster name actions dropserver host port type](#post-cluster-cluster-name-actions-dropserver-host-port-type) | Drop a server monitor from a cluster | + + + +### cluster_provision + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| POST | /api/clusters/{clusterName}/actions/cancel-rolling-reprov | [post API clusters cluster name actions cancel rolling reprov](#post-api-clusters-cluster-name-actions-cancel-rolling-reprov) | Cancel rolling reprovision for a specific cluster | +| POST | /api/clusters/{clusterName}/services/actions/provision | [post API clusters cluster name services actions provision](#post-api-clusters-cluster-name-services-actions-provision) | Provision services for a specific cluster | +| POST | /api/clusters/{clusterName}/services/actions/unprovision | [post API clusters cluster name services actions unprovision](#post-api-clusters-cluster-name-services-actions-unprovision) | Unprovision services for a specific cluster | + + + +### cluster_replication + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| POST | /api/clusters/{clusterName}/actions/replication/bootstrap/{topology} | [post API clusters cluster name actions replication bootstrap topology](#post-api-clusters-cluster-name-actions-replication-bootstrap-topology) | Bootstrap replication for a specific cluster | +| POST | /api/clusters/{clusterName}/actions/replication/cleanup | [post API clusters cluster name actions replication cleanup](#post-api-clusters-cluster-name-actions-replication-cleanup) | Cleanup replication bootstrap for a specific cluster | + + + +### cluster_schema + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| GET | /api/clusters/{clusterName}/schema | [get API clusters cluster name schema](#get-api-clusters-cluster-name-schema) | Retrieve schema information for a specific cluster | +| POST | /api/clusters/{clusterName}/actions/checksum-all-tables | [post API clusters cluster name actions checksum all tables](#post-api-clusters-cluster-name-actions-checksum-all-tables) | Calculate checksum for all tables in a specific cluster | +| POST | /api/clusters/{clusterName}/schema/{schemaName}/{tableName}/actions/checksum-table | [post API clusters cluster name schema schema name table name actions checksum table](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-checksum-table) | Calculate checksum for a specific table in a specific cluster | +| POST | /api/clusters/{clusterName}/schema/{schemaName}/{tableName}/actions/move-table/{clusterShard} | [post API clusters cluster name schema schema name table name actions move table cluster shard](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-move-table-cluster-shard) | Move a table to a different shard cluster | +| POST | /api/clusters/{clusterName}/schema/{schemaName}/{tableName}/actions/reshard-table | [post API clusters cluster name schema schema name table name actions reshard table](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-reshard-table) | Reshard a table for a specific cluster | +| POST | /api/clusters/{clusterName}/schema/{schemaName}/{tableName}/actions/reshard-table/{clusterList} | [post API clusters cluster name schema schema name table name actions reshard table cluster list](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-reshard-table-cluster-list) | Reshard a table for a specific cluster | +| POST | /api/clusters/{clusterName}/schema/{schemaName}/{tableName}/actions/universal-table | [post API clusters cluster name schema schema name table name actions universal table](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-universal-table) | Set a universal table for a specific cluster | + + + +### cluster_settings + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| GET | /api/clusters/{clusterName}/settings | [get API clusters cluster name settings](#get-api-clusters-cluster-name-settings) | Retrieve settings for a specific cluster | +| POST | /api/clusters/{clusterName}/settings/actions/certificates-reload | [post API clusters cluster name settings actions certificates reload](#post-api-clusters-cluster-name-settings-actions-certificates-reload) | Reload client certificates for a specific cluster | +| POST | /api/clusters/{clusterName}/settings/actions/discover | [post API clusters cluster name settings actions discover](#post-api-clusters-cluster-name-settings-actions-discover) | Discover settings for a specific cluster | +| POST | /api/clusters/{clusterName}/settings/actions/reload | [post API clusters cluster name settings actions reload](#post-api-clusters-cluster-name-settings-actions-reload) | Reload cluster settings | +| POST | /api/clusters/{clusterName}/settings/actions/set-cron/{settingName}/{settingValue} | [post API clusters cluster name settings actions set cron setting name setting value](#post-api-clusters-cluster-name-settings-actions-set-cron-setting-name-setting-value) | Set cron jobs for a specific cluster | +| POST | /api/clusters/{clusterName}/settings/actions/set/{settingName}/{settingValue} | [post API clusters cluster name settings actions set setting name setting value](#post-api-clusters-cluster-name-settings-actions-set-setting-name-setting-value) | Set settings for a specific cluster | +| POST | /api/clusters/{clusterName}/settings/actions/switch/{settingName} | [post API clusters cluster name settings actions switch setting name](#post-api-clusters-cluster-name-settings-actions-switch-setting-name) | Switch settings for a specific cluster | +| POST | /api/clusters/settings/actions/set/{settingName}/{settingValue} | [post API clusters settings actions set setting name setting value](#post-api-clusters-settings-actions-set-setting-name-setting-value) | Set global settings for the server | + + + +### cluster_tags + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| GET | /api/clusters/{clusterName}/tags | [get API clusters cluster name tags](#get-api-clusters-cluster-name-tags) | Retrieve tags for a specific cluster | +| POST | /api/clusters/{clusterName}/settings/actions/add-db-tag/{tagValue} | [post API clusters cluster name settings actions add db tag tag value](#post-api-clusters-cluster-name-settings-actions-add-db-tag-tag-value) | Add a tag to a specific cluster | +| POST | /api/clusters/{clusterName}/settings/actions/add-proxy-tag/{tagValue} | [post API clusters cluster name settings actions add proxy tag tag value](#post-api-clusters-cluster-name-settings-actions-add-proxy-tag-tag-value) | Add a proxy tag to a specific cluster | +| POST | /api/clusters/{clusterName}/settings/actions/apply-dynamic-config | [post API clusters cluster name settings actions apply dynamic config](#post-api-clusters-cluster-name-settings-actions-apply-dynamic-config) | Apply dynamic configuration for a specific cluster | +| POST | /api/clusters/{clusterName}/settings/actions/drop-db-tag/{tagValue} | [post API clusters cluster name settings actions drop db tag tag value](#post-api-clusters-cluster-name-settings-actions-drop-db-tag-tag-value) | Remove a tag from a specific cluster | +| POST | /api/clusters/{clusterName}/settings/actions/drop-proxy-tag/{tagValue} | [post API clusters cluster name settings actions drop proxy tag tag value](#post-api-clusters-cluster-name-settings-actions-drop-proxy-tag-tag-value) | Remove a proxy tag from a specific cluster | + + + +### cluster_test + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| POST | /api/clusters/{clusterName}/actions/sysbench | [post API clusters cluster name actions sysbench](#post-api-clusters-cluster-name-actions-sysbench) | Run sysbench for a specific cluster | +| POST | /api/clusters/{clusterName}/tests/actions/run/all | [post API clusters cluster name tests actions run all](#post-api-clusters-cluster-name-tests-actions-run-all) | Run all tests for a given cluster | +| POST | /api/clusters/{clusterName}/tests/actions/run/{testName} | [post API clusters cluster name tests actions run test name](#post-api-clusters-cluster-name-tests-actions-run-test-name) | Run a specific test for a given cluster | + + + +### cluster_topology + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| GET | /api/clusters/{clusterName}/shardclusters | [get API clusters cluster name shardclusters](#get-api-clusters-cluster-name-shardclusters) | Retrieve shard clusters for a specific cluster | +| GET | /api/clusters/{clusterName}/topology/alerts | [get API clusters cluster name topology alerts](#get-api-clusters-cluster-name-topology-alerts) | Shows the alerts for that specific named cluster | +| GET | /api/clusters/{clusterName}/topology/logs | [get API clusters cluster name topology logs](#get-api-clusters-cluster-name-topology-logs) | Retrieve logs for a specific cluster | +| GET | /api/clusters/{clusterName}/topology/master | [get API clusters cluster name topology master](#get-api-clusters-cluster-name-topology-master) | Retrieve master of a cluster | +| GET | /api/clusters/{clusterName}/topology/proxies | [get API clusters cluster name topology proxies](#get-api-clusters-cluster-name-topology-proxies) | Shows the proxies for that specific named cluster | +| GET | /api/clusters/{clusterName}/topology/servers | [get API clusters cluster name topology servers](#get-api-clusters-cluster-name-topology-servers) | Retrieve servers for a specific cluster | +| GET | /api/clusters/{clusterName}/topology/slaves | [get API clusters cluster name topology slaves](#get-api-clusters-cluster-name-topology-slaves) | Shows the slaves for that specific named cluster | +| POST | /api/clusters/{clusterName}/actions/add/{clusterShardingName} | [post API clusters cluster name actions add cluster sharding name](#post-api-clusters-cluster-name-actions-add-cluster-sharding-name) | Add a sharding cluster to an existing cluster | + + + +### cluster_traffics + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| POST | /api/clusters/{clusterName}/actions/start-traffic | [post API clusters cluster name actions start traffic](#post-api-clusters-cluster-name-actions-start-traffic) | Start traffic for a specific cluster | +| POST | /api/clusters/{clusterName}/actions/stop-traffic | [post API clusters cluster name actions stop traffic](#post-api-clusters-cluster-name-actions-stop-traffic) | Stop traffic for a specific cluster | + + + +### cluster_vault + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| POST | /api/clusters/{clusterName}/send-vault-token | [post API clusters cluster name send vault token](#post-api-clusters-cluster-name-send-vault-token) | Send Vault token to a specific cluster | + + + +### database + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| GET | /api/clusters/{clusterName}/need-rolling-reprov | [get API clusters cluster name need rolling reprov](#get-api-clusters-cluster-name-need-rolling-reprov) | Check if a cluster needs a rolling reprovision | +| GET | /api/clusters/{clusterName}/need-rolling-restart | [get API clusters cluster name need rolling restart](#get-api-clusters-cluster-name-need-rolling-restart) | Check if a cluster needs a rolling restart | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/toogle-innodb-monitor | [get API clusters cluster name servers server name actions toogle innodb monitor](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-innodb-monitor) | Toggle InnoDB monitor on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/all-slaves-status | [get API clusters cluster name servers server name all slaves status](#get-api-clusters-cluster-name-servers-server-name-all-slaves-status) | Get status of all slaves of a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/is-master | [get API clusters cluster name servers server name is master](#get-api-clusters-cluster-name-servers-server-name-is-master) | Check if a server is a master | +| GET | /api/clusters/{clusterName}/servers/{serverName}/is-slave | [get API clusters cluster name servers server name is slave](#get-api-clusters-cluster-name-servers-server-name-is-slave) | Check if a server is a slave | +| GET | /api/clusters/{clusterName}/servers/{serverName}/master-status | [get API clusters cluster name servers server name master status](#get-api-clusters-cluster-name-servers-server-name-master-status) | Get master status of a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/meta-data-locks | [get API clusters cluster name servers server name meta data locks](#get-api-clusters-cluster-name-servers-server-name-meta-data-locks) | Get metadata locks of a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/processlist | [get API clusters cluster name servers server name processlist](#get-api-clusters-cluster-name-servers-server-name-processlist) | Get process list of a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/config | [get API clusters cluster name servers server name server port config](#get-api-clusters-cluster-name-servers-server-name-server-port-config) | Get server port configuration | +| GET | /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/is-master | [get API clusters cluster name servers server name server port is master](#get-api-clusters-cluster-name-servers-server-name-server-port-is-master) | Check if a server port is a master | +| GET | /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/is-slave | [get API clusters cluster name servers server name server port is slave](#get-api-clusters-cluster-name-servers-server-name-server-port-is-slave) | Check if a server port is a slave | +| GET | /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/need-config-change | [get API clusters cluster name servers server name server port need config change](#get-api-clusters-cluster-name-servers-server-name-server-port-need-config-change) | Check if a server needs a config change | +| GET | /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/need-prov | [get API clusters cluster name servers server name server port need prov](#get-api-clusters-cluster-name-servers-server-name-server-port-need-prov) | Check if a server needs provisioning | +| GET | /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/need-reprov | [get API clusters cluster name servers server name server port need reprov](#get-api-clusters-cluster-name-servers-server-name-server-port-need-reprov) | Check if a server needs re-provisioning | +| GET | /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/need-restart | [get API clusters cluster name servers server name server port need restart](#get-api-clusters-cluster-name-servers-server-name-server-port-need-restart) | Check if a server needs a restart | +| GET | /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/need-start | [get API clusters cluster name servers server name server port need start](#get-api-clusters-cluster-name-servers-server-name-server-port-need-start) | Check if a server needs to start | +| GET | /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/need-stop | [get API clusters cluster name servers server name server port need stop](#get-api-clusters-cluster-name-servers-server-name-server-port-need-stop) | Check if a server needs to stop | +| GET | /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/need-unprov | [get API clusters cluster name servers server name server port need unprov](#get-api-clusters-cluster-name-servers-server-name-server-port-need-unprov) | Check if a server needs unprovisioning | +| GET | /api/clusters/{clusterName}/servers/{serverName}/service-opensvc | [get API clusters cluster name servers server name service opensvc](#get-api-clusters-cluster-name-servers-server-name-service-opensvc) | Get database service configuration of a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/status | [get API clusters cluster name servers server name status](#get-api-clusters-cluster-name-servers-server-name-status) | Get status of a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/status-delta | [get API clusters cluster name servers server name status delta](#get-api-clusters-cluster-name-servers-server-name-status-delta) | Get status delta of a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/status-innodb | [get API clusters cluster name servers server name status innodb](#get-api-clusters-cluster-name-servers-server-name-status-innodb) | Get InnoDB status of a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/tables | [get API clusters cluster name servers server name tables](#get-api-clusters-cluster-name-servers-server-name-tables) | Get tables of a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/variables | [get API clusters cluster name servers server name variables](#get-api-clusters-cluster-name-servers-server-name-variables) | Get variables of a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/vtables | [get API clusters cluster name servers server name vtables](#get-api-clusters-cluster-name-servers-server-name-vtables) | Get virtual tables of a server | + + + +### database_actions + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/optimize | [get API clusters cluster name servers server name actions optimize](#get-api-clusters-cluster-name-servers-server-name-actions-optimize) | Optimize a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/start | [get API clusters cluster name servers server name actions start](#get-api-clusters-cluster-name-servers-server-name-actions-start) | Start a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/stop | [get API clusters cluster name servers server name actions stop](#get-api-clusters-cluster-name-servers-server-name-actions-stop) | Stop a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/toogle-meta-data-locks | [get API clusters cluster name servers server name actions toogle meta data locks](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-meta-data-locks) | Toggle metadata locks on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/toogle-query-response-time | [get API clusters cluster name servers server name actions toogle query response time](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-query-response-time) | Toggle query response time on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/toogle-read-only | [get API clusters cluster name servers server name actions toogle read only](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-read-only) | Toggle read-only mode on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/wait-innodb-purge | [get API clusters cluster name servers server name actions wait innodb purge](#get-api-clusters-cluster-name-servers-server-name-actions-wait-innodb-purge) | Wait for InnoDB purge on a server | + + + +### database_backup + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/backup-logical | [get API clusters cluster name servers server name actions backup logical](#get-api-clusters-cluster-name-servers-server-name-actions-backup-logical) | Perform a logical backup on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/backup-physical | [get API clusters cluster name servers server name actions backup physical](#get-api-clusters-cluster-name-servers-server-name-actions-backup-physical) | Perform a physical backup on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/reseed/{backupMethod} | [get API clusters cluster name servers server name actions reseed backup method](#get-api-clusters-cluster-name-servers-server-name-actions-reseed-backup-method) | Reseed a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/reseed-cancel/{task} | [get API clusters cluster name servers server name actions reseed cancel task](#get-api-clusters-cluster-name-servers-server-name-actions-reseed-cancel-task) | Cancel a reseed task on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/backup | [get API clusters cluster name servers server name server port backup](#get-api-clusters-cluster-name-servers-server-name-server-port-backup) | Perform a physical backup on a server port | +| POST | /api/clusters/{clusterName}/servers/{serverName}/actions/pitr | [post API clusters cluster name servers server name actions pitr](#post-api-clusters-cluster-name-servers-server-name-actions-pitr) | Perform a point-in-time recovery on a server | + + + +### database_logs + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/backup-error-log | [get API clusters cluster name servers server name actions backup error log](#get-api-clusters-cluster-name-servers-server-name-actions-backup-error-log) | Perform a backup of the error log on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/backup-slowquery-log | [get API clusters cluster name servers server name actions backup slowquery log](#get-api-clusters-cluster-name-servers-server-name-actions-backup-slowquery-log) | Perform a backup of the slow query log on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/flush-logs | [get API clusters cluster name servers server name actions flush logs](#get-api-clusters-cluster-name-servers-server-name-actions-flush-logs) | Flush logs on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/toogle-sql-error-log | [get API clusters cluster name servers server name actions toogle SQL error log](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-sql-error-log) | Toggle SQL error log on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/errorlog | [get API clusters cluster name servers server name errorlog](#get-api-clusters-cluster-name-servers-server-name-errorlog) | Get error log of a server | + + + +### database_maintenance + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/del-maintenance | [get API clusters cluster name servers server name actions del maintenance](#get-api-clusters-cluster-name-servers-server-name-actions-del-maintenance) | Delete maintenance mode on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/maintenance | [get API clusters cluster name servers server name actions maintenance](#get-api-clusters-cluster-name-servers-server-name-actions-maintenance) | Toggle maintenance mode on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/set-maintenance | [get API clusters cluster name servers server name actions set maintenance](#get-api-clusters-cluster-name-servers-server-name-actions-set-maintenance) | Set a server to maintenance mode | + + + +### database_provision + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/provision | [get API clusters cluster name servers server name actions provision](#get-api-clusters-cluster-name-servers-server-name-actions-provision) | Provision a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/unprovision | [get API clusters cluster name servers server name actions unprovision](#get-api-clusters-cluster-name-servers-server-name-actions-unprovision) | Unprovision a server | + + + +### database_queries + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/reset-pfs-queries | [get API clusters cluster name servers server name actions reset pfs queries](#get-api-clusters-cluster-name-servers-server-name-actions-reset-pfs-queries) | Reset PFS queries on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/set-long-query-time/{queryTime} | [get API clusters cluster name servers server name actions set long query time query time](#get-api-clusters-cluster-name-servers-server-name-actions-set-long-query-time-query-time) | Set long query time on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/toogle-pfs-slow-query | [get API clusters cluster name servers server name actions toogle pfs slow query](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-pfs-slow-query) | Toggle PFS slow query capture on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/toogle-slow-query | [get API clusters cluster name servers server name actions toogle slow query](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-slow-query) | Toggle slow query on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/toogle-slow-query-capture | [get API clusters cluster name servers server name actions toogle slow query capture](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-slow-query-capture) | Toggle slow query capture on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/toogle-slow-query-table | [get API clusters cluster name servers server name actions toogle slow query table](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-slow-query-table) | Toggle slow query table mode on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/digest-statements-pfs | [get API clusters cluster name servers server name digest statements pfs](#get-api-clusters-cluster-name-servers-server-name-digest-statements-pfs) | Get PFS statements of a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/digest-statements-slow | [get API clusters cluster name servers server name digest statements slow](#get-api-clusters-cluster-name-servers-server-name-digest-statements-slow) | Get PFS statements from the slow log of a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/queries/{queryDigest}/actions/analyze-pfs | [get API clusters cluster name servers server name queries query digest actions analyze pfs](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-analyze-pfs) | Analyze a query using PFS on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/queries/{queryDigest}/actions/analyze-slowlog | [get API clusters cluster name servers server name queries query digest actions analyze slowlog](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-analyze-slowlog) | Analyze a query using the slow log on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/queries/{queryDigest}/actions/explain-pfs | [get API clusters cluster name servers server name queries query digest actions explain pfs](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-explain-pfs) | Explain a query using PFS on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/queries/{queryDigest}/actions/explain-slowlog | [get API clusters cluster name servers server name queries query digest actions explain slowlog](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-explain-slowlog) | Explain a query using the slow log on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/queries/{queryDigest}/actions/kill-query | [get API clusters cluster name servers server name queries query digest actions kill query](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-kill-query) | Kill a query on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/queries/{queryDigest}/actions/kill-thread | [get API clusters cluster name servers server name queries query digest actions kill thread](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-kill-thread) | Kill a thread on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/query-response-time | [get API clusters cluster name servers server name query response time](#get-api-clusters-cluster-name-servers-server-name-query-response-time) | Get query response time of a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/slow-queries | [get API clusters cluster name servers server name slow queries](#get-api-clusters-cluster-name-servers-server-name-slow-queries) | Get slow log of a server | + + + +### database_replication + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/reset-master | [get API clusters cluster name servers server name actions reset master](#get-api-clusters-cluster-name-servers-server-name-actions-reset-master) | Reset the master on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/reset-slave-all | [get API clusters cluster name servers server name actions reset slave all](#get-api-clusters-cluster-name-servers-server-name-actions-reset-slave-all) | Reset all slaves on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/skip-replication-event | [get API clusters cluster name servers server name actions skip replication event](#get-api-clusters-cluster-name-servers-server-name-actions-skip-replication-event) | Skip a replication event on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/start-slave | [get API clusters cluster name servers server name actions start slave](#get-api-clusters-cluster-name-servers-server-name-actions-start-slave) | Start the slave on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/stop-slave | [get API clusters cluster name servers server name actions stop slave](#get-api-clusters-cluster-name-servers-server-name-actions-stop-slave) | Stop the slave on a server | + + + +### database_schema + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| GET | /api/clusters/{clusterName}/servers/{serverName}/schemas | [get API clusters cluster name servers server name schemas](#get-api-clusters-cluster-name-servers-server-name-schemas) | Get schemas of a server | + + + +### database_tasks + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/job-cancel/{task} | [get API clusters cluster name servers server name actions job cancel task](#get-api-clusters-cluster-name-servers-server-name-actions-job-cancel-task) | Cancel a task on a server | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/run-jobs | [get API clusters cluster name servers server name actions run jobs](#get-api-clusters-cluster-name-servers-server-name-actions-run-jobs) | Run jobs on a server | +| POST | /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/write-log/{task} | [post API clusters cluster name servers server name server port write log task](#post-api-clusters-cluster-name-servers-server-name-server-port-write-log-task) | Write logs for a server | + + + +### database_topology + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/set-ignored | [get API clusters cluster name servers server name actions set ignored](#get-api-clusters-cluster-name-servers-server-name-actions-set-ignored) | Set a server as ignored | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/set-prefered | [get API clusters cluster name servers server name actions set prefered](#get-api-clusters-cluster-name-servers-server-name-actions-set-prefered) | Set a server as preferred | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/set-unrated | [get API clusters cluster name servers server name actions set unrated](#get-api-clusters-cluster-name-servers-server-name-actions-set-unrated) | Set a server as unrated | +| GET | /api/clusters/{clusterName}/servers/{serverName}/actions/switchover | [get API clusters cluster name servers server name actions switchover](#get-api-clusters-cluster-name-servers-server-name-actions-switchover) | Perform a switchover on a server | + + + +### global_setting + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| POST | /api/clusters/settings/actions/switch/{settingName} | [post API clusters settings actions switch setting name](#post-api-clusters-settings-actions-switch-setting-name) | Switch global settings for the server | + + + +### proxies + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| GET | /api/clusters/{clusterName}/proxies/{proxyName}/actions/need-reprov | [get API clusters cluster name proxies proxy name actions need reprov](#get-api-clusters-cluster-name-proxies-proxy-name-actions-need-reprov) | Check if Proxy Needs Reprovision | +| GET | /api/clusters/{clusterName}/proxies/{proxyName}/actions/need-restart | [get API clusters cluster name proxies proxy name actions need restart](#get-api-clusters-cluster-name-proxies-proxy-name-actions-need-restart) | Check if Proxy Needs Restart | +| GET | /api/clusters/{clusterName}/sphinx/indexes | [get API clusters cluster name sphinx indexes](#get-api-clusters-cluster-name-sphinx-indexes) | Get Sphinx Indexes | +| POST | /api/clusters/{clusterName}/proxies/{proxyName}/actions/provision | [post API clusters cluster name proxies proxy name actions provision](#post-api-clusters-cluster-name-proxies-proxy-name-actions-provision) | Provision Proxy Service | +| POST | /api/clusters/{clusterName}/proxies/{proxyName}/actions/start | [post API clusters cluster name proxies proxy name actions start](#post-api-clusters-cluster-name-proxies-proxy-name-actions-start) | Start Proxy Service | +| POST | /api/clusters/{clusterName}/proxies/{proxyName}/actions/stop | [post API clusters cluster name proxies proxy name actions stop](#post-api-clusters-cluster-name-proxies-proxy-name-actions-stop) | Stop Proxy Service | +| POST | /api/clusters/{clusterName}/proxies/{proxyName}/actions/unprovision | [post API clusters cluster name proxies proxy name actions unprovision](#post-api-clusters-cluster-name-proxies-proxy-name-actions-unprovision) | Unprovision Proxy Service | + + + +### public + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| GET | /api/configs/grafana | [get API configs grafana](#get-api-configs-grafana) | List Grafana files | +| GET | /api/heartbeat | [get API heartbeat](#get-api-heartbeat) | Monitor Heartbeat | +| GET | /api/monitor | [get API monitor](#get-api-monitor) | Handles replication manager requests | +| GET | /api/prometheus | [get API prometheus](#get-api-prometheus) | Fetch Prometheus metrics | +| GET | /api/repocomp/current | [get API repocomp current](#get-api-repocomp-current) | Retrieve current repository component | +| GET | /api/status | [get API status](#get-api-status) | Get Replication Manager Status | +| GET | /api/timeout | [get API timeout](#get-api-timeout) | Check if the replication manager is running | + + + +### user + +| Method | URI | Name | Summary | +|---------|---------|--------|---------| +| POST | /api/clusters/{clusterName}/users/add | [post API clusters cluster name users add](#post-api-clusters-cluster-name-users-add) | Add a new user to a cluster | +| POST | /api/clusters/{clusterName}/users/drop | [post API clusters cluster name users drop](#post-api-clusters-cluster-name-users-drop) | Drop a cluster user | +| POST | /api/clusters/{clusterName}/users/send-credentials | [post API clusters cluster name users send credentials](#post-api-clusters-cluster-name-users-send-credentials) | Send credentials to a specific user | +| POST | /api/clusters/{clusterName}/users/update | [post API clusters cluster name users update](#post-api-clusters-cluster-name-users-update) | Update a cluster user | + + + +## Paths + +### Delete a cluster (*DeleteAPIClustersActionsDeleteClusterName*) + +``` +DELETE /api/clusters/actions/delete/{clusterName} +``` + +Deletes a cluster identified by its name. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#delete-api-clusters-actions-delete-cluster-name-200) | OK | Cluster deleted successfully | | [schema](#delete-api-clusters-actions-delete-cluster-name-200-schema) | +| [400](#delete-api-clusters-actions-delete-cluster-name-400) | Bad Request | Invalid cluster name | | [schema](#delete-api-clusters-actions-delete-cluster-name-400-schema) | +| [500](#delete-api-clusters-actions-delete-cluster-name-500) | Internal Server Error | Internal server error | | [schema](#delete-api-clusters-actions-delete-cluster-name-500-schema) | + +#### Responses + + +##### 200 - Cluster deleted successfully +Status: OK + +###### Schema + + + + + +##### 400 - Invalid cluster name +Status: Bad Request + +###### Schema + + + + + +##### 500 - Internal server error +Status: Internal Server Error + +###### Schema + + + + + +### Fetch clusters (*GetAPIClusters*) + +``` +GET /api/clusters +``` + +Fetches the list of clusters that the user has access to based on ACL. + +#### Produces + * application/json + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-200) | OK | List of clusters | | [schema](#get-api-clusters-200-schema) | +| [401](#get-api-clusters-401) | Unauthorized | Unauthenticated resource | | [schema](#get-api-clusters-401-schema) | +| [500](#get-api-clusters-500) | Internal Server Error | Internal server error | | [schema](#get-api-clusters-500-schema) | + +#### Responses + + +##### 200 - List of clusters +Status: OK + +###### Schema + + + +[][ClusterCluster](#cluster-cluster) + +##### 401 - Unauthenticated resource +Status: Unauthorized + +###### Schema + + + + + +##### 500 - Internal server error +Status: Internal Server Error + +###### Schema + + + + + +### Retrieve details of a cluster (*GetAPIClustersClusterName*) + +``` +GET /api/clusters/{clusterName} +``` + +This endpoint retrieves the details of a specified cluster and returns it in JSON format. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-200) | OK | Cluster details | | [schema](#get-api-clusters-cluster-name-200-schema) | +| [403](#get-api-clusters-cluster-name-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-403-schema) | +| [500](#get-api-clusters-cluster-name-500) | Internal Server Error | No cluster | | [schema](#get-api-clusters-cluster-name-500-schema) | + +#### Responses + + +##### 200 - Cluster details +Status: OK + +###### Schema + + + +[ClusterCluster](#cluster-cluster) + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Retrieve backups for a specific cluster (*GetAPIClustersClusterNameBackups*) + +``` +GET /api/clusters/{clusterName}/backups +``` + +This endpoint retrieves the backups for the specified cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-backups-200) | OK | List of backups | | [schema](#get-api-clusters-cluster-name-backups-200-schema) | +| [403](#get-api-clusters-cluster-name-backups-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-backups-403-schema) | +| [500](#get-api-clusters-cluster-name-backups-500) | Internal Server Error | No cluster | | [schema](#get-api-clusters-cluster-name-backups-500-schema) | + +#### Responses + + +##### 200 - List of backups +Status: OK + +###### Schema + + + +[][interface{}](#interface) + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Retrieve client certificates for a specific cluster (*GetAPIClustersClusterNameCertificates*) + +``` +GET /api/clusters/{clusterName}/certificates +``` + +This endpoint retrieves the client certificates for the specified cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-certificates-200) | OK | List of client certificates | | [schema](#get-api-clusters-cluster-name-certificates-200-schema) | +| [500](#get-api-clusters-cluster-name-certificates-500) | Internal Server Error | Internal Server Error | | [schema](#get-api-clusters-cluster-name-certificates-500-schema) | + +#### Responses + + +##### 200 - List of client certificates +Status: OK + +###### Schema + + + +[][interface{}](#interface) + +##### 500 - Internal Server Error +Status: Internal Server Error + +###### Schema + + + + + +### Retrieve variable differences for a specific cluster (*GetAPIClustersClusterNameDiffvariables*) + +``` +GET /api/clusters/{clusterName}/diffvariables +``` + +This endpoint retrieves the variable differences for the specified cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-diffvariables-200) | OK | List of variable differences | | [schema](#get-api-clusters-cluster-name-diffvariables-200-schema) | +| [403](#get-api-clusters-cluster-name-diffvariables-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-diffvariables-403-schema) | +| [500](#get-api-clusters-cluster-name-diffvariables-500) | Internal Server Error | No cluster | | [schema](#get-api-clusters-cluster-name-diffvariables-500-schema) | + +#### Responses + + +##### 200 - List of variable differences +Status: OK + +###### Schema + + + +[][ClusterVariableDiff](#cluster-variable-diff) + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Retrieve Graphite filter list for a specific cluster (*GetAPIClustersClusterNameGraphiteFilterlist*) + +``` +GET /api/clusters/{clusterName}/graphite-filterlist +``` + +This endpoint retrieves the Graphite filter list for the specified cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-graphite-filterlist-200) | OK | List of Graphite filters | | [schema](#get-api-clusters-cluster-name-graphite-filterlist-200-schema) | +| [500](#get-api-clusters-cluster-name-graphite-filterlist-500) | Internal Server Error | Internal Server Error | | [schema](#get-api-clusters-cluster-name-graphite-filterlist-500-schema) | + +#### Responses + + +##### 200 - List of Graphite filters +Status: OK + +###### Schema + + + +[]string + +##### 500 - Internal Server Error +Status: Internal Server Error + +###### Schema + + + + + +### Retrieve job entries for a specific cluster (*GetAPIClustersClusterNameJobs*) + +``` +GET /api/clusters/{clusterName}/jobs +``` + +This endpoint retrieves the job entries for the specified cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-jobs-200) | OK | List of job entries | | [schema](#get-api-clusters-cluster-name-jobs-200-schema) | +| [403](#get-api-clusters-cluster-name-jobs-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-jobs-403-schema) | +| [500](#get-api-clusters-cluster-name-jobs-500) | Internal Server Error | Cluster Not Found | | [schema](#get-api-clusters-cluster-name-jobs-500-schema) | + +#### Responses + + +##### 200 - List of job entries +Status: OK + +###### Schema + + + +[][interface{}](#interface) + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Check if a cluster needs a rolling reprovision (*GetAPIClustersClusterNameNeedRollingReprov*) + +``` +GET /api/clusters/{clusterName}/need-rolling-reprov +``` + +Checks if a specified cluster needs a rolling reprovision. + +#### Produces + * text/plain + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-need-rolling-reprov-200) | OK | 200 -Need rolling reprov! | | [schema](#get-api-clusters-cluster-name-need-rolling-reprov-200-schema) | +| [500](#get-api-clusters-cluster-name-need-rolling-reprov-500) | Internal Server Error | 503 -No rolling reprov needed!" or "500 -No cluster | | [schema](#get-api-clusters-cluster-name-need-rolling-reprov-500-schema) | + +#### Responses + + +##### 200 - 200 -Need rolling reprov! +Status: OK + +###### Schema + + + + + +##### 500 - 503 -No rolling reprov needed!" or "500 -No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Check if a cluster needs a rolling restart (*GetAPIClustersClusterNameNeedRollingRestart*) + +``` +GET /api/clusters/{clusterName}/need-rolling-restart +``` + +Checks if a specified cluster needs a rolling restart. + +#### Produces + * text/plain + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-need-rolling-restart-200) | OK | 200 -Need rolling restart! | | [schema](#get-api-clusters-cluster-name-need-rolling-restart-200-schema) | +| [500](#get-api-clusters-cluster-name-need-rolling-restart-500) | Internal Server Error | 503 -No rolling restart needed!" or "500 -No cluster | | [schema](#get-api-clusters-cluster-name-need-rolling-restart-500-schema) | + +#### Responses + + +##### 200 - 200 -Need rolling restart! +Status: OK + +###### Schema + + + + + +##### 500 - 503 -No rolling restart needed!" or "500 -No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Check if Proxy Needs Reprovision (*GetAPIClustersClusterNameProxiesProxyNameActionsNeedReprov*) + +``` +GET /api/clusters/{clusterName}/proxies/{proxyName}/actions/need-reprov +``` + +Check if the proxy service for a given cluster and proxy needs reprovisioning + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| proxyName | `path` | string | `string` | | ✓ | | Proxy Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-proxies-proxy-name-actions-need-reprov-200) | OK | Need reprov! | | [schema](#get-api-clusters-cluster-name-proxies-proxy-name-actions-need-reprov-200-schema) | +| [403](#get-api-clusters-cluster-name-proxies-proxy-name-actions-need-reprov-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-proxies-proxy-name-actions-need-reprov-403-schema) | +| [500](#get-api-clusters-cluster-name-proxies-proxy-name-actions-need-reprov-500) | Internal Server Error | No cluster | | [schema](#get-api-clusters-cluster-name-proxies-proxy-name-actions-need-reprov-500-schema) | +| [503](#get-api-clusters-cluster-name-proxies-proxy-name-actions-need-reprov-503) | Service Unavailable | No reprov needed!" "Not a Valid Server! | | [schema](#get-api-clusters-cluster-name-proxies-proxy-name-actions-need-reprov-503-schema) | + +#### Responses + + +##### 200 - Need reprov! +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +##### 503 - No reprov needed!" "Not a Valid Server! +Status: Service Unavailable + +###### Schema + + + + + +### Check if Proxy Needs Restart (*GetAPIClustersClusterNameProxiesProxyNameActionsNeedRestart*) + +``` +GET /api/clusters/{clusterName}/proxies/{proxyName}/actions/need-restart +``` + +Check if the proxy service for a given cluster and proxy needs a restart + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| proxyName | `path` | string | `string` | | ✓ | | Proxy Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-proxies-proxy-name-actions-need-restart-200) | OK | Need restart! | | [schema](#get-api-clusters-cluster-name-proxies-proxy-name-actions-need-restart-200-schema) | +| [403](#get-api-clusters-cluster-name-proxies-proxy-name-actions-need-restart-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-proxies-proxy-name-actions-need-restart-403-schema) | +| [500](#get-api-clusters-cluster-name-proxies-proxy-name-actions-need-restart-500) | Internal Server Error | No cluster | | [schema](#get-api-clusters-cluster-name-proxies-proxy-name-actions-need-restart-500-schema) | +| [503](#get-api-clusters-cluster-name-proxies-proxy-name-actions-need-restart-503) | Service Unavailable | No restart needed!" "Not a Valid Server! | | [schema](#get-api-clusters-cluster-name-proxies-proxy-name-actions-need-restart-503-schema) | + +#### Responses + + +##### 200 - Need restart! +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +##### 503 - No restart needed!" "Not a Valid Server! +Status: Service Unavailable + +###### Schema + + + + + +### Retrieve query rules for a specific cluster (*GetAPIClustersClusterNameQueryrules*) + +``` +GET /api/clusters/{clusterName}/queryrules +``` + +This endpoint retrieves the query rules for the specified cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-queryrules-200) | OK | List of query rules | | [schema](#get-api-clusters-cluster-name-queryrules-200-schema) | +| [403](#get-api-clusters-cluster-name-queryrules-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-queryrules-403-schema) | +| [500](#get-api-clusters-cluster-name-queryrules-500) | Internal Server Error | No cluster | | [schema](#get-api-clusters-cluster-name-queryrules-500-schema) | + +#### Responses + + +##### 200 - List of query rules +Status: OK + +###### Schema + + + +[][interface{}](#interface) + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Retrieve schema information for a specific cluster (*GetAPIClustersClusterNameSchema*) + +``` +GET /api/clusters/{clusterName}/schema +``` + +This endpoint retrieves the schema information for the specified cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-schema-200) | OK | Schema information | | [schema](#get-api-clusters-cluster-name-schema-200-schema) | +| [403](#get-api-clusters-cluster-name-schema-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-schema-403-schema) | +| [500](#get-api-clusters-cluster-name-schema-500) | Internal Server Error | No cluster | | [schema](#get-api-clusters-cluster-name-schema-500-schema) | + +#### Responses + + +##### 200 - Schema information +Status: OK + +###### Schema + + + +any + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Perform a backup of the error log on a server (*GetAPIClustersClusterNameServersServerNameActionsBackupErrorLog*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/backup-error-log +``` + +Initiates a backup of the error log on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-backup-error-log-200) | OK | Backup initiated successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-backup-error-log-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-backup-error-log-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-backup-error-log-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-backup-error-log-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-backup-error-log-500-schema) | + +#### Responses + + +##### 200 - Backup initiated successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Perform a logical backup on a server (*GetAPIClustersClusterNameServersServerNameActionsBackupLogical*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/backup-logical +``` + +Initiates a logical backup on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-backup-logical-200) | OK | Backup initiated successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-backup-logical-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-backup-logical-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-backup-logical-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-backup-logical-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-backup-logical-500-schema) | + +#### Responses + + +##### 200 - Backup initiated successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Perform a physical backup on a server (*GetAPIClustersClusterNameServersServerNameActionsBackupPhysical*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/backup-physical +``` + +Initiates a physical backup on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-backup-physical-200) | OK | Backup initiated successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-backup-physical-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-backup-physical-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-backup-physical-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-backup-physical-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-backup-physical-500-schema) | + +#### Responses + + +##### 200 - Backup initiated successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Perform a backup of the slow query log on a server (*GetAPIClustersClusterNameServersServerNameActionsBackupSlowqueryLog*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/backup-slowquery-log +``` + +Initiates a backup of the slow query log on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-backup-slowquery-log-200) | OK | Backup initiated successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-backup-slowquery-log-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-backup-slowquery-log-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-backup-slowquery-log-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-backup-slowquery-log-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-backup-slowquery-log-500-schema) | + +#### Responses + + +##### 200 - Backup initiated successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Delete maintenance mode on a server (*GetAPIClustersClusterNameServersServerNameActionsDelMaintenance*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/del-maintenance +``` + +Deletes the maintenance mode on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-del-maintenance-200) | OK | Maintenance mode deleted successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-del-maintenance-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-del-maintenance-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-del-maintenance-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-del-maintenance-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-del-maintenance-500-schema) | + +#### Responses + + +##### 200 - Maintenance mode deleted successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Flush logs on a server (*GetAPIClustersClusterNameServersServerNameActionsFlushLogs*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/flush-logs +``` + +Flushes the logs on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-flush-logs-200) | OK | Logs flushed successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-flush-logs-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-flush-logs-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-flush-logs-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-flush-logs-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-flush-logs-500-schema) | + +#### Responses + + +##### 200 - Logs flushed successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Cancel a task on a server (*GetAPIClustersClusterNameServersServerNameActionsJobCancelTask*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/job-cancel/{task} +``` + +Cancels a task identified by its name on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | +| task | `path` | string | `string` | | ✓ | | Task Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-job-cancel-task-200) | OK | Task canceled successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-job-cancel-task-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-job-cancel-task-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-job-cancel-task-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-job-cancel-task-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Error canceling task | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-job-cancel-task-500-schema) | + +#### Responses + + +##### 200 - Task canceled successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Error canceling task +Status: Internal Server Error + +###### Schema + + + + + +### Toggle maintenance mode on a server (*GetAPIClustersClusterNameServersServerNameActionsMaintenance*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/maintenance +``` + +Toggles the maintenance mode on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-maintenance-200) | OK | Maintenance mode toggled successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-maintenance-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-maintenance-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-maintenance-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-maintenance-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-maintenance-500-schema) | + +#### Responses + + +##### 200 - Maintenance mode toggled successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Optimize a server (*GetAPIClustersClusterNameServersServerNameActionsOptimize*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/optimize +``` + +Optimizes a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-optimize-200) | OK | Server optimized successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-optimize-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-optimize-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-optimize-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-optimize-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-optimize-500-schema) | + +#### Responses + + +##### 200 - Server optimized successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Provision a server (*GetAPIClustersClusterNameServersServerNameActionsProvision*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/provision +``` + +Provisions a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-provision-200) | OK | Server provisioned successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-provision-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-provision-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-provision-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-provision-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-provision-500-schema) | + +#### Responses + + +##### 200 - Server provisioned successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Reseed a server (*GetAPIClustersClusterNameServersServerNameActionsReseedBackupMethod*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/reseed/{backupMethod} +``` + +Reseeds a specified server within a cluster using the specified backup method. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| backupMethod | `path` | string | `string` | | ✓ | | Backup Method | +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-reseed-backup-method-200) | OK | Reseed initiated successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-reseed-backup-method-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-reseed-backup-method-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-reseed-backup-method-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-reseed-backup-method-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Error reseed logical backup" or "Error reseed physical backup | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-reseed-backup-method-500-schema) | + +#### Responses + + +##### 200 - Reseed initiated successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Error reseed logical backup" or "Error reseed physical backup +Status: Internal Server Error + +###### Schema + + + + + +### Cancel a reseed task on a server (*GetAPIClustersClusterNameServersServerNameActionsReseedCancelTask*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/reseed-cancel/{task} +``` + +Cancels a reseed task identified by its name on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | +| task | `path` | string | `string` | | ✓ | | Task Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-reseed-cancel-task-200) | OK | Task canceled successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-reseed-cancel-task-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-reseed-cancel-task-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-reseed-cancel-task-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-reseed-cancel-task-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Error canceling task | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-reseed-cancel-task-500-schema) | + +#### Responses + + +##### 200 - Task canceled successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Error canceling task +Status: Internal Server Error + +###### Schema + + + + + +### Reset the master on a server (*GetAPIClustersClusterNameServersServerNameActionsResetMaster*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/reset-master +``` + +Resets the master on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-reset-master-200) | OK | Master reset successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-reset-master-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-reset-master-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-reset-master-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-reset-master-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-reset-master-500-schema) | + +#### Responses + + +##### 200 - Master reset successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Reset PFS queries on a server (*GetAPIClustersClusterNameServersServerNameActionsResetPfsQueries*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/reset-pfs-queries +``` + +Resets PFS queries on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-reset-pfs-queries-200) | OK | PFS queries reset successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-reset-pfs-queries-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-reset-pfs-queries-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-reset-pfs-queries-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-reset-pfs-queries-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-reset-pfs-queries-500-schema) | + +#### Responses + + +##### 200 - PFS queries reset successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Reset all slaves on a server (*GetAPIClustersClusterNameServersServerNameActionsResetSlaveAll*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/reset-slave-all +``` + +Resets all slaves on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-reset-slave-all-200) | OK | Slaves reset successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-reset-slave-all-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-reset-slave-all-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-reset-slave-all-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-reset-slave-all-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-reset-slave-all-500-schema) | + +#### Responses + + +##### 200 - Slaves reset successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Run jobs on a server (*GetAPIClustersClusterNameServersServerNameActionsRunJobs*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/run-jobs +``` + +Runs jobs on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-run-jobs-200) | OK | Jobs run successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-run-jobs-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-run-jobs-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-run-jobs-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-run-jobs-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Error running job | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-run-jobs-500-schema) | + +#### Responses + + +##### 200 - Jobs run successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Error running job +Status: Internal Server Error + +###### Schema + + + + + +### Set a server as ignored (*GetAPIClustersClusterNameServersServerNameActionsSetIgnored*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/set-ignored +``` + +Sets a specified server within a cluster as ignored. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-set-ignored-200) | OK | Server set as ignored successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-set-ignored-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-set-ignored-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-set-ignored-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-set-ignored-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-set-ignored-500-schema) | + +#### Responses + + +##### 200 - Server set as ignored successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Set long query time on a server (*GetAPIClustersClusterNameServersServerNameActionsSetLongQueryTimeQueryTime*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/set-long-query-time/{queryTime} +``` + +Sets the long query time on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| queryTime | `path` | string | `string` | | ✓ | | Query Time | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-set-long-query-time-query-time-200) | OK | Long query time set successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-set-long-query-time-query-time-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-set-long-query-time-query-time-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-set-long-query-time-query-time-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-set-long-query-time-query-time-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-set-long-query-time-query-time-500-schema) | + +#### Responses + + +##### 200 - Long query time set successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Set a server to maintenance mode (*GetAPIClustersClusterNameServersServerNameActionsSetMaintenance*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/set-maintenance +``` + +Sets a specified server within a cluster to maintenance mode. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-set-maintenance-200) | OK | Server set to maintenance mode successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-set-maintenance-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-set-maintenance-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-set-maintenance-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-set-maintenance-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-set-maintenance-500-schema) | + +#### Responses + + +##### 200 - Server set to maintenance mode successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Set a server as preferred (*GetAPIClustersClusterNameServersServerNameActionsSetPrefered*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/set-prefered +``` + +Sets a specified server within a cluster as preferred. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-set-prefered-200) | OK | Server set as preferred successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-set-prefered-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-set-prefered-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-set-prefered-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-set-prefered-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-set-prefered-500-schema) | + +#### Responses + + +##### 200 - Server set as preferred successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Set a server as unrated (*GetAPIClustersClusterNameServersServerNameActionsSetUnrated*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/set-unrated +``` + +Sets a specified server within a cluster as unrated. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-set-unrated-200) | OK | Server set as unrated successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-set-unrated-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-set-unrated-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-set-unrated-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-set-unrated-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-set-unrated-500-schema) | + +#### Responses + + +##### 200 - Server set as unrated successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Skip a replication event on a server (*GetAPIClustersClusterNameServersServerNameActionsSkipReplicationEvent*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/skip-replication-event +``` + +Skips a replication event on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-skip-replication-event-200) | OK | Replication event skipped successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-skip-replication-event-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-skip-replication-event-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-skip-replication-event-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-skip-replication-event-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-skip-replication-event-500-schema) | + +#### Responses + + +##### 200 - Replication event skipped successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Start a server (*GetAPIClustersClusterNameServersServerNameActionsStart*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/start +``` + +Starts a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-start-200) | OK | Server started successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-start-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-start-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-start-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-start-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-start-500-schema) | + +#### Responses + + +##### 200 - Server started successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Start the slave on a server (*GetAPIClustersClusterNameServersServerNameActionsStartSlave*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/start-slave +``` + +Starts the slave on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-start-slave-200) | OK | Slave started successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-start-slave-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-start-slave-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-start-slave-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-start-slave-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-start-slave-500-schema) | + +#### Responses + + +##### 200 - Slave started successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Stop a server (*GetAPIClustersClusterNameServersServerNameActionsStop*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/stop +``` + +Stops a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-stop-200) | OK | Server stopped successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-stop-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-stop-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-stop-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-stop-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-stop-500-schema) | + +#### Responses + + +##### 200 - Server stopped successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Stop the slave on a server (*GetAPIClustersClusterNameServersServerNameActionsStopSlave*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/stop-slave +``` + +Stops the slave on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-stop-slave-200) | OK | Slave stopped successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-stop-slave-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-stop-slave-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-stop-slave-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-stop-slave-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-stop-slave-500-schema) | + +#### Responses + + +##### 200 - Slave stopped successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Perform a switchover on a server (*GetAPIClustersClusterNameServersServerNameActionsSwitchover*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/switchover +``` + +Initiates a switchover on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-switchover-200) | OK | Switchover initiated successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-switchover-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-switchover-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-switchover-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-switchover-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Master failed, cannot initiate switchover | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-switchover-500-schema) | + +#### Responses + + +##### 200 - Switchover initiated successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Master failed, cannot initiate switchover +Status: Internal Server Error + +###### Schema + + + + + +### Toggle InnoDB monitor on a server (*GetAPIClustersClusterNameServersServerNameActionsToogleInnodbMonitor*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/toogle-innodb-monitor +``` + +Toggles the InnoDB monitor on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-innodb-monitor-200) | OK | InnoDB monitor toggled successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-innodb-monitor-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-innodb-monitor-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-innodb-monitor-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-innodb-monitor-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-innodb-monitor-500-schema) | + +#### Responses + + +##### 200 - InnoDB monitor toggled successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Toggle metadata locks on a server (*GetAPIClustersClusterNameServersServerNameActionsToogleMetaDataLocks*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/toogle-meta-data-locks +``` + +Toggles the metadata locks on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-meta-data-locks-200) | OK | Metadata locks toggled successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-meta-data-locks-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-meta-data-locks-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-meta-data-locks-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-meta-data-locks-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-meta-data-locks-500-schema) | + +#### Responses + + +##### 200 - Metadata locks toggled successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Toggle PFS slow query capture on a server (*GetAPIClustersClusterNameServersServerNameActionsTooglePfsSlowQuery*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/toogle-pfs-slow-query +``` + +Toggles the PFS slow query capture on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-pfs-slow-query-200) | OK | PFS slow query capture toggled successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-pfs-slow-query-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-pfs-slow-query-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-pfs-slow-query-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-pfs-slow-query-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-pfs-slow-query-500-schema) | + +#### Responses + + +##### 200 - PFS slow query capture toggled successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Toggle query response time on a server (*GetAPIClustersClusterNameServersServerNameActionsToogleQueryResponseTime*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/toogle-query-response-time +``` + +Toggles the query response time on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-query-response-time-200) | OK | Query response time toggled successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-query-response-time-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-query-response-time-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-query-response-time-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-query-response-time-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-query-response-time-500-schema) | + +#### Responses + + +##### 200 - Query response time toggled successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Toggle read-only mode on a server (*GetAPIClustersClusterNameServersServerNameActionsToogleReadOnly*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/toogle-read-only +``` + +Toggles the read-only mode on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-read-only-200) | OK | Read-only mode toggled successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-read-only-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-read-only-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-read-only-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-read-only-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-read-only-500-schema) | + +#### Responses + + +##### 200 - Read-only mode toggled successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Toggle SQL error log on a server (*GetAPIClustersClusterNameServersServerNameActionsToogleSQLErrorLog*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/toogle-sql-error-log +``` + +Toggles the SQL error log on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-sql-error-log-200) | OK | SQL error log toggled successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-sql-error-log-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-sql-error-log-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-sql-error-log-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-sql-error-log-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-sql-error-log-500-schema) | + +#### Responses + + +##### 200 - SQL error log toggled successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Toggle slow query on a server (*GetAPIClustersClusterNameServersServerNameActionsToogleSlowQuery*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/toogle-slow-query +``` + +Toggles the slow query on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-slow-query-200) | OK | Slow query toggled successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-slow-query-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-slow-query-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-slow-query-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-slow-query-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-slow-query-500-schema) | + +#### Responses + + +##### 200 - Slow query toggled successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Toggle slow query capture on a server (*GetAPIClustersClusterNameServersServerNameActionsToogleSlowQueryCapture*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/toogle-slow-query-capture +``` + +Toggles the slow query capture on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-slow-query-capture-200) | OK | Slow query capture toggled successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-slow-query-capture-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-slow-query-capture-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-slow-query-capture-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-slow-query-capture-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-slow-query-capture-500-schema) | + +#### Responses + + +##### 200 - Slow query capture toggled successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Toggle slow query table mode on a server (*GetAPIClustersClusterNameServersServerNameActionsToogleSlowQueryTable*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/toogle-slow-query-table +``` + +Toggles the slow query table mode on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-slow-query-table-200) | OK | Slow query table mode toggled successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-slow-query-table-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-slow-query-table-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-slow-query-table-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-slow-query-table-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-toogle-slow-query-table-500-schema) | + +#### Responses + + +##### 200 - Slow query table mode toggled successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Unprovision a server (*GetAPIClustersClusterNameServersServerNameActionsUnprovision*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/unprovision +``` + +Unprovisions a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-unprovision-200) | OK | Server unprovisioned successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-unprovision-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-unprovision-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-unprovision-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-unprovision-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-unprovision-500-schema) | + +#### Responses + + +##### 200 - Server unprovisioned successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Wait for InnoDB purge on a server (*GetAPIClustersClusterNameServersServerNameActionsWaitInnodbPurge*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/actions/wait-innodb-purge +``` + +Waits for InnoDB purge on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-actions-wait-innodb-purge-200) | OK | InnoDB purge completed successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-wait-innodb-purge-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-actions-wait-innodb-purge-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-wait-innodb-purge-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-actions-wait-innodb-purge-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Error waiting for InnoDB purge | | [schema](#get-api-clusters-cluster-name-servers-server-name-actions-wait-innodb-purge-500-schema) | + +#### Responses + + +##### 200 - InnoDB purge completed successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Error waiting for InnoDB purge +Status: Internal Server Error + +###### Schema + + + + + +### Get status of all slaves of a server (*GetAPIClustersClusterNameServersServerNameAllSlavesStatus*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/all-slaves-status +``` + +Retrieves the status of all slaves of a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-all-slaves-status-200) | OK | Status of all slaves retrieved successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-all-slaves-status-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-all-slaves-status-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-all-slaves-status-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-all-slaves-status-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Encoding error | | [schema](#get-api-clusters-cluster-name-servers-server-name-all-slaves-status-500-schema) | + +#### Responses + + +##### 200 - Status of all slaves retrieved successfully +Status: OK + +###### Schema + + + +any + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Encoding error +Status: Internal Server Error + +###### Schema + + + + + +### Get PFS statements of a server (*GetAPIClustersClusterNameServersServerNameDigestStatementsPfs*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/digest-statements-pfs +``` + +Retrieves the PFS statements of a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-digest-statements-pfs-200) | OK | PFS statements retrieved successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-digest-statements-pfs-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-digest-statements-pfs-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-digest-statements-pfs-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-digest-statements-pfs-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Encoding error | | [schema](#get-api-clusters-cluster-name-servers-server-name-digest-statements-pfs-500-schema) | + +#### Responses + + +##### 200 - PFS statements retrieved successfully +Status: OK + +###### Schema + + + +any + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Encoding error +Status: Internal Server Error + +###### Schema + + + + + +### Get PFS statements from the slow log of a server (*GetAPIClustersClusterNameServersServerNameDigestStatementsSlow*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/digest-statements-slow +``` + +Retrieves the PFS statements from the slow log of a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-digest-statements-slow-200) | OK | PFS statements from slow log retrieved successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-digest-statements-slow-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-digest-statements-slow-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-digest-statements-slow-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-digest-statements-slow-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Encoding error | | [schema](#get-api-clusters-cluster-name-servers-server-name-digest-statements-slow-500-schema) | + +#### Responses + + +##### 200 - PFS statements from slow log retrieved successfully +Status: OK + +###### Schema + + + +any + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Encoding error +Status: Internal Server Error + +###### Schema + + + + + +### Get error log of a server (*GetAPIClustersClusterNameServersServerNameErrorlog*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/errorlog +``` + +Retrieves the error log of a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-errorlog-200) | OK | Error log retrieved successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-errorlog-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-errorlog-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-errorlog-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-errorlog-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Encoding error | | [schema](#get-api-clusters-cluster-name-servers-server-name-errorlog-500-schema) | + +#### Responses + + +##### 200 - Error log retrieved successfully +Status: OK + +###### Schema + + + +any + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Encoding error +Status: Internal Server Error + +###### Schema + + + + + +### Check if a server is a master (*GetAPIClustersClusterNameServersServerNameIsMaster*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/is-master +``` + +Checks if a specified server within a cluster is a master. + +#### Produces + * text/plain + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-is-master-200) | OK | 200 -Valid Master! | | [schema](#get-api-clusters-cluster-name-servers-server-name-is-master-200-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-is-master-500) | Internal Server Error | No cluster | | [schema](#get-api-clusters-cluster-name-servers-server-name-is-master-500-schema) | +| [503](#get-api-clusters-cluster-name-servers-server-name-is-master-503) | Service Unavailable | 503 -Not a Valid Master! | | [schema](#get-api-clusters-cluster-name-servers-server-name-is-master-503-schema) | + +#### Responses + + +##### 200 - 200 -Valid Master! +Status: OK + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +##### 503 - 503 -Not a Valid Master! +Status: Service Unavailable + +###### Schema + + + + + +### Check if a server is a slave (*GetAPIClustersClusterNameServersServerNameIsSlave*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/is-slave +``` + +Checks if a specified server within a cluster is a slave. + +#### Produces + * text/plain + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-is-slave-200) | OK | 200 -Valid Slave! | | [schema](#get-api-clusters-cluster-name-servers-server-name-is-slave-200-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-is-slave-500) | Internal Server Error | No cluster | | [schema](#get-api-clusters-cluster-name-servers-server-name-is-slave-500-schema) | +| [503](#get-api-clusters-cluster-name-servers-server-name-is-slave-503) | Service Unavailable | 503 -Not a Valid Slave! | | [schema](#get-api-clusters-cluster-name-servers-server-name-is-slave-503-schema) | + +#### Responses + + +##### 200 - 200 -Valid Slave! +Status: OK + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +##### 503 - 503 -Not a Valid Slave! +Status: Service Unavailable + +###### Schema + + + + + +### Get master status of a server (*GetAPIClustersClusterNameServersServerNameMasterStatus*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/master-status +``` + +Retrieves the master status of a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-master-status-200) | OK | Master status retrieved successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-master-status-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-master-status-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-master-status-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-master-status-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Encoding error | | [schema](#get-api-clusters-cluster-name-servers-server-name-master-status-500-schema) | + +#### Responses + + +##### 200 - Master status retrieved successfully +Status: OK + +###### Schema + + + +any + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Encoding error +Status: Internal Server Error + +###### Schema + + + + + +### Get metadata locks of a server (*GetAPIClustersClusterNameServersServerNameMetaDataLocks*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/meta-data-locks +``` + +Retrieves the metadata locks of a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-meta-data-locks-200) | OK | Metadata locks retrieved successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-meta-data-locks-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-meta-data-locks-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-meta-data-locks-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-meta-data-locks-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Encoding error | | [schema](#get-api-clusters-cluster-name-servers-server-name-meta-data-locks-500-schema) | + +#### Responses + + +##### 200 - Metadata locks retrieved successfully +Status: OK + +###### Schema + + + +any + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Encoding error +Status: Internal Server Error + +###### Schema + + + + + +### Get process list of a server (*GetAPIClustersClusterNameServersServerNameProcesslist*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/processlist +``` + +Retrieves the process list of a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-processlist-200) | OK | Process list retrieved successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-processlist-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-processlist-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-processlist-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-processlist-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Encoding error | | [schema](#get-api-clusters-cluster-name-servers-server-name-processlist-500-schema) | + +#### Responses + + +##### 200 - Process list retrieved successfully +Status: OK + +###### Schema + + + +any + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Encoding error +Status: Internal Server Error + +###### Schema + + + + + +### Analyze a query using PFS on a server (*GetAPIClustersClusterNameServersServerNameQueriesQueryDigestActionsAnalyzePfs*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/queries/{queryDigest}/actions/analyze-pfs +``` + +Analyzes a query identified by its digest on a specified server within a cluster using PFS. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| queryDigest | `path` | string | `string` | | ✓ | | Query Digest | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-analyze-pfs-200) | OK | Query analyzed successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-analyze-pfs-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-analyze-pfs-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-analyze-pfs-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-analyze-pfs-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-analyze-pfs-500-schema) | + +#### Responses + + +##### 200 - Query analyzed successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Analyze a query using the slow log on a server (*GetAPIClustersClusterNameServersServerNameQueriesQueryDigestActionsAnalyzeSlowlog*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/queries/{queryDigest}/actions/analyze-slowlog +``` + +Analyzes a query identified by its digest on a specified server within a cluster using the slow log. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| queryDigest | `path` | string | `string` | | ✓ | | Query Digest | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-analyze-slowlog-200) | OK | Query analyzed successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-analyze-slowlog-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-analyze-slowlog-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-analyze-slowlog-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-analyze-slowlog-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-analyze-slowlog-500-schema) | + +#### Responses + + +##### 200 - Query analyzed successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Explain a query using PFS on a server (*GetAPIClustersClusterNameServersServerNameQueriesQueryDigestActionsExplainPfs*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/queries/{queryDigest}/actions/explain-pfs +``` + +Explains a query identified by its digest on a specified server within a cluster using PFS. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| queryDigest | `path` | string | `string` | | ✓ | | Query Digest | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-explain-pfs-200) | OK | Query explained successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-explain-pfs-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-explain-pfs-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-explain-pfs-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-explain-pfs-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Encoding error | | [schema](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-explain-pfs-500-schema) | + +#### Responses + + +##### 200 - Query explained successfully +Status: OK + +###### Schema + + + +any + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Encoding error +Status: Internal Server Error + +###### Schema + + + + + +### Explain a query using the slow log on a server (*GetAPIClustersClusterNameServersServerNameQueriesQueryDigestActionsExplainSlowlog*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/queries/{queryDigest}/actions/explain-slowlog +``` + +Explains a query identified by its digest on a specified server within a cluster using the slow log. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| queryDigest | `path` | string | `string` | | ✓ | | Query Digest | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-explain-slowlog-200) | OK | Query explained successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-explain-slowlog-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-explain-slowlog-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-explain-slowlog-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-explain-slowlog-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Encoding error | | [schema](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-explain-slowlog-500-schema) | + +#### Responses + + +##### 200 - Query explained successfully +Status: OK + +###### Schema + + + +any + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Encoding error +Status: Internal Server Error + +###### Schema + + + + + +### Kill a query on a server (*GetAPIClustersClusterNameServersServerNameQueriesQueryDigestActionsKillQuery*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/queries/{queryDigest}/actions/kill-query +``` + +Kills a query identified by its digest on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| queryDigest | `path` | string | `string` | | ✓ | | Query Digest | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-kill-query-200) | OK | Query killed successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-kill-query-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-kill-query-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-kill-query-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-kill-query-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-kill-query-500-schema) | + +#### Responses + + +##### 200 - Query killed successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Kill a thread on a server (*GetAPIClustersClusterNameServersServerNameQueriesQueryDigestActionsKillThread*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/queries/{queryDigest}/actions/kill-thread +``` + +Kills a thread identified by its digest on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| queryDigest | `path` | string | `string` | | ✓ | | Query Digest | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-kill-thread-200) | OK | Query killed successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-kill-thread-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-kill-thread-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-kill-thread-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-kill-thread-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-queries-query-digest-actions-kill-thread-500-schema) | + +#### Responses + + +##### 200 - Query killed successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Get query response time of a server (*GetAPIClustersClusterNameServersServerNameQueryResponseTime*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/query-response-time +``` + +Retrieves the query response time of a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-query-response-time-200) | OK | Query response time retrieved successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-query-response-time-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-query-response-time-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-query-response-time-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-query-response-time-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Encoding error | | [schema](#get-api-clusters-cluster-name-servers-server-name-query-response-time-500-schema) | + +#### Responses + + +##### 200 - Query response time retrieved successfully +Status: OK + +###### Schema + + + +any + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Encoding error +Status: Internal Server Error + +###### Schema + + + + + +### Get schemas of a server (*GetAPIClustersClusterNameServersServerNameSchemas*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/schemas +``` + +Retrieves the schemas of a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-schemas-200) | OK | Schemas retrieved successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-schemas-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-schemas-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-schemas-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-schemas-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Encoding error | | [schema](#get-api-clusters-cluster-name-servers-server-name-schemas-500-schema) | + +#### Responses + + +##### 200 - Schemas retrieved successfully +Status: OK + +###### Schema + + + +any + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Encoding error +Status: Internal Server Error + +###### Schema + + + + + +### Perform a physical backup on a server port (*GetAPIClustersClusterNameServersServerNameServerPortBackup*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/backup +``` + +Initiates a physical backup on a specified server port within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | +| serverPort | `path` | string | `string` | | ✓ | | Server Port | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-server-port-backup-200) | OK | Backup initiated successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-backup-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-server-port-backup-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-backup-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-server-port-backup-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-backup-500-schema) | + +#### Responses + + +##### 200 - Backup initiated successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Get server port configuration (*GetAPIClustersClusterNameServersServerNameServerPortConfig*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/config +``` + +Retrieves the configuration of a specified server port within a cluster. + +#### Produces + * application/octet-stream + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | +| serverPort | `path` | string | `string` | | ✓ | | Server Port | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-server-port-config-200) | OK | Configuration file | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-config-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-server-port-config-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-config-403-schema) | +| [404](#get-api-clusters-cluster-name-servers-server-name-server-port-config-404) | Not Found | File not found | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-config-404-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-server-port-config-500) | Internal Server Error | No cluster" or "No server | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-config-500-schema) | + +#### Responses + + +##### 200 - Configuration file +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 404 - File not found +Status: Not Found + +###### Schema + + + + + +##### 500 - No cluster" or "No server +Status: Internal Server Error + +###### Schema + + + + + +### Check if a server port is a master (*GetAPIClustersClusterNameServersServerNameServerPortIsMaster*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/is-master +``` + +Checks if a specified server port within a cluster is a master. + +#### Produces + * text/plain + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | +| serverPort | `path` | string | `string` | | ✓ | | Server Port | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-server-port-is-master-200) | OK | 200 -Valid Master! | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-is-master-200-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-server-port-is-master-500) | Internal Server Error | No cluster | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-is-master-500-schema) | +| [503](#get-api-clusters-cluster-name-servers-server-name-server-port-is-master-503) | Service Unavailable | 503 -Not a Valid Master! | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-is-master-503-schema) | + +#### Responses + + +##### 200 - 200 -Valid Master! +Status: OK + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +##### 503 - 503 -Not a Valid Master! +Status: Service Unavailable + +###### Schema + + + + + +### Check if a server port is a slave (*GetAPIClustersClusterNameServersServerNameServerPortIsSlave*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/is-slave +``` + +Checks if a specified server port within a cluster is a slave. + +#### Produces + * text/plain + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | +| serverPort | `path` | string | `string` | | ✓ | | Server Port | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-server-port-is-slave-200) | OK | 200 -Valid Slave! | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-is-slave-200-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-server-port-is-slave-500) | Internal Server Error | No cluster | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-is-slave-500-schema) | +| [503](#get-api-clusters-cluster-name-servers-server-name-server-port-is-slave-503) | Service Unavailable | 503 -Not a Valid Slave! | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-is-slave-503-schema) | + +#### Responses + + +##### 200 - 200 -Valid Slave! +Status: OK + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +##### 503 - 503 -Not a Valid Slave! +Status: Service Unavailable + +###### Schema + + + + + +### Check if a server needs a config change (*GetAPIClustersClusterNameServersServerNameServerPortNeedConfigChange*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/need-config-change +``` + +Checks if a specified server within a cluster needs a config change. + +#### Produces + * text/plain + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | +| serverPort | `path` | string | `string` | | ✓ | | Server Port | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-server-port-need-config-change-200) | OK | 200 -Need config change! | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-need-config-change-200-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-server-port-need-config-change-500) | Internal Server Error | 500 -No config change needed!" or "500 -No valid server!" or "500 -No cluster! | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-need-config-change-500-schema) | + +#### Responses + + +##### 200 - 200 -Need config change! +Status: OK + +###### Schema + + + + + +##### 500 - 500 -No config change needed!" or "500 -No valid server!" or "500 -No cluster! +Status: Internal Server Error + +###### Schema + + + + + +### Check if a server needs provisioning (*GetAPIClustersClusterNameServersServerNameServerPortNeedProv*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/need-prov +``` + +Checks if a specified server within a cluster needs provisioning. + +#### Produces + * text/plain + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | +| serverPort | `path` | string | `string` | | ✓ | | Server Port | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-server-port-need-prov-200) | OK | 200 -Need provisioning! | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-need-prov-200-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-server-port-need-prov-500) | Internal Server Error | 503 -Not a Valid Server! | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-need-prov-500-schema) | +| [503](#get-api-clusters-cluster-name-servers-server-name-server-port-need-prov-503) | Service Unavailable | 503 -No provisioning needed! | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-need-prov-503-schema) | + +#### Responses + + +##### 200 - 200 -Need provisioning! +Status: OK + +###### Schema + + + + + +##### 500 - 503 -Not a Valid Server! +Status: Internal Server Error + +###### Schema + + + + + +##### 503 - 503 -No provisioning needed! +Status: Service Unavailable + +###### Schema + + + + + +### Check if a server needs re-provisioning (*GetAPIClustersClusterNameServersServerNameServerPortNeedReprov*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/need-reprov +``` + +Checks if a specified server within a cluster needs re-provisioning. + +#### Produces + * text/plain + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | +| serverPort | `path` | string | `string` | | ✓ | | Server Port | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-server-port-need-reprov-200) | OK | 200 -Need reprov! | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-need-reprov-200-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-server-port-need-reprov-500) | Internal Server Error | 503 -Not a Valid Server! | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-need-reprov-500-schema) | +| [503](#get-api-clusters-cluster-name-servers-server-name-server-port-need-reprov-503) | Service Unavailable | 503 -No reprov needed! | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-need-reprov-503-schema) | + +#### Responses + + +##### 200 - 200 -Need reprov! +Status: OK + +###### Schema + + + + + +##### 500 - 503 -Not a Valid Server! +Status: Internal Server Error + +###### Schema + + + + + +##### 503 - 503 -No reprov needed! +Status: Service Unavailable + +###### Schema + + + + + +### Check if a server needs a restart (*GetAPIClustersClusterNameServersServerNameServerPortNeedRestart*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/need-restart +``` + +Checks if a specified server within a cluster needs a restart. + +#### Produces + * text/plain + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | +| serverPort | `path` | string | `string` | | ✓ | | Server Port | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-server-port-need-restart-200) | OK | 200 -Need restart! | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-need-restart-200-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-server-port-need-restart-500) | Internal Server Error | 503 -Not a Valid Server! | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-need-restart-500-schema) | +| [503](#get-api-clusters-cluster-name-servers-server-name-server-port-need-restart-503) | Service Unavailable | 503 -No restart needed! | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-need-restart-503-schema) | + +#### Responses + + +##### 200 - 200 -Need restart! +Status: OK + +###### Schema + + + + + +##### 500 - 503 -Not a Valid Server! +Status: Internal Server Error + +###### Schema + + + + + +##### 503 - 503 -No restart needed! +Status: Service Unavailable + +###### Schema + + + + + +### Check if a server needs to start (*GetAPIClustersClusterNameServersServerNameServerPortNeedStart*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/need-start +``` + +Checks if a specified server within a cluster needs to start. + +#### Produces + * text/plain + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | +| serverPort | `path` | string | `string` | | ✓ | | Server Port | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-server-port-need-start-200) | OK | 200 -Need start! | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-need-start-200-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-server-port-need-start-500) | Internal Server Error | 500 -No start needed!" or "500 -No valid server!" or "500 -No cluster! | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-need-start-500-schema) | + +#### Responses + + +##### 200 - 200 -Need start! +Status: OK + +###### Schema + + + + + +##### 500 - 500 -No start needed!" or "500 -No valid server!" or "500 -No cluster! +Status: Internal Server Error + +###### Schema + + + + + +### Check if a server needs to stop (*GetAPIClustersClusterNameServersServerNameServerPortNeedStop*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/need-stop +``` + +Checks if a specified server within a cluster needs to stop. + +#### Produces + * text/plain + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | +| serverPort | `path` | string | `string` | | ✓ | | Server Port | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-server-port-need-stop-200) | OK | 200 -Need stop! | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-need-stop-200-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-server-port-need-stop-500) | Internal Server Error | 500 -No stop needed!" or "500 -No valid server!" or "500 -No cluster! | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-need-stop-500-schema) | + +#### Responses + + +##### 200 - 200 -Need stop! +Status: OK + +###### Schema + + + + + +##### 500 - 500 -No stop needed!" or "500 -No valid server!" or "500 -No cluster! +Status: Internal Server Error + +###### Schema + + + + + +### Check if a server needs unprovisioning (*GetAPIClustersClusterNameServersServerNameServerPortNeedUnprov*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/need-unprov +``` + +Checks if a specified server within a cluster needs unprovisioning. + +#### Produces + * text/plain + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | +| serverPort | `path` | string | `string` | | ✓ | | Server Port | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-server-port-need-unprov-200) | OK | 200 -Need unprov! | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-need-unprov-200-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-server-port-need-unprov-500) | Internal Server Error | 503 -Not a Valid Server! | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-need-unprov-500-schema) | +| [503](#get-api-clusters-cluster-name-servers-server-name-server-port-need-unprov-503) | Service Unavailable | 503 -No unprov needed! | | [schema](#get-api-clusters-cluster-name-servers-server-name-server-port-need-unprov-503-schema) | + +#### Responses + + +##### 200 - 200 -Need unprov! +Status: OK + +###### Schema + + + + + +##### 500 - 503 -Not a Valid Server! +Status: Internal Server Error + +###### Schema + + + + + +##### 503 - 503 -No unprov needed! +Status: Service Unavailable + +###### Schema + + + + + +### Get database service configuration of a server (*GetAPIClustersClusterNameServersServerNameServiceOpensvc*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/service-opensvc +``` + +Retrieves the database service configuration of a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-service-opensvc-200) | OK | Database service configuration retrieved successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-service-opensvc-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-service-opensvc-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-service-opensvc-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-service-opensvc-500) | Internal Server Error | Cluster Not Found" or "Server Not Found | | [schema](#get-api-clusters-cluster-name-servers-server-name-service-opensvc-500-schema) | + +#### Responses + + +##### 200 - Database service configuration retrieved successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Get slow log of a server (*GetAPIClustersClusterNameServersServerNameSlowQueries*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/slow-queries +``` + +Retrieves the slow log of a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-slow-queries-200) | OK | Slow log retrieved successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-slow-queries-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-slow-queries-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-slow-queries-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-slow-queries-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Encoding error | | [schema](#get-api-clusters-cluster-name-servers-server-name-slow-queries-500-schema) | + +#### Responses + + +##### 200 - Slow log retrieved successfully +Status: OK + +###### Schema + + + +any + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Encoding error +Status: Internal Server Error + +###### Schema + + + + + +### Get status of a server (*GetAPIClustersClusterNameServersServerNameStatus*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/status +``` + +Retrieves the status of a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-status-200) | OK | Status retrieved successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-status-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-status-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-status-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-status-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Encoding error | | [schema](#get-api-clusters-cluster-name-servers-server-name-status-500-schema) | + +#### Responses + + +##### 200 - Status retrieved successfully +Status: OK + +###### Schema + + + +any + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Encoding error +Status: Internal Server Error + +###### Schema + + + + + +### Get status delta of a server (*GetAPIClustersClusterNameServersServerNameStatusDelta*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/status-delta +``` + +Retrieves the status delta of a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-status-delta-200) | OK | Status delta retrieved successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-status-delta-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-status-delta-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-status-delta-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-status-delta-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Encoding error | | [schema](#get-api-clusters-cluster-name-servers-server-name-status-delta-500-schema) | + +#### Responses + + +##### 200 - Status delta retrieved successfully +Status: OK + +###### Schema + + + +any + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Encoding error +Status: Internal Server Error + +###### Schema + + + + + +### Get InnoDB status of a server (*GetAPIClustersClusterNameServersServerNameStatusInnodb*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/status-innodb +``` + +Retrieves the InnoDB status of a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-status-innodb-200) | OK | InnoDB status retrieved successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-status-innodb-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-status-innodb-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-status-innodb-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-status-innodb-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Encoding error | | [schema](#get-api-clusters-cluster-name-servers-server-name-status-innodb-500-schema) | + +#### Responses + + +##### 200 - InnoDB status retrieved successfully +Status: OK + +###### Schema + + + +any + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Encoding error +Status: Internal Server Error + +###### Schema + + + + + +### Get tables of a server (*GetAPIClustersClusterNameServersServerNameTables*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/tables +``` + +Retrieves the tables of a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-tables-200) | OK | Tables retrieved successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-tables-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-tables-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-tables-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-tables-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Encoding error | | [schema](#get-api-clusters-cluster-name-servers-server-name-tables-500-schema) | + +#### Responses + + +##### 200 - Tables retrieved successfully +Status: OK + +###### Schema + + + +any + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Encoding error +Status: Internal Server Error + +###### Schema + + + + + +### Get variables of a server (*GetAPIClustersClusterNameServersServerNameVariables*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/variables +``` + +Retrieves the variables of a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-variables-200) | OK | Variables retrieved successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-variables-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-variables-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-variables-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-variables-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Encoding error | | [schema](#get-api-clusters-cluster-name-servers-server-name-variables-500-schema) | + +#### Responses + + +##### 200 - Variables retrieved successfully +Status: OK + +###### Schema + + + +any + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Encoding error +Status: Internal Server Error + +###### Schema + + + + + +### Get virtual tables of a server (*GetAPIClustersClusterNameServersServerNameVtables*) + +``` +GET /api/clusters/{clusterName}/servers/{serverName}/vtables +``` + +Retrieves the virtual tables of a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-servers-server-name-vtables-200) | OK | Virtual tables retrieved successfully | | [schema](#get-api-clusters-cluster-name-servers-server-name-vtables-200-schema) | +| [403](#get-api-clusters-cluster-name-servers-server-name-vtables-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-servers-server-name-vtables-403-schema) | +| [500](#get-api-clusters-cluster-name-servers-server-name-vtables-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Encoding error | | [schema](#get-api-clusters-cluster-name-servers-server-name-vtables-500-schema) | + +#### Responses + + +##### 200 - Virtual tables retrieved successfully +Status: OK + +###### Schema + + + +any + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Encoding error +Status: Internal Server Error + +###### Schema + + + + + +### Retrieve settings for a specific cluster (*GetAPIClustersClusterNameSettings*) + +``` +GET /api/clusters/{clusterName}/settings +``` + +This endpoint retrieves the settings for the specified cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-settings-200) | OK | Cluster settings | | [schema](#get-api-clusters-cluster-name-settings-200-schema) | +| [403](#get-api-clusters-cluster-name-settings-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-settings-403-schema) | +| [500](#get-api-clusters-cluster-name-settings-500) | Internal Server Error | No cluster | | [schema](#get-api-clusters-cluster-name-settings-500-schema) | + +#### Responses + + +##### 200 - Cluster settings +Status: OK + +###### Schema + + + +[GithubComSignal18ReplicationManagerConfigConfig](#github-com-signal18-replication-manager-config-config) + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Retrieve shard clusters for a specific cluster (*GetAPIClustersClusterNameShardclusters*) + +``` +GET /api/clusters/{clusterName}/shardclusters +``` + +This endpoint retrieves the shard clusters for the specified cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-shardclusters-200) | OK | List of shard clusters | | [schema](#get-api-clusters-cluster-name-shardclusters-200-schema) | +| [403](#get-api-clusters-cluster-name-shardclusters-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-shardclusters-403-schema) | +| [500](#get-api-clusters-cluster-name-shardclusters-500) | Internal Server Error | No cluster | | [schema](#get-api-clusters-cluster-name-shardclusters-500-schema) | + +#### Responses + + +##### 200 - List of shard clusters +Status: OK + +###### Schema + + + +[][interface{}](#interface) + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Get Sphinx Indexes (*GetAPIClustersClusterNameSphinxIndexes*) + +``` +GET /api/clusters/{clusterName}/sphinx/indexes +``` + +Get the Sphinx indexes for a given cluster + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-sphinx-indexes-200) | OK | Sphinx Indexes | | [schema](#get-api-clusters-cluster-name-sphinx-indexes-200-schema) | +| [403](#get-api-clusters-cluster-name-sphinx-indexes-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-sphinx-indexes-403-schema) | +| [404](#get-api-clusters-cluster-name-sphinx-indexes-404) | Not Found | Something went wrong | | [schema](#get-api-clusters-cluster-name-sphinx-indexes-404-schema) | +| [500](#get-api-clusters-cluster-name-sphinx-indexes-500) | Internal Server Error | Cluster Not Found | | [schema](#get-api-clusters-cluster-name-sphinx-indexes-500-schema) | + +#### Responses + + +##### 200 - Sphinx Indexes +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 404 - Something went wrong +Status: Not Found + +###### Schema + + + + + +##### 500 - Cluster Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Retrieve status of a cluster (*GetAPIClustersClusterNameStatus*) + +``` +GET /api/clusters/{clusterName}/status +``` + +This endpoint retrieves the status of a specified cluster and returns it in JSON format. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-status-200) | OK | Cluster status | | [schema](#get-api-clusters-cluster-name-status-200-schema) | +| [400](#get-api-clusters-cluster-name-status-400) | Bad Request | No cluster found | | [schema](#get-api-clusters-cluster-name-status-400-schema) | + +#### Responses + + +##### 200 - Cluster status +Status: OK + +###### Schema + + + +map of string + +##### 400 - No cluster found +Status: Bad Request + +###### Schema + + + + + +### Retrieve tags for a specific cluster (*GetAPIClustersClusterNameTags*) + +``` +GET /api/clusters/{clusterName}/tags +``` + +This endpoint retrieves the tags for the specified cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-tags-200) | OK | List of tags | | [schema](#get-api-clusters-cluster-name-tags-200-schema) | +| [500](#get-api-clusters-cluster-name-tags-500) | Internal Server Error | Internal Server Error | | [schema](#get-api-clusters-cluster-name-tags-500-schema) | + +#### Responses + + +##### 200 - List of tags +Status: OK + +###### Schema + + + +[]string + +##### 500 - Internal Server Error +Status: Internal Server Error + +###### Schema + + + + + +### Retrieve top metrics for a specific cluster (*GetAPIClustersClusterNameTop*) + +``` +GET /api/clusters/{clusterName}/top +``` + +This endpoint retrieves the top metrics for the specified cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `query` | string | `string` | | | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-top-200) | OK | Top metrics | | [schema](#get-api-clusters-cluster-name-top-200-schema) | +| [403](#get-api-clusters-cluster-name-top-403) | Forbidden | No valid ACL | | [schema](#get-api-clusters-cluster-name-top-403-schema) | +| [500](#get-api-clusters-cluster-name-top-500) | Internal Server Error | No cluster | | [schema](#get-api-clusters-cluster-name-top-500-schema) | + +#### Responses + + +##### 200 - Top metrics +Status: OK + +###### Schema + + + +any + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Shows the alerts for that specific named cluster (*GetAPIClustersClusterNameTopologyAlerts*) + +``` +GET /api/clusters/{clusterName}/topology/alerts +``` + +Shows the alerts for that specific named cluster + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-topology-alerts-200) | OK | A list of alerts | | [schema](#get-api-clusters-cluster-name-topology-alerts-200-schema) | +| [500](#get-api-clusters-cluster-name-topology-alerts-500) | Internal Server Error | Internal Server Error | | [schema](#get-api-clusters-cluster-name-topology-alerts-500-schema) | + +#### Responses + + +##### 200 - A list of alerts +Status: OK + +###### Schema + + + +[ClusterAlerts](#cluster-alerts) + +##### 500 - Internal Server Error +Status: Internal Server Error + +###### Schema + + + + + +### Retrieve crashes for a specific cluster (*GetAPIClustersClusterNameTopologyCrashes*) + +``` +GET /api/clusters/{clusterName}/topology/crashes +``` + +This endpoint retrieves the crashes for the specified cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-topology-crashes-200) | OK | List of crashes | | [schema](#get-api-clusters-cluster-name-topology-crashes-200-schema) | +| [500](#get-api-clusters-cluster-name-topology-crashes-500) | Internal Server Error | Cluster Not Found | | [schema](#get-api-clusters-cluster-name-topology-crashes-500-schema) | + +#### Responses + + +##### 200 - List of crashes +Status: OK + +###### Schema + + + +[]string + +##### 500 - Cluster Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Retrieve logs for a specific cluster (*GetAPIClustersClusterNameTopologyLogs*) + +``` +GET /api/clusters/{clusterName}/topology/logs +``` + +This endpoint retrieves the logs for the specified cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-topology-logs-200) | OK | List of logs | | [schema](#get-api-clusters-cluster-name-topology-logs-200-schema) | +| [500](#get-api-clusters-cluster-name-topology-logs-500) | Internal Server Error | Internal Server Error | | [schema](#get-api-clusters-cluster-name-topology-logs-500-schema) | + +#### Responses + + +##### 200 - List of logs +Status: OK + +###### Schema + + + +[]string + +##### 500 - Internal Server Error +Status: Internal Server Error + +###### Schema + + + + + +### Retrieve master of a cluster (*GetAPIClustersClusterNameTopologyMaster*) + +``` +GET /api/clusters/{clusterName}/topology/master +``` + +This endpoint retrieves the master of a specified cluster and returns it in JSON format. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-topology-master-200) | OK | Master server | | [schema](#get-api-clusters-cluster-name-topology-master-200-schema) | +| [500](#get-api-clusters-cluster-name-topology-master-500) | Internal Server Error | Internal Server Error | | [schema](#get-api-clusters-cluster-name-topology-master-500-schema) | + +#### Responses + + +##### 200 - Master server +Status: OK + +###### Schema + + + +[ClusterServerMonitor](#cluster-server-monitor) + +##### 500 - Internal Server Error +Status: Internal Server Error + +###### Schema + + + + + +### Shows the proxies for that specific named cluster (*GetAPIClustersClusterNameTopologyProxies*) + +``` +GET /api/clusters/{clusterName}/topology/proxies +``` + +Shows the proxies for that specific named cluster + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-topology-proxies-200) | OK | A list of proxies | | [schema](#get-api-clusters-cluster-name-topology-proxies-200-schema) | +| [500](#get-api-clusters-cluster-name-topology-proxies-500) | Internal Server Error | Internal Server Error | | [schema](#get-api-clusters-cluster-name-topology-proxies-500-schema) | + +#### Responses + + +##### 200 - A list of proxies +Status: OK + +###### Schema + + + +[][interface{}](#interface) + +##### 500 - Internal Server Error +Status: Internal Server Error + +###### Schema + + + + + +### Retrieve servers for a specific cluster (*GetAPIClustersClusterNameTopologyServers*) + +``` +GET /api/clusters/{clusterName}/topology/servers +``` + +This endpoint retrieves the servers for the specified cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-topology-servers-200) | OK | List of servers | | [schema](#get-api-clusters-cluster-name-topology-servers-200-schema) | +| [500](#get-api-clusters-cluster-name-topology-servers-500) | Internal Server Error | Internal Server Error | | [schema](#get-api-clusters-cluster-name-topology-servers-500-schema) | + +#### Responses + + +##### 200 - List of servers +Status: OK + +###### Schema + + + +[][interface{}](#interface) + +##### 500 - Internal Server Error +Status: Internal Server Error + +###### Schema + + + + + +### Shows the slaves for that specific named cluster (*GetAPIClustersClusterNameTopologySlaves*) + +``` +GET /api/clusters/{clusterName}/topology/slaves +``` + +Shows the slaves for that specific named cluster + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-cluster-name-topology-slaves-200) | OK | A list of slaves | | [schema](#get-api-clusters-cluster-name-topology-slaves-200-schema) | +| [500](#get-api-clusters-cluster-name-topology-slaves-500) | Internal Server Error | Internal Server Error | | [schema](#get-api-clusters-cluster-name-topology-slaves-500-schema) | + +#### Responses + + +##### 200 - A list of slaves +Status: OK + +###### Schema + + + +[][interface{}](#interface) + +##### 500 - Internal Server Error +Status: Internal Server Error + +###### Schema + + + + + +### Retrieve peer clusters for sale (*GetAPIClustersForSale*) + +``` +GET /api/clusters/for-sale +``` + +This endpoint returns a list of peer clusters that are available for sale, excluding those that are booked by the requesting user. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| Authorization | `header` | string | `string` | | ✓ | | JWT token | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-for-sale-200) | OK | List of peer clusters available for sale | | [schema](#get-api-clusters-for-sale-200-schema) | +| [401](#get-api-clusters-for-sale-401) | Unauthorized | Unauthenticated resource | | [schema](#get-api-clusters-for-sale-401-schema) | +| [500](#get-api-clusters-for-sale-500) | Internal Server Error | Failed to get token claims or Error Marshal | | [schema](#get-api-clusters-for-sale-500-schema) | + +#### Responses + + +##### 200 - List of peer clusters available for sale +Status: OK + +###### Schema + + + +[][ConfigPeerCluster](#config-peer-cluster) + +##### 401 - Unauthenticated resource +Status: Unauthorized + +###### Schema + + + + + +##### 500 - Failed to get token claims or Error Marshal +Status: Internal Server Error + +###### Schema + + + + + +### Retrieve peer clusters for a user (*GetAPIClustersPeers*) + +``` +GET /api/clusters/peers +``` + +This endpoint retrieves the peer clusters that a user has access to. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| Authorization | `header` | string | `string` | | ✓ | | Bearer token | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-clusters-peers-200) | OK | List of peer clusters | | [schema](#get-api-clusters-peers-200-schema) | +| [401](#get-api-clusters-peers-401) | Unauthorized | Unauthenticated resource | | [schema](#get-api-clusters-peers-401-schema) | +| [500](#get-api-clusters-peers-500) | Internal Server Error | Failed to get token claims or Error Marshal | | [schema](#get-api-clusters-peers-500-schema) | + +#### Responses + + +##### 200 - List of peer clusters +Status: OK + +###### Schema + + + +[][ConfigPeerCluster](#config-peer-cluster) + +##### 401 - Unauthenticated resource +Status: Unauthorized + +###### Schema + + + + + +##### 500 - Failed to get token claims or Error Marshal +Status: Internal Server Error + +###### Schema + + + + + +### List Grafana files (*GetAPIConfigsGrafana*) + +``` +GET /api/configs/grafana +``` + +Returns a list of Grafana files from the specified directory. + +#### Produces + * application/json + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-configs-grafana-200) | OK | List of Grafana files | | [schema](#get-api-configs-grafana-200-schema) | +| [500](#get-api-configs-grafana-500) | Internal Server Error | Internal Server Error | | [schema](#get-api-configs-grafana-500-schema) | + +#### Responses + + +##### 200 - List of Grafana files +Status: OK + +###### Schema + + + +[]string + +##### 500 - Internal Server Error +Status: Internal Server Error + +###### Schema + + + + + +### Monitor Heartbeat (*GetAPIHeartbeat*) + +``` +GET /api/heartbeat +``` + +Returns the heartbeat status of the replication manager. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-heartbeat-200) | OK | OK | | [schema](#get-api-heartbeat-200-schema) | +| [500](#get-api-heartbeat-500) | Internal Server Error | Internal Server Error | | [schema](#get-api-heartbeat-500-schema) | + +#### Responses + + +##### 200 - OK +Status: OK + +###### Schema + + + +[ServerHeartbeat](#server-heartbeat) + +##### 500 - Internal Server Error +Status: Internal Server Error + +###### Schema + + + +map of string + +### Handles replication manager requests (*GetAPIMonitor*) + +``` +GET /api/monitor +``` + +This endpoint processes the replication manager requests, validates cluster ACLs, and returns the cluster list in JSON format. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-monitor-200) | OK | Successful response with replication manager details | | [schema](#get-api-monitor-200-schema) | +| [500](#get-api-monitor-500) | Internal Server Error | Internal Server Error | | [schema](#get-api-monitor-500-schema) | + +#### Responses + + +##### 200 - Successful response with replication manager details +Status: OK + +###### Schema + + + +[ServerReplicationManager](#server-replication-manager) + +##### 500 - Internal Server Error +Status: Internal Server Error + +###### Schema + + + + + +### Fetch Prometheus metrics (*GetAPIPrometheus*) + +``` +GET /api/prometheus +``` + +Fetches Prometheus metrics for all servers in all clusters managed by the replication manager. + +#### Produces + * text/plain + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-prometheus-200) | OK | Prometheus metrics | | [schema](#get-api-prometheus-200-schema) | +| [500](#get-api-prometheus-500) | Internal Server Error | Internal Server Error | | [schema](#get-api-prometheus-500-schema) | + +#### Responses + + +##### 200 - Prometheus metrics +Status: OK + +###### Schema + + + + + +##### 500 - Internal Server Error +Status: Internal Server Error + +###### Schema + + + + + +### Retrieve current repository component (*GetAPIRepocompCurrent*) + +``` +GET /api/repocomp/current +``` + +Reads the current repository component from the specified directory and returns its content. + +#### Produces + * text/plain + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-repocomp-current-200) | OK | Current repository component content | | [schema](#get-api-repocomp-current-200-schema) | +| [404](#get-api-repocomp-current-404) | Not Found | 404 Something went wrong - Not Found | | [schema](#get-api-repocomp-current-404-schema) | + +#### Responses + + +##### 200 - Current repository component content +Status: OK + +###### Schema + + + + + +##### 404 - 404 Something went wrong - Not Found +Status: Not Found + +###### Schema + + + + + +### Get Replication Manager Status (*GetAPIStatus*) + +``` +GET /api/status +``` + +Returns the status of the replication manager indicating whether it is running or starting. + +#### Produces + * application/json + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-status-200) | OK | {"alive": "running"} or {"alive": "starting"} | | [schema](#get-api-status-200-schema) | + +#### Responses + + +##### 200 - {"alive": "running"} or {"alive": "starting"} +Status: OK + +###### Schema + + + +map of string + +### Retrieves terms (*GetAPITerms*) + +``` +GET /api/terms +``` + +This endpoint returns the terms managed by the replication manager. + +#### Produces + * text/plain + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-terms-200) | OK | Terms | | [schema](#get-api-terms-200-schema) | + +#### Responses + + +##### 200 - Terms +Status: OK + +###### Schema + + + + + +### Check if the replication manager is running (*GetAPITimeout*) + +``` +GET /api/timeout +``` + +This endpoint is used to check if the replication manager is running. It will respond with a JSON object after a delay of 1200 seconds. + +#### Produces + * application/json + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#get-api-timeout-200) | OK | OK | | [schema](#get-api-timeout-200-schema) | + +#### Responses + + +##### 200 - OK +Status: OK + +###### Schema + + + +map of string + +### Add a new cluster (*PostAPIClustersActionsAddClusterName*) + +``` +POST /api/clusters/actions/add/{clusterName} +``` + +Adds a new cluster to the replication manager. If the cluster already exists, it returns an error. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| cluster | `body` | [ClusterClusterForm](#cluster-cluster-form) | `models.ClusterClusterForm` | | ✓ | | Cluster Form | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-actions-add-cluster-name-200) | OK | Cluster added successfully | | [schema](#post-api-clusters-actions-add-cluster-name-200-schema) | +| [400](#post-api-clusters-actions-add-cluster-name-400) | Bad Request | Error in request or Cluster already exists | | [schema](#post-api-clusters-actions-add-cluster-name-400-schema) | +| [500](#post-api-clusters-actions-add-cluster-name-500) | Internal Server Error | User is not valid | | [schema](#post-api-clusters-actions-add-cluster-name-500-schema) | + +#### Responses + + +##### 200 - Cluster added successfully +Status: OK + +###### Schema + + + +[ClusterCluster](#cluster-cluster) + +##### 400 - Error in request or Cluster already exists +Status: Bad Request + +###### Schema + + + + + +##### 500 - User is not valid +Status: Internal Server Error + +###### Schema + + + + + +### Add a sharding cluster to an existing cluster (*PostAPIClustersClusterNameActionsAddClusterShardingName*) + +``` +POST /api/clusters/{clusterName}/actions/add/{clusterShardingName} +``` + +This endpoint adds a sharding cluster to an existing cluster and triggers a rolling restart. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| clusterShardingName | `path` | string | `string` | | ✓ | | Cluster Sharding Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-actions-add-cluster-sharding-name-200) | OK | Sharding cluster added successfully | | [schema](#post-api-clusters-cluster-name-actions-add-cluster-sharding-name-200-schema) | +| [403](#post-api-clusters-cluster-name-actions-add-cluster-sharding-name-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-actions-add-cluster-sharding-name-403-schema) | +| [500](#post-api-clusters-cluster-name-actions-add-cluster-sharding-name-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-actions-add-cluster-sharding-name-500-schema) | + +#### Responses + + +##### 200 - Sharding cluster added successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Add a server to a specific cluster (*PostAPIClustersClusterNameActionsAddserverHostPort*) + +``` +POST /api/clusters/{clusterName}/actions/addserver/{host}/{port} +``` + +This endpoint adds a server to the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| host | `path` | string | `string` | | ✓ | | Host | +| port | `path` | string | `string` | | ✓ | | Port | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-actions-addserver-host-port-200) | OK | Monitor added | | [schema](#post-api-clusters-cluster-name-actions-addserver-host-port-200-schema) | +| [403](#post-api-clusters-cluster-name-actions-addserver-host-port-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-actions-addserver-host-port-403-schema) | +| [409](#post-api-clusters-cluster-name-actions-addserver-host-port-409) | Conflict | Error adding new monitor | | [schema](#post-api-clusters-cluster-name-actions-addserver-host-port-409-schema) | +| [500](#post-api-clusters-cluster-name-actions-addserver-host-port-500) | Internal Server Error | Cluster Not Found | | [schema](#post-api-clusters-cluster-name-actions-addserver-host-port-500-schema) | + +#### Responses + + +##### 200 - Monitor added +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 409 - Error adding new monitor +Status: Conflict + +###### Schema + + + + + +##### 500 - Cluster Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Add a server to a specific cluster (*PostAPIClustersClusterNameActionsAddserverHostPortType*) + +``` +POST /api/clusters/{clusterName}/actions/addserver/{host}/{port}/{type} +``` + +This endpoint adds a server to the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| host | `path` | string | `string` | | ✓ | | Host | +| port | `path` | string | `string` | | ✓ | | Port | +| type | `path` | string | `string` | | | | Type | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-actions-addserver-host-port-type-200) | OK | Monitor added | | [schema](#post-api-clusters-cluster-name-actions-addserver-host-port-type-200-schema) | +| [403](#post-api-clusters-cluster-name-actions-addserver-host-port-type-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-actions-addserver-host-port-type-403-schema) | +| [409](#post-api-clusters-cluster-name-actions-addserver-host-port-type-409) | Conflict | Error adding new monitor | | [schema](#post-api-clusters-cluster-name-actions-addserver-host-port-type-409-schema) | +| [500](#post-api-clusters-cluster-name-actions-addserver-host-port-type-500) | Internal Server Error | Cluster Not Found | | [schema](#post-api-clusters-cluster-name-actions-addserver-host-port-type-500-schema) | + +#### Responses + + +##### 200 - Monitor added +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 409 - Error adding new monitor +Status: Conflict + +###### Schema + + + + + +##### 500 - Cluster Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Cancel rolling reprovision for a specific cluster (*PostAPIClustersClusterNameActionsCancelRollingReprov*) + +``` +POST /api/clusters/{clusterName}/actions/cancel-rolling-reprov +``` + +This endpoint cancels the rolling reprovision for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-actions-cancel-rolling-reprov-200) | OK | Successfully cancelled rolling reprovision | | [schema](#post-api-clusters-cluster-name-actions-cancel-rolling-reprov-200-schema) | +| [403](#post-api-clusters-cluster-name-actions-cancel-rolling-reprov-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-actions-cancel-rolling-reprov-403-schema) | +| [500](#post-api-clusters-cluster-name-actions-cancel-rolling-reprov-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-actions-cancel-rolling-reprov-500-schema) | + +#### Responses + + +##### 200 - Successfully cancelled rolling reprovision +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Cancel rolling restart for a specific cluster (*PostAPIClustersClusterNameActionsCancelRollingRestart*) + +``` +POST /api/clusters/{clusterName}/actions/cancel-rolling-restart +``` + +This endpoint cancels the rolling restart for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-actions-cancel-rolling-restart-200) | OK | Successfully cancelled rolling restart | | [schema](#post-api-clusters-cluster-name-actions-cancel-rolling-restart-200-schema) | +| [403](#post-api-clusters-cluster-name-actions-cancel-rolling-restart-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-actions-cancel-rolling-restart-403-schema) | +| [500](#post-api-clusters-cluster-name-actions-cancel-rolling-restart-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-actions-cancel-rolling-restart-500-schema) | + +#### Responses + + +##### 200 - Successfully cancelled rolling restart +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Rotate keys for a specific cluster (*PostAPIClustersClusterNameActionsCertificatesRotate*) + +``` +POST /api/clusters/{clusterName}/actions/certificates-rotate +``` + +Rotate the keys for the specified cluster + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-actions-certificates-rotate-200) | OK | Keys rotated successfully | | [schema](#post-api-clusters-cluster-name-actions-certificates-rotate-200-schema) | +| [403](#post-api-clusters-cluster-name-actions-certificates-rotate-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-actions-certificates-rotate-403-schema) | +| [500](#post-api-clusters-cluster-name-actions-certificates-rotate-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-actions-certificates-rotate-500-schema) | + +#### Responses + + +##### 200 - Keys rotated successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Calculate checksum for all tables in a specific cluster (*PostAPIClustersClusterNameActionsChecksumAllTables*) + +``` +POST /api/clusters/{clusterName}/actions/checksum-all-tables +``` + +This endpoint triggers the checksum calculation for all tables in the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-actions-checksum-all-tables-200) | OK | Successfully triggered checksum calculation for all tables | | [schema](#post-api-clusters-cluster-name-actions-checksum-all-tables-200-schema) | +| [403](#post-api-clusters-cluster-name-actions-checksum-all-tables-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-actions-checksum-all-tables-403-schema) | +| [500](#post-api-clusters-cluster-name-actions-checksum-all-tables-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-actions-checksum-all-tables-500-schema) | + +#### Responses + + +##### 200 - Successfully triggered checksum calculation for all tables +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Handles the failover process for a given cluster. (*PostAPIClustersClusterNameActionsFailover*) + +``` +POST /api/clusters/{clusterName}/actions/failover +``` + +This endpoint triggers a master failover for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-actions-failover-200) | OK | Successfully triggered failover | | [schema](#post-api-clusters-cluster-name-actions-failover-200-schema) | +| [403](#post-api-clusters-cluster-name-actions-failover-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-actions-failover-403-schema) | +| [500](#post-api-clusters-cluster-name-actions-failover-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-actions-failover-500-schema) | + +#### Responses + + +##### 200 - Successfully triggered failover +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Perform a physical backup for the master of a specific cluster (*PostAPIClustersClusterNameActionsMasterPhysicalBackup*) + +``` +POST /api/clusters/{clusterName}/actions/master-physical-backup +``` + +This endpoint triggers a physical backup for the master of the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-actions-master-physical-backup-200) | OK | Successfully triggered physical backup | | [schema](#post-api-clusters-cluster-name-actions-master-physical-backup-200-schema) | +| [400](#post-api-clusters-cluster-name-actions-master-physical-backup-400) | Bad Request | No cluster found | | [schema](#post-api-clusters-cluster-name-actions-master-physical-backup-400-schema) | +| [403](#post-api-clusters-cluster-name-actions-master-physical-backup-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-actions-master-physical-backup-403-schema) | + +#### Responses + + +##### 200 - Successfully triggered physical backup +Status: OK + +###### Schema + + + + + +##### 400 - No cluster found +Status: Bad Request + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +### Optimize a specific cluster (*PostAPIClustersClusterNameActionsOptimize*) + +``` +POST /api/clusters/{clusterName}/actions/optimize +``` + +This endpoint triggers the optimization process for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-actions-optimize-200) | OK | Successfully triggered optimization | | [schema](#post-api-clusters-cluster-name-actions-optimize-200-schema) | +| [400](#post-api-clusters-cluster-name-actions-optimize-400) | Bad Request | No cluster found | | [schema](#post-api-clusters-cluster-name-actions-optimize-400-schema) | +| [403](#post-api-clusters-cluster-name-actions-optimize-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-actions-optimize-403-schema) | + +#### Responses + + +##### 200 - Successfully triggered optimization +Status: OK + +###### Schema + + + + + +##### 400 - No cluster found +Status: Bad Request + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +### Bootstrap replication for a specific cluster (*PostAPIClustersClusterNameActionsReplicationBootstrapTopology*) + +``` +POST /api/clusters/{clusterName}/actions/replication/bootstrap/{topology} +``` + +This endpoint triggers the bootstrap replication process for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| topology | `path` | string | `string` | | ✓ | | Topology | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-actions-replication-bootstrap-topology-200) | OK | Successfully bootstrapped replication | | [schema](#post-api-clusters-cluster-name-actions-replication-bootstrap-topology-200-schema) | +| [403](#post-api-clusters-cluster-name-actions-replication-bootstrap-topology-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-actions-replication-bootstrap-topology-403-schema) | +| [500](#post-api-clusters-cluster-name-actions-replication-bootstrap-topology-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-actions-replication-bootstrap-topology-500-schema) | + +#### Responses + + +##### 200 - Successfully bootstrapped replication +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Cleanup replication bootstrap for a specific cluster (*PostAPIClustersClusterNameActionsReplicationCleanup*) + +``` +POST /api/clusters/{clusterName}/actions/replication/cleanup +``` + +This endpoint triggers the cleanup process for replication bootstrap for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-actions-replication-cleanup-200) | OK | Successfully cleaned up replication bootstrap | | [schema](#post-api-clusters-cluster-name-actions-replication-cleanup-200-schema) | +| [403](#post-api-clusters-cluster-name-actions-replication-cleanup-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-actions-replication-cleanup-403-schema) | +| [500](#post-api-clusters-cluster-name-actions-replication-cleanup-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-actions-replication-cleanup-500-schema) | + +#### Responses + + +##### 200 - Successfully cleaned up replication bootstrap +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Reset failover control for a specific cluster (*PostAPIClustersClusterNameActionsResetFailoverControl*) + +``` +POST /api/clusters/{clusterName}/actions/reset-failover-control +``` + +This endpoint resets the failover control for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-actions-reset-failover-control-200) | OK | Successfully reset failover control | | [schema](#post-api-clusters-cluster-name-actions-reset-failover-control-200-schema) | +| [403](#post-api-clusters-cluster-name-actions-reset-failover-control-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-actions-reset-failover-control-403-schema) | +| [500](#post-api-clusters-cluster-name-actions-reset-failover-control-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-actions-reset-failover-control-500-schema) | + +#### Responses + + +##### 200 - Successfully reset failover control +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Reset SLA for a specific cluster (*PostAPIClustersClusterNameActionsResetSLA*) + +``` +POST /api/clusters/{clusterName}/actions/reset-sla +``` + +Reset the SLA for the specified cluster + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-actions-reset-sla-200) | OK | SLA reset successfully | | [schema](#post-api-clusters-cluster-name-actions-reset-sla-200-schema) | +| [403](#post-api-clusters-cluster-name-actions-reset-sla-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-actions-reset-sla-403-schema) | +| [500](#post-api-clusters-cluster-name-actions-reset-sla-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-actions-reset-sla-500-schema) | + +#### Responses + + +##### 200 - SLA reset successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Handles the rolling restart process for a given cluster. (*PostAPIClustersClusterNameActionsRolling*) + +``` +POST /api/clusters/{clusterName}/actions/rolling +``` + +This endpoint triggers a rolling restart for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-actions-rolling-200) | OK | Successfully triggered rolling restart | | [schema](#post-api-clusters-cluster-name-actions-rolling-200-schema) | +| [403](#post-api-clusters-cluster-name-actions-rolling-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-actions-rolling-403-schema) | +| [500](#post-api-clusters-cluster-name-actions-rolling-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-actions-rolling-500-schema) | + +#### Responses + + +##### 200 - Successfully triggered rolling restart +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Rotate passwords for a specific cluster (*PostAPIClustersClusterNameActionsRotatePasswords*) + +``` +POST /api/clusters/{clusterName}/actions/rotate-passwords +``` + +This endpoint rotates the passwords for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-actions-rotate-passwords-200) | OK | Successfully rotated passwords | | [schema](#post-api-clusters-cluster-name-actions-rotate-passwords-200-schema) | +| [403](#post-api-clusters-cluster-name-actions-rotate-passwords-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-actions-rotate-passwords-403-schema) | +| [500](#post-api-clusters-cluster-name-actions-rotate-passwords-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-actions-rotate-passwords-500-schema) | + +#### Responses + + +##### 200 - Successfully rotated passwords +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Start traffic for a specific cluster (*PostAPIClustersClusterNameActionsStartTraffic*) + +``` +POST /api/clusters/{clusterName}/actions/start-traffic +``` + +This endpoint starts traffic for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-actions-start-traffic-200) | OK | Successfully started traffic | | [schema](#post-api-clusters-cluster-name-actions-start-traffic-200-schema) | +| [403](#post-api-clusters-cluster-name-actions-start-traffic-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-actions-start-traffic-403-schema) | +| [500](#post-api-clusters-cluster-name-actions-start-traffic-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-actions-start-traffic-500-schema) | + +#### Responses + + +##### 200 - Successfully started traffic +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Stop traffic for a specific cluster (*PostAPIClustersClusterNameActionsStopTraffic*) + +``` +POST /api/clusters/{clusterName}/actions/stop-traffic +``` + +This endpoint stops traffic for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-actions-stop-traffic-200) | OK | Successfully stopped traffic | | [schema](#post-api-clusters-cluster-name-actions-stop-traffic-200-schema) | +| [403](#post-api-clusters-cluster-name-actions-stop-traffic-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-actions-stop-traffic-403-schema) | +| [500](#post-api-clusters-cluster-name-actions-stop-traffic-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-actions-stop-traffic-500-schema) | + +#### Responses + + +##### 200 - Successfully stopped traffic +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Handles the switchover process for a given cluster. (*PostAPIClustersClusterNameActionsSwitchover*) + +``` +POST /api/clusters/{clusterName}/actions/switchover +``` + +This endpoint triggers a master switchover for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| prefmaster | `formData` | string | `string` | | | | Preferred Master | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-actions-switchover-200) | OK | Successfully triggered switchover | | [schema](#post-api-clusters-cluster-name-actions-switchover-200-schema) | +| [400](#post-api-clusters-cluster-name-actions-switchover-400) | Bad Request | Master failed | | [schema](#post-api-clusters-cluster-name-actions-switchover-400-schema) | +| [403](#post-api-clusters-cluster-name-actions-switchover-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-actions-switchover-403-schema) | +| [500](#post-api-clusters-cluster-name-actions-switchover-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-actions-switchover-500-schema) | + +#### Responses + + +##### 200 - Successfully triggered switchover +Status: OK + +###### Schema + + + + + +##### 400 - Master failed +Status: Bad Request + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Run sysbench for a specific cluster (*PostAPIClustersClusterNameActionsSysbench*) + +``` +POST /api/clusters/{clusterName}/actions/sysbench +``` + +This endpoint runs sysbench for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| threads | `query` | string | `string` | | | | Number of threads | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-actions-sysbench-200) | OK | Successfully triggered sysbench | | [schema](#post-api-clusters-cluster-name-actions-sysbench-200-schema) | +| [403](#post-api-clusters-cluster-name-actions-sysbench-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-actions-sysbench-403-schema) | +| [500](#post-api-clusters-cluster-name-actions-sysbench-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-actions-sysbench-500-schema) | + +#### Responses + + +##### 200 - Successfully triggered sysbench +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Wait for databases to be ready for a specific cluster (*PostAPIClustersClusterNameActionsWaitdatabases*) + +``` +POST /api/clusters/{clusterName}/actions/waitdatabases +``` + +This endpoint waits for the databases to be ready for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-actions-waitdatabases-200) | OK | Databases are ready | | [schema](#post-api-clusters-cluster-name-actions-waitdatabases-200-schema) | +| [403](#post-api-clusters-cluster-name-actions-waitdatabases-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-actions-waitdatabases-403-schema) | +| [500](#post-api-clusters-cluster-name-actions-waitdatabases-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-actions-waitdatabases-500-schema) | + +#### Responses + + +##### 200 - Databases are ready +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Provision Proxy Service (*PostAPIClustersClusterNameProxiesProxyNameActionsProvision*) + +``` +POST /api/clusters/{clusterName}/proxies/{proxyName}/actions/provision +``` + +Provision the proxy service for a given cluster and proxy + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| proxyName | `path` | string | `string` | | ✓ | | Proxy Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-proxies-proxy-name-actions-provision-200) | OK | Proxy Service Provisioned | | [schema](#post-api-clusters-cluster-name-proxies-proxy-name-actions-provision-200-schema) | +| [403](#post-api-clusters-cluster-name-proxies-proxy-name-actions-provision-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-proxies-proxy-name-actions-provision-403-schema) | +| [500](#post-api-clusters-cluster-name-proxies-proxy-name-actions-provision-500) | Internal Server Error | Cluster Not Found" "Server Not Found | | [schema](#post-api-clusters-cluster-name-proxies-proxy-name-actions-provision-500-schema) | + +#### Responses + + +##### 200 - Proxy Service Provisioned +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Start Proxy Service (*PostAPIClustersClusterNameProxiesProxyNameActionsStart*) + +``` +POST /api/clusters/{clusterName}/proxies/{proxyName}/actions/start +``` + +Start the proxy service for a given cluster and proxy + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| proxyName | `path` | string | `string` | | ✓ | | Proxy Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-proxies-proxy-name-actions-start-200) | OK | Proxy Service Started | | [schema](#post-api-clusters-cluster-name-proxies-proxy-name-actions-start-200-schema) | +| [403](#post-api-clusters-cluster-name-proxies-proxy-name-actions-start-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-proxies-proxy-name-actions-start-403-schema) | +| [500](#post-api-clusters-cluster-name-proxies-proxy-name-actions-start-500) | Internal Server Error | Cluster Not Found" "Server Not Found | | [schema](#post-api-clusters-cluster-name-proxies-proxy-name-actions-start-500-schema) | + +#### Responses + + +##### 200 - Proxy Service Started +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Stop Proxy Service (*PostAPIClustersClusterNameProxiesProxyNameActionsStop*) + +``` +POST /api/clusters/{clusterName}/proxies/{proxyName}/actions/stop +``` + +Stop the proxy service for a given cluster and proxy + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| proxyName | `path` | string | `string` | | ✓ | | Proxy Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-proxies-proxy-name-actions-stop-200) | OK | Proxy Service Stopped | | [schema](#post-api-clusters-cluster-name-proxies-proxy-name-actions-stop-200-schema) | +| [403](#post-api-clusters-cluster-name-proxies-proxy-name-actions-stop-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-proxies-proxy-name-actions-stop-403-schema) | +| [500](#post-api-clusters-cluster-name-proxies-proxy-name-actions-stop-500) | Internal Server Error | Cluster Not Found" "Server Not Found | | [schema](#post-api-clusters-cluster-name-proxies-proxy-name-actions-stop-500-schema) | + +#### Responses + + +##### 200 - Proxy Service Stopped +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Unprovision Proxy Service (*PostAPIClustersClusterNameProxiesProxyNameActionsUnprovision*) + +``` +POST /api/clusters/{clusterName}/proxies/{proxyName}/actions/unprovision +``` + +Unprovision the proxy service for a given cluster and proxy + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| proxyName | `path` | string | `string` | | ✓ | | Proxy Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-proxies-proxy-name-actions-unprovision-200) | OK | Proxy Service Unprovisioned | | [schema](#post-api-clusters-cluster-name-proxies-proxy-name-actions-unprovision-200-schema) | +| [403](#post-api-clusters-cluster-name-proxies-proxy-name-actions-unprovision-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-proxies-proxy-name-actions-unprovision-403-schema) | +| [500](#post-api-clusters-cluster-name-proxies-proxy-name-actions-unprovision-500) | Internal Server Error | Cluster Not Found" "Server Not Found | | [schema](#post-api-clusters-cluster-name-proxies-proxy-name-actions-unprovision-500-schema) | + +#### Responses + + +##### 200 - Proxy Service Unprovisioned +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" "Server Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Accept a subscription for a specific cluster (*PostAPIClustersClusterNameSalesAcceptSubscription*) + +``` +POST /api/clusters/{clusterName}/sales/accept-subscription +``` + +This endpoint accepts a subscription for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| body | `body` | [ClusterUserForm](#cluster-user-form) | `models.ClusterUserForm` | | ✓ | | User Form | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-sales-accept-subscription-200) | OK | Email sent to sponsor! | | [schema](#post-api-clusters-cluster-name-sales-accept-subscription-200-schema) | +| [403](#post-api-clusters-cluster-name-sales-accept-subscription-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-sales-accept-subscription-403-schema) | +| [500](#post-api-clusters-cluster-name-sales-accept-subscription-500) | Internal Server Error | Error accepting subscription | | [schema](#post-api-clusters-cluster-name-sales-accept-subscription-500-schema) | + +#### Responses + + +##### 200 - Email sent to sponsor! +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Error accepting subscription +Status: Internal Server Error + +###### Schema + + + + + +### Remove a sponsor from a specific cluster (*PostAPIClustersClusterNameSalesEndSubscription*) + +``` +POST /api/clusters/{clusterName}/sales/end-subscription +``` + +This endpoint removes a sponsor from the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| body | `body` | [ClusterUserForm](#cluster-user-form) | `models.ClusterUserForm` | | ✓ | | User Form | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-sales-end-subscription-200) | OK | Sponsor subscription removed! | | [schema](#post-api-clusters-cluster-name-sales-end-subscription-200-schema) | +| [403](#post-api-clusters-cluster-name-sales-end-subscription-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-sales-end-subscription-403-schema) | +| [500](#post-api-clusters-cluster-name-sales-end-subscription-500) | Internal Server Error | Error removing sponsor subscription | | [schema](#post-api-clusters-cluster-name-sales-end-subscription-500-schema) | + +#### Responses + + +##### 200 - Sponsor subscription removed! +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Error removing sponsor subscription +Status: Internal Server Error + +###### Schema + + + + + +### Reject a subscription for a specific cluster (*PostAPIClustersClusterNameSalesRefuseSubscription*) + +``` +POST /api/clusters/{clusterName}/sales/refuse-subscription +``` + +This endpoint rejects a subscription for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| body | `body` | [ClusterUserForm](#cluster-user-form) | `models.ClusterUserForm` | | ✓ | | User Form | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-sales-refuse-subscription-200) | OK | Subscription removed! | | [schema](#post-api-clusters-cluster-name-sales-refuse-subscription-200-schema) | +| [403](#post-api-clusters-cluster-name-sales-refuse-subscription-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-sales-refuse-subscription-403-schema) | +| [500](#post-api-clusters-cluster-name-sales-refuse-subscription-500) | Internal Server Error | Error removing subscription | | [schema](#post-api-clusters-cluster-name-sales-refuse-subscription-500-schema) | + +#### Responses + + +##### 200 - Subscription removed! +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Error removing subscription +Status: Internal Server Error + +###### Schema + + + + + +### Calculate checksum for a specific table in a specific cluster (*PostAPIClustersClusterNameSchemaSchemaNameTableNameActionsChecksumTable*) + +``` +POST /api/clusters/{clusterName}/schema/{schemaName}/{tableName}/actions/checksum-table +``` + +This endpoint triggers the checksum calculation for a specific table in the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| schemaName | `path` | string | `string` | | ✓ | | Schema Name | +| tableName | `path` | string | `string` | | ✓ | | Table Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-checksum-table-200) | OK | Successfully triggered checksum calculation for the table | | [schema](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-checksum-table-200-schema) | +| [403](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-checksum-table-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-checksum-table-403-schema) | +| [500](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-checksum-table-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-checksum-table-500-schema) | + +#### Responses + + +##### 200 - Successfully triggered checksum calculation for the table +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Move a table to a different shard cluster (*PostAPIClustersClusterNameSchemaSchemaNameTableNameActionsMoveTableClusterShard*) + +``` +POST /api/clusters/{clusterName}/schema/{schemaName}/{tableName}/actions/move-table/{clusterShard} +``` + +This endpoint moves a table to a different shard cluster for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| clusterShard | `path` | string | `string` | | ✓ | | Cluster Shard | +| schemaName | `path` | string | `string` | | ✓ | | Schema Name | +| tableName | `path` | string | `string` | | ✓ | | Table Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-move-table-cluster-shard-200) | OK | Successfully moved table | | [schema](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-move-table-cluster-shard-200-schema) | +| [403](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-move-table-cluster-shard-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-move-table-cluster-shard-403-schema) | +| [500](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-move-table-cluster-shard-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-move-table-cluster-shard-500-schema) | + +#### Responses + + +##### 200 - Successfully moved table +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Reshard a table for a specific cluster (*PostAPIClustersClusterNameSchemaSchemaNameTableNameActionsReshardTable*) + +``` +POST /api/clusters/{clusterName}/schema/{schemaName}/{tableName}/actions/reshard-table +``` + +This endpoint triggers the resharding of a table for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| schemaName | `path` | string | `string` | | ✓ | | Schema Name | +| tableName | `path` | string | `string` | | ✓ | | Table Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-reshard-table-200) | OK | Successfully triggered resharding of the table | | [schema](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-reshard-table-200-schema) | +| [403](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-reshard-table-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-reshard-table-403-schema) | +| [500](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-reshard-table-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-reshard-table-500-schema) | + +#### Responses + + +##### 200 - Successfully triggered resharding of the table +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Reshard a table for a specific cluster (*PostAPIClustersClusterNameSchemaSchemaNameTableNameActionsReshardTableClusterList*) + +``` +POST /api/clusters/{clusterName}/schema/{schemaName}/{tableName}/actions/reshard-table/{clusterList} +``` + +This endpoint triggers the resharding of a table for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterList | `path` | string | `string` | | | | Cluster List | +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| schemaName | `path` | string | `string` | | ✓ | | Schema Name | +| tableName | `path` | string | `string` | | ✓ | | Table Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-reshard-table-cluster-list-200) | OK | Successfully triggered resharding of the table | | [schema](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-reshard-table-cluster-list-200-schema) | +| [403](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-reshard-table-cluster-list-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-reshard-table-cluster-list-403-schema) | +| [500](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-reshard-table-cluster-list-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-reshard-table-cluster-list-500-schema) | + +#### Responses + + +##### 200 - Successfully triggered resharding of the table +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Set a universal table for a specific cluster (*PostAPIClustersClusterNameSchemaSchemaNameTableNameActionsUniversalTable*) + +``` +POST /api/clusters/{clusterName}/schema/{schemaName}/{tableName}/actions/universal-table +``` + +This endpoint sets a universal table for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| schemaName | `path` | string | `string` | | ✓ | | Schema Name | +| tableName | `path` | string | `string` | | ✓ | | Table Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-universal-table-200) | OK | Successfully set universal table | | [schema](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-universal-table-200-schema) | +| [403](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-universal-table-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-universal-table-403-schema) | +| [500](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-universal-table-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-schema-schema-name-table-name-actions-universal-table-500-schema) | + +#### Responses + + +##### 200 - Successfully set universal table +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Send Vault token to a specific cluster (*PostAPIClustersClusterNameSendVaultToken*) + +``` +POST /api/clusters/{clusterName}/send-vault-token +``` + +This endpoint sends the Vault token to the specified cluster via email. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-send-vault-token-200) | OK | Vault token sent successfully | | [schema](#post-api-clusters-cluster-name-send-vault-token-200-schema) | +| [403](#post-api-clusters-cluster-name-send-vault-token-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-send-vault-token-403-schema) | +| [500](#post-api-clusters-cluster-name-send-vault-token-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-send-vault-token-500-schema) | + +#### Responses + + +##### 200 - Vault token sent successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Perform a point-in-time recovery on a server (*PostAPIClustersClusterNameServersServerNameActionsPitr*) + +``` +POST /api/clusters/{clusterName}/servers/{serverName}/actions/pitr +``` + +Initiates a point-in-time recovery on a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-servers-server-name-actions-pitr-200) | OK | PITR initiated successfully | | [schema](#post-api-clusters-cluster-name-servers-server-name-actions-pitr-200-schema) | +| [403](#post-api-clusters-cluster-name-servers-server-name-actions-pitr-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-servers-server-name-actions-pitr-403-schema) | +| [500](#post-api-clusters-cluster-name-servers-server-name-actions-pitr-500) | Internal Server Error | Cluster Not Found" or "Server Not Found" or "Decode error" or "PITR error | | [schema](#post-api-clusters-cluster-name-servers-server-name-actions-pitr-500-schema) | + +#### Responses + + +##### 200 - PITR initiated successfully +Status: OK + +###### Schema + + + +[ServerAPIResponse](#server-api-response) + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found" or "Server Not Found" or "Decode error" or "PITR error +Status: Internal Server Error + +###### Schema + + + + + +### Write logs for a server (*PostAPIClustersClusterNameServersServerNameServerPortWriteLogTask*) + +``` +POST /api/clusters/{clusterName}/servers/{serverName}/{serverPort}/write-log/{task} +``` + +Writes logs for a specified server within a cluster. + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| serverName | `path` | string | `string` | | ✓ | | Server Name | +| serverPort | `path` | string | `string` | | ✓ | | Server Port | +| task | `path` | string | `string` | | ✓ | | Task | +| data | `body` | [ServerDecodedData](#server-decoded-data) | `models.ServerDecodedData` | | ✓ | | Log Data | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-servers-server-name-server-port-write-log-task-200) | OK | Message logged | | [schema](#post-api-clusters-cluster-name-servers-server-name-server-port-write-log-task-200-schema) | +| [400](#post-api-clusters-cluster-name-servers-server-name-server-port-write-log-task-400) | Bad Request | Bad request: Task is not registered" or "Decode reading body" or "Decode body | | [schema](#post-api-clusters-cluster-name-servers-server-name-server-port-write-log-task-400-schema) | +| [500](#post-api-clusters-cluster-name-servers-server-name-server-port-write-log-task-500) | Internal Server Error | No cluster" or "No server" or "Error decrypting data | | [schema](#post-api-clusters-cluster-name-servers-server-name-server-port-write-log-task-500-schema) | + +#### Responses + + +##### 200 - Message logged +Status: OK + +###### Schema + + + +[ServerAPIResponse](#server-api-response) + +##### 400 - Bad request: Task is not registered" or "Decode reading body" or "Decode body +Status: Bad Request + +###### Schema + + + + + +##### 500 - No cluster" or "No server" or "Error decrypting data +Status: Internal Server Error + +###### Schema + + + + + +### Provision services for a specific cluster (*PostAPIClustersClusterNameServicesActionsProvision*) + +``` +POST /api/clusters/{clusterName}/services/actions/provision +``` + +This endpoint provisions services for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-services-actions-provision-200) | OK | Successfully provisioned services | | [schema](#post-api-clusters-cluster-name-services-actions-provision-200-schema) | +| [403](#post-api-clusters-cluster-name-services-actions-provision-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-services-actions-provision-403-schema) | +| [500](#post-api-clusters-cluster-name-services-actions-provision-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-services-actions-provision-500-schema) | + +#### Responses + + +##### 200 - Successfully provisioned services +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Unprovision services for a specific cluster (*PostAPIClustersClusterNameServicesActionsUnprovision*) + +``` +POST /api/clusters/{clusterName}/services/actions/unprovision +``` + +This endpoint unprovisions services for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-services-actions-unprovision-200) | OK | Successfully unprovisioned services | | [schema](#post-api-clusters-cluster-name-services-actions-unprovision-200-schema) | +| [403](#post-api-clusters-cluster-name-services-actions-unprovision-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-services-actions-unprovision-403-schema) | +| [500](#post-api-clusters-cluster-name-services-actions-unprovision-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-services-actions-unprovision-500-schema) | + +#### Responses + + +##### 200 - Successfully unprovisioned services +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Add a tag to a specific cluster (*PostAPIClustersClusterNameSettingsActionsAddDbTagTagValue*) + +``` +POST /api/clusters/{clusterName}/settings/actions/add-db-tag/{tagValue} +``` + +This endpoint adds a tag to the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| tagValue | `path` | string | `string` | | ✓ | | Tag Value | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-settings-actions-add-db-tag-tag-value-200) | OK | Tag added successfully | | [schema](#post-api-clusters-cluster-name-settings-actions-add-db-tag-tag-value-200-schema) | +| [403](#post-api-clusters-cluster-name-settings-actions-add-db-tag-tag-value-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-settings-actions-add-db-tag-tag-value-403-schema) | +| [500](#post-api-clusters-cluster-name-settings-actions-add-db-tag-tag-value-500) | Internal Server Error | Cluster Not Found | | [schema](#post-api-clusters-cluster-name-settings-actions-add-db-tag-tag-value-500-schema) | + +#### Responses + + +##### 200 - Tag added successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Add a proxy tag to a specific cluster (*PostAPIClustersClusterNameSettingsActionsAddProxyTagTagValue*) + +``` +POST /api/clusters/{clusterName}/settings/actions/add-proxy-tag/{tagValue} +``` + +This endpoint adds a proxy tag to the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| tagValue | `path` | string | `string` | | ✓ | | Tag Value | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-settings-actions-add-proxy-tag-tag-value-200) | OK | Tag added successfully | | [schema](#post-api-clusters-cluster-name-settings-actions-add-proxy-tag-tag-value-200-schema) | +| [403](#post-api-clusters-cluster-name-settings-actions-add-proxy-tag-tag-value-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-settings-actions-add-proxy-tag-tag-value-403-schema) | +| [500](#post-api-clusters-cluster-name-settings-actions-add-proxy-tag-tag-value-500) | Internal Server Error | Cluster Not Found | | [schema](#post-api-clusters-cluster-name-settings-actions-add-proxy-tag-tag-value-500-schema) | + +#### Responses + + +##### 200 - Tag added successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Apply dynamic configuration for a specific cluster (*PostAPIClustersClusterNameSettingsActionsApplyDynamicConfig*) + +``` +POST /api/clusters/{clusterName}/settings/actions/apply-dynamic-config +``` + +This endpoint applies dynamic configuration for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-settings-actions-apply-dynamic-config-200) | OK | Successfully applied dynamic configuration | | [schema](#post-api-clusters-cluster-name-settings-actions-apply-dynamic-config-200-schema) | +| [403](#post-api-clusters-cluster-name-settings-actions-apply-dynamic-config-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-settings-actions-apply-dynamic-config-403-schema) | +| [500](#post-api-clusters-cluster-name-settings-actions-apply-dynamic-config-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-settings-actions-apply-dynamic-config-500-schema) | + +#### Responses + + +##### 200 - Successfully applied dynamic configuration +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Reload client certificates for a specific cluster (*PostAPIClustersClusterNameSettingsActionsCertificatesReload*) + +``` +POST /api/clusters/{clusterName}/settings/actions/certificates-reload +``` + +This endpoint reloads the client certificates for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-settings-actions-certificates-reload-200) | OK | Successfully reloaded client certificates | | [schema](#post-api-clusters-cluster-name-settings-actions-certificates-reload-200-schema) | +| [403](#post-api-clusters-cluster-name-settings-actions-certificates-reload-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-settings-actions-certificates-reload-403-schema) | +| [500](#post-api-clusters-cluster-name-settings-actions-certificates-reload-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-settings-actions-certificates-reload-500-schema) | + +#### Responses + + +##### 200 - Successfully reloaded client certificates +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Discover settings for a specific cluster (*PostAPIClustersClusterNameSettingsActionsDiscover*) + +``` +POST /api/clusters/{clusterName}/settings/actions/discover +``` + +This endpoint triggers the discovery of settings for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-settings-actions-discover-200) | OK | Successfully discovered settings | | [schema](#post-api-clusters-cluster-name-settings-actions-discover-200-schema) | +| [403](#post-api-clusters-cluster-name-settings-actions-discover-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-settings-actions-discover-403-schema) | +| [500](#post-api-clusters-cluster-name-settings-actions-discover-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-settings-actions-discover-500-schema) | + +#### Responses + + +##### 200 - Successfully discovered settings +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Remove a tag from a specific cluster (*PostAPIClustersClusterNameSettingsActionsDropDbTagTagValue*) + +``` +POST /api/clusters/{clusterName}/settings/actions/drop-db-tag/{tagValue} +``` + +This endpoint removes a tag from the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| tagValue | `path` | string | `string` | | ✓ | | Tag Value | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-settings-actions-drop-db-tag-tag-value-200) | OK | Tag removed successfully | | [schema](#post-api-clusters-cluster-name-settings-actions-drop-db-tag-tag-value-200-schema) | +| [403](#post-api-clusters-cluster-name-settings-actions-drop-db-tag-tag-value-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-settings-actions-drop-db-tag-tag-value-403-schema) | +| [500](#post-api-clusters-cluster-name-settings-actions-drop-db-tag-tag-value-500) | Internal Server Error | Cluster Not Found | | [schema](#post-api-clusters-cluster-name-settings-actions-drop-db-tag-tag-value-500-schema) | + +#### Responses + + +##### 200 - Tag removed successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Remove a proxy tag from a specific cluster (*PostAPIClustersClusterNameSettingsActionsDropProxyTagTagValue*) + +``` +POST /api/clusters/{clusterName}/settings/actions/drop-proxy-tag/{tagValue} +``` + +This endpoint removes a proxy tag from the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| tagValue | `path` | string | `string` | | ✓ | | Tag Value | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-settings-actions-drop-proxy-tag-tag-value-200) | OK | Tag removed successfully | | [schema](#post-api-clusters-cluster-name-settings-actions-drop-proxy-tag-tag-value-200-schema) | +| [403](#post-api-clusters-cluster-name-settings-actions-drop-proxy-tag-tag-value-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-settings-actions-drop-proxy-tag-tag-value-403-schema) | +| [500](#post-api-clusters-cluster-name-settings-actions-drop-proxy-tag-tag-value-500) | Internal Server Error | Cluster Not Found | | [schema](#post-api-clusters-cluster-name-settings-actions-drop-proxy-tag-tag-value-500-schema) | + +#### Responses + + +##### 200 - Tag removed successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Reload cluster settings (*PostAPIClustersClusterNameSettingsActionsReload*) + +``` +POST /api/clusters/{clusterName}/settings/actions/reload +``` + +This endpoint reloads the settings for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-settings-actions-reload-200) | OK | Successfully reloaded settings | | [schema](#post-api-clusters-cluster-name-settings-actions-reload-200-schema) | +| [500](#post-api-clusters-cluster-name-settings-actions-reload-500) | Internal Server Error | Cluster Not Found | | [schema](#post-api-clusters-cluster-name-settings-actions-reload-500-schema) | + +#### Responses + + +##### 200 - Successfully reloaded settings +Status: OK + +###### Schema + + + + + +##### 500 - Cluster Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Reload Graphite filter list for a specific cluster (*PostAPIClustersClusterNameSettingsActionsReloadGraphiteFilterlist*) + +``` +POST /api/clusters/{clusterName}/settings/actions/reload-graphite-filterlist +``` + +This endpoint reloads the Graphite filter list for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-settings-actions-reload-graphite-filterlist-200) | OK | Successfully reloaded Graphite filter list | | [schema](#post-api-clusters-cluster-name-settings-actions-reload-graphite-filterlist-200-schema) | +| [403](#post-api-clusters-cluster-name-settings-actions-reload-graphite-filterlist-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-settings-actions-reload-graphite-filterlist-403-schema) | +| [500](#post-api-clusters-cluster-name-settings-actions-reload-graphite-filterlist-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-settings-actions-reload-graphite-filterlist-500-schema) | + +#### Responses + + +##### 200 - Successfully reloaded Graphite filter list +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Reset Graphite filter list for a specific cluster (*PostAPIClustersClusterNameSettingsActionsResetGraphiteFilterlistTemplate*) + +``` +POST /api/clusters/{clusterName}/settings/actions/reset-graphite-filterlist/{template} +``` + +This endpoint resets the Graphite filter list for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| template | `path` | string | `string` | | ✓ | | Template | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-settings-actions-reset-graphite-filterlist-template-200) | OK | Successfully reset Graphite filter list | | [schema](#post-api-clusters-cluster-name-settings-actions-reset-graphite-filterlist-template-200-schema) | +| [403](#post-api-clusters-cluster-name-settings-actions-reset-graphite-filterlist-template-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-settings-actions-reset-graphite-filterlist-template-403-schema) | +| [500](#post-api-clusters-cluster-name-settings-actions-reset-graphite-filterlist-template-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-settings-actions-reset-graphite-filterlist-template-500-schema) | + +#### Responses + + +##### 200 - Successfully reset Graphite filter list +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Set cron jobs for a specific cluster (*PostAPIClustersClusterNameSettingsActionsSetCronSettingNameSettingValue*) + +``` +POST /api/clusters/{clusterName}/settings/actions/set-cron/{settingName}/{settingValue} +``` + +This endpoint sets the cron jobs for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| settingName | `path` | string | `string` | | ✓ | | Setting Name | +| settingValue | `path` | string | `string` | | ✓ | | Setting Value | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-settings-actions-set-cron-setting-name-setting-value-200) | OK | Successfully set cron job | | [schema](#post-api-clusters-cluster-name-settings-actions-set-cron-setting-name-setting-value-200-schema) | +| [403](#post-api-clusters-cluster-name-settings-actions-set-cron-setting-name-setting-value-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-settings-actions-set-cron-setting-name-setting-value-403-schema) | +| [500](#post-api-clusters-cluster-name-settings-actions-set-cron-setting-name-setting-value-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-settings-actions-set-cron-setting-name-setting-value-500-schema) | + +#### Responses + + +##### 200 - Successfully set cron job +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Set Graphite filter list for a specific cluster (*PostAPIClustersClusterNameSettingsActionsSetGraphiteFilterlistFilterType*) + +``` +POST /api/clusters/{clusterName}/settings/actions/set-graphite-filterlist/{filterType} +``` + +This endpoint sets the Graphite filter list for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| filterType | `path` | string | `string` | | ✓ | | Filter Type | +| body | `body` | [ClusterGraphiteFilterList](#cluster-graphite-filter-list) | `models.ClusterGraphiteFilterList` | | ✓ | | Graphite Filter List | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-settings-actions-set-graphite-filterlist-filter-type-200) | OK | Filterlist updated | | [schema](#post-api-clusters-cluster-name-settings-actions-set-graphite-filterlist-filter-type-200-schema) | +| [403](#post-api-clusters-cluster-name-settings-actions-set-graphite-filterlist-filter-type-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-settings-actions-set-graphite-filterlist-filter-type-403-schema) | +| [500](#post-api-clusters-cluster-name-settings-actions-set-graphite-filterlist-filter-type-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-settings-actions-set-graphite-filterlist-filter-type-500-schema) | + +#### Responses + + +##### 200 - Filterlist updated +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Set settings for a specific cluster (*PostAPIClustersClusterNameSettingsActionsSetSettingNameSettingValue*) + +``` +POST /api/clusters/{clusterName}/settings/actions/set/{settingName}/{settingValue} +``` + +This endpoint sets the settings for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| settingName | `path` | string | `string` | | ✓ | | Setting Name | +| settingValue | `path` | string | `string` | | ✓ | | Setting Value | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-settings-actions-set-setting-name-setting-value-200) | OK | Successfully set setting | | [schema](#post-api-clusters-cluster-name-settings-actions-set-setting-name-setting-value-200-schema) | +| [403](#post-api-clusters-cluster-name-settings-actions-set-setting-name-setting-value-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-settings-actions-set-setting-name-setting-value-403-schema) | +| [500](#post-api-clusters-cluster-name-settings-actions-set-setting-name-setting-value-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-settings-actions-set-setting-name-setting-value-500-schema) | + +#### Responses + + +##### 200 - Successfully set setting +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Switch settings for a specific cluster (*PostAPIClustersClusterNameSettingsActionsSwitchSettingName*) + +``` +POST /api/clusters/{clusterName}/settings/actions/switch/{settingName} +``` + +This endpoint switches the settings for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| settingName | `path` | string | `string` | | ✓ | | Setting Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-settings-actions-switch-setting-name-200) | OK | Successfully switched setting | | [schema](#post-api-clusters-cluster-name-settings-actions-switch-setting-name-200-schema) | +| [403](#post-api-clusters-cluster-name-settings-actions-switch-setting-name-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-settings-actions-switch-setting-name-403-schema) | +| [500](#post-api-clusters-cluster-name-settings-actions-switch-setting-name-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-cluster-name-settings-actions-switch-setting-name-500-schema) | + +#### Responses + + +##### 200 - Successfully switched setting +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Subscribe a user to a cluster (*PostAPIClustersClusterNameSubscribe*) + +``` +POST /api/clusters/{clusterName}/subscribe +``` + +This endpoint allows a user to subscribe to a specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| userform | `body` | [ClusterUserForm](#cluster-user-form) | `models.ClusterUserForm` | | ✓ | | User Form | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-subscribe-200) | OK | Email sent to admin! | | [schema](#post-api-clusters-cluster-name-subscribe-200-schema) | +| [400](#post-api-clusters-cluster-name-subscribe-400) | Bad Request | Error in request | | [schema](#post-api-clusters-cluster-name-subscribe-400-schema) | +| [401](#post-api-clusters-cluster-name-subscribe-401) | Unauthorized | Error logging in to gitlab: Token credentials is not valid | | [schema](#post-api-clusters-cluster-name-subscribe-401-schema) | +| [403](#post-api-clusters-cluster-name-subscribe-403) | Forbidden | Error parsing JWT" / "Current user is not logged in via Gitlab! | | [schema](#post-api-clusters-cluster-name-subscribe-403-schema) | +| [409](#post-api-clusters-cluster-name-subscribe-409) | Conflict | User already subscribed on peer cluster!" / "Another user already subscribed on peer cluster! | | [schema](#post-api-clusters-cluster-name-subscribe-409-schema) | +| [500](#post-api-clusters-cluster-name-subscribe-500) | Internal Server Error | No valid cluster" / "Peer does not have cloud18 setup!" / "Error sending email | | [schema](#post-api-clusters-cluster-name-subscribe-500-schema) | + +#### Responses + + +##### 200 - Email sent to admin! +Status: OK + +###### Schema + + + + + +##### 400 - Error in request +Status: Bad Request + +###### Schema + + + + + +##### 401 - Error logging in to gitlab: Token credentials is not valid +Status: Unauthorized + +###### Schema + + + + + +##### 403 - Error parsing JWT" / "Current user is not logged in via Gitlab! +Status: Forbidden + +###### Schema + + + + + +##### 409 - User already subscribed on peer cluster!" / "Another user already subscribed on peer cluster! +Status: Conflict + +###### Schema + + + + + +##### 500 - No valid cluster" / "Peer does not have cloud18 setup!" / "Error sending email +Status: Internal Server Error + +###### Schema + + + + + +### Run all tests for a given cluster (*PostAPIClustersClusterNameTestsActionsRunAll*) + +``` +POST /api/clusters/{clusterName}/tests/actions/run/all +``` + +This endpoint runs all tests for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-tests-actions-run-all-200) | OK | List of test results | | [schema](#post-api-clusters-cluster-name-tests-actions-run-all-200-schema) | +| [403](#post-api-clusters-cluster-name-tests-actions-run-all-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-tests-actions-run-all-403-schema) | +| [500](#post-api-clusters-cluster-name-tests-actions-run-all-500) | Internal Server Error | Cluster Not Found | | [schema](#post-api-clusters-cluster-name-tests-actions-run-all-500-schema) | + +#### Responses + + +##### 200 - List of test results +Status: OK + +###### Schema + + + +[][ClusterTest](#cluster-test) + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Run a specific test for a given cluster (*PostAPIClustersClusterNameTestsActionsRunTestName*) + +``` +POST /api/clusters/{clusterName}/tests/actions/run/{testName} +``` + +This endpoint runs a specific test for the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| testName | `path` | string | `string` | | ✓ | | Test Name | +| provision | `formData` | string | `string` | | | | Provision the cluster before running the test | +| unprovision | `formData` | string | `string` | | | | Unprovision the cluster after running the test | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-tests-actions-run-test-name-200) | OK | Test result | | [schema](#post-api-clusters-cluster-name-tests-actions-run-test-name-200-schema) | +| [403](#post-api-clusters-cluster-name-tests-actions-run-test-name-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-tests-actions-run-test-name-403-schema) | +| [500](#post-api-clusters-cluster-name-tests-actions-run-test-name-500) | Internal Server Error | Cluster Not Found | | [schema](#post-api-clusters-cluster-name-tests-actions-run-test-name-500-schema) | + +#### Responses + + +##### 200 - Test result +Status: OK + +###### Schema + + + +[ClusterTest](#cluster-test) + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Add a new user to a cluster (*PostAPIClustersClusterNameUsersAdd*) + +``` +POST /api/clusters/{clusterName}/users/add +``` + +Adds a new user to the specified cluster if the request is valid and the user has the necessary permissions. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| userform | `body` | [ClusterUserForm](#cluster-user-form) | `models.ClusterUserForm` | | ✓ | | User Form | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-users-add-200) | OK | User added successfully | | [schema](#post-api-clusters-cluster-name-users-add-200-schema) | +| [400](#post-api-clusters-cluster-name-users-add-400) | Bad Request | Error in request | | [schema](#post-api-clusters-cluster-name-users-add-400-schema) | +| [403](#post-api-clusters-cluster-name-users-add-403) | Forbidden | No Valid ACL | | [schema](#post-api-clusters-cluster-name-users-add-403-schema) | +| [500](#post-api-clusters-cluster-name-users-add-500) | Internal Server Error | Error adding new user" or "No valid cluster | | [schema](#post-api-clusters-cluster-name-users-add-500-schema) | + +#### Responses + + +##### 200 - User added successfully +Status: OK + +###### Schema + + + + + +##### 400 - Error in request +Status: Bad Request + +###### Schema + + + + + +##### 403 - No Valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Error adding new user" or "No valid cluster +Status: Internal Server Error + +###### Schema + + + + + +### Drop a cluster user (*PostAPIClustersClusterNameUsersDrop*) + +``` +POST /api/clusters/{clusterName}/users/drop +``` + +Drops a user from the specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| userform | `body` | [ClusterUserForm](#cluster-user-form) | `models.ClusterUserForm` | | ✓ | | User Form | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-users-drop-200) | OK | User dropped successfully | | [schema](#post-api-clusters-cluster-name-users-drop-200-schema) | +| [400](#post-api-clusters-cluster-name-users-drop-400) | Bad Request | Error in request | | [schema](#post-api-clusters-cluster-name-users-drop-400-schema) | +| [403](#post-api-clusters-cluster-name-users-drop-403) | Forbidden | No Valid ACL | | [schema](#post-api-clusters-cluster-name-users-drop-403-schema) | +| [500](#post-api-clusters-cluster-name-users-drop-500) | Internal Server Error | Error dropping user" or "No valid cluster | | [schema](#post-api-clusters-cluster-name-users-drop-500-schema) | + +#### Responses + + +##### 200 - User dropped successfully +Status: OK + +###### Schema + + + + + +##### 400 - Error in request +Status: Bad Request + +###### Schema + + + + + +##### 403 - No Valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Error dropping user" or "No valid cluster +Status: Internal Server Error + +###### Schema + + + + + +### Send credentials to a specific user (*PostAPIClustersClusterNameUsersSendCredentials*) + +``` +POST /api/clusters/{clusterName}/users/send-credentials +``` + +This endpoint sends the credentials to the specified user via email. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| body | `body` | [ServerCredentialMailForm](#server-credential-mail-form) | `models.ServerCredentialMailForm` | | ✓ | | Credential Mail Form | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-users-send-credentials-200) | OK | Credentials sent to user! | | [schema](#post-api-clusters-cluster-name-users-send-credentials-200-schema) | +| [403](#post-api-clusters-cluster-name-users-send-credentials-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-cluster-name-users-send-credentials-403-schema) | +| [500](#post-api-clusters-cluster-name-users-send-credentials-500) | Internal Server Error | Error sending email | | [schema](#post-api-clusters-cluster-name-users-send-credentials-500-schema) | + +#### Responses + + +##### 200 - Credentials sent to user! +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Error sending email +Status: Internal Server Error + +###### Schema + + + + + +### Update a cluster user (*PostAPIClustersClusterNameUsersUpdate*) + +``` +POST /api/clusters/{clusterName}/users/update +``` + +Updates the user information for a specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| userform | `body` | [ClusterUserForm](#cluster-user-form) | `models.ClusterUserForm` | | ✓ | | User Form | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-cluster-name-users-update-200) | OK | User updated successfully | | [schema](#post-api-clusters-cluster-name-users-update-200-schema) | +| [400](#post-api-clusters-cluster-name-users-update-400) | Bad Request | Error in request | | [schema](#post-api-clusters-cluster-name-users-update-400-schema) | +| [403](#post-api-clusters-cluster-name-users-update-403) | Forbidden | No Valid ACL | | [schema](#post-api-clusters-cluster-name-users-update-403-schema) | +| [500](#post-api-clusters-cluster-name-users-update-500) | Internal Server Error | Error updating user" or "No valid cluster | | [schema](#post-api-clusters-cluster-name-users-update-500-schema) | + +#### Responses + + +##### 200 - User updated successfully +Status: OK + +###### Schema + + + + + +##### 400 - Error in request +Status: Bad Request + +###### Schema + + + + + +##### 403 - No Valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Error updating user" or "No valid cluster +Status: Internal Server Error + +###### Schema + + + + + +### Reload cluster plans (*PostAPIClustersSettingsActionsReloadClustersPlans*) + +``` +POST /api/clusters/settings/actions/reload-clusters-plans +``` + +This endpoint reloads the cluster plans for all clusters. + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-settings-actions-reload-clusters-plans-200) | OK | Successfully reloaded plans | | [schema](#post-api-clusters-settings-actions-reload-clusters-plans-200-schema) | +| [403](#post-api-clusters-settings-actions-reload-clusters-plans-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-settings-actions-reload-clusters-plans-403-schema) | +| [500](#post-api-clusters-settings-actions-reload-clusters-plans-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-settings-actions-reload-clusters-plans-500-schema) | + +#### Responses + + +##### 200 - Successfully reloaded plans +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Set global settings for the server (*PostAPIClustersSettingsActionsSetSettingNameSettingValue*) + +``` +POST /api/clusters/settings/actions/set/{settingName}/{settingValue} +``` + +This endpoint sets the global settings for the server. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | | | Cluster Name | +| settingName | `path` | string | `string` | | ✓ | | Setting Name | +| settingValue | `path` | string | `string` | | ✓ | | Setting Value | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-settings-actions-set-setting-name-setting-value-200) | OK | Successfully set setting | | [schema](#post-api-clusters-settings-actions-set-setting-name-setting-value-200-schema) | +| [403](#post-api-clusters-settings-actions-set-setting-name-setting-value-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-settings-actions-set-setting-name-setting-value-403-schema) | +| [500](#post-api-clusters-settings-actions-set-setting-name-setting-value-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-settings-actions-set-setting-name-setting-value-500-schema) | + +#### Responses + + +##### 200 - Successfully set setting +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### Switch global settings for the server (*PostAPIClustersSettingsActionsSwitchSettingName*) + +``` +POST /api/clusters/settings/actions/switch/{settingName} +``` + +This endpoint switches the global settings for the server. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | | | Cluster Name | +| settingName | `path` | string | `string` | | ✓ | | Setting Name | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-clusters-settings-actions-switch-setting-name-200) | OK | Successfully switched setting | | [schema](#post-api-clusters-settings-actions-switch-setting-name-200-schema) | +| [403](#post-api-clusters-settings-actions-switch-setting-name-403) | Forbidden | No valid ACL | | [schema](#post-api-clusters-settings-actions-switch-setting-name-403-schema) | +| [500](#post-api-clusters-settings-actions-switch-setting-name-500) | Internal Server Error | No cluster | | [schema](#post-api-clusters-settings-actions-switch-setting-name-500-schema) | + +#### Responses + + +##### 200 - Successfully switched setting +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - No cluster +Status: Internal Server Error + +###### Schema + + + + + +### User login (*PostAPILogin*) + +``` +POST /api/login +``` + +Authenticates a user and returns a JWT token upon successful login. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| userCredentials | `body` | [ServerUserCredentials](#server-user-credentials) | `models.ServerUserCredentials` | | ✓ | | User credentials | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-api-login-200) | OK | JWT token | | [schema](#post-api-login-200-schema) | +| [401](#post-api-login-401) | Unauthorized | Invalid credentials | | [schema](#post-api-login-401-schema) | +| [403](#post-api-login-403) | Forbidden | Error in request | | [schema](#post-api-login-403-schema) | +| [429](#post-api-login-429) | Too Many Requests | Too many requests | | [schema](#post-api-login-429-schema) | +| [500](#post-api-login-500) | Internal Server Error | Error signing token | | [schema](#post-api-login-500-schema) | + +#### Responses + + +##### 200 - JWT token +Status: OK + +###### Schema + + + +[ServerToken](#server-token) + +##### 401 - Invalid credentials +Status: Unauthorized + +###### Schema + + + + + +##### 403 - Error in request +Status: Forbidden + +###### Schema + + + + + +##### 429 - Too many requests +Status: Too Many Requests + +###### Schema + + + + + +##### 500 - Error signing token +Status: Internal Server Error + +###### Schema + + + + + +### Drop a server monitor from a cluster (*PostClusterClusterNameActionsDropserverHostPort*) + +``` +POST /cluster/{clusterName}/actions/dropserver/{host}/{port} +``` + +This endpoint allows dropping a server monitor or proxy monitor from a specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| host | `path` | string | `string` | | ✓ | | Host | +| port | `path` | string | `string` | | ✓ | | Port | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-cluster-cluster-name-actions-dropserver-host-port-200) | OK | Monitor dropped successfully | | [schema](#post-cluster-cluster-name-actions-dropserver-host-port-200-schema) | +| [403](#post-cluster-cluster-name-actions-dropserver-host-port-403) | Forbidden | No valid ACL | | [schema](#post-cluster-cluster-name-actions-dropserver-host-port-403-schema) | +| [500](#post-cluster-cluster-name-actions-dropserver-host-port-500) | Internal Server Error | Cluster Not Found | | [schema](#post-cluster-cluster-name-actions-dropserver-host-port-500-schema) | + +#### Responses + + +##### 200 - Monitor dropped successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found +Status: Internal Server Error + +###### Schema + + + + + +### Drop a server monitor from a cluster (*PostClusterClusterNameActionsDropserverHostPortType*) + +``` +POST /cluster/{clusterName}/actions/dropserver/{host}/{port}/{type} +``` + +This endpoint allows dropping a server monitor or proxy monitor from a specified cluster. + +#### Consumes + * application/json + +#### Produces + * application/json + +#### Parameters + +| Name | Source | Type | Go type | Separator | Required | Default | Description | +|------|--------|------|---------|-----------| :------: |---------|-------------| +| clusterName | `path` | string | `string` | | ✓ | | Cluster Name | +| host | `path` | string | `string` | | ✓ | | Host | +| port | `path` | string | `string` | | ✓ | | Port | +| type | `path` | string | `string` | | | | Monitor Type (proxy or database) | + +#### All responses +| Code | Status | Description | Has headers | Schema | +|------|--------|-------------|:-----------:|--------| +| [200](#post-cluster-cluster-name-actions-dropserver-host-port-type-200) | OK | Monitor dropped successfully | | [schema](#post-cluster-cluster-name-actions-dropserver-host-port-type-200-schema) | +| [403](#post-cluster-cluster-name-actions-dropserver-host-port-type-403) | Forbidden | No valid ACL | | [schema](#post-cluster-cluster-name-actions-dropserver-host-port-type-403-schema) | +| [500](#post-cluster-cluster-name-actions-dropserver-host-port-type-500) | Internal Server Error | Cluster Not Found | | [schema](#post-cluster-cluster-name-actions-dropserver-host-port-type-500-schema) | + +#### Responses + + +##### 200 - Monitor dropped successfully +Status: OK + +###### Schema + + + + + +##### 403 - No valid ACL +Status: Forbidden + +###### Schema + + + + + +##### 500 - Cluster Not Found +Status: Internal Server Error + +###### Schema + + + + + +## Models + +### cluster.APIUser + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| grants | map of boolean| `map[string]bool` | | | | | +| roles | map of boolean| `map[string]bool` | | | | | +| user | string| `string` | | | | | + + + +### cluster.Agent + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| cpuCores | integer| `int64` | | | | | +| cpuFreq | integer| `int64` | | | | | +| hostName | string| `string` | | | | | +| id | string| `string` | | | | | +| memBytes | integer| `int64` | | | | | +| memFreeBytes | integer| `int64` | | | | | +| osKernel | string| `string` | | | | | +| osName | string| `string` | | | | | +| status | string| `string` | | | | | +| version | string| `string` | | | | | + + + +### cluster.Alerts + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| errors | [][StateStateHTTP](#state-state-http)| `[]*StateStateHTTP` | | | | | +| warnings | [][StateStateHTTP](#state-state-http)| `[]*StateStateHTTP` | | | | | + + + +### cluster.Cluster + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| activePassiveStatus | string| `string` | | | | | +| agents | [][ClusterAgent](#cluster-agent)| `[]*ClusterAgent` | | | | | +| apiUsers | map of [ClusterAPIUser](#cluster-api-user)| `map[string]ClusterAPIUser` | | | | | +| backupList | [ConfigBackupMetaMap](#config-backup-meta-map)| `ConfigBackupMetaMap` | | | | | +| backupStat | [Repmanv3BackupStat](#repmanv3-backup-stat)| `Repmanv3BackupStat` | | | | | +| blacklist | [][RegexpRegexp](#regexp-regexp)| `[]RegexpRegexp` | | | | | +| canConnectVault | boolean| `bool` | | | | | +| canInitNodes | boolean| `bool` | | | | | +| cleanReplication | boolean| `bool` | | | used in testing | | +| config | [GithubComSignal18ReplicationManagerConfigConfig](#github-com-signal18-replication-manager-config-config)| `GithubComSignal18ReplicationManagerConfigConfig` | | | | | +| configurator | [ConfiguratorConfigurator](#configurator-configurator)| `ConfiguratorConfigurator` | | | | | +| dbServers | []string| `[]string` | | | | | +| dbServersCrashes | [][ClusterCrash](#cluster-crash)| `[]*ClusterCrash` | | | This will be purged on all db node up | | +| diffVariables | [][ClusterVariableDiff](#cluster-variable-diff)| `[]*ClusterVariableDiff` | | | | | +| diskType | map of string| `map[string]string` | | | | | +| failoverCounter | integer| `int64` | | | | | +| failoverHistory | [][ClusterCrash](#cluster-crash)| `[]*ClusterCrash` | | | This will be used for PITR | | +| failoverLastTime | integer| `int64` | | | | | +| fsType | map of boolean| `map[string]bool` | | | | | +| haveDBTLSCert | boolean| `bool` | | | | | +| haveDBTLSOldCert | boolean| `bool` | | | | | +| inBinlogBackup | boolean| `bool` | | | | | +| inLogicalBackup | boolean| `bool` | | | | | +| inPhysicalBackup | boolean| `bool` | | | | | +| inResticBackup | boolean| `bool` | | | | | +| inRollingRestart | boolean| `bool` | | | | | +| isAlertDisable | boolean| `bool` | | | | | +| isAllDbUp | boolean| `bool` | | | | | +| isCapturing | boolean| `bool` | | | | | +| isClusterDown | boolean| `bool` | | | | | +| isDown | boolean| `bool` | | | | | +| isExportPush | boolean| `bool` | | | | | +| isFailable | boolean| `bool` | | | | | +| isFailedArbitrator | boolean| `bool` | | | | | +| isGettingSlowLog | boolean| `bool` | | | | | +| isGitPull | boolean| `bool` | | | | | +| isGitPush | boolean| `bool` | | | | | +| isLostMajority | boolean| `bool` | | | | | +| isMasterDown | boolean| `bool` | | | | | +| isNeedDatabasesConfigChange | boolean| `bool` | | | | | +| isNeedDatabasesReprov | boolean| `bool` | | | | | +| isNeedDatabasesRestart | boolean| `bool` | | | | | +| isNeedDatabasesRollingReprov | boolean| `bool` | | | | | +| isNeedDatabasesRollingRestart | boolean| `bool` | | | | | +| isNeedProxiesConfigChange | boolean| `bool` | | | | | +| isNeedProxiesRestart | boolean| `bool` | | | | | +| isNeedProxyRestart | boolean| `bool` | | | | | +| isNotMonitoring | boolean| `bool` | | | | | +| isPostgres | boolean| `bool` | | | | | +| isProvision | boolean| `bool` | | | | | +| isSplitBrain | boolean| `bool` | | | | | +| isValidBackup | boolean| `bool` | | | | | +| jobResults | [ConfigTasksMap](#config-tasks-map)| `ConfigTasksMap` | | | | | +| lastDelayStatPrint | string| `string` | | | | | +| log | [S18logHTTPLog](#s18log-http-log)| `S18logHTTPLog` | | | | | +| logTask | [S18logHTTPLog](#s18log-http-log)| `S18logHTTPLog` | | | | | +| monitorSpin | string| `string` | | | | | +| monitorType | map of string| `map[string]string` | | | | | +| name | string| `string` | | | | | +| proxyServers | []string| `[]string` | | | | | +| slaHistory | [][StateSLA](#state-sla)| `[]*StateSLA` | | | | | +| slavesConnected | integer| `int64` | | | | | +| slavesOldestMasterFile | [ClusterSlavesOldestMasterFile](#cluster-slaves-oldest-master-file)| `ClusterSlavesOldestMasterFile` | | | | | +| sqlErrorLog | [S18logHTTPLog](#s18log-http-log)| `S18logHTTPLog` | | | | | +| sqlGeneralLog | [S18logHTTPLog](#s18log-http-log)| `S18logHTTPLog` | | | | | +| sstAvailablePorts | map of string| `map[string]string` | | | | | +| stateMachine | [ClusterCluster](#cluster-cluster)| `ClusterCluster` | | | dbUser string `json:"-"`
oldDbUser string `json:"-"`
dbPass string `json:"-"`
oldDbPass string `json:"-"`
rplUser string `json:"-"`
rplPass string `json:"-"`
proxysqlUser string `json:"-"`
proxysqlPass string `json:"-"` | | +| tenant | string| `string` | | | | | +| topology | string| `string` | | | | | +| topologyType | map of string| `map[string]string` | | | | | +| uptime | string| `string` | | | | | +| uptimeFailable | string| `string` | | | | | +| uptimeSemisync | string| `string` | | | | | +| useBlacklist | boolean| `bool` | | | | | +| useWhitelist | boolean| `bool` | | | | | +| versionsMap | [ConfigVersionsMap](#config-versions-map)| `ConfigVersionsMap` | | | | | +| vmType | map of boolean| `map[string]bool` | | | | | +| waitingFailover | integer| `int64` | | | | | +| waitingRejoin | integer| `int64` | | | | | +| waitingSwitchover | integer| `int64` | | | | | +| whitelist | [][RegexpRegexp](#regexp-regexp)| `[]RegexpRegexp` | | | | | +| workLoad | [ConfigWorkLoad](#config-work-load)| `ConfigWorkLoad` | | | | | +| workingDir | string| `string` | | | | | + + + +### cluster.ClusterForm + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| clusterName | string| `string` | | | | | +| orchestrator | string| `string` | | | | | +| plan | string| `string` | | | | | + + + +### cluster.Crash + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| electedMasterURL | string| `string` | | | | | +| failoverIOGtid | [][GtidGtid](#gtid-gtid)| `[]*GtidGtid` | | | | | +| failoverMasterLogFile | string| `string` | | | | | +| failoverMasterLogPos | string| `string` | | | | | +| failoverSemiSyncSlaveStatus | boolean| `bool` | | | | | +| newMasterLogFile | string| `string` | | | | | +| newMasterLogPos | string| `string` | | | | | +| switchover | boolean| `bool` | | | | | +| unixTimestamp | integer| `int64` | | | | | +| url | string| `string` | | | | | + + + +### cluster.DelayStat + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| counter | integer| `int64` | | | Increment | | +| delay | number| `float64` | | | Average Seconds of Delay | | +| delayCount | integer| `int64` | | | Number of Delay Occurred | | +| slaveErrCount | integer| `int64` | | | Number of Slave Err Occurred | | + + + +### cluster.DelayStatHistory + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| delayDT | string| `string` | | | | | +| delayStat | [ClusterDelayStat](#cluster-delay-stat)| `ClusterDelayStat` | | | | | + + + +### cluster.Diff + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| serverName | string| `string` | | | | | +| variableValue | string| `string` | | | | | + + + +### cluster.GraphiteFilterList + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| blacklist | string| `string` | | | | | +| whitelist | string| `string` | | | | | + + + +### cluster.ServerBackupMeta + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| logical | [ConfigBackupMetadata](#config-backup-metadata)| `ConfigBackupMetadata` | | | | | +| physical | [ConfigBackupMetadata](#config-backup-metadata)| `ConfigBackupMetadata` | | | | | + + + +### cluster.ServerDelayStat + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| current | [ClusterDelayStat](#cluster-delay-stat)| `ClusterDelayStat` | | | | | +| currentDT | string| `string` | | | | | +| delayHistory | [][ClusterDelayStatHistory](#cluster-delay-stat-history)| `[]*ClusterDelayStatHistory` | | | | | +| rotated | [ClusterDelayStat](#cluster-delay-stat)| `ClusterDelayStat` | | | | | +| total | [ClusterServerDelayStat](#cluster-server-delay-stat)| `ClusterServerDelayStat` | | | Total Delay Average since SRM started | | + + + +### cluster.ServerMonitor + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| HaveBinlogSlaveUpdates | boolean| `bool` | | | | | +| HaveHealthyReplica | boolean| `bool` | | | | | +| HaveSshError | boolean| `bool` | | | | | +| agent | string| `string` | | | used to provision service in orchestrator | | +| binaryLogDir | string| `string` | | | | | +| binaryLogFile | string| `string` | | | | | +| binaryLogFileOldest | string| `string` | | | | | +| binaryLogFilePrevious | string| `string` | | | | | +| binaryLogFiles | [DbhelperBinaryLogMetaMap](#dbhelper-binary-log-meta-map)| `DbhelperBinaryLogMetaMap` | | | | | +| binaryLogFilesCount | integer| `int64` | | | | | +| binaryLogOldestTimestamp | integer| `int64` | | | | | +| binaryLogPos | string| `string` | | | | | +| binaryLogPurgeBefore | integer| `int64` | | | | | +| binlogDumpThreads | integer| `int64` | | | | | +| currentGtid | [][GtidGtid](#gtid-gtid)| `[]*GtidGtid` | | | | | +| datadir | string| `string` | | | | | +| dbVersion | [VersionVersion](#version-version)| `VersionVersion` | | | | | +| dbdataDir | string| `string` | | | | | +| delayStat | [ClusterServerDelayStat](#cluster-server-delay-stat)| `ClusterServerDelayStat` | | | | | +| domain | string| `string` | | | Use to store orchestrator CNI domain ..svc. | | +| domainId | integer| `int64` | | | | | +| engineInnodb | [ConfigStringsMap](#config-strings-map)| `ConfigStringsMap` | | | | | +| errorLog | [S18logHTTPLog](#s18log-http-log)| `S18logHTTPLog` | | | | | +| eventScheduler | boolean| `bool` | | | | | +| eventStatus | [][DbhelperEvent](#dbhelper-event)| `[]*DbhelperEvent` | | | | | +| failCount | integer| `int64` | | | | | +| failSuspectHeartbeat | integer| `int64` | | | | | +| failoverIoGtid | [][GtidGtid](#gtid-gtid)| `[]*GtidGtid` | | | | | +| failoverMasterLogFile | string| `string` | | | | | +| failoverMasterLogPos | string| `string` | | | | | +| failoverSemiSyncSlaveStatus | boolean| `bool` | | | | | +| gtidBinlogPos | [][GtidGtid](#gtid-gtid)| `[]*GtidGtid` | | | | | +| gtidExecuted | string| `string` | | | | | +| hashUUID | integer| `int64` | | | | | +| haveBinLogSync | boolean| `bool` | | | | | +| haveBinlog | boolean| `bool` | | | | | +| haveBinlogAnnotate | boolean| `bool` | | | | | +| haveBinlogCompress | boolean| `bool` | | | | | +| haveBinlogMixed | boolean| `bool` | | | | | +| haveBinlogRow | boolean| `bool` | | | | | +| haveBinlogSlowqueries | boolean| `bool` | | | | | +| haveBinlogStatement | boolean| `bool` | | | | | +| haveDiskMonitor | boolean| `bool` | | | | | +| haveGtidStrictMode | boolean| `bool` | | | | | +| haveInnodbChecksum | boolean| `bool` | | | | | +| haveInnodbTrxCommit | boolean| `bool` | | | | | +| haveLogGeneral | boolean| `bool` | | | | | +| haveMariadbGtid | boolean| `bool` | | | | | +| haveMetaDataLocksLog | boolean| `bool` | | | | | +| haveMysqlGtid | boolean| `bool` | | | | | +| haveNoMasterOnStart | boolean| `bool` | | | | | +| havePFS | boolean| `bool` | | | | | +| havePFSSlowQueryLog | boolean| `bool` | | | | | +| haveQueryResponseTimeLog | boolean| `bool` | | | | | +| haveReadOnly | boolean| `bool` | | | | | +| haveSQLErrorLog | boolean| `bool` | | | | | +| haveSemiSync | boolean| `bool` | | | | | +| haveSlaveAggressive | boolean| `bool` | | | | | +| haveSlaveConservative | boolean| `bool` | | | | | +| haveSlaveIdempotent | boolean| `bool` | | | | | +| haveSlaveMinimal | boolean| `bool` | | | | | +| haveSlaveOptimistic | boolean| `bool` | | | | | +| haveSlaveSerialized | boolean| `bool` | | | | | +| haveSlowQueryLog | boolean| `bool` | | | | | +| haveWsrep | boolean| `bool` | | | | | +| host | string| `string` | | | | | +| id | string| `string` | | | Unique name given by cluster & crc64(URL) used by test to provision | | +| ignored | boolean| `bool` | | | | | +| ignoredRO | boolean| `bool` | | | | | +| inCaptureMode | boolean| `bool` | | | | | +| inPurgingBinaryLog | boolean| `bool` | | | | | +| ioGtid | [][GtidGtid](#gtid-gtid)| `[]*GtidGtid` | | | | | +| ip | string| `string` | | | | | +| isBackingUpBinaryLog | boolean| `bool` | | | | | +| isCompute | boolean| `bool` | | | Used to idenfied spider compute nide | | +| isConfigGen | boolean| `bool` | | | | | +| isDelayed | boolean| `bool` | | | | | +| isFull | boolean| `bool` | | | | | +| isGroupReplicationMaster | boolean| `bool` | | | | | +| isGroupReplicationSlave | boolean| `bool` | | | | | +| isInPFSQueryCapture | boolean| `bool` | | | | | +| isInSlowQueryCapture | boolean| `bool` | | | | | +| isLoadingJobList | boolean| `bool` | | | | | +| isMaintenance | boolean| `bool` | | | | | +| isMaxscale | boolean| `bool` | | | | | +| isRefreshingBinlog | boolean| `bool` | | | | | +| isRefreshingBinlogMeta | boolean| `bool` | | | | | +| isRelay | boolean| `bool` | | | | | +| isReseeding | string| `string` | | | | | +| isSlave | boolean| `bool` | | | | | +| isVirtualMaster | boolean| `bool` | | | | | +| isWsrepDonor | boolean| `bool` | | | | | +| isWsrepPrimary | boolean| `bool` | | | | | +| isWsrepSync | boolean| `bool` | | | | | +| jobResults | [ConfigTasksMap](#config-tasks-map)| `ConfigTasksMap` | | | | | +| lastBackupMeta | [ClusterServerBackupMeta](#cluster-server-backup-meta)| `ClusterServerBackupMeta` | | | | | +| lastSeenReplications | [][DbhelperSlaveStatus](#dbhelper-slave-status)| `[]*DbhelperSlaveStatus` | | | | | +| logOutput | string| `string` | | | | | +| longQueryTime | string| `string` | | | | | +| longQueryTimeSaved | string| `string` | | | | | +| masterStatus | [DbhelperMasterStatus](#dbhelper-master-status)| `DbhelperMasterStatus` | | | | | +| maxSlowQueryTimestamp | integer| `int64` | | | | | +| maxscaleHaveGtid | boolean| `bool` | | | | | +| maxscaleServerName | string| `string` | | | Unique server Name in maxscale conf | | +| maxscaleServerStatus | string| `string` | | | | | +| maxscaleVersion | integer| `int64` | | | | | +| name | string| `string` | | | | | +| needRefreshJobs | boolean| `bool` | | | | | +| pointInTimeMeta | [ConfigPointInTimeMeta](#config-point-in-time-meta)| `ConfigPointInTimeMeta` | | | | | +| port | string| `string` | | | | | +| postgressDB | string| `string` | | | | | +| prefered | boolean| `bool` | | | | | +| preferedBackup | boolean| `bool` | | | | | +| prevState | string| `string` | | | | | +| process | [OsProcess](#os-process)| `OsProcess` | | | | | +| proxysqlHostgroup | string| `string` | | | | | +| qps | integer| `int64` | | | | | +| readOnly | string| `string` | | | | | +| relayLogSize | integer| `int64` | | | | | +| replicationHealth | string| `string` | | | | | +| replicationSourceName | string| `string` | | | | | +| replicationTags | string| `string` | | | | | +| replications | [][DbhelperSlaveStatus](#dbhelper-slave-status)| `[]*DbhelperSlaveStatus` | | | | | +| semiSyncMasterStatus | boolean| `bool` | | | | | +| semiSyncSlaveStatus | boolean| `bool` | | | | | +| serverId | integer| `int64` | | | | | +| serviceName | string| `string` | | | | | +| slaposDatadir | string| `string` | | | | | +| slaveGtid | [][GtidGtid](#gtid-gtid)| `[]*GtidGtid` | | | | | +| slaveVariables | [ClusterSlaveVariables](#cluster-slave-variables)| `ClusterSlaveVariables` | | | | | +| slowQueryCapture | boolean| `bool` | | | | | +| slowQueryLog | string| `string` | | | | | +| sourceClusterName | string| `string` | | | Used to idenfied server added from other clusters linked with multi source | | +| sstPort | string| `string` | | | used to send data to dbjobs | | +| state | string| `string` | | | | | +| strict | string| `string` | | | | | +| tlsConfigUsed | string| `string` | | | used to track TLS config during key rotation | | +| tunnelPort | string| `string` | | | | | +| url | string| `string` | | | | | +| user | string| `string` | | | | | +| workLoad | [ConfigWorkLoadsMap](#config-work-loads-map)| `ConfigWorkLoadsMap` | | | | | + + + +### cluster.SlaveVariables + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| slaveParallelMaxQueued | integer| `int64` | | | | | +| slaveParallelMode | string| `string` | | | | | +| slaveParallelThreads | integer| `int64` | | | | | +| slaveParallelWorkers | integer| `int64` | | | | | +| slaveTypeConversions | string| `string` | | | | | + + + +### cluster.SlavesOldestMasterFile + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| oldestTimestamp | string| `string` | | | | | +| prefix | string| `string` | | | | | +| suffix | integer| `int64` | | | | | + + + +### cluster.Test + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| config-file | string| `string` | | | | | +| config-init | [GithubComSignal18ReplicationManagerConfigConfig](#github-com-signal18-replication-manager-config-config)| `GithubComSignal18ReplicationManagerConfigConfig` | | | | | +| config-test | [GithubComSignal18ReplicationManagerConfigConfig](#github-com-signal18-replication-manager-config-config)| `GithubComSignal18ReplicationManagerConfigConfig` | | | | | +| name | string| `string` | | | | | +| result | string| `string` | | | | | + + + +### cluster.UserForm + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| grants | string| `string` | | | | | +| password | string| `string` | | | | | +| roles | string| `string` | | | | | +| username | string| `string` | | | | | + + + +### cluster.VariableDiff + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| diffValues | [][ClusterDiff](#cluster-diff)| `[]*ClusterDiff` | | | | | +| variableName | string| `string` | | | | | + + + +### config.BackupMetaMap + + + + +[interface{}](#interface) + +### config.BackupMetadata + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| backupMethod | integer| `int64` | | | | | +| backupStrategy | integer| `int64` | | | | | +| backupTool | string| `string` | | | | | +| binLogFileName | string| `string` | | | | | +| binLogFilePos | integer| `int64` | | | | | +| binLogUuid | string| `string` | | | | | +| checksum | string| `string` | | | | | +| completed | boolean| `bool` | | | | | +| compressed | boolean| `bool` | | | | | +| dest | string| `string` | | | | | +| encrypted | boolean| `bool` | | | | | +| encryptionAlgo | string| `string` | | | | | +| encryptionKey | string| `string` | | | | | +| endTime | string| `string` | | | | | +| id | integer| `int64` | | | | | +| previous | integer| `int64` | | | | | +| retentionDays | integer| `int64` | | | | | +| size | integer| `int64` | | | | | +| source | string| `string` | | | | | +| startTime | string| `string` | | | | | + + + +### config.ConfigVariableType + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| available | boolean| `bool` | | | | | +| id | integer| `int64` | | | | | +| label | string| `string` | | | | | +| name | string| `string` | | | | | + + + +### config.DockerRepo + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| image | string| `string` | | | | | +| name | string| `string` | | | | | +| tags | [ConfigDockerTag](#config-docker-tag)| `ConfigDockerTag` | | | | | + + + +### config.DockerTag + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| results | [][ConfigTagResult](#config-tag-result)| `[]*ConfigTagResult` | | | | | + + + +### config.Grant + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| enable | boolean| `bool` | | | | | +| grant | string| `string` | | | | | + + + +### config.Partner + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| dbopsEmail | string| `string` | | | | | +| domains | string| `string` | | | | | +| id | integer| `int64` | | | | | +| isDbops | integer| `int64` | | | | | +| isSysops | integer| `int64` | | | | | +| name | string| `string` | | | | | +| stars | integer| `int64` | | | | | +| sysopsEmail | string| `string` | | | | | + + + +### config.PeerCluster + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| api-credentials-acl-allow | string| `string` | | | | | +| api-credentials-acl-allow-external | string| `string` | | | | | +| api-public-url | string| `string` | | | | | +| cloud18-cost-currency | string| `string` | | | | | +| cloud18-database-read-srv-record | string| `string` | | | | | +| cloud18-database-read-write-split-srv-record | string| `string` | | | | | +| cloud18-database-read-write-srv-record | string| `string` | | | | | +| cloud18-domain | string| `string` | | | | | +| cloud18-external-dbops | string| `string` | | | | | +| cloud18-external-sysops | string| `string` | | | | | +| cloud18-infra-certifications | string| `string` | | | | | +| cloud18-infra-cpu-freq | string| `string` | | | | | +| cloud18-infra-cpu-model | string| `string` | | | | | +| cloud18-infra-data-centers | string| `string` | | | | | +| cloud18-infra-geo-localizations | string| `string` | | | | | +| cloud18-infra-public-bandwidth | string| `string` | | | | `0` | +| cloud18-monthly-dbops-cost | string| `string` | | | | `0` | +| cloud18-monthly-infra-cost | string| `string` | | | | `0` | +| cloud18-monthly-license-cost | string| `string` | | | | `0` | +| cloud18-monthly-sysops-cost | string| `string` | | | | `0` | +| cloud18-open-dbops | string| `string` | | | | `false` | +| cloud18-open-sysops | string| `string` | | | | `false` | +| cloud18-peer | string| `string` | | | | `false` | +| cloud18-platform-description | string| `string` | | | | | +| cloud18-promotion-pct | string| `string` | | | | `0` | +| cloud18-shared | string| `string` | | | | `false` | +| cloud18-sla-provision-time | string| `string` | | | | `0` | +| cloud18-sla-repair-time | string| `string` | | | | `0` | +| cloud18-sla-response-time | string| `string` | | | | `0` | +| cloud18-sub-domain | string| `string` | | | | | +| cloud18-sub-domain-zone | string| `string` | | | | | +| cloud18-subscribed-dbops | string| `string` | | | | `false` | +| cluster-name | string| `string` | | | | | +| peer-users | []string| `[]string` | | | | | +| prov-db-cpu-cores | string| `string` | | | | `0` | +| prov-db-disk-iops | string| `string` | | | | `0` | +| prov-db-disk-size | string| `string` | | | | `0` | +| prov-db-memory | string| `string` | | | | `0` | +| prov-orchestrator | string| `string` | | | | | +| prov-service-plan | string| `string` | | | | | + + + +### config.PointInTimeMeta + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| backup | integer| `int64` | | | | | +| isInPITR | boolean| `bool` | | | | | +| restoreTime | integer| `int64` | | | | | +| useBinlog | boolean| `bool` | | | | | + + + +### config.Role + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| enable | boolean| `bool` | | | | | +| role | string| `string` | | | | | + + + +### config.ServicePlan + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| bp | string| `string` | | | | `0` | +| certs | string| `string` | | | | | +| cpu | string| `string` | | | | | +| dbacost | string| `string` | | | | `0` | +| dbcores | string| `string` | | | | `0` | +| dbcpufreq | string| `string` | | | | | +| dbdatasize | string| `string` | | | | `0` | +| dbiops | string| `string` | | | | `0` | +| dbmemory | string| `string` | | | | `0` | +| dbsystemsize | string| `string` | | | | `0` | +| dc | string| `string` | | | | | +| devise | string| `string` | | | | | +| extdbops | string| `string` | | | | | +| extsysops | string| `string` | | | | | +| gti | string| `string` | | | | `0` | +| gtr | string| `string` | | | | `0` | +| id | string| `string` | | | | `0` | +| infra | string| `string` | | | | | +| infracost | string| `string` | | | | `0` | +| licencecost | string| `string` | | | | `0` | +| plan | string| `string` | | | | | +| promo | string| `string` | | | | `0` | +| provtime | string| `string` | | | | `0` | +| prxcores | string| `string` | | | | `0` | +| prxdatasize | string| `string` | | | | `0` | +| syscost | string| `string` | | | | `0` | +| zone | string| `string` | | | | | + + + +### config.StringsMap + + + + +[interface{}](#interface) + +### config.TagResult + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| name | string| `string` | | | | | + + + +### config.Tarball + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| OS | string| `string` | | | | | +| checksum | string| `string` | | | | | +| date_added | string| `string` | | | | | +| flavor | string| `string` | | | | | +| minimal | boolean| `bool` | | | | | +| name | string| `string` | | | | | +| notes | string| `string` | | | | | +| short_version | string| `string` | | | | | +| size | integer| `int64` | | | | | +| updated_by | string| `string` | | | | | +| url | string| `string` | | | | | +| version | string| `string` | | | | | + + + +### config.TasksMap + + + + +[interface{}](#interface) + +### config.VersionsMap + + + + +[interface{}](#interface) + +### config.WorkLoad + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| busyTime | string| `string` | | | | | +| connections | integer| `int64` | | | | | +| cpuThreadPool | number| `float64` | | | | | +| cpuUserStats | number| `float64` | | | | | +| dbIndexSize | integer| `int64` | | | | | +| dbTableSize | integer| `int64` | | | | | +| qps | integer| `int64` | | | | | + + + +### config.WorkLoadsMap + + + + +[interface{}](#interface) + +### configurator.Configurator + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| configPrxTags | [][Repmanv3Tag](#repmanv3-tag)| `[]*Repmanv3Tag` | | | from module | | +| configTags | [][Repmanv3Tag](#repmanv3-tag)| `[]*Repmanv3Tag` | | | from module | | +| dbServersTags | []string| `[]string` | | | from conf | | +| dbServersTagsDiscover | []string| `[]string` | | | from conf | | +| proxyServersTags | []string| `[]string` | | | | | +| proxyServersTagsDiscover | []string| `[]string` | | | | | + + + +### dbhelper.BinaryLogMetaMap + + + + +[interface{}](#interface) + +### dbhelper.Event + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| db | string| `string` | | | | | +| definer | string| `string` | | | | | +| name | string| `string` | | | | | +| status | integer| `int64` | | | | | + + + +### dbhelper.MasterStatus + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| binlogDoDB | string| `string` | | | | | +| binlogIgnoreDB | string| `string` | | | | | +| file | string| `string` | | | | | +| position | integer| `int64` | | | | | + + + +### dbhelper.SlaveStatus + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| channelName | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| connectionName | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| eeplicateDoDomainIds | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| execMasterLogPos | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| executedGtidSet | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| gtidIoPos | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| gtidSlavePos | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| lastIoErrno | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| lastIoError | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| lastSqlErrno | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| lastSqlError | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| masterHost | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| masterLogFile | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| masterPort | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| masterServerId | integer| `int64` | | | | | +| masterUser | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| postgresExternalId | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| readMasterLogPos | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| relayMasterLogFile | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| replicateDoDb | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| replicateDoTable | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| replicateIgnoreDb | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| replicateIgnoreDomainIds | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| replicateIgnoreServerIds | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| replicateIgnoreTable | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| replicateWildDoTable | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| replicateWildIgnoreTable | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| retrievedGtidSet | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| secondsBehindMaster | [SQLNullInt64](#sql-null-int64)| `SQLNullInt64` | | | | | +| slaveHeartbeatPeriod | number| `float64` | | | | | +| slaveIoRunning | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| slaveSQLRunningState | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| slaveSqlRunning | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | +| usingGtid | [SQLNullString](#sql-null-string)| `SQLNullString` | | | | | + + + +### github_com_signal18_replication-manager_config.Config + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| alertPushoverAppToken | string| `string` | | | | | +| alertPushoverUserToken | string| `string` | | | | | +| alertScript | string| `string` | | | | | +| alertSlackChannel | string| `string` | | | | | +| alertSlackUrl | string| `string` | | | | | +| alertSlackUser | string| `string` | | | | | +| alertTeamsProxyUrl | string| `string` | | | | | +| alertTeamsState | string| `string` | | | | | +| alertTeamsUrl | string| `string` | | | | | +| analyzeUseSql | boolean| `bool` | | | | | +| apiBind | string| `string` | | | | | +| apiCredentials | string| `string` | | | | | +| apiCredentialsACLAllow | string| `string` | | | | | +| apiCredentialsACLAllowExternal | string| `string` | | | | | +| apiCredentialsACLDiscard | string| `string` | | | | | +| apiCredentialsACLDiscardExternal | string| `string` | | | | | +| apiCredentialsExternal | string| `string` | | | | | +| apiCredentialsSecureConfig | boolean| `bool` | | | | | +| apiHttpsBind | boolean| `bool` | | | | | +| apiOAuthClientID | string| `string` | | | | | +| apiOAuthClientSecret | string| `string` | | | | | +| apiOAuthProvider | string| `string` | | | | | +| apiPort | string| `string` | | | | | +| apiPublicUrl | string| `string` | | | | | +| apiServer | boolean| `bool` | | | | | +| apiSwaggerEnabled | boolean| `bool` | | | | | +| apiTokenTimeout | integer| `int64` | | | | | +| arbitrationExternal | boolean| `bool` | | | | | +| arbitrationExternalHosts | string| `string` | | | | | +| arbitrationExternalSecret | string| `string` | | | | | +| arbitrationExternalUniqueId | integer| `int64` | | | | | +| arbitrationFailedMasterScript | string| `string` | | | | | +| arbitrationPeerHosts | string| `string` | | | | | +| arbitrationReadTimout | integer| `int64` | | | | | +| arbitratorBindAddress | string| `string` | | | | | +| arbitratorDriver | string| `string` | | | | | +| autorejoin | boolean| `bool` | | | | | +| autorejoinBackupBinlog | boolean| `bool` | | | | | +| autorejoinFlashback | boolean| `bool` | | | | | +| autorejoinFlashbackOnSync | boolean| `bool` | | | | | +| autorejoinFlashbackOnUnsync | boolean| `bool` | | | | | +| autorejoinForceRestore | boolean| `bool` | | | | | +| autorejoinLogicalBackup | boolean| `bool` | | | | | +| autorejoinMysqldump | boolean| `bool` | | | | | +| autorejoinPhysicalBackup | boolean| `bool` | | | | | +| autorejoinScript | string| `string` | | | | | +| autorejoinSlavePositionalHeartbeat | boolean| `bool` | | | | | +| autorejoinZfsFlashback | boolean| `bool` | | | | | +| autoseed | boolean| `bool` | | | | | +| backup | boolean| `bool` | | | | | +| backupBinlogs | boolean| `bool` | | | | | +| backupBinlogsKeep | integer| `int64` | | | | | +| backupKeepDaily | integer| `int64` | | | | | +| backupKeepHourly | integer| `int64` | | | | | +| backupKeepMonthly | integer| `int64` | | | | | +| backupKeepUntilValid | boolean| `bool` | | | | | +| backupKeepWeekly | integer| `int64` | | | | | +| backupKeepYearly | integer| `int64` | | | | | +| backupLoadScript | string| `string` | | | | | +| backupLockDDL | boolean| `bool` | | | | | +| backupLogicalDumpSystemTables | boolean| `bool` | | | | | +| backupLogicalDumpThreads | integer| `int64` | | | | | +| backupLogicalLoadThreads | integer| `int64` | | | | | +| backupLogicalType | string| `string` | | | | | +| backupMyDumperOptions | string| `string` | | | | | +| backupMyDumperRegex | string| `string` | | | | | +| backupMyLoaderOptions | string| `string` | | | | | +| backupMydumperPath | string| `string` | | | | | +| backupMyloaderPath | string| `string` | | | | | +| backupMysqlbinlogPath | string| `string` | | | | | +| backupMysqlclientgPath | string| `string` | | | | | +| backupMysqldumpOptions | string| `string` | | | | | +| backupMysqldumpPath | string| `string` | | | | | +| backupPhysicalType | string| `string` | | | | | +| backupRestic | boolean| `bool` | | | | | +| backupResticAws | boolean| `bool` | | | | | +| backupResticAwsAccessKeyId | string| `string` | | | | | +| backupResticBinaryPath | string| `string` | | | | | +| backupResticRepository | string| `string` | | | | | +| backupSaveScript | string| `string` | | | | | +| backupStreaming | boolean| `bool` | | | | | +| backupStreamingBucket | string| `string` | | | | | +| backupStreamingDebug | boolean| `bool` | | | | | +| backupStreamingEndpoint | string| `string` | | | | | +| backupStreamingRegion | string| `string` | | | | | +| binlogCopyMode | string| `string` | | | | | +| binlogCopyScript | string| `string` | | | | | +| binlogParseMode | string| `string` | | | | | +| binlogRotationScript | string| `string` | | | | | +| checkBinlogFilters | boolean| `bool` | | | | | +| checkBinlogServerId | integer| `int64` | | | | | +| checkGrants | boolean| `bool` | | | | | +| checkReplicationErrantTrx | boolean| `bool` | | | | | +| checkReplicationFilters | boolean| `bool` | | | | | +| checkReplicationState | boolean| `bool` | | | | | +| checkType | string| `string` | | | | | +| cloud18 | boolean| `bool` | | | | | +| cloud18CostCurrency | string| `string` | | | | | +| cloud18DatabaseReadSrvRecord | string| `string` | | | | | +| cloud18DatabaseReadWriteSplitSrvRecord | string| `string` | | | | | +| cloud18DatabaseReadWriteSrvRecord | string| `string` | | | | | +| cloud18DbOps | string| `string` | | | | | +| cloud18DbaUserCredential | string| `string` | | | | | +| cloud18Domain | string| `string` | | | | | +| cloud18ExternalDbOps | string| `string` | | | | | +| cloud18ExternalSysOps | string| `string` | | | | | +| cloud18GitUser | string| `string` | | | | | +| cloud18InfraCertifications | string| `string` | | | | | +| cloud18InfraCpuFreq | string| `string` | | | | | +| cloud18InfraCpuModel | string| `string` | | | | | +| cloud18InfraDataCenters | string| `string` | | | | | +| cloud18InfraDescription | string| `string` | | | | | +| cloud18InfraGeoLocalizations | string| `string` | | | | | +| cloud18InfraPublicBandwidth | number| `float64` | | | | | +| cloud18MonthlyDbopsCost | number| `float64` | | | | | +| cloud18MonthlyInfraCost | number| `float64` | | | | | +| cloud18MonthlyLicenseCost | number| `float64` | | | | | +| cloud18MonthlySysopsCost | number| `float64` | | | | | +| cloud18OpenDbops | boolean| `bool` | | | | | +| cloud18OpenSysops | boolean| `bool` | | | | | +| cloud18PlatformDescription | string| `string` | | | | | +| cloud18PromotionPct | number| `float64` | | | | | +| cloud18SalesSubscriptionScript | string| `string` | | | | | +| cloud18SalesSubscriptionValidateScript | string| `string` | | | | | +| cloud18SalesUnsubscribeScript | string| `string` | | | | | +| cloud18Shared | boolean| `bool` | | | | | +| cloud18SlaProvisionTime | number| `float64` | | | | | +| cloud18SlaRepairTime | number| `float64` | | | | | +| cloud18SlaResponseTime | number| `float64` | | | | | +| cloud18SponsorUserCredential | string| `string` | | | | | +| cloud18SubDomain | string| `string` | | | | | +| cloud18SubDomainZone | string| `string` | | | | | +| cloud18SubscribedDbops | boolean| `bool` | | | | | +| clusterHead | string| `string` | | | | | +| compressBackups | boolean| `bool` | | | | | +| dbServersBackupHosts | string| `string` | | | | | +| dbServersConnectTimeout | integer| `int64` | | | | | +| dbServersCredential | string| `string` | | | | | +| dbServersHosts | string| `string` | | | | | +| dbServersIgnoredHosts | string| `string` | | | | | +| dbServersIgnoredReadonly | string| `string` | | | | | +| dbServersLocality | string| `string` | | | | | +| dbServersPreferedMaster | string| `string` | | | | | +| dbServersReadTimeout | integer| `int64` | | | | | +| dbServersStateChangeScript | string| `string` | | | | | +| dbServersTlsCaCert | string| `string` | | | | | +| dbServersTlsClientCert | string| `string` | | | | | +| dbServersTlsClientKey | string| `string` | | | | | +| dbServersTlsServerCert | string| `string` | | | | | +| dbServersTlsServerKey | string| `string` | | | | | +| dbServersUseGeneratedCert | boolean| `bool` | | | | | +| delayStatCapture | boolean| `bool` | | | | | +| delayStatRotate | integer| `int64` | | | | | +| eeplicationRestartOnSqlLErrorMatch | string| `string` | | | | | +| enterprise | boolean| `bool` | | | used to talk to opensvc collector | | +| extproxy | boolean| `bool` | | | | | +| extproxyAddress | string| `string` | | | | | +| failoverAtSync | boolean| `bool` | | | | | +| failoverCheckDelayStat | boolean| `bool` | | | | | +| failoverEventScheduler | boolean| `bool` | | | | | +| failoverEventStatus | boolean| `bool` | | | | | +| failoverFalsePositiveExternal | boolean| `bool` | | | | | +| failoverFalsePositiveExternalPort | integer| `int64` | | | | | +| failoverFalsePositiveHeartbeat | boolean| `bool` | | | | | +| failoverFalsePositiveHeartbeatTimeout | integer| `int64` | | | | | +| failoverFalsePositiveMaxscale | boolean| `bool` | | | | | +| failoverFalsePositiveMaxscaleTimeout | integer| `int64` | | | | | +| failoverFalsePositivePingCounter | integer| `int64` | | | | | +| failoverLimit | integer| `int64` | | | | | +| failoverLogFileKeep | integer| `int64` | | | | | +| failoverMaxSlaveDelay | integer| `int64` | | | | | +| failoverMdevCheck | boolean| `bool` | | | | | +| failoverMdevLevel | string| `string` | | | | | +| failoverMode | string| `string` | | | | | +| failoverPostScript | string| `string` | | | | | +| failoverPreScript | string| `string` | | | | | +| failoverReadOnlyState | boolean| `bool` | | | | | +| failoverResetTime | integer| `int64` | | | | | +| failoverRestartUnsafe | boolean| `bool` | | | | | +| failoverSemisyncState | boolean| `bool` | | | | | +| failoverSuperReadOnlyState | boolean| `bool` | | | | | +| failoverSwithToPrefered | boolean| `bool` | | | | | +| failoverTimeLimit | integer| `int64` | | | | | +| forceBinlogAnnotate | boolean| `bool` | | | | | +| forceBinlogChecksum | boolean| `bool` | | | | | +| forceBinlogCompress | boolean| `bool` | | | | | +| forceBinlogPurge | boolean| `bool` | | | | | +| forceBinlogPurgeMinReplica | integer| `int64` | | | | | +| forceBinlogPurgeOnRestore | boolean| `bool` | | | | | +| forceBinlogPurgeReplicas | boolean| `bool` | | | | | +| forceBinlogPurgeTotalSize | integer| `int64` | | | | | +| forceBinlogRow | boolean| `bool` | | | | | +| forceBinlogSlowqueries | boolean| `bool` | | | | | +| forceDiskRelaylogSizeLimit | boolean| `bool` | | | | | +| forceDiskRelaylogSizeLimitSize | integer| `int64` | | | | | +| forceInmemoryBinlogCacheSize | boolean| `bool` | | | | | +| forceNoslaveBehind | boolean| `bool` | | | | | +| forceSlaveGtidMode | boolean| `bool` | | | | | +| forceSlaveGtidModeStrict | boolean| `bool` | | | | | +| forceSlaveHeartbeat | boolean| `bool` | | | | | +| forceSlaveHeartbeatRetry | integer| `int64` | | | | | +| forceSlaveHeartbeatTime | integer| `int64` | | | | | +| forceSlaveIdempotent | boolean| `bool` | | | | | +| forceSlaveNoGtidMode | boolean| `bool` | | | | | +| forceSlaveParallelMode | string| `string` | | | | | +| forceSlaveReadonly | boolean| `bool` | | | | | +| forceSlaveSemisync | boolean| `bool` | | | | | +| forceSlaveStrict | boolean| `bool` | | | | | +| forceSyncBinlog | boolean| `bool` | | | | | +| forceSyncInnodb | boolean| `bool` | | | | | +| fullVersion | string| `string` | | | | | +| gitMonitoringTicker | integer| `int64` | | | | | +| gitUrl | string| `string` | | | | | +| gitUrlPull | string| `string` | | | | | +| gitUsername | string| `string` | | | | | +| goArch | string| `string` | | | | | +| goOS | string| `string` | | | | | +| graphiteBlacklist | boolean| `bool` | | | | | +| graphiteCarbonApiPort | integer| `int64` | | | | | +| graphiteCarbonHost | string| `string` | | | | | +| graphiteCarbonLinkPort | integer| `int64` | | | | | +| graphiteCarbonPicklePort | integer| `int64` | | | | | +| graphiteCarbonPort | integer| `int64` | | | | | +| graphiteCarbonPprofPort | integer| `int64` | | | | | +| graphiteCarbonServerPort | integer| `int64` | | | | | +| graphiteEmbedded | boolean| `bool` | | | | | +| graphiteMetrics | boolean| `bool` | | | | | +| graphiteWhitelist | boolean| `bool` | | | | | +| graphiteWhitelistTemplate | string| `string` | | | | | +| haproxy | boolean| `bool` | | | | | +| haproxyAPIPort | integer| `int64` | | | | | +| haproxyAPIReadBackend | string| `string` | | | | | +| haproxyAPIWriteBackend | string| `string` | | | | | +| haproxyBinaryPath | string| `string` | | | | | +| haproxyDebug | boolean| `bool` | | | | | +| haproxyIpReadBind | string| `string` | | | | | +| haproxyIpWriteBind | string| `string` | | | | | +| haproxyJanitorWeights | string| `string` | | | | | +| haproxyLogLevel | integer| `int64` | | | | | +| haproxyMode | string| `string` | | | | | +| haproxyPassword | string| `string` | | | | | +| haproxyReadPort | integer| `int64` | | | | | +| haproxyServers | string| `string` | | | | | +| haproxyServers-ipv6 | string| `string` | | | | | +| haproxyStatPort | integer| `int64` | | | | | +| haproxyWritePort | integer| `int64` | | | | | +| haproxylUser | string| `string` | | | | | +| heartbeatTable | boolean| `bool` | | | | | +| http-use-react | boolean| `bool` | | | | | +| httpAuth | boolean| `bool` | | | | | +| httpBindAdress | string| `string` | | | | | +| httpBootstrapButton | boolean| `bool` | | | | | +| httpPort | string| `string` | | | | | +| httpRefreshInterval | integer| `int64` | | | | | +| httpRoot | string| `string` | | | | | +| httpServer | boolean| `bool` | | | | | +| httpSessionLifetime | integer| `int64` | | | | | +| interactive | boolean| `bool` | | | | | +| jobLogBatchSize | integer| `int64` | | | | | +| kubeConfig | string| `string` | | | | | +| logBackupStream | boolean| `bool` | | | | | +| logBackupStreamLevel | integer| `int64` | | | | | +| logBinlogPurge | boolean| `bool` | | | | | +| logBinlogPurgeLevel | integer| `int64` | | | | | +| logConfigLoad | boolean| `bool` | | | | | +| logConfigLoadLevel | integer| `int64` | | | | | +| logFile | string| `string` | | | | | +| logFileLevel | integer| `int64` | | | | | +| logGit | boolean| `bool` | | | | | +| logGitLevel | integer| `int64` | | | | | +| logGraphite | boolean| `bool` | | | | | +| logGraphiteLevel | integer| `int64` | | | | | +| logHeartbeat | boolean| `bool` | | | | | +| logHeartbeatLevel | integer| `int64` | | | | | +| logLevel | integer| `int64` | | | | | +| logOrchestrator | boolean| `bool` | | | | | +| logOrchestratorLevel | integer| `int64` | | | | | +| logProxy | boolean| `bool` | | | | | +| logProxyLevel | integer| `int64` | | | | | +| logRotateMaxAge | integer| `int64` | | | | | +| logRotateMaxBackup | integer| `int64` | | | | | +| logRotateMaxSize | integer| `int64` | | | | | +| logSqlInMonitoring | boolean| `bool` | | | | | +| logSst | boolean| `bool` | | | internal replication-manager sst | | +| logSstLevel | integer| `int64` | | | internal replication-manager sst | | +| logSyslog | boolean| `bool` | | | | | +| logTask | boolean| `bool` | | | | | +| logTaskLevel | integer| `int64` | | | | | +| logTopology | boolean| `bool` | | | | | +| logTopologyLevel | integer| `int64` | | | | | +| logVault | boolean| `bool` | | | | | +| logVaultLevel | integer| `int64` | | | | | +| logWriterElection | boolean| `bool` | | | | | +| logWriterElectionLevel | integer| `int64` | | | | | +| mailFrom | string| `string` | | | | | +| mailSmtpAddr | string| `string` | | | | | +| mailSmtpPassword | string| `string` | | | | | +| mailSmtpTlsSkipVerify | boolean| `bool` | | | | | +| mailSmtpUser | string| `string` | | | | | +| mailTo | string| `string` | | | | | +| maxscale | boolean| `bool` | | | | | +| maxscaleBinlog | boolean| `bool` | | | | | +| maxscaleBinlogPort | integer| `int64` | | | | | +| maxscaleDebug | boolean| `bool` | | | | | +| maxscaleDisableMonitor | boolean| `bool` | | | | | +| maxscaleGetInfoMethod | string| `string` | | | | | +| maxscaleJanitorWeights | string| `string` | | | | | +| maxscaleLogLevel | integer| `int64` | | | | | +| maxscaleMaxinfoPort | integer| `int64` | | | | | +| maxscalePass | string| `string` | | | | | +| maxscalePort | string| `string` | | | | | +| maxscaleReadPort | integer| `int64` | | | | | +| maxscaleReadWritePort | integer| `int64` | | | | | +| maxscaleServerMatchPort | boolean| `bool` | | | | | +| maxscaleServers | string| `string` | | | | | +| maxscaleServers-ipv6 | string| `string` | | | | | +| maxscaleUser | string| `string` | | | | | +| maxscaleWritePort | integer| `int64` | | | | | +| maxscalemBinaryPath | string| `string` | | | | | +| monitoringAddress | string| `string` | | | | | +| monitoringAlertTrigger | string| `string` | | | | | +| monitoringBasedir | string| `string` | | | | | +| monitoringCapture | boolean| `bool` | | | | | +| monitoringCaptureFileKeep | integer| `int64` | | | | | +| monitoringCaptureTrigger | string| `string` | | | | | +| monitoringCheckGrants | boolean| `bool` | | | | | +| monitoringCloseStateScript | string| `string` | | | | | +| monitoringConfdir | string| `string` | | | | | +| monitoringConfdirBackup | string| `string` | | | | | +| monitoringConfdirExtra | string| `string` | | | | | +| monitoringDatadir | string| `string` | | | | | +| monitoringDiskUsage | boolean| `bool` | | | | | +| monitoringDiskUsagePct | integer| `int64` | | | | | +| monitoringErreurLogLength | integer| `int64` | | | | | +| monitoringIgnoreErrors | string| `string` | | | | | +| monitoringInnoDBStatus | boolean| `bool` | | | | | +| monitoringKeyPath | string| `string` | | | | | +| monitoringKeyPathGitOverwrite | boolean| `bool` | | | | | +| monitoringLongQueryLogLength | integer| `int64` | | | | | +| monitoringLongQueryScript | string| `string` | | | | | +| monitoringLongQueryTime | integer| `int64` | | | | | +| monitoringLongQueryWithProcess | boolean| `bool` | | | | | +| monitoringLongQueryWithTable | boolean| `bool` | | | | | +| monitoringMergeConfigOnStart | boolean| `bool` | | | | | +| monitoringOpenStateScript | string| `string` | | | | | +| monitoringPause | boolean| `bool` | | | | | +| monitoringPerformanceSchema | boolean| `bool` | | | | | +| monitoringPlugins | boolean| `bool` | | | | | +| monitoringProcesslist | boolean| `bool` | | | | | +| monitoringQueries | boolean| `bool` | | | | | +| monitoringQueryRules | boolean| `bool` | | | | | +| monitoringQueryTimeout | integer| `int64` | | | | | +| monitoringRestoreConfigOnStart | boolean| `bool` | | | | | +| monitoringSSLCert | string| `string` | | | | | +| monitoringSSLKey | string| `string` | | | | | +| monitoringSaveConfig | boolean| `bool` | | | | | +| monitoringScheduler | boolean| `bool` | | | | | +| monitoringSchemaChange | boolean| `bool` | | | | | +| monitoringSchemaChangeScript | string| `string` | | | | | +| monitoringSharedir | string| `string` | | | | | +| monitoringSocket | string| `string` | | | | | +| monitoringTenant | string| `string` | | | | | +| monitoringTicker | integer| `int64` | | | | | +| monitoringTunnelCredential | string| `string` | | | | | +| monitoringTunnelHost | string| `string` | | | | | +| monitoringTunnelKeyPath | string| `string` | | | | | +| monitoringVariableDiff | boolean| `bool` | | | | | +| monitoringWaitRetry | integer| `int64` | | | | | +| monitoringWriteHeartbeat | boolean| `bool` | | | | | +| monitoringWriteHeartbeatCredential | string| `string` | | | | | +| myproxy | boolean| `bool` | | | | | +| myproxyDebug | boolean| `bool` | | | | | +| myproxyLogLevel | integer| `int64` | | | | | +| myproxyPassword | string| `string` | | | | | +| myproxyPort | integer| `int64` | | | | | +| myproxyUser | string| `string` | | | | | +| mysqlrouter | boolean| `bool` | | | | | +| mysqlrouterDebug | boolean| `bool` | | | | | +| mysqlrouterJanitorWeights | string| `string` | | | | | +| mysqlrouterLogLevel | integer| `int64` | | | | | +| mysqlrouterPass | string| `string` | | | | | +| mysqlrouterPort | string| `string` | | | | | +| mysqlrouterReadPort | integer| `int64` | | | | | +| mysqlrouterReadWritePort | integer| `int64` | | | | | +| mysqlrouterServers | string| `string` | | | | | +| mysqlrouterUser | string| `string` | | | | | +| mysqlrouterWritePort | integer| `int64` | | | | | +| onpremiseSsh | boolean| `bool` | | | | | +| onpremiseSshCredential | string| `string` | | | | | +| onpremiseSshDbJobScript | string| `string` | | | | | +| onpremiseSshPort | integer| `int64` | | | | | +| onpremiseSshPrivateKey | string| `string` | | | | | +| onpremiseSshStartDbScript | string| `string` | | | | | +| onpremiseSshStartProxyScript | string| `string` | | | | | +| onpremiseSshStopProxyScript | string| `string` | | | | | +| opensvcAdminUser | string| `string` | | | | | +| opensvcCodeapp | string| `string` | | | | | +| opensvcCollectorAccount | string| `string` | | | | | +| opensvcHost | string| `string` | | | | | +| opensvcP12Certificate | string| `string` | | | | | +| opensvcP12Secret | string| `string` | | | | | +| opensvcRegister | boolean| `bool` | | | | | +| opensvcUseCollectorApi | boolean| `bool` | | | | | +| opensvcUser | string| `string` | | | | | +| optimizeUseSql | boolean| `bool` | | | | | +| printDelayStat | boolean| `bool` | | | | | +| printDelayStatHistory | boolean| `bool` | | | | | +| printDelayStatInterval | integer| `int64` | | | | | +| provDBApplyDynamicConfig | boolean| `bool` | | | | | +| provDBCompliance | string| `string` | | | | | +| provDBForceWriteConfig | boolean| `bool` | | | | | +| provDbAgents | string| `string` | | | | | +| provDbBinaryBasedir | string| `string` | | | | | +| provDbBinaryInTarball | boolean| `bool` | | | | | +| provDbBinaryTarballName | string| `string` | | | | | +| provDbBootstrapScript | string| `string` | | | | | +| provDbCleanupScript | string| `string` | | | | | +| provDbClientBasedir | string| `string` | | | | | +| provDbCpuCores | string| `string` | | | | | +| provDbDatadirVersion | string| `string` | | | | | +| provDbDiskDevice | string| `string` | | | | | +| provDbDiskDockerSize | string| `string` | | | | | +| provDbDiskFs | string| `string` | | | | | +| provDbDiskFsCompress | string| `string` | | | | | +| provDbDiskIops | string| `string` | | | | | +| provDbDiskIopsLatency | string| `string` | | | | | +| provDbDiskPool | string| `string` | | | | | +| provDbDiskSize | string| `string` | | | | | +| provDbDiskSnapshotKeep | integer| `int64` | | | | | +| provDbDiskSnapshotPreferedMaster | boolean| `bool` | | | | | +| provDbDiskSystemSize | string| `string` | | | | | +| provDbDiskTempSize | string| `string` | | | | | +| provDbDiskType | string| `string` | | | | | +| provDbDockerImg | string| `string` | | | | | +| provDbDomain | string| `string` | | | | | +| provDbExpireLogDays | integer| `int64` | | | | | +| provDbLoadCsv | string| `string` | | | | | +| provDbLoadSql | string| `string` | | | | | +| provDbMaxConnections | integer| `int64` | | | | | +| provDbMemory | string| `string` | | | | | +| provDbMemorySharedPct | string| `string` | | | | | +| provDbMemoryThreadedPct | string| `string` | | | | | +| provDbNetGateway | string| `string` | | | | | +| provDbNetIface | string| `string` | | | | | +| provDbNetMask | string| `string` | | | | | +| provDbServiceType | string| `string` | | | | | +| provDbStartScript | string| `string` | | | | | +| provDbStopScript | string| `string` | | | | | +| provDbTags | string| `string` | | | | | +| provDbVolumeData | string| `string` | | | | | +| provDbVolumeDocker | string| `string` | | | | | +| provDockerDaemonPrivate | boolean| `bool` | | | | | +| provNetCni | boolean| `bool` | | | | | +| provNetCniCluster | string| `string` | | | | | +| provOrchestrator | string| `string` | | | | | +| provOrchestratorCluster | string| `string` | | | | | +| provOrchestratorEnable | string| `string` | | | | | +| provProxyAgents | string| `string` | | | | | +| provProxyAgentsFailover | string| `string` | | | | | +| provProxyBootstrapScript | string| `string` | | | | | +| provProxyCleanupScript | string| `string` | | | | | +| provProxyCompliance | string| `string` | | | | | +| provProxyCpuCores | string| `string` | | | | | +| provProxyDiskDevice | string| `string` | | | | | +| provProxyDiskFs | string| `string` | | | | | +| provProxyDiskPool | string| `string` | | | | | +| provProxyDiskSize | string| `string` | | | | | +| provProxyDiskType | string| `string` | | | | | +| provProxyDockerHaproxyImg | string| `string` | | | | | +| provProxyDockerMaxscaleImg | string| `string` | | | | | +| provProxyDockerMysqlrouterImg | string| `string` | | | | | +| provProxyDockerProxysqlImg | string| `string` | | | | | +| provProxyDockerShardproxyImg | string| `string` | | | | | +| provProxyMemory | string| `string` | | | | | +| provProxyNetGateway | string| `string` | | | | | +| provProxyNetIface | string| `string` | | | | | +| provProxyNetMask | string| `string` | | | | | +| provProxyRouteAddr | string| `string` | | | | | +| provProxyRouteMask | string| `string` | | | | | +| provProxyRoutePolicy | string| `string` | | | | | +| provProxyRoutePort | string| `string` | | | | | +| provProxyServiceType | string| `string` | | | | | +| provProxyStartScript | string| `string` | | | | | +| provProxyStopScript | string| `string` | | | | | +| provProxyTags | string| `string` | | | | | +| provProxyVolumeData | string| `string` | | | | | +| provSerialized | boolean| `bool` | | | | | +| provServicePlan | string| `string` | | | | | +| provServicePlanRegistry | string| `string` | | | | | +| provSphinxAgents | string| `string` | | | | | +| provSphinxCpuCores | string| `string` | | | | | +| provSphinxDiskDevice | string| `string` | | | | | +| provSphinxDiskFs | string| `string` | | | | | +| provSphinxDiskPool | string| `string` | | | | | +| provSphinxDiskSize | string| `string` | | | | | +| provSphinxDiskType | string| `string` | | | | | +| provSphinxDockerImg | string| `string` | | | | | +| provSphinxMaxChildrens | string| `string` | | | | | +| provSphinxMemory | string| `string` | | | | | +| provSphinxReindexSchedule | string| `string` | | | | | +| provSphinxServiceType | string| `string` | | | | | +| provSphinxTags | string| `string` | | | | | +| provTlsServerCa | string| `string` | | | | | +| provTlsServerCert | string| `string` | | | | | +| provTlsServerKey | string| `string` | | | | | +| proxyServersBackendCompression | boolean| `bool` | | | | | +| proxyServersBackendMaxConnections | integer| `int64` | | | | | +| proxyServersBackendMaxReplicationLag | integer| `int64` | | | | | +| proxyServersChangeStateScript | string| `string` | | | | | +| proxyServersReadOnMaster | boolean| `bool` | | | | | +| proxyServersReadOnMasterNoSlave | boolean| `bool` | | | | | +| proxyjanitorAdminPort | string| `string` | | | | | +| proxyjanitorBinaryPath | string| `string` | | | | | +| proxyjanitorDebug | boolean| `bool` | | | | | +| proxyjanitorLogLevel | integer| `int64` | | | | | +| proxyjanitorPassword | string| `string` | | | | | +| proxyjanitorPort | string| `string` | | | | | +| proxyjanitorServers | string| `string` | | | | | +| proxyjanitorServers-ipv6 | string| `string` | | | | | +| proxyjanitorUser | string| `string` | | | | | +| proxysql | boolean| `bool` | | | | | +| proxysqlAdminPort | string| `string` | | | | | +| proxysqlBinaryPath | string| `string` | | | | | +| proxysqlBootstrap | boolean| `bool` | | | | | +| proxysqlBootstrapHostgroups | boolean| `bool` | | | | | +| proxysqlBootstrapQueryRules | boolean| `bool` | | | | | +| proxysqlBootstrapVariables | boolean| `bool` | | | | | +| proxysqlBootstrapyUsers | boolean| `bool` | | | | | +| proxysqlDebug | boolean| `bool` | | | | | +| proxysqlJanitorWeights | string| `string` | | | | | +| proxysqlLogLevel | integer| `int64` | | | | | +| proxysqlMultiplexing | boolean| `bool` | | | | | +| proxysqlPassword | string| `string` | | | | | +| proxysqlPort | string| `string` | | | | | +| proxysqlReaderHostgroup | string| `string` | | | | | +| proxysqlSaveToDisk | boolean| `bool` | | | | | +| proxysqlServers | string| `string` | | | | | +| proxysqlServersIpv6 | string| `string` | | | | | +| proxysqlUser | string| `string` | | | | | +| proxysqlWriterHostgroup | string| `string` | | | | | +| registryConsul | boolean| `bool` | | | | | +| registryConsulCredential | string| `string` | | | | | +| registryConsulDebug | boolean| `bool` | | | | | +| registryConsulLogLevel | integer| `int64` | | | | | +| registryConsulToken | string| `string` | | | | | +| registryJanitorWeights | string| `string` | | | | | +| registryServers | string| `string` | | | | | +| replicationActivePassive | boolean| `bool` | | | | | +| replicationCredential | string| `string` | | | | | +| replicationDelayedHosts | string| `string` | | | | | +| replicationDelayedTime | integer| `int64` | | | | | +| replicationDynamicTopology | boolean| `bool` | | | | | +| replicationErrorScript | string| `string` | | | | | +| replicationMasterConnectRetry | integer| `int64` | | | | | +| replicationMasterSlaveNeverRelay | boolean| `bool` | | | | | +| replicationMasterSlavePgLogical | boolean| `bool` | | | | | +| replicationMasterSlavePgStream | boolean| `bool` | | | | | +| replicationMultiMaster | boolean| `bool` | | | | | +| replicationMultiMasterConcurrentWrite | boolean| `bool` | | | | | +| replicationMultiMasterGrouprep | boolean| `bool` | | | | | +| replicationMultiMasterGrouprepPort | integer| `int64` | | | | | +| replicationMultiMasterRing | boolean| `bool` | | | | | +| replicationMultiMasterRingUnsafe | boolean| `bool` | | | | | +| replicationMultiMasterWsrep | boolean| `bool` | | | | | +| replicationMultiMasterWsrepPort | integer| `int64` | | | | | +| replicationMultiMasterWsrepSSTMethod | string| `string` | | | | | +| replicationMultiTierSlave | boolean| `bool` | | | | | +| replicationMultisourceHeadClusters | string| `string` | | | | | +| replicationSourceName | string| `string` | | | | | +| replicationUseSsl | boolean| `bool` | | | | | +| schedulerAlertDisable | boolean| `bool` | | | | | +| schedulerAlertDisableCron | string| `string` | | | | | +| schedulerAlertDisableTime | integer| `int64` | | | | | +| schedulerDatabaseLogsTableKeep | integer| `int64` | | | | | +| schedulerDbServersAnalyze | boolean| `bool` | | | | | +| schedulerDbServersAnalyzeCron | string| `string` | | | | | +| schedulerDbServersLogicalBackup | boolean| `bool` | | | | | +| schedulerDbServersLogicalBackupCron | string| `string` | | | | | +| schedulerDbServersLogs | boolean| `bool` | | | | | +| schedulerDbServersLogsCron | string| `string` | | | | | +| schedulerDbServersLogsTableRotate | boolean| `bool` | | | | | +| schedulerDbServersLogsTableRotateCron | string| `string` | | | | | +| schedulerDbServersOptimize | boolean| `bool` | | | | | +| schedulerDbServersOptimizeCron | string| `string` | | | | | +| schedulerDbServersPhysicalBackup | boolean| `bool` | | | | | +| schedulerDbServersPhysicalBackupCron | string| `string` | | | | | +| schedulerDbServersReceiverPorts | string| `string` | | | | | +| schedulerDbServersReceiverUseSSL | boolean| `bool` | | | | | +| schedulerDbServersSenderPorts | string| `string` | | | | | +| schedulerJobsSsh | boolean| `bool` | | | | | +| schedulerJobsSshCron | string| `string` | | | | | +| schedulerRollingReprov | boolean| `bool` | | | | | +| schedulerRollingReprovCron | string| `string` | | | | | +| schedulerRollingRestart | boolean| `bool` | | | | | +| schedulerRollingRestartCron | string| `string` | | | | | +| schedulerSlaRotateCron | string| `string` | | | | | +| shardproxy | boolean| `bool` | | | | | +| shardproxyCopyGrants | boolean| `bool` | | | | | +| shardproxyCredential | string| `string` | | | | | +| shardproxyDebug | boolean| `bool` | | | | | +| shardproxyIgnoreTables | string| `string` | | | | | +| shardproxyJanitorWeights | string| `string` | | | | | +| shardproxyLoadSystem | boolean| `bool` | | | | | +| shardproxyLogLevel | integer| `int64` | | | | | +| shardproxyServers | string| `string` | | | | | +| shardproxyServers-ipv6 | string| `string` | | | | | +| shardproxyUniversalTables | string| `string` | | | | | +| slaposConfig | string| `string` | | | | | +| slaposDbPartitions | string| `string` | | | | | +| slaposHaproxyPartitions | string| `string` | | | | | +| slaposMaxscalePartitions | string| `string` | | | | | +| slaposProxysqlPartitions | string| `string` | | | | | +| slaposShardproxyPartitions | string| `string` | | | | | +| slaposSphinxPartitions | string| `string` | | | | | +| sphinx | boolean| `bool` | | | | | +| sphinxConfig | string| `string` | | | | | +| sphinxDebug | boolean| `bool` | | | | | +| sphinxJanitorWeights | string| `string` | | | | | +| sphinxLogLevel | integer| `int64` | | | | | +| sphinxPort | string| `string` | | | | | +| sphinxServers | string| `string` | | | | | +| sphinxServers-ipv6 | string| `string` | | | | | +| sphinxSqlPort | string| `string` | | | | | +| sstSendBuffer | integer| `int64` | | | | | +| switchoverAtEqualGtid | boolean| `bool` | | | | | +| switchoverAtSync | boolean| `bool` | | | | | +| switchoverDecreaseMaxConn | boolean| `bool` | | | | | +| switchoverDecreaseMaxConnValue | integer| `int64` | | | | | +| switchoverLowerRelease | boolean| `bool` | | | | | +| switchoverMaxSlaveDelay | integer| `int64` | | | | | +| switchoverSlaveWaitCatch | boolean| `bool` | | | | | +| switchoverWaitKill | integer| `int64` | | | | | +| switchoverWaitRouteChange | integer| `int64` | | | | | +| switchoverWaitTrx | integer| `int64` | | | | | +| switchoverWaitWriteQuery | integer| `int64` | | | | | +| sysbenchBinaryPath | string| `string` | | | | | +| sysbenchBinaryTest | string| `string` | | | | | +| sysbenchScale | integer| `int64` | | | | | +| sysbenchTables | integer| `int64` | | | | | +| sysbenchThreads | integer| `int64` | | | | | +| sysbenchTime | integer| `int64` | | | | | +| sysbenchV1 | boolean| `bool` | | | | | +| test | boolean| `bool` | | | | | +| testInjectTraffic | boolean| `bool` | | | | | +| topologyTarget | string| `string` | | | | | +| vaultAuth | string| `string` | | | | | +| vaultMode | string| `string` | | | | | +| vaultMount | string| `string` | | | | | +| vaultRoleId | string| `string` | | | | | +| vaultSecretId | string| `string` | | | | | +| vaultServerAddr | string| `string` | | | | | +| vaultToken | string| `string` | | | | | +| verbose | boolean| `bool` | | | | | +| version | string| `string` | | | | | +| withEmbed | string| `string` | | | | | +| withTarball | string| `string` | | | | | + + + +### gtid.Gtid + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| domainId | integer| `int64` | | | | | +| seqNo | integer| `int64` | | | | | +| serverId | integer| `int64` | | | | | + + + +### opensvc.Addr + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| addr | string| `string` | | | | | +| addr_type | string| `string` | | | | | +| intf | string| `string` | | | | | +| mask | string| `string` | | | | | +| net_broadcast | string| `string` | | | | | +| net_gateway | string| `string` | | | | | +| net_name | string| `string` | | | | | +| net_network | string| `string` | | | | | + + + +### opensvc.Host + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| cpu_cores | integer| `int64` | | | | | +| cpu_freq | integer| `int64` | | | | | +| id | integer| `int64` | | | | | +| ips | [][OpensvcAddr](#opensvc-addr)| `[]*OpensvcAddr` | | | | | +| mem_bytes | integer| `int64` | | | | | +| node_id | string| `string` | | | | | +| nodename | string| `string` | | | | | +| os_kernel | string| `string` | | | | | +| os_name | string| `string` | | | | | +| svc | [][OpensvcService](#opensvc-service)| `[]*OpensvcService` | | | | | + + + +### opensvc.Service + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| id | integer| `int64` | | | | | +| svc_id | string| `string` | | | | | +| svc_status | string| `string` | | | | | +| svcname | string| `string` | | | | | +| updated | string| `string` | | | | | + + + +### os.Process + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| pid | integer| `int64` | | | | | + + + +### regexp.Regexp + + + + +[interface{}](#interface) + +### repmanv3.BackupStat + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| total_blob_count | integer| `int64` | | | | | +| total_file_count | integer| `int64` | | | | | +| total_size | integer| `int64` | | | | | + + + +### repmanv3.Tag + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| category | string| `string` | | | | | +| id | integer| `int64` | | | | | +| name | string| `string` | | | | | + + + +### s18log.HttpLog + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| buffer | [][S18logHTTPMessage](#s18log-http-message)| `[]*S18logHTTPMessage` | | | | | +| len | integer| `int64` | | | | | +| line | integer| `int64` | | | | | + + + +### s18log.HttpMessage + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| group | string| `string` | | | | | +| level | string| `string` | | | | | +| text | string| `string` | | | | | +| timestamp | string| `string` | | | | | + + + +### server.ApiResponse + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| data | string| `string` | | | | | +| success | boolean| `bool` | | | | | + + + +### server.CredentialMailForm + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| type | string| `string` | | | | | +| username | string| `string` | | | | | + + + +### server.DecodedData + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| data | string| `string` | | | | | + + + +### server.Heartbeat + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| cluster | string| `string` | | | | | +| failed | integer| `int64` | | | | | +| hosts | integer| `int64` | | | | | +| id | integer| `int64` | | | | | +| master | string| `string` | | | | | +| secret | string| `string` | | | | | +| status | string| `string` | | | | | +| uuid | string| `string` | | | | | + + + +### server.ReplicationManager + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| agents | [][OpensvcHost](#opensvc-host)| `[]*OpensvcHost` | | | | | +| arch | string| `string` | | | | | +| backupBinlogList | map of boolean| `map[string]bool` | | | | | +| backupLogicalList | map of boolean| `map[string]bool` | | | | | +| backupPhysicalList | map of boolean| `map[string]bool` | | | | | +| binlogParseList | map of boolean| `map[string]bool` | | | | | +| canConnectVault | boolean| `bool` | | | | | +| clusters | []string| `[]string` | | | | | +| config | [GithubComSignal18ReplicationManagerConfigConfig](#github-com-signal18-replication-manager-config-config)| `GithubComSignal18ReplicationManagerConfigConfig` | | | | | +| confs | map of [GithubComSignal18ReplicationManagerConfigConfig](#github-com-signal18-replication-manager-config-config)| `map[string]GithubComSignal18ReplicationManagerConfigConfig` | | | | | +| cpuprofile | string| `string` | | | | | +| fullVersion | string| `string` | | | | | +| graphiteTemplateList | map of boolean| `map[string]bool` | | | | | +| hasSavingConfigQueue | boolean| `bool` | | | | | +| hostname | string| `string` | | | | | +| isGitPull | boolean| `bool` | | | | | +| isGitPush | boolean| `bool` | | | | | +| isSavingConfig | boolean| `bool` | | | | | +| logs | [S18logHTTPLog](#s18log-http-log)| `S18logHTTPLog` | | | | | +| memprofile | string| `string` | | | | | +| os | string| `string` | | | | | +| osUser | [UserUser](#user-user)| `UserUser` | | | | | +| partner | [ConfigPartner](#config-partner)| `ConfigPartner` | | | | | +| partners | [][ConfigPartner](#config-partner)| `[]*ConfigPartner` | | | | | +| serviceAcl | [][ConfigGrant](#config-grant)| `[]*ConfigGrant` | | | | | +| serviceDisk | map of string| `map[string]string` | | | | | +| serviceFS | map of boolean| `map[string]bool` | | | | | +| serviceOrchestrators | [][ConfigConfigVariableType](#config-config-variable-type)| `[]*ConfigConfigVariableType` | | | | | +| servicePlans | [][ConfigServicePlan](#config-service-plan)| `[]*ConfigServicePlan` | | | | | +| servicePool | map of boolean| `map[string]bool` | | | | | +| serviceRepos | [][ConfigDockerRepo](#config-docker-repo)| `[]*ConfigDockerRepo` | | | | | +| serviceRoles | [][ConfigRole](#config-role)| `[]*ConfigRole` | | | | | +| serviceTarballs | [][ConfigTarball](#config-tarball)| `[]*ConfigTarball` | | | | | +| serviceVM | map of boolean| `map[string]bool` | | | | | +| spitBrain | boolean| `bool` | | | | | +| status | string| `string` | | | | | +| termsDT | map of string| `map[string]string` | | | | | +| tests | []string| `[]string` | | | | | +| uuid | string| `string` | | | | | +| version | string| `string` | | | | | + + + +### server.token + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| token | string| `string` | | | | | + + + +### server.userCredentials + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| password | string| `string` | | | | | +| username | string| `string` | | | | | + + + +### sql.NullInt64 + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| int64 | integer| `int64` | | | | | +| valid | boolean| `bool` | | | Valid is true if Int64 is not NULL | | + + + +### sql.NullString + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| string | string| `string` | | | | | +| valid | boolean| `bool` | | | Valid is true if String is not NULL | | + + + +### state.Sla + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| firsttime | integer| `int64` | | | | | +| lasttime | integer| `int64` | | | | | +| uptime | integer| `int64` | | | | | +| uptimeFailable | integer| `int64` | | | | | +| uptimeSemisync | integer| `int64` | | | | | + + + +### state.StateHttp + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| desc | string| `string` | | | | | +| from | string| `string` | | | | | +| number | string| `string` | | | | | + + + +### state.StateMachine + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| discovered | boolean| `bool` | | | | | +| inFailover | boolean| `bool` | | | | | +| inSchemaMonitor | boolean| `bool` | | | | | + + + +### user.User + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| gid | string| `string` | | | Gid is the primary group ID.
On POSIX systems, this is a decimal number representing the gid.
On Windows, this is a SID in a string format.
On Plan 9, this is the contents of /dev/user. | | +| homeDir | string| `string` | | | HomeDir is the path to the user's home directory (if they have one). | | +| name | string| `string` | | | Name is the user's real or display name.
It might be blank.
On POSIX systems, this is the first (or only) entry in the GECOS field
list.
On Windows, this is the user's display name.
On Plan 9, this is the contents of /dev/user. | | +| uid | string| `string` | | | Uid is the user ID.
On POSIX systems, this is a decimal number representing the uid.
On Windows, this is a security identifier (SID) in a string format.
On Plan 9, this is the contents of /dev/user. | | +| username | string| `string` | | | Username is the login name. | | + + + +### version.Version + + + + + + +**Properties** + +| Name | Type | Go type | Required | Default | Description | Example | +|------|------|---------|:--------:| ------- |-------------|---------| +| dist | [VersionVersion](#version-version)| `VersionVersion` | | | | | +| flavor | string| `string` | | | | | +| major | integer| `int64` | | | | | +| minor | integer| `int64` | | | | | +| path | string| `string` | | | | | +| release | integer| `int64` | | | | | +| suffix | string| `string` | | | | | + + diff --git a/03.usage/03.api/docs.md b/03.usage/03.api/02.previous-versions/docs.md similarity index 87% rename from 03.usage/03.api/docs.md rename to 03.usage/03.api/02.previous-versions/docs.md index 786c1fe..03ccdd0 100644 --- a/03.usage/03.api/docs.md +++ b/03.usage/03.api/02.previous-versions/docs.md @@ -1,63 +1,9 @@ --- -title: API Client Usage +title: API Client Usage (v2 and older) taxonomy: category: docs --- -## API Client Usage - -The rest API is using JWT TLS and is served by default on port 10005 by the replication-manager monitor/ - -Credentials can be customized by setting your own user and password in configuration file. - -``` -api-port ="10005" -api-credential = "admin:repman" -``` - -At startup of the monitor, X509 certificates are loaded from the replication-manager share directory or from keys defined from config files to ensure TLS https secure communication. - -Replace those files with your own certificate signed or self signed to make sure your deployment is secured. - -``` -# Key considerations for algorithm "RSA" ≥ 2048-bit -openssl genrsa -out server.key 2048 - -# Key considerations for algorithm "ECDSA" ≥ secp384r1 -# List ECDSA the supported curves (openssl ecparam -list_curves) -openssl ecparam -genkey -name secp384r1 -out server.key -openssl req -new -x509 -sha256 -key server.key -out server.crt -days 3650 -``` - -At startup **replication-manager** monitor will generate in memory extra self-signed RSA certificate to ensure later token encryption exchange for JWT. - -# Calling API via the client - -API can be called via command line client to simplify curl syntax with JWT token. - -``` -./replication-manager-cli api --url="https://127.0.0.1:10005/api/clusters/ux_dck_zpool_loop/servers/actions/add/192.168.1.73/3306" --cluster="ux_dck_zpool_loop" -``` - -# Calling API via curl or wget - -TOKEN=$(curl -s -k -X POST -H 'Accept: application/json' -H 'Content-Type: application/json' --data '{"username":"admin","password":"repman"}' https://demo.signal18.io/api/login | jq -r '.token') - -or without json response - -TOKEN=$(curl -s -k -X POST -H 'Accept: text/html' -H 'Content-Type: application/json' --data '{"username":"admin","password":"repman"}' https://127.0.0.1:10005/api/login) - - -follow by your request: - -curl -k -H 'Accept: application/json' -H "Authorization: Bearer ${TOKEN}" https://demo.signal18.io/api/clusters - -Or via wget - -TOKEN=$(wget -qO- --no-check-certificate --post-data '{"username":"admin","password":"repman"}' --header 'Accept: text/html' --header 'Content-Type: application/json' https://127.0.0.1:10005/api/login) - -wget -qO- --no-check-certificate --header 'Accept: application/json' --header "Authorization: Bearer ${TOKEN}" https://127.0.0.1:10005/api/clusters - ### Monitor Unprotected Endpoints /api/login diff --git a/03.usage/03.api/chapter.md b/03.usage/03.api/chapter.md new file mode 100644 index 0000000..2699eee --- /dev/null +++ b/03.usage/03.api/chapter.md @@ -0,0 +1,8 @@ +--- +title: API Usage +taxonomy: + category: docs +--- +### Chapter 3 + +# API Usage From 42b75bb09226dd35a1fd32a855995ee506174109 Mon Sep 17 00:00:00 2001 From: caffeinated92 Date: Mon, 15 Sep 2025 09:59:34 +0700 Subject: [PATCH 2/4] Fix typo in API credential key from `api-credential` to `api-credentials` in documentation --- 03.usage/03.api/00.overview/docs.md | 2 +- 03.usage/03.api/02.previous-versions/docs.md | 2 +- 05.configuration/07.security/docs.md | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/03.usage/03.api/00.overview/docs.md b/03.usage/03.api/00.overview/docs.md index 6068dab..befd164 100644 --- a/03.usage/03.api/00.overview/docs.md +++ b/03.usage/03.api/00.overview/docs.md @@ -12,7 +12,7 @@ Credentials can be customized by setting your own user and password in configura ``` api-port ="10005" -api-credential = "admin:repman" +api-credentials = "admin:repman" ``` At startup of the monitor, X509 certificates are loaded from the replication-manager share directory or from keys defined from config files to ensure TLS https secure communication. diff --git a/03.usage/03.api/02.previous-versions/docs.md b/03.usage/03.api/02.previous-versions/docs.md index 03ccdd0..7fe9038 100644 --- a/03.usage/03.api/02.previous-versions/docs.md +++ b/03.usage/03.api/02.previous-versions/docs.md @@ -337,7 +337,7 @@ OUPUT: "prov-tls-server-ca": "", "prov-tls-server-cert": "", "prov-tls-server-key": "", - "api-credential": "admin:repman", + "api-credentials": "admin:repman", "api-port": "10005", "api-bind": "0.0.0.0", "alert-script": "", diff --git a/05.configuration/07.security/docs.md b/05.configuration/07.security/docs.md index c176a75..c4742ad 100644 --- a/05.configuration/07.security/docs.md +++ b/05.configuration/07.security/docs.md @@ -26,9 +26,9 @@ When an encryption key is detected at `replication-manager monitor` start, the e **replications-manager-cli** clients and API use JWT TLS protocol over https. -The REST API is secured using encrypted token that is used to validate user:password credential of the API, the client will use same default password and so enter the API without asking a password but if the configuration `api-credential` is changed, all client will prompt for the password unless given the correct parameter `user` and `password` flags. +The REST API is secured using encrypted token that is used to validate user:password credential of the API, the client will use same default password and so enter the API without asking a password but if the configuration `api-credentials` is changed, all client will prompt for the password unless given the correct parameter `user` and `password` flags. -##### `api-credential` (2.0), `user` (1.1) +##### `api-credentials` (2.0), `user` (1.1) | Item | Value | | ---- | ----- | From 469aa5130feb36458ee7c77be47b07c4052af395 Mon Sep 17 00:00:00 2001 From: caffeinated92 Date: Mon, 15 Sep 2025 10:11:48 +0700 Subject: [PATCH 3/4] Update API documentation section in latest and previous versions --- 03.usage/03.api/01.latest/docs.md | 4 ++++ 03.usage/03.api/02.previous-versions/docs.md | 3 --- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/03.usage/03.api/01.latest/docs.md b/03.usage/03.api/01.latest/docs.md index 56dc0bc..63d4f97 100644 --- a/03.usage/03.api/01.latest/docs.md +++ b/03.usage/03.api/01.latest/docs.md @@ -4,6 +4,10 @@ taxonomy: category: docs --- +## API documentation +[Can be browsed online] https://dbaas-fr-2.signal18.io/api-docs/index.html) +Or by installing the product and point to http://127.0.0.1:10001/api-docs + ## All endpoints ### auth diff --git a/03.usage/03.api/02.previous-versions/docs.md b/03.usage/03.api/02.previous-versions/docs.md index c85c117..7fe9038 100644 --- a/03.usage/03.api/02.previous-versions/docs.md +++ b/03.usage/03.api/02.previous-versions/docs.md @@ -27,9 +27,6 @@ OUPUT: /api/clusters/{clusterName}/status -## API documentation -[Can be browsed online] https://dbaas-fr-2.signal18.io/api-docs/index.html) -Or by installing the product and point to http://127.0.0.1:10001/api-docs # Version 2.0 & 2.1 /clusters/{clusterName}/servers/{serverName}/master-status From d38bb79ed11de3834e97babb88ad377723a56c4e Mon Sep 17 00:00:00 2001 From: caffeinated92 Date: Mon, 15 Sep 2025 10:15:42 +0700 Subject: [PATCH 4/4] Update API documentation to include online browsing link and installation instructions --- 03.usage/03.api/00.overview/docs.md | 6 +++++- 03.usage/03.api/01.latest/docs.md | 4 ---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/03.usage/03.api/00.overview/docs.md b/03.usage/03.api/00.overview/docs.md index befd164..979505f 100644 --- a/03.usage/03.api/00.overview/docs.md +++ b/03.usage/03.api/00.overview/docs.md @@ -56,4 +56,8 @@ Or via wget TOKEN=$(wget -qO- --no-check-certificate --post-data '{"username":"admin","password":"repman"}' --header 'Accept: text/html' --header 'Content-Type: application/json' https://127.0.0.1:10005/api/login) -wget -qO- --no-check-certificate --header 'Accept: application/json' --header "Authorization: Bearer ${TOKEN}" https://127.0.0.1:10005/api/clusters \ No newline at end of file +wget -qO- --no-check-certificate --header 'Accept: application/json' --header "Authorization: Bearer ${TOKEN}" https://127.0.0.1:10005/api/clusters + +## API documentation +[Can be browsed online] https://dbaas-fr-2.signal18.io/api-docs/index.html) +Or by installing the product and point to http://127.0.0.1:10001/api-docs \ No newline at end of file diff --git a/03.usage/03.api/01.latest/docs.md b/03.usage/03.api/01.latest/docs.md index 63d4f97..56dc0bc 100644 --- a/03.usage/03.api/01.latest/docs.md +++ b/03.usage/03.api/01.latest/docs.md @@ -4,10 +4,6 @@ taxonomy: category: docs --- -## API documentation -[Can be browsed online] https://dbaas-fr-2.signal18.io/api-docs/index.html) -Or by installing the product and point to http://127.0.0.1:10001/api-docs - ## All endpoints ### auth