Veeam Backup & Replication 13
REST API Reference
Related documents

Global Exclusions

The Global Exclusions section defines paths and operations for managing which VMs will be excluded from processing, even if they are included in jobs. In this version, you can use these operations for VMware vSphere, VMware Cloud Director, and Microsoft Hyper-V VMs.

Get All Global VM Exclusions

The HTTP GET request to the /api/v1/globalExclusions/vm path allows you to get an array of VMs that are excluded from processing.

Available to: Veeam Backup Administrator.

SecurityBearer
Request
query Parameters
skip
integer <int32>

Number of global VM exclusions to skip.

limit
integer <int32>
Default: 200

Maximum number of global VM exclusions to return.

orderColumn
string (EGlobalVMExclusionsFiltersOrderColumn)

Sorts global VM exclusions by one of the parameters.

Enum: "Note" "Name"
orderAsc
boolean

If true, sorts global VM exclusions in the ascending order by the orderColumn parameter.

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.

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/globalExclusions/vm
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Add Global VM Exclusion
The HTTP POST request to the /api/v1/globalExclusions/vm path allows you to exclude a VM from processing.
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
required
object (InventoryObjectModel) 
Inventory object properties.


 
Responses 
201
Global VM exclusion 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/globalExclusions/vm
Request samples 
application/json
{
  • "vmObject": {
    }
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "inventoryObject": {
    },
  • "note": "Exclude due to maintenance"
}
Get Global VM Exclusion
The HTTP GET request to the /api/v1/globalExclusions/vm/{id} path allows you to get a global VM exclusion that has the specified id.
 Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the global VM exclusion. To get the ID, run the Get All Global VM Exclusions 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/globalExclusions/vm/{id}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "inventoryObject": {
    },
  • "note": "Exclude due to maintenance"
}
Remove Global VM Exclusion
The HTTP DELETE request to the /api/v1/globalExclusions/vm/{id} path allows you to remove a global VM exclusion that has the specified id.
 Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the global VM exclusion. To get the ID, run the Get All Global VM Exclusions 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 
204
Global VM exclusion has been removed.


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/globalExclusions/vm/{id}
Request samples 
Response samples 
application/json
{ }
Edit Global VM Exclusion Note
The HTTP PUT request to the /api/v1/globalExclusions/vm/{id}/note path allows you to edit the note for a global VM exclusion that has the specified id.
 Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
id
required
string <uuid> 
ID of the global VM exclusion. To get the ID, run the Get All Global VM Exclusions 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
note
required
string
Note for the global VM exclusion.


 
Responses 
200
The note for the global VM exclusion 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/globalExclusions/vm/{id}/note
Request samples 
application/json
{
  • "note": "Exclude due to maintenance"
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "inventoryObject": {
    },
  • "note": "Exclude due to maintenance"
}