Veeam Service Provider Console 9.3
REST API Reference
Related documents

Proxy

This resource collection contains operations related to proxying HTTP requests to connected Veeam products.

Get Veeam Products with Available Request Proxying.

Returns a collection resource representation of Veeam products with available request proxying installed on the server where a management agent with the specified UID resides.

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.7
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) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.

get/infrastructure/managementAgents/{managementAgentUid}/proxyableProducts
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Active Proxy Sessions.
Returns a collection resource representation of active proxy sessions.


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.7
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) as well as errors with custom error codes are returned with the 520 HTTP status code. For details, see the response body.


get/proxy/sessions
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}