Returning the single plan activity for the specified resource
application/json
plan_attempt_idstring
plan_attempt_namestring
healthybooleanrequired
attempt_start_timestring · format: date-time
attempt_end_timestring · format: date-time
plan_end_timestring · format: date-time
planobject
plan_attempt_logobject[]required
step_idstringrequired
ID of current step
startedstring · format: date-timerequired
When the step started (ISO format in UTC)
completedstring · format: date-time
When the step completed (ISO format in UTC)
duration_in_millisinteger · format: int64
The duration of the step in MS
statusenumrequired
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:successwarningerrorpending
stageenumrequired
Current stage that the step is in
Values:startingcompletedin_progress
info_logobject[]required
Human readable summaries of the step, including messages for each stage of the step
timestampstring · format: date-timerequired
Timestamp marking on info log of step
delta_in_millisinteger · format: int64
Time in milliseconds since previous log message
stageenumrequired
Stage that info log message takes place in
Values:startingcompletedin_progress
messagestringrequired
Human readable log message
detailsmapstring to stringrequired
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.
internal_detailsmapstring to string
A json object with sensitive details for the log, visible only to admins. May contain nested json objects.
failure_typestring
The failure type, in case the step failed
sourceobject
A container for information about the source of a change.
facilitatorstringrequired
The service where the change originated from
actionstringrequired
The type of plan change that was initiated
datestring · format: date-timerequired
The time the change was initiated
user_idstring
The user that requested the change
admin_idstring
The admin user that requested the change
remote_addressesstring[]
The host addresses of the user that originated the change
warningsobject[]required
codestringrequired
A unique warning code
messagestringrequired
A description of the warning
step_idstring
The ID of the step which produced a warning, if any
errorobject
Information about an error during a plan attempt.
timestampstring · format: date-timerequired
Timestamp marking on info log of step
messagestringrequired
Human readable error message
detailsmapstring to stringrequired
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.
failure_typestring
The failure type
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
errorsobject[]required
A list of errors that occurred in the failing request
codestringrequired
A structured code representing the error type that occurred
messagestringrequired
A human readable message describing the error that occurred
fieldsstring[]
If the error can be tied to a specific field or fields in the user request, this lists those fields