Skip to main content

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

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

Create a schedule​

POST/api/v1/schedules

Request body​

FieldTypeDescription
bridgeIdstring
taskNamestring
cronstring
timezonestring
inputobject
isActiveboolean
{
"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

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

Get schedule details​

GET/api/v1/schedules/{id}

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Responses​

200 Schedule details

GET/api/v1/schedules/{id}

Get schedule details

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

Update a schedule​

PATCH/api/v1/schedules/{id}

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Request body​

{}

Responses​

200 Schedule updated

PATCH/api/v1/schedules/{id}

Update a schedule

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

Delete a schedule​

DELETE/api/v1/schedules/{id}

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Responses​

200 Schedule deleted

DELETE/api/v1/schedules/{id}

Delete a schedule

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

Pause a schedule​

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

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Responses​

200 Schedule paused

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

Pause a schedule

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

Resume a paused schedule​

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

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Responses​

200 Schedule resumed

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

Resume a paused schedule

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

Manually trigger a schedule​

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

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Responses​

200 Schedule triggered

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

Manually trigger a schedule

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