Get the user settings of a Deployment resource
- Base URL
-
https://api.elastic-cloud.com/api/v1
No auth
Retrieves the current user-defined settings for a resource belonging to a given Deployment.
-
deployment_id
string
required
-
Identifier for the Deployment
-
resource_kind
enum
required
-
The kind of resource
-
Values:
elasticsearch
kibana
apm
appsearch
enterprise_search
integrations_server
-
ref_id
string
required
-
User-specified RefId for the Resource (or '_main' if there is only one)
The current user-defined settings for the resource
-
user_settings
object
-
The user-defined settings for the resource
- 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)
-
errors
object[]
required
-
A list of errors that occurred in the failing request
-
-
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
string[]
-
If the error can be tied to a specific field or fields in the user request, this lists those fields
We have failed you. (code: deployments.metadata_internal_error)
-
errors
object[]
required
-
A list of errors that occurred in the failing request
-
-
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
string[]
-
If the error can be tied to a specific field or fields in the user request, this lists those fields