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.

« Deployment Resources - CRUD Add or remove settings from the Elasticsearch resource keystore »
Elastic Docs ›Elastic Cloud Enterprise Reference [2.7] ›RESTful API ›API reference ›Deployment Resources - CRUD

Get the settings from the Elasticsearch resource keystore

edit

Get the settings from the Elasticsearch resource keystore

edit

Adds the specified values to the Elasticsearch keystore, or removes the keys for the unspecified values.

Request

edit

GET /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore

Path parameters

edit
Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment

ref_id

string

Y

User-specified RefId for the Resource

Responses

edit
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 example

edit
curl -XGET https://{{hostname}}/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore \
-H "Authorization: ApiKey $ECE_API_KEY"
« Deployment Resources - CRUD Add or remove settings from the Elasticsearch resource keystore »