Veeam Service Provider Console 9.1
REST API Reference
Related documents

Backup Policies

This resource collection represents backup policies configured in Veeam Service Provider Console.

Get All Backup Policies

Returns a collection resource representation of all backup policies.

Request
query Parameters
availableToAssignForCompanyUid
string <uuid>

Limits the collection to the policies that can be assigned to agents of a company with the UID specified in this parameter.

Array of objects or null (FilterParameter)

Specifies the conditions that a resource must meet to be returned in the output.

Array of objects or null (SortParameter)

Specifies the order in which resources are returned from the collection.

limit
integer <int32> [ 1 .. 500 ]
Default: 100

Specifies the first N resources that must be returned in the output.

offset
integer <int32> [ 0 .. 2147483647 ]
Default: 0

Excludes the first N resources from the query output.

Array of objects or null (SelectParameter)

Returns explicitly requested properties.

header Parameters
X-Request-id
string <uuid>

Random UID that you can assign to a request for idempotence and async action progress tracking.

Note that an operation is idempotent only during 5 minute time interval.

Example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string

Version of Veeam Service Provider Console RESTful API supported by client.

Example: 3.6.1
Responses
200

OK

202

Request has been queued for execution.

default

All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.

get/configuration/backupPolicies
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Available Backup Policies
Returns a collection resource representation of all backup policies that can be assigned to agents.


Request 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/configuration/backupPoliciesToAssign
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Backup Policy
Returns a resource representation of a backup policy with the specified UID.


