Path parameters

• deployment_id string Required

  Identifier for the Deployment

• resource_kind string Required

  The kind of resource

  Values are elasticsearch, kibana, apm, appsearch, enterprise_search, or integrations_server.

• ref_id string Required

  User-specified RefId for the Resource (or '_main' if there is only one)

• attempt_id string Required

  Attempt id for the activity

Responses

• 200 application/json

  Returning the single plan activity for the specified resource

  Hide response attributes Show response attributes object

  • plan_attempt_id string
  • plan_attempt_name string
  • healthy boolean Required
  • attempt_start_time string(date-time)
  • attempt_end_time string(date-time)
  • plan_end_time string(date-time)
  • plan object
  • plan_attempt_log array[object] Required

    Information about a step in a plan.

    Hide plan_attempt_log attributes Show plan_attempt_log attributes object

    • step_id string Required

      ID of current step

    • started string(date-time) Required

      When the step started (ISO format in UTC)

    • completed string(date-time)

      When the step completed (ISO format in UTC)

    • duration_in_millis integer(int64)

      The duration of the step in MS

    • status string Required

      The status of the step (success, warning, error - warning means something didn't go as expected but it was not serious enough to abort the plan)

      Values are success, warning, error, or pending.

    • stage string Required

      Current stage that the step is in

      Values are starting, completed, or in_progress.

    • info_log array[object] Required

      Human readable summaries of the step, including messages for each stage of the step

      The log message from a specified stage of an executed step in a plan.

      Hide info_log attributes Show info_log attributes object

      • timestamp string(date-time) Required

        Timestamp marking on info log of step

      • delta_in_millis integer(int64)

        Time in milliseconds since previous log message

      • stage string Required

        Stage that info log message takes place in

        Values are starting, completed, or in_progress.

      • message string Required

        Human readable log message

      • details object Required

        A map with details for the log about what happened during the step execution. Keys and values for are always both strings, representing the name of the detail and its value, respectively.

        Hide details attribute Show details attribute object

        • * string Additional properties
      • internal_details object

        A json object with sensitive details for the log, visible only to admins. May contain nested json objects.

        Hide internal_details attribute Show internal_details attribute object

        • * string Additional properties
      • failure_type string

        The failure type, in case the step failed

  • source object

    A container for information about the source of a change.

    Hide source attributes Show source attributes object

    • facilitator string Required

      The service where the change originated from

    • action string Required

      The type of plan change that was initiated

    • date string(date-time) Required

      The time the change was initiated

    • user_id string

      The user that requested the change

    • admin_id string

      The admin user that requested the change

    • remote_addresses array[string]

      The host addresses of the user that originated the change

  • warnings array[object] Required

    Information about a warning from a plan.

    Hide warnings attributes Show warnings attributes object

    • code string Required

      A unique warning code

    • message string Required

      A description of the warning

    • step_id string

      The ID of the step which produced a warning, if any

  • error object

    Information about an error during a plan attempt.

    Hide error attributes Show error attributes object

    • timestamp string(date-time) Required

      Timestamp marking on info log of step

    • message string Required

      Human readable error message

    • details object Required

      A map with details regarding the error. Both the keys and values are always strings, representing the name of the detail and its value, respectively.

      Hide details attribute Show details attribute object

      • * string Additional properties
    • failure_type string

      The failure type

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