Run a schedule now

POST

/api/v1/schedules/{schedule_id}/run

Run a schedule now, as a test. It runs even when the schedule is paused, and its next and last run times stay as they were. The answer comes at once with the run's id. See Manual trigger.

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

schedule_id*string

The schedule's id.

Response Body

The run was started.

application/json

response

status?string

schedule_id?string

run_id?string

curl -X POST "https://api.synapseorch.com/api/v1/schedules/sched_01a10c2e4f6a8b0c1d3e5f7a9b1c3d5e/run" \  -H "Authorization: Bearer sk-syn-..."

{  "status": "triggered",  "schedule_id": "sched_01a10c2e4f6a8b0c1d3e5f7a9b1c3d5e",  "run_id": "run_01a10d4f6a8c0e2a4b6c8d0e2f4a6b8c"}