Request 
path Parameters
policyUid
required
string <uuid> 
Policy UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/configuration/backupPolicies/{policyUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Delete Backup Policy
Deletes a backup policy with the specified UID.


Request 
path Parameters
policyUid
required
string <uuid> 
Policy UID.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


delete/configuration/backupPolicies/{policyUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Modify Backup Policy
Modifies a backup policy with the specified UID.


Request 
path Parameters
policyUid
required
string <uuid> 
Policy UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
Array of JSON Patch operations according to RFC 6902.


 Array 
op
required
string
Performed operation.


 Enum: "add" "replace" "test" "remove" "move" "copy"  
value
required
string
Value that is added, replaced, tested or removed by the PATCH operation.


 
path
required
string
JSON Pointer containing path to a target location where the PATCH operation is performed.


 
from
string or null
JSON Pointer containing path to a location from which data is moved or copied.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


patch/configuration/backupPolicies/{policyUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Copy Backup Policy
Creates a copy of a backup policy with the specified UID.


Request 
path Parameters
policyUid
required
string <uuid> 
Policy UID.


 
query Parameters
newPolicyName
required
string
Name of a backup policy copy. Pattern is '^[^$()%]+$' for Windows policy and '^[^~"#%&*:<>?!/\{|}'`$]+$' for Linux and Mac policies.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/configuration/backupPolicies/{policyUid}/copy
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Get All Policies for Windows Computers
Returns a collection resource representation of all backup policies configured for Microsoft Windows computers.


Request 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/configuration/backupPolicies/windows
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Backup Policy for Windows Computers
Creates a backup policy for Microsoft Windows computers.


Request 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
Backup policy properties.


name
required
string  [ 1 .. 128 ] characters ^[^$()%]+$
Backup policy name.


 
operationMode
required
string (BackupJobOperationMode) 
Backup job operation mode.


 Enum: "Unknown" "Workstation" "Server"  
accessMode
required
string (BackupPolicyAccessMode) 
Backup policy access mode.


 Enum: "Private" "Public"  
required
object
Job configuration.


 
description
string or null  <= 1024 characters 
Backup policy description.


 
createSubtenants
boolean
 Default:  true
Defines whether a subtenant must be created for each Veeam Agent for Microsoft Windows. 




Available if a cloud repository is selected as backup destination.




 
createSubFolders
boolean
 Default:  false
Defines whether a subfolder must be created for each Veeam Agent for Microsoft Windows on the shared folder.




Available if a shared folder is selected as backup destination.




 
unlimitedSubtenantQuota
boolean
 Default:  false
Defines whether a subtenant can consume unlimited amount of space on a repository.




Available if a cloud repository is selected as backup destination.




 
repositoryQuotaGb
integer or null <int32> 
 Default:  100
Maximum amount of space that a subtenant can consume on a repository.




If a subtenant can consume unlimited amount of space, the value of this property is ignored. 

Available if a cloud repository is selected as backup destination.




 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/configuration/backupPolicies/windows
Request samples 
application/json
{
  • "name": "WWrkstEntireCloud",
  • "description": "temp description",
  • "operationMode": "Workstation",
  • "accessMode": "Public",
  • "createSubtenants": true,
  • "createSubFolders": false,
  • "unlimitedSubtenantQuota": false,
  • "repositoryQuotaGb": 1,
  • "jobConfiguration": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Get All Policies for Linux Computers
Returns a collection resource representation of all backup policies configured for Linux computers.


Request 
query Parameters
Array of objects or null (FilterParameter) 
Specifies the conditions that a resource must meet to be returned in the output.


 
Array of objects or null (SortParameter) 
Specifies the order in which resources are returned from the collection.


 
limit
integer <int32>   [ 1 .. 500 ] 
 Default:  100
Specifies the first N resources that must be returned in the output.


 
offset
integer <int32>   [ 0 .. 2147483647 ] 
 Default:  0
Excludes the first N resources from the query output.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/configuration/backupPolicies/linux
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Backup Policy for Linux Computers
Creates a backup policy for Linux computers.


Request 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
Backup policy properties.


name
required
string  [ 1 .. 128 ] characters ^[^~"#%&*:<>?!/\\{|}'`$]+$
Backup policy name.


 
accessMode
required
string (BackupPolicyAccessMode) 
Backup policy access mode.


 Enum: "Private" "Public"  
operationMode
required
string (BackupJobOperationMode) 
Backup job operation mode.


 Enum: "Unknown" "Workstation" "Server"  
required
object
Job configuration.


 
description
string  <= 1024 characters 
 Default:  ""
Backup policy description.


 
createSubtenants
boolean
 Default:  true
Defines whether a subtenant must be created for each Veeam Agent for Linux.




Available if a cloud repository is selected as backup destination.




 
unlimitedSubtenantQuota
boolean
 Default:  false
Defines whether a subtenant can consume unlimited amount of space on a repository.




Available if a cloud repository is selected as backup destination.




 
repositoryQuotaGB
integer or null <int32> 
 Default:  100
Maximum amount of space that a subtenant can consume on a repository.




If a subtenant can consume unlimited amount of space, the value of this property is ignored. 

Available if a cloud repository is selected as backup destination.




 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/configuration/backupPolicies/linux
Request samples 
application/json
{
  • "name": "LinuxSrvtEntireCloud",
  • "description": "",
  • "operationMode": "Server",
  • "accessMode": "Public",
  • "createSubtenants": true,
  • "unlimitedSubtenantQuota": false,
  • "repositoryQuotaGB": 100,
  • "jobConfiguration": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Backup Policy for Windows Computers
Returns a resource representation of a Windows computer backup policy with the specified UID.


Request 
path Parameters
policyUid
required
string <uuid> 
Policy UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/configuration/backupPolicies/windows/{policyUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Backup Policy for Windows Computers
Modifies a Windows computer backup policy with the specified UID.


Request 
path Parameters
policyUid
required
string <uuid> 
Policy UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
Array of JSON Patch operations according to RFC 6902.


 Array 
op
required
string
Performed operation.


 Enum: "add" "replace" "test" "remove" "move" "copy"  
value
required
string
Value that is added, replaced, tested or removed by the PATCH operation.


 
path
required
string
JSON Pointer containing path to a target location where the PATCH operation is performed.


 
from
string or null
JSON Pointer containing path to a location from which data is moved or copied.


 
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


patch/configuration/backupPolicies/windows/{policyUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Get Backup Policy for Linux Computers
Returns a resource representation of a Linux computer backup policy with the specified UID.


Request 
path Parameters
policyUid
required
string <uuid> 
Policy UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


get/configuration/backupPolicies/linux/{policyUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Backup Policy for Linux Computers
Modifies a Linux computer backup policy with the specified UID.


Request 
path Parameters
policyUid
required
string <uuid> 
Policy UID.


 
query Parameters
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Request Body schema: application/json
required
Array of JSON Patch operations according to RFC 6902.


 Array 
op
required
string
Performed operation.


 Enum: "add" "replace" "test" "remove" "move" "copy"  
value
required
string
Value that is added, replaced, tested or removed by the PATCH operation.


 
path
required
string
JSON Pointer containing path to a target location where the PATCH operation is performed.


 
from
string or null
JSON Pointer containing path to a location from which data is moved or copied.


 
Responses 
200
Modified backup policy.


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


patch/configuration/backupPolicies/linux/{policyUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}

    
    

                                

                                    
Document updated 11/06/2025
Page content applies to build 9.1.0.30345