Veeam Service Provider Console 9.1
REST API Reference
Related documents

Discovery

This resource collection represents discovery rules and discovered computers.

Get All Discovery Rules

Returns a collection resource representation of all discovery rules.

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/discovery/rules
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Discovery Rule
Returns a resource representation of a discovery rule with the specified UID.


Request 
path Parameters
ruleUid
required
string <uuid> 
Discovery rule 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/discovery/rules/{ruleUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Discovery Rule
Modifies a discovery rule with the specified UID.


Request 
path Parameters
ruleUid
required
string <uuid> 
Discovery rule 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/discovery/rules/{ruleUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Discovery Rule
Deletes a discovery rule with the specified UID.


Request 
path Parameters
ruleUid
required
string <uuid> 
Discovery rule 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/discovery/rules/{ruleUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Start Discovery Rule
Run discovery by a discovery rule with the specified UID. Returns a positive response when the discovery task is added to the internal queue and not when the task is executed.


Request 
path Parameters
ruleUid
required
string <uuid> 
Discovery rule 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/discovery/rules/{ruleUid}/start
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Stop Discovery Rule
Stop discovery by a discovery rule with the specified UID. Returns a positive response when the task is added to the internal queue and not when the task is executed.


Request 
path Parameters
ruleUid
required
string <uuid> 
Discovery rule 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/discovery/rules/{ruleUid}/stop
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Reset Discovery Rule Results
Resets results of discovery by a discovery rule with the specified UID.


Request 
path Parameters
ruleUid
required
string <uuid> 
Discovery rule 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/discovery/rules/{ruleUid}/reset
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Discovery Rules for Windows
Returns a collection resource representation of all Windows discovery rules.


Request 
query Parameters
expand
Array of strings (WindowsDiscoveryRuleExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "DiscoveryRule"  
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/discovery/rules/windows
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Discovery Rule for Windows
Returns a resource representation of a Windows discovery rule with the specified UID.


Request 
path Parameters
ruleUid
required
string <uuid> 
Discovery rule 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/discovery/rules/windows/{ruleUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Discovery Rule for Windows
Modifies a Windows discovery rule with the specified UID.


Request 
path Parameters
ruleUid
required
string <uuid> 
Discovery rule 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/discovery/rules/windows/{ruleUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Get All Network-Based Discovery Rules for Windows
Returns a collection resource representation of all Windows network-based discovery rules.


Request 
query Parameters
expand
Array of strings (WindowsNetworkBasedDiscoveryRuleExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Enum: "DiscoveryRule" "WindowsDiscoveryRule"  
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/discovery/rules/windows/networkBased
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Network-Based Discovery Rule for Windows
Creates a Windows network-based discovery rule.


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
Discovery rule settings.


name
required
string  [ 1 .. 128 ] characters ^[^\<\>\=\%\~]+$
Name of a network-based discovery rule.


 
masterAgentUid
required
string <uuid> 
UID assigned to a master agent.


 
required
Array of objects (DiscoveryRuleNetwork)   non-empty 
Range of IP addresses.


 
required
object
Credentials of an account with Local Administrator permissions on discovered computers.


 
useMasterManagementAgentCredentials
boolean
 Default:  true
Indicates whether credentials specified in the master management agent configuration must be used.


 
object or null
Discovery filter.


 
object or null
Settings configured for email notifications about discovery results.


 
object or null
Settings configured for Veeam backup agent deployment.


 
object or null
Discovery scheduling settings.


 
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/discovery/rules/windows/networkBased
Request samples 
application/json
{
  • "name": "Complex Network Rule",
  • "masterAgentUid": "4ae8db95-8a4e-4a6a-b1fb-89a0d4b8aca5",
  • "networks": [
    ],
  • "useMasterManagementAgentCredentials": true,
  • "accessAccount": {
    },
  • "filter": {
    },
  • "notificationSettings": {
    },
  • "deploymentSettings": {
    },
  • "scheduleSettings": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Network-Based Discovery Rule for Windows
Returns a resource representation of a Windows network-based discovery rule.


Request 
path Parameters
ruleUid
required
string <uuid> 
Discovery rule 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/discovery/rules/windows/networkBased/{ruleUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Network-Based Discovery Rule for Windows
Modifies a Windows network-based discovery rule with the specified UID.


Request 
path Parameters
ruleUid
required
string <uuid> 
Discovery rule 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/discovery/rules/windows/networkBased/{ruleUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Get All Microsoft Entra ID Discovery Rules for Windows
Returns a collection resource representation of all Microsoft Entra ID discovery rules.


Request 
query Parameters
expand
Array of strings (WindowsActiveDirectoryBasedDiscoveryRuleExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Enum: "DiscoveryRule" "WindowsDiscoveryRule"  
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/discovery/rules/windows/adBased
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Microsoft Entra ID Discovery Rule for Windows
Creates an Microsoft Entra ID discovery rule.


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
Discovery rule settings.


name
required
string  [ 1 .. 128 ] characters ^[^\<\>\=\%\~]+$
Name of an Microsoft Entra ID discovery rule.


 
masterAgentUid
required
string <uuid> 
UID assigned to a master agent.


 
adMethod
required
string
Microsoft Entra ID discovery method.


 Enum: "Unknown" "Search" "Query" "Custom"  
required
object
Credentials of an account with Local Administrator permissions on discovered computers.


 
skipOfflineComputersDays
integer or null <int32> 
Number of days for which offline computers are skipped from discovery.


 
customQuery
string or null
LDAP query that returns a list of computers to scan.


 
useMasterManagementAgentCredentials
boolean
 Default:  true
Indicates whether credentials specified in the master management agent configuration must be used.


 
object or null
Discovery filter.


 
object or null
Settings configured for email notifications about discovery results.


 
object or null
Settings configured for Veeam backup agent deployment.


 
object or null
Discovery scheduling settings.


 
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/discovery/rules/windows/adBased
Request samples 
application/json
{
  • "name": "Complex AD Rule By Query",
  • "masterAgentUid": "4ae8db95-8a4e-4a6a-b1fb-89a0d4b8aca5",
  • "skipOfflineComputersDays": 45,
  • "customQuery": "OU=auto, DC=n, DC=local",
  • "adMethod": "Query",
  • "useMasterManagementAgentCredentials": true,
  • "accessAccount": {
    },
  • "filter": {
    },
  • "notificationSettings": {
    },
  • "deploymentSettings": {
    },
  • "scheduleSettings": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Microsoft Entra ID Discovery Rule for Windows
Returns a resource representation of an Microsoft Entra ID discovery rule with the specified UID.


Request 
path Parameters
ruleUid
required
string <uuid> 
Discovery rule 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/discovery/rules/windows/adBased/{ruleUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Microsoft Entra ID Discovery Rule for Windows
Modifies an Microsoft Entra ID discovery rule with the specified UID.


Request 
path Parameters
ruleUid
required
string <uuid> 
Discovery rule 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/discovery/rules/windows/adBased/{ruleUid}
Request samples 
application/json
[
  • {
    },
  • {
    },
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Get All Import-Based Discovery Rules for Windows
Returns a collection resource representation of all Windows discovery rules based on lists of IP addresses and DNS names.


Request 
query Parameters
expand
Array of strings (WindowsCustomDiscoveryRuleExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Enum: "DiscoveryRule" "WindowsDiscoveryRule"  
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/discovery/rules/windows/custom
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Import-Based Discovery Rule for Windows
Creates a Windows rule based on a list of IP addresses and DNS names.


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
Discovery rule configuration data.


name
required
string  [ 1 .. 128 ] characters ^[^\<\>\=\%\~]+$
Name of a discovery rule.


 
masterAgentUid
required
string <uuid> 
UID assigned to a management agent.


 
hosts
required
Array of strings  non-empty 
Array of IP addresses or DNS names of computers on which Veeam backup agent is deployed.


 
required
object
Credentials of an account with Local Administrator permissions on discovered computers.


 
useMasterManagementAgentCredentials
boolean
 Default:  true
Indicates whether credentials specified in the master management agent configuration must be used.


 
object or null
Discovery filter.


 
object or null
Settings configured for email notifications about discovery results.


 
object or null
Settings configured for Veeam backup agent deployment.


 
object or null
Discovery scheduling settings.


 
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/discovery/rules/windows/custom
Request samples 
application/json
{
  • "name": "Complex Custom Rule",
  • "masterAgentUid": "4ae8db95-8a4e-4a6a-b1fb-89a0d4b8aca5",
  • "hosts": [
    ],
  • "useMasterManagementAgentCredentials": true,
  • "accessAccount": {
    },
  • "filter": {
    },
  • "notificationSettings": {
    },
  • "deploymentSettings": {
    },
  • "scheduleSettings": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Import-Based Discovery Rule for Windows
Returns a resource representation of a Windows discovery rule based on a list of IP addresses and DNS names.


Request 
path Parameters
ruleUid
required
string <uuid> 
Discovery rule 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/discovery/rules/windows/custom/{ruleUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Import-Based Discovery Rule for Windows
Modifies a Windows discovery rule based on a list of IP addresses and DNS names.


Request 
path Parameters
ruleUid
required
string <uuid> 
Discovery rule 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/discovery/rules/windows/custom/{ruleUid}
Request samples 
application/json
[
  • {
    },
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Get All Discovery Rules for Linux
Returns a collection resource representation of all Linux discovery rules.


Request 
query Parameters
expand
Array of strings (LinuxDiscoveryRuleExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Value: "DiscoveryRule"  
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/discovery/rules/linux
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Discovery Rule for Linux
Returns a resource representation of a Linux discovery rule with the specified UID.


Request 
path Parameters
ruleUid
required
string <uuid> 
Discovery rule 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/discovery/rules/linux/{ruleUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Discovery Rule for Windows
Modifies a Linux discovery rule with the specified UID.


Request 
path Parameters
ruleUid
required
string <uuid> 
Discovery rule 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/discovery/rules/linux/{ruleUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Get All Network-Based Discovery Rules for Linux
Returns a collection resource representation of all Linux network-based discovery rules.


Request 
query Parameters
expand
Array of strings (LinuxNetworkBasedDiscoveryRuleExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Enum: "DiscoveryRule" "LinuxDiscoveryRule"  
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/discovery/rules/linux/networkBased
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Network-Based Discovery Rule for Linux
Creates a Linux network-based discovery rule.


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
Discovery rule settings.


name
required
string  [ 1 .. 128 ] characters ^[^\<\>\=\%\~]+$
Name of a network-based discovery rule.


 
masterAgentUid
required
string <uuid> 
UID assigned to a master agent.


 
required
Array of objects (DiscoveryRuleNetwork) 
Range of IP addresses.


 
required
Array of objects (LinuxDiscoveryCredentialsInput) 
Credentials required to access discovered computers.


 
object or null
Discovery filter.


 
object or null
Settings configured for email notifications about discovery results.


 
object or null
Settings configured for Veeam backup agent deployment.


 
object or null
Discovery scheduling settings.


 
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/discovery/rules/linux/networkBased
Request samples 
application/json
{
  • "name": "Complex Linux Network Rule",
  • "masterAgentUid": "da463bea-d186-4a14-b809-4aba366b03e8",
  • "networks": [
    ],
  • "credentials": [
    ],
  • "filter": {
    },
  • "notificationSettings": {
    },
  • "deploymentSettings": {
    },
  • "scheduleSettings": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Network-Based Discovery Rule for Linux
Returns a resource representation of a Linux network-based discovery rule.


Request 
path Parameters
ruleUid
required
string <uuid> 
Discovery rule 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/discovery/rules/linux/networkBased/{ruleUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Network-Based Discovery Rule for Linux
Modifies a Linux network-based discovery rule with the specified UID.


Request 
path Parameters
ruleUid
required
string <uuid> 
Discovery rule 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/discovery/rules/linux/networkBased/{ruleUid}
Request samples 
application/json
[
  • {
    },
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Get All Import-Based Discovery Rules for Linux
Returns a collection resource representation of all Linux discovery rules based on lists of IP addresses and DNS names.


Request 
query Parameters
expand
Array of strings (LinuxCustomDiscoveryRuleExpand) 
Includes a resource representation of the root entities in the embedded property of a response.


Items Enum: "DiscoveryRule" "LinuxDiscoveryRule"  
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/discovery/rules/linux/custom
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Import-Based Discovery Rule for Linux
Creates a Linux rule based on a list of IP addresses and DNS names.


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
Discovery rule configuration data.


name
required
string  [ 1 .. 128 ] characters ^[^\<\>\=\%\~]+$
Name of a discovery rule.


 
masterAgentUid
required
string <uuid> 
UID assigned to a management agent.


 
hosts
required
Array of strings
Array of IP addresses or DNS names of computers on which Veeam Agent for Linux is deployed.


 
required
Array of objects (LinuxDiscoveryCredentialsInput) 
Credentials required to access discovered computers.


 
object or null
Discovery filter.


 
object or null
Settings configured for email notifications about discovery results.


 
object or null
Settings configured for Veeam backup agent deployment.


 
object or null
Discovery scheduling settings.


 
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/discovery/rules/linux/custom
Request samples 
application/json
{
  • "name": "Linux Custom Rule",
  • "masterAgentUid": "da463bea-d186-4a14-b809-4aba366b03e8",
  • "hosts": [
    ],
  • "credentials": [
    ],
  • "filter": null,
  • "notificationSettings": null,
  • "deploymentSettings": null,
  • "scheduleSettings": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Import-Based Discovery Rule for Linux
Returns a resource representation of a Linux discovery rule based on a list of IP addresses and DNS names.


Request 
path Parameters
ruleUid
required
string <uuid> 
Discovery rule 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/discovery/rules/linux/custom/{ruleUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Import-Based Discovery Rule for Linux
Modifies a Linux discovery rule based on a list of IP addresses and DNS names.


Request 
path Parameters
ruleUid
required
string <uuid> 
Discovery rule 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/discovery/rules/linux/custom/{ruleUid}
Request samples 
application/json
[
  • {
    },
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Get All Discovered Computers
Returns a collection resource representation of all discovered 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/discovery/computers
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Computers Discovered with Specific Rule
Returns a collection resource representation of all computers discovered with a rule with the specified UID.


Request 
path Parameters
ruleUid
required
string <uuid> 
Discovery rule UID.


 
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/discovery/rules/{ruleUid}/computers
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Discovered Computer
Returns a resource representation of a discovered computer with the specified UID.


Request 
path Parameters
computerUid
required
string <uuid> 
Computer 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/discovery/computers/{computerUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Reboot Discovered Computer
Reboots Veeam backup agent on a discovered computer with the specified UID. Returns positive response when management agent receives the reboot task and not when the task is executed.


Request 
path Parameters
computerUid
required
string <uuid> 
Computer 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/discovery/computers/{computerUid}/reboot
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}

    
    

                                

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