Add or remove items from the Elasticsearch resource keystore

PATCH /deployments/{deployment_id}/elasticsearch/{ref_id}/keystore

Auth

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

Path parameters

deployment_id string required: Identifier for the Deployment
ref_id string required: User-specified RefId for the Resource (or '_main' if there is only one)

Request body

The new settings that will be applied to the keystore of the Elasticsearch resource.

secrets map string to object required: List of secrets

Responses

The new contents of the Elasticsearch keystore

application/json

secrets map string to object required: List of secrets

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)

application/json

We have failed you. (code: deployments.metadata_internal_error)

application/json

View as Markdown

Examples

Request curl 1 / 1 language

curl Shell

curl -X PATCH "${API_URL}/deployments/${DEPLOYMENT_ID}/elasticsearch/${REF_ID}/keystore" \
  -u "${USERNAME}:${PASSWORD}" \
  -H "Content-Type: application/json" \
  -d '{
    "secrets": {}
  }'

Generated from the API spec

Response

{
  "secrets": {
    "key": {
      "value": {},
      "as_file": false
    }
  }
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec