IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Set legacy security settingsedit
This endpoint is deprecated and 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
-
Returns the updated legacy security settings for the specified cluster
-
404
-
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
-
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 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" } '