API reference · Automation
GET/api/v1/automation/executions/{id}

Get automation execution

Returns one automation execution by execution_id for the authenticated tenant, with HATEOAS links to the parent rule and retry endpoint when the status is failed. Authentication uses x-api-key with optional x-tenant-id; the controller validates the API key, resolves tenant context, validates the UUID path parameter, and requires automation:read permission. The service scopes lookup by execution_id and tenant. Missing executions currently throw a generic Error and may surface as 500 rather than 404.

RBAC · automation

Path parameters

idstring <uuid>Required
Automation execution UUID from automation_executions.execution_id.

Response body

Success response 200 · schema AutomationExecutionResponse

dataobjectRequired
execution_idstring <uuid>Required
Execution UUID generated with crypto.randomUUID when the execution is created.
automation_rule_idstring <uuid>Required
Parent automation rule UUID.
trigger_dataobject
Trigger payload captured when execution started.
statusstringRequired
Current execution status.
Enum: pendingrunningcompletedfailedcancelledtimeoutskipped
started_atstring <date-time>
Timestamp when execution started.
completed_atstring <date-time>Nullable
Timestamp when execution completed.
duration_msnumberNullable
Execution duration in milliseconds.
≥ 0
actions_totalintegerRequired
Number of actions planned for this execution.
≥ 0
actions_successfulintegerRequired
Number of actions completed successfully.
≥ 0
actions_failedintegerRequired
Number of actions that failed.
≥ 0
error_messagestringNullable
Top-level error message, when failed.
error_stackstringNullable
Error stack, when captured.
failed_action_indexintegerNullable
Index of failed action, when applicable.
execution_contextobject
Execution context data.
logsarray of AutomationExecutionLogEntry
Execution log entries.
itemsobject
timestampstring <date-time>
Log timestamp.
levelstringRequired
Log level.
Enum: debuginfowarnerror
messagestringRequired
Log message.
action_indexinteger
Optional action index that produced the log.
metadataobject
Optional structured log metadata.
tenantstring <uuid>Required
Tenant UUID scoped from the API key context.
_linksobject
HATEOAS links generated by the automation controller. Some generic links may point to methods not implemented by a route file.

Response codes

200
Automation execution returned successfully.
400
Invalid execution UUID format.
401
API key is missing, invalid, expired, over limit, or the key user was not found.
403
Authenticated user lacks automation:read permission.
404
Intended not-found response for a missing execution; current service may surface this as 500.
500
Unexpected failure, including current generic not-found errors.