Asynchronous Processing

In some cases requests take significant time to process or there are multiple requests processed at the same time.The Veeam Service Provider Console REST API v3 allows such operations to be handled asynchronously. Asynchronous processing decreases the load on web-browsers and notifies clients when their requests are accepted but not yet processed by the server.

When a request initiates an asynchronous action, a user receives a response with the 202 Accepted code. The Location header of the response contains a link to the /asyncAction/(asyncActionId} resource of the task. This link allows the user who initiated the task to track its progress. For details, see Get Async Action.

If you want to track operation progress, you can enable asynchronous processing for this operation. To do that, add the x-request-id header with a randomly generated UID to the request. Note that for endpoints containing the x-veeam-vspc-deny-async-action-registration extension asynchronous processing cannot be forced.

Some operations can take longer time to finish but do not behave as async actions. These operations are marked with the x-veeam-vspc-fire-and-forget: true extension.