Add or remove items from the Elasticsearch resource keystore

edit

Add or remove items from the Elasticsearch resource keystore

edit

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

Request

edit

PATCH /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 (or '_main' if there is only one)

Request body

edit

(KeystoreContents) (required) The new settings that will be applied to the keystore of the Elasticsearch resource.

Responses

edit

200

(KeystoreContents)

The new contents of the Elasticsearch keystore

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

Request example

edit

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" : {}
      }
   }
}
'

« Get the items in the Elasticsearch resource keystore Restores a shutdown resource »