Veeam Service Provider Console 9.1
REST API Reference
Related documents

AsyncActions

This resource collection represents Veeam Service Provider Console REST API async actions.

Get Async Action Configuration

Returns a configuration of an async action service.

Request
query Parameters
Array of objects or null (SelectParameter)

Returns explicitly requested properties.

header Parameters
X-Client-Version
string

Version of Veeam Service Provider Console RESTful API supported by client.

Example: 3.6.1
Responses
200

OK

default

All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.

get/asyncActions/config
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Get Async Actions
Returns a collection resource representation of all active async actions of the current user.


Request 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/asyncActions
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Async Action
Returns a resource representation of an async action with the specified UID.


Request 
path Parameters
actionId
required
string <uuid> 
Async action UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/asyncActions/{actionId}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Cancel Async Action
Cancels an action with the specified UID.


Request 
path Parameters
actionId
required
string <uuid> 
Async action UID.


 
header Parameters
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


delete/asyncActions/{actionId}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Attach Request Data to Async Action
Attaches provided request data to an async action with the specified UID.


Request 
path Parameters
actionId
required
string <uuid> 
Async action UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
requestBody
string or null  <= 2000000 characters 
Content of a request body of the operation that initiated an async action.


 
object or null
Key-value map containing query parameters of the operation that initiated an async action.


 
Responses 
200
OK


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


put/asyncActions/{actionId}/requestData
Request samples 
application/json
{
  • "requestBody": "{ \"siteUid\": \"d18f40ef-a80f-45c0-a4b6-0de1f5615145\", \"cloudTenantType\": \"General\", \"vCloudOrganizationUid\": null, \"leaseExpirationEnabled\": false, \"ownerCredentials\": { \"userName\": \"Alpha\", \"password\": \"Password1\" }, \"description\": \"Site Resource for Alpha Company\", \"throttlingEnabled\": false, \"throttlingValue\": 1, \"throttlingUnit\": \"MbitPerSec\", \"maxConcurrentTask\": 1, \"backupProtectionEnabled\": false, \"backupProtectionPeriodDays\": 1, \"gatewaySelectionType\": \"StandaloneGateways\", \"isGatewayFailoverEnabled\": false}",
  • "queryParameters": null
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Async Action Result
Returns a resource representation of results of an action with the specified UID.


Request 
path Parameters
actionId
required
string <uuid> 
Async action UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/asyncActions/{actionId}/result
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]
Delete Async Action Result
Deletes results of an action with the specified UID.


Request 
path Parameters
actionId
required
string <uuid> 
Async action UID.


 
header Parameters
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


delete/asyncActions/{actionId}/result
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}

    
    

                                

                                    
Document updated 11/06/2025
Page content applies to build 9.1.0.30345