This is an archive version of the document. To get the most up-to-date information, see the current version.Get Async Action
You can get a resource representation of an async action with the specified UID.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator, Company Owner, Company Administrator.
Request
To get a resource representation of an async action with the specified UID, send the GET HTTP request to the URL of the /asyncActions/{actionId} resource.
HTTP Request
GET https://<hostname>:<port>/api/v3/asyncActions/{actionId} |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
actionId | Path | String (uuid) | Yes | — | Async action UID |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message: application/json; charset=utf-8 |
Response Body
In the response body, Veeam Service Provider Console returns a resource representation based on the AsyncActionsInfo schema.
Example 
The following request returns a representation of the async action with UID 8db65bf7-581b-437b-b640-76212ff40b3a.
Request: GET https://localhost:1280/api/v3/asyncActions/8db65bf7-581b-437b-b640-76212ff40b3a
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": { "id": "8db65bf7-581b-437b-b640-76212ff40b3a", "initiatorUid": "fd45fcc4-6c14-41c7-ba1a-77953af85a99", "actionName": "AgentDeployment", "status": "running" } } |