Get the items in the Elasticsearch resource keystore

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

Fetches the current fields and metadata (but not the values) of the keystore for the Elasticsearch resource.

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)

Responses

200

The contents of the Elasticsearch keystore, with values redacted
Hide response attribute Show response attribute object
- secrets object Required
  
  List of secrets
  
  Hide secrets attribute Show secrets attribute object
  
  * object Additional properties
  
  The value that you configure for the Elasticsearch keystore secret.
  
  Additional properties are allowed.
  
  Hide * attributes Show * attributes object
  
  value object
  
  Value of this setting. This can either be a string or a JSON object that is stored as a JSON string in the keystore. NOTE: When the keystore secret is unspecified, it is removed.
  
  Additional properties are allowed.
  
  as_file boolean
  
  Stores the keystore secret as a file. The default is false, which stores the keystore secret as string when value is a plain string, or true when value is an object.
404
- 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)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Values are deployments.deployment_not_found or deployments.deployment_resource_not_found.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields
500

We have failed you. (code: deployments.metadata_internal_error)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is deployments.metadata_internal_error.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields

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

curl \
 -X GET https://{{hostname}}/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}/keystore

Response examples (200)

{
  "secrets": {
    "additionalProperty1": {
      "value": {},
      "as_file": true
    },
    "additionalProperty2": {
      "value": {},
      "as_file": true
    }
  }
}

Response examples (404)

# Headers
x-cloud-error-codes: deployments.deployment_not_found

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

Response examples (500)

# Headers
x-cloud-error-codes: deployments.metadata_internal_error

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