Skip to content
  • Auto
  • Light
  • Dark
Get Started

Automation Executions

Automation Executions

Automation Executions

Get Automation Execution
client.AutomationExecutions.Get(ctx, id) (*AutomationExecutionAutomationExecutionAutomationExecutionGetResponse, error)
get/api/v1/automation_executions/{id}
List Automation Executions
client.AutomationExecutions.List(ctx) (*AutomationExecutionsarrayNextPageTokenstringAutomationExecutionListResponse, error)
get/api/v1/automation_executions
Search Automation Executions
client.AutomationExecutions.Search(ctx, body) (*ExpandedarrayListarrayNextPageTokenstringAutomationExecutionSearchResponse, error)
post/api/v1/automation_executions/search
Automation Execution
AutomationExecutionstruct

The AutomationExecution message.

ShowShow
IDstring
optional

The id field.

formatint64
AutomationTemplateIDstring
optional

The automationTemplateId field.

CompletedAtTime
optional
formatdate-time
ContextContextmapAutomationContext
optional

The AutomationContext message.

CreatedAtTime
optional
formatdate-time
CurrentVersionint64
optional

The currentVersion field.

formatint32
DeletedAtTime
optional
formatdate-time
Durationstring
optional
formatduration
IsDraftbool
optional

The isDraft field.

StateAutomationExecutionStateAutomationExecutionStateUnspecifiedAutomationExecutionStateAutomationExecutionStateAutomationExecutionStatePendingAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateCreatingAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateGetStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateProcessStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateCompleteStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateDoneAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateErrorAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateTerminateAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateWaitingAutomationExecutionStateAutomationExecutionState
optional

The state field.

Hide ParametersShow Parameters
AutomationExecutionStateAutomationExecutionStateUnspecifiedconst
AutomationExecutionStateAutomationExecutionStateUnspecifiedAutomationExecutionStateAutomationExecutionStateAutomationExecutionStatePendingAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateCreatingAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateGetStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateProcessStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateCompleteStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateDoneAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateErrorAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateTerminateAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateWaitingAutomationExecutionStateAutomationExecutionState
"AUTOMATION_EXECUTION_STATE_UNSPECIFIED"
AutomationExecutionStateAutomationExecutionStatePendingconst
AutomationExecutionStateAutomationExecutionStateUnspecifiedAutomationExecutionStateAutomationExecutionStateAutomationExecutionStatePendingAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateCreatingAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateGetStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateProcessStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateCompleteStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateDoneAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateErrorAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateTerminateAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateWaitingAutomationExecutionStateAutomationExecutionState
"AUTOMATION_EXECUTION_STATE_PENDING"
AutomationExecutionStateAutomationExecutionStateCreatingconst
AutomationExecutionStateAutomationExecutionStateUnspecifiedAutomationExecutionStateAutomationExecutionStateAutomationExecutionStatePendingAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateCreatingAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateGetStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateProcessStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateCompleteStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateDoneAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateErrorAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateTerminateAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateWaitingAutomationExecutionStateAutomationExecutionState
"AUTOMATION_EXECUTION_STATE_CREATING"
AutomationExecutionStateAutomationExecutionStateGetStepconst
AutomationExecutionStateAutomationExecutionStateUnspecifiedAutomationExecutionStateAutomationExecutionStateAutomationExecutionStatePendingAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateCreatingAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateGetStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateProcessStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateCompleteStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateDoneAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateErrorAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateTerminateAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateWaitingAutomationExecutionStateAutomationExecutionState
"AUTOMATION_EXECUTION_STATE_GET_STEP"
AutomationExecutionStateAutomationExecutionStateProcessStepconst
AutomationExecutionStateAutomationExecutionStateUnspecifiedAutomationExecutionStateAutomationExecutionStateAutomationExecutionStatePendingAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateCreatingAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateGetStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateProcessStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateCompleteStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateDoneAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateErrorAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateTerminateAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateWaitingAutomationExecutionStateAutomationExecutionState
"AUTOMATION_EXECUTION_STATE_PROCESS_STEP"
AutomationExecutionStateAutomationExecutionStateCompleteStepconst
AutomationExecutionStateAutomationExecutionStateUnspecifiedAutomationExecutionStateAutomationExecutionStateAutomationExecutionStatePendingAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateCreatingAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateGetStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateProcessStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateCompleteStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateDoneAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateErrorAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateTerminateAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateWaitingAutomationExecutionStateAutomationExecutionState
"AUTOMATION_EXECUTION_STATE_COMPLETE_STEP"
AutomationExecutionStateAutomationExecutionStateDoneconst
AutomationExecutionStateAutomationExecutionStateUnspecifiedAutomationExecutionStateAutomationExecutionStateAutomationExecutionStatePendingAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateCreatingAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateGetStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateProcessStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateCompleteStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateDoneAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateErrorAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateTerminateAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateWaitingAutomationExecutionStateAutomationExecutionState
"AUTOMATION_EXECUTION_STATE_DONE"
AutomationExecutionStateAutomationExecutionStateErrorconst
AutomationExecutionStateAutomationExecutionStateUnspecifiedAutomationExecutionStateAutomationExecutionStateAutomationExecutionStatePendingAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateCreatingAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateGetStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateProcessStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateCompleteStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateDoneAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateErrorAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateTerminateAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateWaitingAutomationExecutionStateAutomationExecutionState
"AUTOMATION_EXECUTION_STATE_ERROR"
AutomationExecutionStateAutomationExecutionStateTerminateconst
AutomationExecutionStateAutomationExecutionStateUnspecifiedAutomationExecutionStateAutomationExecutionStateAutomationExecutionStatePendingAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateCreatingAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateGetStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateProcessStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateCompleteStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateDoneAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateErrorAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateTerminateAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateWaitingAutomationExecutionStateAutomationExecutionState
"AUTOMATION_EXECUTION_STATE_TERMINATE"
AutomationExecutionStateAutomationExecutionStateWaitingconst
AutomationExecutionStateAutomationExecutionStateUnspecifiedAutomationExecutionStateAutomationExecutionStateAutomationExecutionStatePendingAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateCreatingAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateGetStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateProcessStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateCompleteStepAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateDoneAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateErrorAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateTerminateAutomationExecutionStateAutomationExecutionStateAutomationExecutionStateWaitingAutomationExecutionStateAutomationExecutionState
"AUTOMATION_EXECUTION_STATE_WAITING"
UpdatedAtTime
optional
formatdate-time

Automation ExecutionsActions

Terminate Automation
client.AutomationExecutions.Actions.Terminate(ctx, id, body) (*AutomationExecutionActionTerminateResponse, error)
post/api/v1/automation_executions/{id}/actions/terminate