Reset the secret token for an APM resource.
editReset the secret token for an APM resource.
editReset the token of an APM resource.
Request
editPOST /api/v1/deployments/{deployment_id}/apm/{ref_id}/_reset-token
Path parameters
edit| Name | Type | Required | Description |
|---|---|---|---|
|
|
Y |
Identifier for the Deployment. |
|
|
Y |
User-specified RefId for the Resource (or '_main' if there is only one). |
Responses
edit-
202 -
Response containing the new secret token, plan to apply it starts
-
400 -
Reset token is not supported when APM is managed by Elastic Agent. (code:
clusters.cluster_plan_state_error)Headers
-
x-cloud-error-codes(string; allowed values: [clusters.cluster_plan_state_error]) - The error codes associated with the response
-
-
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)
Headers
-
x-cloud-error-codes(string; allowed values: [deployments.deployment_not_found,deployments.deployment_resource_not_found]) - The error codes associated with the response
-
The Deployment specified by {deployment_id} cannot be found. (code:
-
500 -
We have failed you. (code:
deployments.deployment_resource_no_longer_exists)Headers
-
x-cloud-error-codes(string; allowed values: [deployments.deployment_resource_no_longer_exists]) - The error codes associated with the response
-
Request example
editcurl -XPOST https://{{hostname}}/api/v1/deployments/{deployment_id}/apm/{ref_id}/_reset-token \
-H "Authorization: ApiKey $ECE_API_KEY"