List a run's events

GET

/api/v2/orchestrations/runs/{run_id}/events

The run's stored events as JSON, {id, event} each, oldest first — the run log. start and end are event ids, inclusive; - and + mean the first and the last.

Authorization

apiKey

headerAuthorizationBearer <token>

An API key, sk-syn- and 32 characters. On SynapseOrch Cloud an owner or admin makes it under Settings → Developer; on a self-hosted install, under Settings → API Keys.

Path Parameters

run_id*string

The run.

Query Parameters

start?string

The first event id to return; - (the default) is the first event.

Lengthlength <= 64

Default"-"

end?string

The last event id to return; + (the default) is the last event.

Lengthlength <= 64

Default"+"

Response Body

The events.

application/json

response

run_id?string

count?integer

events?array<>

curl -X GET "https://api.synapseorch.com/api/v2/orchestrations/runs/run_01a10a1553d57036bae3d17421a4ba16/events" \  -H "Authorization: Bearer sk-syn-..."

{  "run_id": "run_01a111a910667216b459f4b6e770eec6",  "count": 2,  "events": [    {      "id": "1790249607461-0",      "event": {        "type": "orchestration_start",        "run_id": "run_01a111a910667216b459f4b6e770eec6",        "orchestration_name": "Echo"      }    },    {      "id": "1790249607470-0",      "event": {        "type": "step_start",        "orch_step_id": "p",        "step_name": "P",        "step_type": "print"      }    }  ]}