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.
Add or remove settings from the Elasticsearch resource keystoreedit
Fetches the current values of the keystore for the Elasticsearch resource.
Requestedit
PATCH /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
Identifier for the Deployment |
|
|
Y |
User-specified RefId for the Resource |
Request bodyedit
(KeystoreContents
) (required) The new settings that will be applied to the keystore of the Elasticsearch resource.
Responsesedit
-
200
-
(
KeystoreContents
) The new value for the keystore contents -
404
-
(
BasicFailedReply
) * The Deployment specified by {deployment_id} cannot be found. (code:deployments.deployment_not_found
) * The Resource specified by {ref_id} cannot be found. (code:deployments.deployment_resource_not_found
)Headers
-
x-cloud-error-codes
(string
; allowed values: [deployments.deployment_not_found
,deployments.deployment_resource_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
-
-
500
-
(
BasicFailedReply
) We have failed you. (code:deployments.metadata_internal_error
)Headers
-
x-cloud-error-codes
(string
; allowed values: [deployments.metadata_internal_error
]) - 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 -XPATCH https://{{hostname}}/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore \ -H "Authorization: ApiKey $ECE_API_KEY" \ -H 'Content-Type: application/json' \ -d ' { "secrets" : { "some_property" : { "as_file" : true, "value" : {} } } } '