Veeam Service Provider Console 9.1
REST API Reference
Related documents

Management Agents

This resource collection represents management agents installed on Veeam Service Provider Console infrastructure components.

Get All Unverified Management Agents

Returns a collection resource representation of all unverified management 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/infrastructure/unverifiedAgents
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Unverified Management Agent
Returns a resource representation of an unverified management agent with the specified UID.


Request 
path Parameters
unverifiedAgentUid
required
string <uuid> 
Unverified management agent 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/unverifiedAgents/{unverifiedAgentUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Accept Unverified Management Agent
Accepts an unverified management agent with the specified UID.


Request 
path Parameters
unverifiedAgentUid
required
string <uuid> 
Unverified management agent UID.


 
query Parameters
organizationUid
required
string <uuid> 
Organization UID.


 
cloudTenantUid
string <uuid> 
Tenant 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/unverifiedAgents/{unverifiedAgentUid}/accept
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Management Agents
Returns a collection resource representation of all management 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/infrastructure/managementAgents
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Download Management Agent Setup File for Windows
Returns a download link to a management agent setup file in the EXE or MSI format for Microsoft Windows computers.


Request 
query Parameters
organizationUid
string <uuid> 
UID of an organization to which a management agent will be assigned.


 
locationUid
string <uuid> 
UID of a location to which a management agent will be assigned.


 
cloudTenantUid
string <uuid> 
UID of a cloud tenant to which a management agent will be assigned.


 
tokenExpiryPeriodDays
integer <int32>   [ 1 .. 4700 ] 
 Default:  365
Time period for which you want to verify the management agent, in days.




The recommended value is 182 or less.




 
packageType
string
 Default:  "exe"
Setup file extension.


 Enum: "msi" "exe"  
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
Management agent setup file in the byte stream format.


202
Request has been queued for execution.


520
Internal Server Error


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/managementAgents/packages/windows
Request samples 
Response samples 
application/json
"blob:https://lrsw10.tech.local:1280/b64d2863-97c5-49b6-a64a-fadc339c5804"
Download Management Agent Setup File for Linux
Returns a download link to a management agent setup file in the shell script format for Linux computers.


Request 
query Parameters
organizationUid
string <uuid> 
UID of an organization to which a management agent will be assigned.


 
locationUid
string <uuid> 
UID of a location to which a management agent will be assigned.


 
cloudTenantUid
string <uuid> 
UID of a cloud tenant to which a management agent will be assigned.


 
tokenExpiryPeriodDays
integer <int32>   [ 1 .. 4700 ] 
 Default:  365
Time period for which you want to verify the management agent, in days.




The recommended value is 182 or less.




 
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
Management agent setup file in the byte stream format.


202
Request has been queued for execution.


520
Internal Server Error


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/managementAgents/packages/linux
Request samples 
Response samples 
application/json
"blob:https://lrsw10.tech.local:1280/562b5b52-c3d4-4ab4-bdf2-c450e220b38c"
Download Management Agent Setup File for macOS.
Returns a download link to a management agent setup file in the shell script format for macOS computers.


Request 
query Parameters
organizationUid
string <uuid> 
UID of an organization to which a management agent will be assigned.


 
locationUid
string <uuid> 
UID of a location to which a management agent will be assigned.


 
cloudTenantUid
string <uuid> 
UID of a cloud tenant to which a management agent will be assigned.


 
tokenExpiryPeriodDays
integer <int32>   [ 1 .. 4700 ] 
 Default:  365
Time period for which you want to verify the management agent, in days.




The recommended value is 182 or less.




 
packageType
string
 Default:  "zip"
Setup file extension.


 Enum: "sh" "zip"  
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
Management agent setup file in the byte stream format.


202
Request has been queued for execution.


520
Internal Server Error


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/managementAgents/packages/mac
Request samples 
Response samples 
application/json
"blob:https://lrsw10.tech.local:1280/1fa695d3-bc57-4f80-b838-7d7155973602"
Get Management Agent
Returns a resource representation of a management agent with the specified UID.


Request 
path Parameters
managementAgentUid
required
string <uuid> 
Management agent 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/managementAgents/{managementAgentUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Management Agent
Modifies a management agent with the specified UID.


Request 
path Parameters
managementAgentUid
required
string <uuid> 
Management agent 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/infrastructure/managementAgents/{managementAgentUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Management Agent
Deletes a management agent with the specified UID.




If the management agent is inaccessible, it will be deleted only on the Veeam Service Provider Console side 
and the operation response will contain a warning message.






Does not delete the unverified management agents and the management agents that are installed on the Veeam Cloud Connect servers.




Request 
path Parameters
managementAgentUid
required
string <uuid> 
Management agent 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.


delete/infrastructure/managementAgents/{managementAgentUid}
Request samples 
Response samples 
application/json
{
  • "data": [ ],
  • "meta": {
    }
}
Restart Management Agent
Restarts a management agent with the specified UID. Returns a positive response when the management agent receives the restart task and not when the task is executed.


Request 
path Parameters
managementAgentUid
required
string <uuid> 
Management agent 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/managementAgents/{managementAgentUid}/restart
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Reboot System on Managed Computer
Runs system reboot on a computer where management agent with the specified UID is installed. Returns a positive response when the management agent receives the reboot task and not when the task is executed.


Request 
path Parameters
managementAgentUid
required
string <uuid> 
Management agent 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/managementAgents/{managementAgentUid}/reboot
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}

    
    

                                

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