Index

Get cluster info {#get-cluster}

GET /v1/cluster

Get cluster info.

Required permissions

Request {#get-request}

Example HTTP request

GET /v1/cluster 

Request headers

Response {#get-response}

Returns a [cluster object]({{< relref "/operate/rs/references/rest-api/objects/cluster" >}}).

Example JSON body

{
   "name": "my-rlec-cluster",
   "alert_settings": { "..." },
   "created_time": "2015-04-29T09:09:25Z",
   "email_alerts": false,
   "email_from": "",
   "rack_aware": false,
   "smtp_host": "",
   "smtp_password": "",
   "smtp_port": 25,
   "smtp_tls_mode": "none",
   "smtp_username": ""
}

Status codes {#get-status-codes}

Update cluster settings {#put-cluster}

PUT /v1/cluster

Update cluster settings.

If called with the dry_run URL query string, the function will validate the [cluster object]({{< relref "/operate/rs/references/rest-api/objects/cluster" >}}), but will not apply the requested changes.

Required permissions

Request {#put-request}

Example HTTP request

PUT /v1/cluster 

Example JSON body

{
    "email_alerts": true,
    "alert_settings": {
        "node_failed": true,
        "node_memory": {
            "enabled": true,
            "threshold": "80"
        }
    }
}

The above request will enable email alerts and alert reporting for node failures and node removals.

Request headers

URL parameters

Request body

Include a [cluster object]({{< relref "/operate/rs/references/rest-api/objects/cluster" >}}) with updated fields in the request body.

Response {#put-response}

Example JSON body

{
    "name": "mycluster.mydomain.com",
    "email_alerts": true,
    "alert_settings": {
        "node_failed": true,
        "node_memory": {
            "enabled": true,
            "threshold": "80"
        }
    },
    "// additional fields..."
}

Error codes {#put-error-codes}

When errors are reported, the server may return a JSON object with error_code and message field that provide additional information. The following are possible error_code values:

Status codes {#put-status-codes}