Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

Security Certificates

The /settings/certificates resource collection represents TLS certificate details used to establish secure communication between the web browser and the Veeam Backup for Microsoft Azure server.

Get Collection of Certificates

The HTTP GET request to the /settings/certificates endpoint retrieves TLS certificates used to establish secure communication between the web browser and the backup appliance or worker instances.

SecurityBearer
Responses
200

OK

401

Unauthorized

403

Forbidden

get/api/v8/settings/certificates
Request samples 
curl -i -X GET \
  https://123.123.123.123/api/v8/settings/certificates \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Regenerate Certificate

The HTTP POST request to the /settings/certificates/webserver/regenerate/ endpoint replaces an existing security certificate with a new self-signed certificate automatically generated by Veeam Backup for Microsoft Azure.

NOTE
After you replace an existing security certificate, the Veeam Backup for Microsoft Azure REST API and Web UI services will be restarted automatically.

SecurityBearer
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

post/api/v8/settings/certificates/webserver/regenerate
Request samples 
curl -i -X POST \
  https://123.123.123.123/api/v8/settings/certificates/webserver/regenerate \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "detail": "string",
  • "errors": {
    },
  • "status": 0,
  • "title": "string",
  • "traceId": "string",
  • "type": "string"
}

Update Web Certificate

The HTTP PUT request to the /settings/certificates/webServer endpoint updates a web certificate.

SecurityBearer
Request
Request Body schema: application/json
required
webServerCertificatePfxBase64
string or null

Specifies the new web server certificate.

webServerCertificatePfxPassword
string or null

Specifies the password used to protect the certificate.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

415

Client Error

put/api/v8/settings/certificates/webServer
Request samples
application/json
{
  • "webServerCertificatePfxBase64": "data:application/octet-stream;base64,encoded certificate",
  • "webServerCertificatePfxPassword": "certificate password"
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}