Update cluster metadata settings

edit

Any changes in the PATCHed object will be applied to the metadata object. PATCHing existing fields will cause same values to be re-applied.PATCHing a value of 'null' will cause the field to be reverted to it's default value or removed if no default value exists

Request

edit

PATCH /api/v1/clusters/kibana/{cluster_id}/metadata/settings

Path parameters

edit
Name Type Required Description

cluster_id

string

Y

The Kibana deployment identifier.

Query parameters

edit
Name Type Required Description

version

integer

N

Checks for conflicts against the metadata version, then returns the value in the x-cloud-resource-version header.

Request body

edit

(ClusterMetadataSettings) (required) The cluster settings including updated values

Responses

edit
200

(ClusterMetadataSettings) The cluster metadata was successfully updated

Headers

x-cloud-resource-created (string)
The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string)
The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string)
The version of the resource - used to avoid update conflicts from multiple concurrent operations
403

(BasicFailedReply) The provided action was prohibited for the given cluster

404

(BasicFailedReply) The cluster specified by {cluster_id} cannot be found (code: 'clusters.cluster_not_found')

449

(BasicFailedReply) elevated permissions are required. (code: '"root.needs_elevated_permissions"')

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit
curl -XPATCH {{hostname}}/api/v1/clusters/kibana/{cluster_id}/metadata/settings \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
   "contact_email" : "string",
   "hidden" : true,
   "name" : "string",
   "owner_id" : "string",
   "resources" : {
      "cpu" : {
         "boost" : true,
         "hard_limit" : true
      }
   },
   "subscription_level" : "string",
   "system_owned" : true
}
'