Skip to main content
ZStack
Infrastructure/Agents

GetActionResult

Poll the result of a previously dispatched lifecycle action on an agent

GET/api/v1/agents/{uuid}/actions/{actionId}/result

Operation ID

GetActionResult

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Path Parameters

  • uuid
    StringRequired

    UUID of the agent that received the action

  • actionId
    StringRequired

    Identifier of the action whose result to query

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • actionId
    String

    Unique identifier of the lifecycle action

    Example: act-001-xyz

  • agentId
    String

    UUID of the agent the action was applied to

    Example: agent-abc123-def456

  • action
    String

    Name of the lifecycle action (start, stop, restart)

    Example: restart

  • status
    String

    Current status of the action (pending, running, success, failed)

    Example: success

  • error
    String

    Error message if the action failed, empty otherwise

    Example: connection refused

  • createdAt
    String

    Created at

    Example: 2026-01-15T08:00:00Z