Get Collection of Certificates

You can get TLS certificate details used to establish secure communication between the web browser and the Veeam Backup for Microsoft Azure server.

Request

To retrieve security certificate details, send the HTTP GET request to the /settings/certificates endpoint.

HTTP Request

GET https://<hostname>/api/v2/settings/certificates

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 representation of the /certificates collection. The CertificateInfoV2 schema is used for the representation.

Get Collection of CertificatesExample

The following request returns security certificate details.

Request:

GET https://51.11.247.127/api/v2/settings/certificates

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

[

 {

   "keySize": 2048,

   "keyAlgorithm": "RSA",

   "thumbPrint": "2CD0D052BD8FB94316A7CED8D728EA405A295580",

   "serialNumber": "6C5549823DDF0C9B",

   "type": "WebServer",

   "issuedBy": "VBA Web server",

   "issuedTo": "VBA Web server",

   "subject": "O=Veeam, OU=Cloud Backup, CN=VBA Web server",

   "expirationDateUtc": "2021-12-08T14:51:45+00:00",

   "isAutoGenerated": true

 },

 {

   "keySize": 2048,

   "keyAlgorithm": "RSA",

   "thumbPrint": "F58952099D277ED2A3E5C9087C982F136F8C1A50",

   "serialNumber": "00ABF9AC93EDD215E0",

   "type": "Worker",

   "issuedBy": "VBA Worker root CA",

   "issuedTo": "VBA Worker root CA",

   "subject": "O=Veeam, OU=Cloud Backup, CN=VBA Worker root CA",

   "expirationDateUtc": "2021-11-06T14:51:45+00:00",

   "isAutoGenerated": true

 }

]

I want to report a typo

There is a misspelling right here:

 

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