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.

Get General OptionsDeprecated

The HTTP GET request to the /api/v1/generalOptions endpoint gets Veeam Backup & Replication settings.

Available to: Veeam Backup Administrator.

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

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 OptionsDeprecated
The HTTP PUT request to the /api/v1/generalOptions endpoint edits Veeam Backup & Replication settings.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-rev1
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
If true, email notifications are enabled. In this case, 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": {
    }
}
Get Email Settings
The HTTP GET request to the /api/v1/generalOptions/emailSettings endpoint gets Veeam Backup & Replication email settings.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-rev1
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/emailSettings
Request samples 
Response samples 
application/json
{
  • "notificationsEnabled": false,
  • "mailServer": "SMTP",
  • "emailSettings": {
    },
  • "smtpServerName": "string",
  • "advancedSmtpOptions": {
    }
}
Edit Email Settings
The HTTP PUT request to the /api/v1/generalOptions/emailSettings endpoint edits Veeam Backup & Replication email settings.
Available to: Veeam Backup Administrator.


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


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


 
mailServer
string (EEmailSettingsServerType) 
Type of mail server.


 
object (GeneralOptionsEmailSettingsModel) 
Email notification settings.


 
smtpServerName
string
Full DNS name or IP address of the SMTP server.


 
object (AdvancedSmtpOptionsModel) 
Advanced global email notification settings.


 
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/emailSettings
Request samples 
application/json
{
  • "notificationsEnabled": false,
  • "mailServer": "SMTP",
  • "emailSettings": {
    },
  • "smtpServerName": "string",
  • "advancedSmtpOptions": {
    }
}
Response samples 
application/json
{
  • "notificationsEnabled": false,
  • "mailServer": "SMTP",
  • "emailSettings": {
    },
  • "smtpServerName": "string",
  • "advancedSmtpOptions": {
    }
}
Send Test Email
The HTTP POST request to the /api/v1/generalOptions/emailSettings/testMessage endpoint sends a test email notification using the configured settings.
Available to: Veeam Backup Administrator.


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


 
Responses 
204
Test email notification has been sent.


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.


post/api/v1/generalOptions/emailSettings/testMessage
Request samples 
Response samples 
application/json
{
  • "errorCode": "AccessDenied",
  • "message": "string",
  • "resourceId": "string"
}
Get Notification Settings
The HTTP GET request to the /api/v1/generalOptions/notifications endpoint gets Veeam Backup & Replication notifications settings.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-rev1
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/notifications
Request samples 
Response samples 
application/json
{
  • "storageSpaceThresholdEnabled": true,
  • "storageSpaceThreshold": 1,
  • "datastoreSpaceThresholdEnabled": true,
  • "datastoreSpaceThreshold": 1,
  • "skipVMSpaceThresholdEnabled": true,
  • "skipVMSpaceThreshold": 0,
  • "notifyOnSupportExpiration": true,
  • "notifyOnUpdates": true
}
Edit Notification Settings
The HTTP PUT request to the /api/v1/generalOptions/notifications endpoint edits Veeam Backup & Replication notification settings.
Available to: Veeam Backup Administrator.


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


 
Request Body schema: application/json
required
storageSpaceThresholdEnabled
required
boolean
If true, notifications about critical amount of free space in backup storage are enabled.


 
datastoreSpaceThresholdEnabled
required
boolean
If true, notifications about critical amount of free space in production datastore are enabled.


 
skipVMSpaceThresholdEnabled
required
boolean
If true and the skipVMSpaceThreshold threshold is reached, Veeam Backup & Replication terminates backup and replication jobs working with production datastores before VM snapshots are taken.


 
notifyOnSupportExpiration
required
boolean
If true, notifications about support contract expiration are enabled.


 
notifyOnUpdates
required
boolean
If true, notifications about updates are enabled.


 
storageSpaceThreshold
integer <int32>   [ 1 .. 100 ] 
Space threshold of backup storage, in percent.


 
datastoreSpaceThreshold
integer <int32>   [ 1 .. 100 ] 
Space threshold of production datastore, in percent.


 
skipVMSpaceThreshold
integer <int32> 
Space threshold of production datastore, in percent.


 
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/notifications
Request samples 
application/json
{
  • "storageSpaceThresholdEnabled": true,
  • "storageSpaceThreshold": 1,
  • "datastoreSpaceThresholdEnabled": true,
  • "datastoreSpaceThreshold": 1,
  • "skipVMSpaceThresholdEnabled": true,
  • "skipVMSpaceThreshold": 0,
  • "notifyOnSupportExpiration": true,
  • "notifyOnUpdates": true
}
Response samples 
application/json
{
  • "storageSpaceThresholdEnabled": true,
  • "storageSpaceThreshold": 1,
  • "datastoreSpaceThresholdEnabled": true,
  • "datastoreSpaceThreshold": 1,
  • "skipVMSpaceThresholdEnabled": true,
  • "skipVMSpaceThreshold": 0,
  • "notifyOnSupportExpiration": true,
  • "notifyOnUpdates": true
}
Get Event Forwarding Settings
The HTTP GET request to the /api/v1/generalOptions/eventForwarding endpoint gets Veeam Backup & Replication event forwarding settings.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-rev1
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/eventForwarding
Request samples 
Response samples 
application/json
{
  • "SNMPServers": [
    ],
  • "syslogServer": {
    },
  • "syslogEventFiltering": [
    ]
}
Edit Event Forwarding Settings
The HTTP PUT request to the /api/v1/generalOptions/eventForwarding endpoint edits Veeam Backup & Replication event forwarding settings.
Available to: Veeam Backup Administrator.


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


 
Request Body schema: application/json
required
Array of objects (GeneralOptionsSNMPServerModel) 
Array of SNMP servers.


 
object (GeneralOptionsSyslogServerModel) 
Syslog server settings.


 
Array of objects (GeneralOptionsSyslogEventFilteringModel) 
Array of syslog event filters.


 
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/eventForwarding
Request samples 
application/json
{
  • "SNMPServers": [
    ],
  • "syslogServer": {
    },
  • "syslogEventFiltering": [
    ]
}
Response samples 
application/json
{
  • "SNMPServers": [
    ],
  • "syslogServer": {
    },
  • "syslogEventFiltering": [
    ]
}
Get Storage Latency Settings
The HTTP GET request to the /api/v1/generalOptions/storageLatency endpoint gets storage latency settings configured for backup and replication operations. Storage latency control allows you to limit Input/Output operations on the production storage where protected machines reside.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-rev1
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/storageLatency
Request samples 
Response samples 
application/json
{
  • "storageLatencyControlEnabled": false,
  • "storageLatencyControlOptions": {
    }
}
Edit Storage Latency Settings
The HTTP PUT request to the /api/v1/generalOptions/storageLatency endpoint edits storage latency settings configured for backup and replication operations. Storage latency control allows you to limit Input/Output operations on the production storage where protected machines reside.
Available to: Veeam Backup Administrator.


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


 
Request Body schema: application/json
required
storageLatencyControlEnabled
required
boolean
 Default:  false
