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

• 202

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

  Hide response attributes Show response attributes object

  • 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)

    Additional properties are allowed.

• 400

  Reset token is not supported when APM is managed by Elastic Agent. (code: clusters.cluster_plan_state_error)

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is clusters.cluster_plan_state_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

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

  Hide headers attribute Show headers attribute

  • x-cloud-error-codes string

    The error codes associated with the response

    Value is deployments.deployment_resource_no_longer_exists.

  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