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.
Set legacy security settingsedit
DEPRECATED (Scheduled to be removed in the next major version): Sets the legacy Shield security settings for a 2.x Elasticsearch cluster.
Requestedit
PUT /api/v1/clusters/elasticsearch/{cluster_id}/settings/security/legacy
Path parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
The Elasticsearch cluster identifier. |
Request bodyedit
(LegacySecuritySettings) (required) The legacy security settings
Responsesedit
-
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
-
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
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"
}
'