Endpoint

/v1/cluster/settings

GET

Returns cluster settings.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_cluster_name_settings",
  "type": "object",
  "properties": {
    "cluster_name": {
      "description": "Name of the cluster",
      "type": "string"
    }
  }
}

PUT

Set the name of the cluster

Parameters

Name Description Required
If-Match ETag for expected version No

Request

Schema

{
  "description": "api_cluster_name_settings",
  "type": "object",
  "properties": {
    "cluster_name": {
      "description": "Name of the cluster",
      "type": "string"
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_cluster_name_settings",
  "type": "object",
  "properties": {
    "cluster_name": {
      "description": "Name of the cluster",
      "type": "string"
    }
  }
}