Skip to main content
ZStack
Infrastructure/Agents

SendAction

Send a lifecycle action command (start, stop, restart) to a specific agent

POST/api/v1/agents/{uuid}/actions/{action}

Operation ID

SendAction

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 to send the action to

  • action
    StringRequired

    Lifecycle action name (start, stop, restart)

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • actionId
    String

    Unique identifier of the dispatched action for tracking

    Example: act-001-xyz