This is an archive version of the document. To get the most up-to-date information, see the current version.

Getting Certificates

This section explains how to get a list of existing certificates.

Request

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

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

None.

Request Body

None.

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 HTTPS headers.

Header	Description
Content-length	The length of the response body.
Content-type	The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

Property	Type	Description
keySize	integer	The size of the key in bytes.
keyAlgorithm	string	The algorithm that was used to create a key.
thumbPrint	string	A thumbprint.
serialNumber	string	The serial number of the certificate.
type	string	The type of the certificate. Possible values: Worker WebServer
issuedBy	string	Shows the entity that issues the certificate.
issuedTo	string	Shows the entity to which the certificate was issued.
subject	string	Shows the subject.
expirationDateUtc	string	Shows the expiration date of the certificate.
isAutoGenerated	boolean	Shows if the certificate was generated automatically by the controller server.

Example

Request:

GET https://abc.ukwest.cloudapp.azure.com/api/v1/settings/certificates

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

[

{

"keySize": 2048,

"keyAlgorithm": "RSA",

"thumbPrint": "752157F736BB3656C64D30B6A14482413524B245",

"serialNumber": "9FAA6C8A8F061DC700",

"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-01-14T18:50:34+00:00",

"isAutoGenerated": true

{

"keySize": 2048,

"keyAlgorithm": "RSA",

"thumbPrint": "8B48187419D4D4E0FC89A96C3197F64FCC5CC392",

"serialNumber": "8D9FD6BF106AB379",

"type": "WebServer",

"issuedBy": "VBA Web server",

"issuedTo": "VBA Web server",

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

"expirationDateUtc": "2030-01-12T18:50:48+00:00",

"isAutoGenerated": true

}

]