Reset the secret token for an APM resource.

Base URL: https://api.elastic-cloud.com/api/v1

POST /deployments/{deployment_id}/apm/{ref_id}/_reset-token

No auth

Reset the token of an APM 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

Response containing the new secret token, plan to apply it starts

application/json

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)

application/json

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.deployment_resource_no_longer_exists)

application/json

Base URL: https://api.elastic-cloud.com/api/v1

Examples

Request curl 1 / 1 language

curl Shell

curl -X POST "https://api.elastic-cloud.com/api/v1/deployments/${DEPLOYMENT_ID}/apm/${REF_ID}/_reset-token"

Generated from the API spec

Response

{
  "apm_id": "string",
  "secret_token": "string",
  "diagnostics": {}
}

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

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

Generated from the API spec