Veeam Backup & Replication 13
REST API Reference
Related documents

General Options

The General Options section defines paths and operations for retrieving and editing general settings of Veeam Backup & Replication.

NOTE
In this REST API version, you can configure SIEM integration and notification settings only.

Get General Options

The HTTP GET request to the /api/v1/generalOptions path allows you to get Veeam Backup & Replication settings.

Available to: Veeam Backup Administrator.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.3-rev0

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Responses
200

OK

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

404

Not found. No object was found with the path parameter specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

get/api/v1/generalOptions
Request samples 
Response samples 
application/json
{
  • "notificationEnabled": false,
  • "emailSettings": {
    },
  • "notifications": {
    },
  • "siemIntegration": {
    }
}
Edit General Options
The HTTP PUT request to the /api/v1/generalOptions path allows you to edit Veeam Backup & Replication settings.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
notificationEnabled
required
boolean
 Default:  false
Indicates whether the email notifications are enabled. If true, the emailSettings property is required.


 
required
object (GeneralOptionsNotificationsModel) 
Other notifications such as notifications on low disk space, support contract expiration, and available updates.


 
required
object (GeneralOptionsSiemIntegrationModel) 
SIEM integration settings.


 
object (GeneralOptionsEmailNotificationsModel) 
Global email notification settings and job notifications.


 
Responses 
200
Settings have been updated.


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


404
Not found. No object was found with the path parameter specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


put/api/v1/generalOptions
Request samples 
application/json
{
  • "notificationEnabled": false,
  • "emailSettings": {
    },
  • "notifications": {
    },
  • "siemIntegration": {
    }
}
Response samples 
application/json
{
  • "notificationEnabled": false,
  • "emailSettings": {
    },
  • "notifications": {
    },
  • "siemIntegration": {
    }
}