Tasks
Tasks enable monitoring and administering of REST API resources that may require significant time to complete, such as updating HSM firmware. Rather than block and wait for these time-consuming actions to complete, REST API creates tasks to run the resource automatically in the background. Tasked resources return a response immediately and notify you of the status of the action: waiting, running, failed, etc. Because of their time-consuming nature, tasks are grouped separately.
Figure 1: Tasks Tab
The table below defines each command and references its corresponding resource.
Command | Function | Resource |
---|---|---|
List | Lists all available tasked resources. | GET /tasks |
Kickstart | Starts a waiting task. | POST /tasks/{taskid}/actions/start |
Result | Gets result and deletes task. | GET /tasks/{taskid}/response |
Delete All | Deletes all tasks. | DELETE /tasks |