It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Get pending plan Get cluster snapshot settings »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.0] ›RESTful API ›API reference ›Clusters - Elasticsearch - CRUD - Configuration

Set legacy security settings

edit

Set legacy security settings

edit

Sets legacy security (Shield) settings for a 2.x Elasticsearch cluster. Newer (> 2.x) clusters have their Shield settings managed externally via X-Pack in Kibana.

Request

edit

PUT /api/v1/clusters/elasticsearch/{cluster_id}/settings/security/legacy

Path parameters

edit
Name Type Required Description

cluster_id

string

Y

The Elasticsearch cluster identifier.

Request body

edit

(LegacySecuritySettings) (required) The legacy security settings

Responses

edit
200

(LegacySecuritySettings) Returns the updated legacy security settings for the specified cluster

404

(BasicFailedReply) The cluster specified at {cluster_id} could not 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 -XPUT {{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/settings/security/legacy \
-u $CLOUD_USER:$CLOUD_KEY \
-H 'Content-Type: application/json' \
-d '
{
   "roles_yaml" : "string",
   "users_roles_yaml" : "string",
   "users_yaml" : "string"
}
'
« Get pending plan Get cluster snapshot settings »