Schedules

Scheduled task management

All endpoints require a bearer token (oh_... API key or user JWT) and are served under https://api.orderly-hub.com. Use the Try it consoles to run a request against the Preview (test) server.

List schedules

GET/api/v1/schedules

Responses

200 Schedule list

GET/api/v1/schedules

List schedules

API key (Bearer token)

https://api-test.orderly-hub.com/api/v1/schedules

Create a schedule

POST/api/v1/schedules

Request body

Field	Type	Description
bridgeId	string
taskName	string
cron	string
timezone	string
input	object
isActive	boolean

{
  "bridgeId": "550e8400-e29b-41d4-a716-446655440000",
  "taskName": "string",
  "cron": "string",
  "timezone": "string",
  "input": {},
  "isActive": true
}

Responses

201 Schedule created

POST/api/v1/schedules

Create a schedule

API key (Bearer token)

Request body (JSON){ "bridgeId": "550e8400-e29b-41d4-a716-446655440000", "taskName": "string", "cron": "string", "timezone": "string", "input": {}, "isActive": true }

https://api-test.orderly-hub.com/api/v1/schedules

Get schedule details

GET/api/v1/schedules/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Schedule details

GET/api/v1/schedules/{id}

Get schedule details

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/schedules/

Update a schedule

PATCH/api/v1/schedules/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Request body

{}

Responses

200 Schedule updated

PATCH/api/v1/schedules/{id}

Update a schedule

API key (Bearer token)

id * (path)

Request body (JSON){}

https://api-test.orderly-hub.com/api/v1/schedules/

Delete a schedule

DELETE/api/v1/schedules/{id}

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Schedule deleted

DELETE/api/v1/schedules/{id}

Delete a schedule

API key (Bearer token)

id * (path)

https://api-test.orderly-hub.com/api/v1/schedules/

Pause a schedule

POST/api/v1/schedules/{id}/pause

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Schedule paused

POST/api/v1/schedules/{id}/pause

Pause a schedule

API key (Bearer token)

id * (path)

Request body (JSON)

https://api-test.orderly-hub.com/api/v1/schedules//pause

Resume a paused schedule

POST/api/v1/schedules/{id}/resume

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Schedule resumed

POST/api/v1/schedules/{id}/resume

Resume a paused schedule

API key (Bearer token)

id * (path)

Request body (JSON)

https://api-test.orderly-hub.com/api/v1/schedules//resume

Manually trigger a schedule

POST/api/v1/schedules/{id}/trigger

Parameters

Name	In	Required	Type	Description
id	path	yes	string

Responses

200 Schedule triggered

POST/api/v1/schedules/{id}/trigger

Manually trigger a schedule

API key (Bearer token)

id * (path)

Request body (JSON)

https://api-test.orderly-hub.com/api/v1/schedules//trigger