API Reference
Activities
Trigger and track runtime actions on deployment nodes (start, stop, restart, reconfigure).
API Variables
ld-api-key
{tenant_id}
Set variables to auto-fill all examples and run requests in-browser.
Activities are runtime actions dispatched to deployment nodes by the Supervisor. Each targeted node gets its own activity entry with independent status tracking. All endpoints use the Supervisor API ({supervisor_url}).
Supported Runtimes and Actions
| Runtime | Actions |
|---|---|
iggy | start, stop, restart, reconfigure:{config_id} |
connectors | start, stop, restart, reconfigure:{config_id} |
Activity Status
| Status | Meaning |
|---|---|
processing | Action dispatched, waiting for node to complete |
completed | Action finished successfully |
rejected | Action failed or was rejected by the node |
Trigger a Runtime Action
POST{supervisor_url}/deployments/{deployment_id}/activities/{runtime}/{action}Execute a runtime action on all nodes (or specific nodes) in a deployment.
| Path Parameter | Values |
|---|---|
runtime | iggy, connectors |
action | start, stop, restart, reconfigure:{config_id} |
Target all nodes (omit body or send {}):
bash
curl -X POST {supervisor_url}/deployments/{deployment_id}/activities/iggy/restart \
-H "ld-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'Target specific nodes (pass node IDs):
bash
curl -X POST {supervisor_url}/deployments/{deployment_id}/activities/iggy/restart \
-H "ld-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"nodes": [610809900976570889]
}'| Field | Required | Description |
|---|---|---|
nodes | No | Array of node IDs to target. Omit or send {} to target all nodes. |
Returns 202 Accepted.
Required permission: deployment:manage
List Activities
GET{supervisor_url}/deployments/{deployment_id}/activitiesRetrieve the activity log for this deployment, paginated.
bash
curl "{supervisor_url}/deployments/{deployment_id}/activities?page=1&results=10" \
-H "ld-api-key: YOUR_API_KEY"{
"items": [
{
"id": 1,
"tenant_id": 1,
"division_id": 1,
"environment_id": 1,
"deployment_id": 1,
"author_id": 608123456789012345,
"runtime": "iggy",
"action": "restart",
"node_id": 610809900976570889,
"status": "completed",
"created_at": "2026-03-16T12:00:00Z",
"finished_at": "2026-03-16T12:00:05Z"
}
],
"page": 1,
"total_results": 1,
"total_pages": 1
}Required permission: deployment:read