Skip to main content

Tasks

Task execution 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.

Execute a task asynchronously​

POST/api/v1/tasks/execute

Request body​

FieldTypeDescription
bridgeIdstring
taskNamestring
inputobject
{
"bridgeId": "550e8400-e29b-41d4-a716-446655440000",
"taskName": "string",
"input": {}
}

Responses​

202 Task queued

POST/api/v1/tasks/execute

Execute a task asynchronously

https://api-test.orderly-hub.com/api/v1/tasks/execute

Execute a task synchronously​

POST/api/v1/tasks/execute-sync

Request body​

FieldTypeDescription
bridgeIdstring
taskNamestring
inputobject
{
"bridgeId": "550e8400-e29b-41d4-a716-446655440000",
"taskName": "string",
"input": {}
}

Responses​

200 Task result

POST/api/v1/tasks/execute-sync

Execute a task synchronously

https://api-test.orderly-hub.com/api/v1/tasks/execute-sync

List task executions​

GET/api/v1/tasks/executions

Requires scope bridges:read. Secret fields in input, output and error (API keys, tokens, passwords, client secrets and similar) are returned as "••••••••", and a credentials object as {"masked": true}.

Parameters​

NameInRequiredTypeDescription
pagequerynointeger
limitquerynointeger
bridgeIdquerynostring
statusquerynostring
taskNamequerynostring

Responses​

200 Paginated execution list

403 The caller lacks bridges:read

GET/api/v1/tasks/executions

List task executions

https://api-test.orderly-hub.com/api/v1/tasks/executions

Get task execution details​

GET/api/v1/tasks/executions/{id}

Requires scope bridges:read. Secret fields in input, output and error are masked as in listTaskExecutions.

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Responses​

200 Execution details

403 The caller lacks bridges:read

404 Execution not found

GET/api/v1/tasks/executions/{id}

Get task execution details

https://api-test.orderly-hub.com/api/v1/tasks/executions/

Cancel a running task execution​

POST/api/v1/tasks/executions/{id}/cancel

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Responses​

200 Execution cancelled

POST/api/v1/tasks/executions/{id}/cancel

Cancel a running task execution

https://api-test.orderly-hub.com/api/v1/tasks/executions//cancel

Retry a failed task execution​

POST/api/v1/tasks/executions/{id}/retry

Parameters​

NameInRequiredTypeDescription
idpathyesstring

Responses​

202 Retry queued

POST/api/v1/tasks/executions/{id}/retry

Retry a failed task execution

https://api-test.orderly-hub.com/api/v1/tasks/executions//retry