Get Update Status

You can retrieve the status of backup appliance update.

Request

To retrieve the link, send the HTTP GET request to the /system/status endpoint.

HTTP Request

GET https://<hostname>/api/v2/system/status

Request Headers

The request contains the following headers.

Header

Required

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.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a 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

Value

Description

Content-length

integer

Identifies the length of the response body message, in bytes.

Content-type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for Microsoft Azure returns a state of the backup appliance update.

Get Update StatusExample

The following request returns a state of the backup appliance update.

Request:

GET https://51.11.247.127/api/v2/system/status

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "state": "Ready",

 "serverTime": "2020-12-01T07:40:20.4160774Z"

}

 

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.