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.11] ›RESTful API ›API reference ›Clusters - Elasticsearch - CRUD - Configuration

Set legacy security settings

edit

Set legacy security settings

edit

DEPRECATED (Scheduled to be removed in the next major version): Sets the legacy Shield security settings for a 2.x Elasticsearch cluster.

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)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_not_found])
The error codes associated with the response
449

(BasicFailedReply) Elevated permissions are required. (code: root.unauthorized.rbac.elevated_permissions_required)

Headers

x-cloud-error-codes (string; allowed values: [root.unauthorized.rbac.elevated_permissions_required])
The error codes associated with the response

Request example

edit
curl -XPUT https://{{hostname}}/api/v1/clusters/elasticsearch/{cluster_id}/settings/security/legacy \
-H "Authorization: ApiKey $ECE_API_KEY" \
-H 'Content-Type: application/json' \
-d '
{
   "roles_yaml" : "string",
   "users_roles_yaml" : "string",
   "users_yaml" : "string"
}
'
« Get pending plan Get cluster snapshot settings »