Reset the secret token for an APM resource.
- Base URL
-
https://api.elastic-cloud.com/api/v1
No auth
Reset the token of an APM resource.
-
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).
Response containing the new secret token, plan to apply it starts
-
apm_id
string
-
For an operation creating or updating an APM server, the Id of that server
-
secret_token
string
required
-
The secret token for accessing the server
-
diagnostics
object
-
If the endpoint is called with URL param 'validate_only=true', then this contains advanced debug info (the internal plan representation)
Reset token is not supported when APM is managed by Elastic Agent. (code: clusters.cluster_plan_state_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
- 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.deployment_resource_no_longer_exists)
-
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