Veeam Service Provider Console 9.1
REST API Reference
Related documents

Resellers

This resource collection represents resellers.

Get All Resellers

Returns a collection resource representation of all resellers.

Request
query Parameters
expand
Array of strings (ResellerExpand)

Includes a resource representation of the root entities in the embedded property of a response.

Items Value: "Organization"
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/organizations/resellers
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Reseller
Creates a new reseller with specific properties.


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
Reseller properties.


required
object
Reseller organization settings.


 
required
object
User credentials configured for Service Provider Global Administrator.


 
description
string or null
Description of a reseller.


 
proPartnerId
string or null
ProPartner Portal ID assigned to a reseller.


 
object
Services available to a reseller.


 
isRestAccessEnabled
boolean
 Default:  false
Defines whether access to REST API is enabled for a reseller.


 
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/organizations/resellers
Request samples 
application/json
{
  • "description": null,
  • "proPartnerId": null,
  • "organizationInput": {
    },
  • "resellerServices": {
    },
  • "ownerCredentials": {
    },
  • "isRestAccessEnabled": true
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Reseller
Returns a resource representation of a reseller with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller 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/organizations/resellers/{resellerUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Reseller
Modifies a reseller with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller 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/organizations/resellers/{resellerUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Reseller
Deletes a reseller with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller 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
Reseller has been deleted.


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/organizations/resellers/{resellerUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Send Welcome Email to Reseller
Sends a welcome email to a reseller with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller 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
Password for the account.


password
required
string or null <password>   [ 1 .. 128 ] characters 
Password for created account.


 
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/organizations/resellers/{resellerUid}/welcomeEmail
Request samples 
application/json
{
  • "password": "Password1"
}
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Companies Managed by Reseller
Returns a collection resource representation of companies managed by a reseller with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


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


Items Value: "Organization"  
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/organizations/resellers/{resellerUid}/companies
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Assign Company to Reseller
Assigns a company with the specified UID to a reseller.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
query Parameters
companyUid
required
string <uuid> 
Company 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/organizations/resellers/{resellerUid}/companies
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Unassign Company from Reseller
Unassigns a company with the specified UID from a reseller.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
query Parameters
companyUid
required
string <uuid> 
Company 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/organizations/resellers/{resellerUid}/companies
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Reseller License Management Resources
Returns a collection resource representation of all license management resources allocated to resellers.


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/organizations/resellers/licenseResource
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get License Management Resource Allocated to Reseller
Returns a resource representation of a license management resource allocated to a reseller with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller 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/organizations/resellers/{resellerUid}/licenseResource
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify License Management Resource Allocated to Reseller
Modifies a license management resource allocated to a reseller with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller 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/organizations/resellers/{resellerUid}/licenseResource
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Get All Reseller Veeam Backup for Microsoft 365 Resources
Returns a collection resource representation of Veeam Backup for Microsoft 365 resources allocated to all resellers.


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/organizations/resellers/hostedResources/vb365
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Veeam Backup for Microsoft 365 Resources of Reseller
Returns a collection resource representation of all Veeam Backup for Microsoft 365 resources allocated to a reseller with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller 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/organizations/resellers/{resellerUid}/hostedResources/vb365
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Reseller Veeam Backup for Microsoft 365 Resource.
Allocates a Veeam Backup for Microsoft 365 resource to a reseller with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller 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
Reseller Veeam Backup for Microsoft 365 resource properties.


vb365ServerUid
required
string <uuid> 
UID assigned to a Veeam Backup for Microsoft 365 resource.


 
friendlyName
required
string  [ 1 .. 256 ] characters 
Friendly name of a Veeam Backup for Microsoft 365 resource.


 
vb365RepositoriesUids
Array of strings <uuid> 
Array of UIDs assigned to Veeam Backup for Microsoft 365 backup repositories.


 
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/organizations/resellers/{resellerUid}/hostedResources/vb365
Request samples 
application/json
{
  • "vb365ServerUid": "cac1f37d-a177-4cd6-a08b-852cb40dcad7",
  • "friendlyName": "VBM365 Resource",
  • "vb365RepositoriesUids": [
    ]
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Reseller Veeam Backup for Microsoft 365 Resource
Returns a resource representation of a reseller Veeam Backup for Microsoft 365 resource with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
resourceUid
required
string <uuid> 
Veeam Backup for Microsoft 365 resource 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/organizations/resellers/{resellerUid}/hostedResources/vb365/{resourceUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Reseller Veeam Backup for Microsoft 365 Resource
Modifies a reseller Veeam Backup for Microsoft 365 resource with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
resourceUid
required
string <uuid> 
Veeam Backup for Microsoft 365 resource 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/organizations/resellers/{resellerUid}/hostedResources/vb365/{resourceUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Reseller Veeam Backup for Microsoft 365 Resource
Deletes a reseller Veeam Backup for Microsoft 365 resource with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
resourceUid
required
string <uuid> 
Veeam Backup for Microsoft 365 resource 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/organizations/resellers/{resellerUid}/hostedResources/vb365/{resourceUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Delete Reseller Veeam Backup for Microsoft 365 Repository
Deletes a reseller Veeam Backup for Microsoft 365 repository with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
resourceUid
required
string <uuid> 
Veeam Backup for Microsoft 365 server UID.


 
repositoryUid
required
string <uuid> 
Veeam Backup for Microsoft 365 repository 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/organizations/resellers/{resellerUid}/hostedResources/vb365/{resourceUid}/repositoryResources/{repositoryUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Reseller Veeam Backup & Replication Server Resources
Returns a collection resource representation of Veeam Backup & Replication server resources allocated to all resellers.


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/organizations/resellers/hostedResources/vbr
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Veeam Backup & Replication Server Resources of Reseller
Returns a collection resource representation of all Veeam Backup & Replication server resources allocated to a reseller with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller 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/organizations/resellers/{resellerUid}/hostedResources/vbr
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Reseller Veeam Backup & Replication Server Resource
Allocates a Veeam Backup & Replication server resource to a reseller with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller 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
Reseller Veeam Backup & Replication server resource properties.


vbrServerUid
required
string <uuid> 
UID assigned to a Veeam Backup & Replication server resource.


 
friendlyName
required
string  [ 1 .. 256 ] characters 
Friendly name of a Veeam Backup & Replication server resource.


 
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/organizations/resellers/{resellerUid}/hostedResources/vbr
Request samples 
application/json
{
  • "vbrServerUid": "ae61e533-82c7-4cb6-a030-78ae589cf49d",
  • "friendlyName": "Beta VBR Resource"
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Reseller Veeam Backup & Replication Server Resource
Returns a resource representation of a reseller Veeam Backup & Replication server resource with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
resourceUid
required
string <uuid> 
Veeam Backup & Replication server resource 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/organizations/resellers/{resellerUid}/hostedResources/vbr/{resourceUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Reseller Veeam Backup & Replication Server Resource
Modifies a reseller Veeam Backup & Replication server resource with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
resourceUid
required
string <uuid> 
Veeam Backup & Replication server resource 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/organizations/resellers/{resellerUid}/hostedResources/vbr/{resourceUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Reseller Veeam Backup & Replication Server Resource
Deletes a reseller Veeam Backup & Replication server resource with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
resourceUid
required
string <uuid> 
Veeam Backup & Replication server resource 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/organizations/resellers/{resellerUid}/hostedResources/vbr/{resourceUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Reseller Site Resources
Returns a collection resource representation of managed company quotas configured for all resellers.


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/organizations/resellers/sites
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Site Resources Allocated to Reseller
Returns a collection resource representation of managed company quotas configured for a reseller with the specified UID on all sites.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller 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/organizations/resellers/{resellerUid}/sites
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Reseller Site Resource
Creates a managed company quota for a reseller with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller 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
Company quota properties.


siteUid
required
string <uuid> 
UID assigned to a Veeam Cloud Connect site.




The property value cannot be changed after creation.




 
tenantsQuota
integer or null <int32>   [ 1 .. 99999 ] 
 Default:  20
Maximum number of tenants that a reseller can manage on a Veeam Cloud Connect site.


 
isTenantsQuotaUnlimited
boolean
 Default:  false
Indicates whether a reseller can manage an unlimited number of tenants.


 
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/organizations/resellers/{resellerUid}/sites
Request samples 
application/json
{
  • "siteUid": "d83442bc-03fc-469b-be4e-c0761bfc9ddd",
  • "tenantsQuota": 45,
  • "isTenantsQuotaUnlimited": false
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Reseller Site Resource
Returns a resource representation of a managed companies quota configured for a reseller on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site 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/organizations/resellers/{resellerUid}/sites/{siteUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Reseller Site Resource
Modifies a managed companies quota configured for a reseller on the Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site 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/organizations/resellers/{resellerUid}/sites/{siteUid}
Request samples 
application/json
[
  • {
    },
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Reseller Site Resource
Deletes a managed companies quota configured for a reseller on the Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site 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/organizations/resellers/{resellerUid}/sites/{siteUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Reseller Backup Resources
Returns a collection resource representation of all reseller cloud backup resources.


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/organizations/resellers/sites/backupResources
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Backup Resources Allocated to Reseller on Site
Returns a collection resource representation of all cloud backup resources allocated to a reseller on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site 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/organizations/resellers/{resellerUid}/sites/{siteUid}/backupResources
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Reseller Backup Resource on Site
Creates a reseller cloud backup resource on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site 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
repositoryUid
required
string <uuid> 
UID assigned to a cloud backup repository.


 
resourceFriendlyName
required
string
Cloud repository friendly name configured for a reseller.


 
storageQuota
integer or null <int64>   [ 1073741824 .. 1124774006935781400 ] 
Amount of space allocated to a reseller, in bytes.


 
isStorageQuotaUnlimited
boolean
 Default:  true
Indicates whether the amount of space allocated to a reseller is unlimited.


 
serversQuota
integer or null <int32> 
Number of servers that a reseller can store on a cloud backup repository.


 
isServersQuotaUnlimited
boolean
 Default:  true
Indicates whether the number of servers that a reseller can store on a cloud backup repository is unlimited.


 
workstationsQuota
integer or null <int32> 
Number of workstations that a reseller can store on a cloud backup repository.


 
isWorkstationsQuotaUnlimited
boolean
 Default:  true
Indicates whether the number of workstations that a reseller can store on a cloud backup repository is unlimited.


 
vmsQuota
integer or null <int32> 
Number of VMs that a reseller can store on a cloud backup repository.


 
isVmsQuotaUnlimited
boolean
 Default:  true
Indicates whether the number of VMs that a reseller can store on a cloud backup repository is unlimited.


 
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/organizations/resellers/{resellerUid}/sites/{siteUid}/backupResources
Request samples 
application/json
{
  • "repositoryUid": "ae61e533-82c7-4cb6-a030-78ae589cf49d",
  • "resourceFriendlyName": "Beta Site Resource",
  • "storageQuota": 10737418240,
  • "isStorageQuotaUnlimited": false,
  • "serversQuota": 5,
  • "isServersQuotaUnlimited": false,
  • "workstationsQuota": 5,
  • "isWorkstationsQuotaUnlimited": false,
  • "vmsQuota": 5,
  • "isVmsQuotaUnlimited": false
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Usage of All Reseller Backup Resources
Returns a collection resource representation of cloud backup resource usage by all resellers.


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/organizations/resellers/sites/backupResources/usage
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Usage of Reseller Backup Resources on Site
Returns a resource representation of usage of all cloud backup resources allocated to a reseller on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site 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/organizations/resellers/{resellerUid}/sites/{siteUid}/backupResources/usage
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Reseller Backup Resource
Returns a resource representation of a reseller cloud backup resource with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
resourceUid
required
string <uuid> 
Cloud backup resource 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/organizations/resellers/{resellerUid}/sites/{siteUid}/backupResources/{resourceUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Reseller Backup Resource
Modifies a reseller cloud backup resource with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
resourceUid
required
string <uuid> 
Cloud backup resource 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/organizations/resellers/{resellerUid}/sites/{siteUid}/backupResources/{resourceUid}
Request samples 
application/json
[
  • {
    },
  • {
    },
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Reseller Backup Resource
Deletes a reseller cloud backup resource with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
resourceUid
required
string <uuid> 
Cloud backup resource 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/organizations/resellers/{resellerUid}/sites/{siteUid}/backupResources/{resourceUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Cloud WAN Accelerator Resources of All Resellers
Returns a collection resource representation of cloud WAN accelerator resources of all resellers.


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/organizations/resellers/sites/wanAcceleratorResources
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Cloud WAN Accelerator Resources Allocated to Reseller on Site
Returns a collection resource representation of all cloud WAN accelerator resources allocated to a reseller on a site with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site 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/organizations/resellers/{resellerUid}/sites/{siteUid}/wanAcceleratorResources
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Reseller Cloud WAN Accelerator Resource
Creates a reseller cloud WAN accelerator resource on a site with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site 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
wanAcceleratorUid
required
string <uuid> 
UID assigned to a cloud backup repository.


 
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/organizations/resellers/{resellerUid}/sites/{siteUid}/wanAcceleratorResources
Request samples 
application/json
{
  • "wanAcceleratorUid": "00bdb123-c35a-43d6-ad03-7ca78e156ac4"
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Reseller Cloud WAN Accelerator Resource
Returns a resource representation of a reseller cloud WAN accelerator resource with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
resourceUid
required
string <uuid> 
Cloud WAN accelerator resource 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/organizations/resellers/{resellerUid}/sites/{siteUid}/wanAcceleratorResources/{resourceUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Reseller Cloud WAN Accelerator Resource
Modifies a reseller cloud WAN accelerator resource with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
resourceUid
required
string <uuid> 
Cloud WAN accelerator resource 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/organizations/resellers/{resellerUid}/sites/{siteUid}/wanAcceleratorResources/{resourceUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Reseller Cloud WAN Accelerator Resource
Deletes a reseller cloud WAN accelerator resource with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
resourceUid
required
string <uuid> 
Cloud WAN accelerator resource 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/organizations/resellers/{resellerUid}/sites/{siteUid}/wanAcceleratorResources/{resourceUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Reseller Replication Resources
Returns a collection resource representation of all reseller cloud replication resources.


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/organizations/resellers/sites/replicationResources
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Replication Resources Allocated to Reseller on Site
Returns a collection resource representation of all cloud replication resources allocated to a reseller on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site 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/organizations/resellers/{resellerUid}/sites/{siteUid}/replicationResources
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Reseller Replication Resource on Site
Creates a reseller replication resource on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site 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
hardwarePlanUid
required
string <uuid> 
UID assigned to a hardware plan.


 
tenantsPerPlanQuota
integer or null <int32>   >= 1 
Maximum number of companies that a reseller can subscribe to a hardware plan.


 
isWanAccelerationEnabled
boolean
 Default:  false
Indicates whether WAN acceleration is enabled.


 
wanAcceleratorUid
string or null <uuid> 
UID assigned to a WAN accelerator.


 
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/organizations/resellers/{resellerUid}/sites/{siteUid}/replicationResources
Request samples 
application/json
{
  • "hardwarePlanUid": "ae61e533-82c7-4cb6-a030-78ae589cf49d",
  • "tenantsPerPlanQuota": 100,
  • "isWanAccelerationEnabled": true,
  • "wanAcceleratorUid": null
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Usage of All Reseller Replication Resources
Returns a collection resource representation of Veeam Cloud Connect site replication resource usage by all resellers.


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/organizations/resellers/sites/replicationResources/usage
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Usage of Replication Resources by Reseller on Site
Returns a resource representation of cloud replication resource usage by a reseller on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site 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/organizations/resellers/{resellerUid}/sites/{siteUid}/replicationResources/usage
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Reseller Replication Resource
Returns a resource representation of a reseller cloud replication resource with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
resourceUid
required
string <uuid> 
Cloud replication resource 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/organizations/resellers/{resellerUid}/sites/{siteUid}/replicationResources/{resourceUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Reseller Replication Resource
Modifies a reseller cloud replication resource with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
resourceUid
required
string <uuid> 
Cloud replication resource 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/organizations/resellers/{resellerUid}/sites/{siteUid}/replicationResources/{resourceUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Reseller Replication Resource
Deletes a reseller cloud replication resource with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
resourceUid
required
string <uuid> 
Cloud replication resource 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/organizations/resellers/{resellerUid}/sites/{siteUid}/replicationResources/{resourceUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Reseller VMware Cloud Director Replication Resources
Returns a collection resource representation of all reseller VMware Cloud Director replication resources.


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/organizations/resellers/sites/vcdReplicationResources
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All VMware Cloud Director Replication Resources Allocated to Reseller on Site
Returns a collection resource representation of all VMware Cloud Director replication resources allocated to a reseller on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site 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/organizations/resellers/{resellerUid}/sites/{siteUid}/vcdReplicationResources
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Reseller VMware Cloud Director Replication Resource on Site
Creates a VMware Cloud Director replication resource allocated to a reseller on a Veeam Cloud Connect site with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site 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
vcdOrganizationUid
required
string <uuid> 
UID assigned to a VMware Cloud Director organization whose resources are allocated to a reseller.


 
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/organizations/resellers/{resellerUid}/sites/{siteUid}/vcdReplicationResources
Request samples 
application/json
{
  • "vcdOrganizationUid": "ba5c51b7-66b3-4465-a3ba-b52aae245cca"
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Reseller VMware Cloud Director Replication Resource
Returns a resource representation of a reseller VMware Cloud Director replication resource with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
resourceUid
required
string <uuid> 
VMware Cloud Director replication resource 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/organizations/resellers/{resellerUid}/sites/{siteUid}/vcdReplicationResources/{resourceUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Delete Reseller VMware Cloud Director Replication Resource
Deletes a reseller VMware Cloud Director replication resource with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
siteUid
required
string <uuid> 
Veeam Cloud Connect site UID.


 
resourceUid
required
string <uuid> 
VMware Cloud Director replication resource 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/organizations/resellers/{resellerUid}/sites/{siteUid}/vcdReplicationResources/{resourceUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Services Usage by All Resellers
Returns a collection resource representation of services consumed by resellers.


Request 
query Parameters
fromDate
string <date> 
Start timestamp of a searched time range.


 
toDate
string <date> 
End timestamp of a searched time range. Total time range must be less than or equal to 31 day.


 
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/organizations/resellers/usage
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Services Usage by Reseller
Returns a collection resource representation of services consumed by a reseller with the specified UID.


Request 
path Parameters
resellerUid
required
string <uuid> 
Reseller UID.


 
query Parameters
fromDate
string <date> 
Start timestamp of a searched time range.


 
toDate
string <date> 
End timestamp of a searched time range. Total time range must be less than or equal to 31 day.


 
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/organizations/resellers/{resellerUid}/usage
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

    
    

                                

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