Skip to main content
API Explorer|API Explorer
Infrastructure/Agents
GETAgentSince 1.0SynchronousAuth Required

GetActionResult

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

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    UUID of the agent that received the action

  • actionIdStringRequired

    Identifier of the action whose result to query

Responses

200 OK

On success, this API returns the following response structure.

  • actionIdString

    Unique identifier of the lifecycle action

    Example: act-001-xyz

  • agentIdString

    UUID of the agent the action was applied to

    Example: agent-abc123-def456

  • actionString

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

    Example: restart

  • statusString

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

    Example: success

  • errorString

    Error message if the action failed, empty otherwise

    Example: connection refused

  • createdAtString

    Created at

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

Endpoint

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

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

Operation ID

GetActionResult

Permalink

Request Example

curl -X GET '{host}/api/v1/agents/{uuid}/actions/{actionId}/result' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "actionId": "act-001-xyz",
  "agentId": "agent-abc123-def456",
  "action": "restart",
  "status": "success",
  "error": "connection refused",
  "createdAt": "example"
}

Change History

This API has no change history records yet.

View all change history