If true, storage latency control is enabled. In this case, you must specify the storageLatencyControlOptions property.


 
object (StorageLatencyControlOptions) 
Latency control options.


 
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/storageLatency
Request samples 
application/json
{
  • "storageLatencyControlEnabled": false,
  • "storageLatencyControlOptions": {
    }
}
Response samples 
application/json
{
  • "storageLatencyControlEnabled": false,
  • "storageLatencyControlOptions": {
    }
}
Add Latency Settings for Specific Datastore
The HTTP POST request to the /api/v1/generalOptions/storageLatency/datastores endpoint adds custom latency settings for a specific datastore.
Available to: Veeam Backup Administrator.


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


 
Request Body schema: application/json
required
required
object (InventoryObjectModel) 
Inventory object properties.


 
latencyLimitMs
integer
 Default:  20
I/O latency threshold (in milliseconds) at which Veeam Backup & Replication will stop assigning new tasks to the datastore or volume.


 
throttlingIOLimitMs
integer
 Default:  30
I/O latency limit (in milliseconds) at which Veeam Backup & Replication will slow down read and write operations for the datastore or volume.
latencyLimitMs must not be greater than throttlingIOLimitMs.


 
Responses 
201
Datastore latency settings has been added.


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.


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


post/api/v1/generalOptions/storageLatency/datastores
Request samples 
application/json
{
  • "storageObject": {
    },
  • "latencyLimitMs": 20,
  • "throttlingIOLimitMs": 30
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "storageObject": {
    },
  • "latencyLimitMs": 20,
  • "throttlingIOLimitMs": 30
}
Get Latency Settings for Specific Datastore
The HTTP GET request to the /api/v1/generalOptions/storageLatency/datastores/{id} endpoint gets custom latency settings configured for a specific datastore.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of a datastore latency settings record. To get the ID, run the  Get Storage Latency Settings request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev1
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/storageLatency/datastores/{id}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "storageObject": {
    },
  • "latencyLimitMs": 20,
  • "throttlingIOLimitMs": 30
}
Edit Latency Settings for Specific Datastore
The HTTP PUT request to the /api/v1/generalOptions/storageLatency/datastores/{id} endpoint edits custom latency settings configured for a specific datastore.
 Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of a datastore latency settings record. To get the ID, run the  Get Storage Latency Settings request.


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


 
Request Body schema: application/json
required
id
required
string <uuid> 
ID of the datastore latency settings record.


 
required
object (InventoryObjectModel) 
Inventory object properties.


 
latencyLimitMs
integer
 Default:  20
I/O latency threshold (in milliseconds) at which Veeam Backup & Replication will stop assigning new tasks to the datastore or volume.


 
throttlingIOLimitMs
integer
 Default:  30
I/O latency speed limit (in milliseconds) at which Veeam Backup & Replication will slow down read and write operations for the datastore or volume.
latencyLimitMs must not be greater than throttlingIOLimitMs.


 
Responses 
200
Credentials record has 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/storageLatency/datastores/{id}
Request samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "storageObject": {
    },
  • "latencyLimitMs": 20,
  • "throttlingIOLimitMs": 30
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "storageObject": {
    },
  • "latencyLimitMs": 20,
  • "throttlingIOLimitMs": 30
}
Remove Latency Settings for Specific Datastore
The HTTP DELETE request to the /api/v1/generalOptions/storageLatency/datastores/{id} endpoint removes custom latency settings configured for a specific datastore.
 Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of a datastore latency settings record. To get the ID, run the  Get Storage Latency Settings request.


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


 
Responses 
204
Datastore latency settings is deleted.


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.


delete/api/v1/generalOptions/storageLatency/datastores/{id}
Request samples 
Response samples 
application/json
{
  • "errorCode": "AccessDenied",
  • "message": "string",
  • "resourceId": "string"
}