Veeam Service Provider Console 9.1
REST API Reference
Related documents

Veeam ONE Server

This resource collection represents information on Veeam ONE integration.

Get All Connected Veeam ONE Servers

Returns a collection resource representation of all Veeam ONE servers connected to Veeam Service Provider Console.

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/infrastructure/voneServers
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Connected Veeam ONE Server
Returns a resource representation of a connected Veeam ONE server with the specified UID.


Request 
path Parameters
vOneServerUid
required
string <uuid> 
Veeam ONE server 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/infrastructure/voneServers/{vOneServerUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Delete Veeam ONE Server
Delete data of a Veeam ONE server with the specified UID from a Veeam Service Provider Console server.


Request 
path Parameters
vOneServerUid
required
string <uuid> 
Veeam ONE Server 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/infrastructure/voneServers/{vOneServerUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Alarm Options for Veeam ONE Server
Returns a resource representation of alarm options configured for a Veeam ONE server with the specified UID.


Request 
path Parameters
vOneServerUid
required
string <uuid> 
Veeam ONE server 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/infrastructure/voneServers/{vOneServerUid}/settings
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Update Alarm Options for Veeam ONE Server
Updates alarm options configured for a Veeam ONE server with the specified UID.


Request 
path Parameters
vOneServerUid
required
string <uuid> 
Veeam ONE server 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
Request Body schema: application/json
required
alarmsSynchronizationEnabled
required
boolean
 
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.


put/infrastructure/voneServers/{vOneServerUid}/settings
Request samples 
application/json
{
  • "alarmsSynchronizationEnabled": true
}
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Enforce Data Collection from Connected Veeam ONE Server
Enforces data collection from a connected Veeam ONE server with the specified UID.




Returns a positive response when the collection task is added to the internal queue and not when the task is executed.




Request 
path Parameters
vOneServerUid
required
string <uuid> 
Veeam ONE server 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.


post/infrastructure/voneServers/{vOneServerUid}/collect
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Generate New Veeam ONE Installation UID
Generates a new Veeam ONE installation UID for a Veeam ONE server with the specified UID.




If you generate a new installation UID during a license reporting period, you will not be able to approve a license usage report for that period. 




Request 
path Parameters
vOneServerUid
required
string <uuid> 
Veeam ONE server 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.


post/infrastructure/voneServers/{vOneServerUid}/renewInstallationUid
Request samples 
Response samples 
application/json
{
  • "data": "11ab183f-9d80-469a-aa40-2281617a12d2"
}

    
    

                                

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