Veeam Service Provider Console 9.1
REST API Reference
Related documents

Companies

This resource collection represents companies managed in Veeam Service Provider Console.

Get All Companies

Returns a collection resource representation of all companies managed in Veeam Service Provider Console.

Request
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/companies
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Company
Creates a new company managed in Veeam Service Provider Console.


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


required
object
Company properties.


 
required
object
Company owner credentials.


 
resellerUid
string or null <uuid> 
UID assigned to a reseller that manages the company.


 
subscriptionPlanUid
string or null <uuid> 
UID assigned to a company subscription plan.


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


 
isAlarmDetectEnabled
boolean
 Default:  false
Defines whether a company must receive notifications about alarms that were triggered for this company.


 
object
Services available to a company.


 
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/companies
Request samples 
application/json
{
  • "resellerUid": "ae61e533-82c7-4cb6-a030-78ae589cf49d",
  • "organizationInput": {
    },
  • "subscriptionPlanUid": null,
  • "isRestAccessEnabled": true,
  • "isAlarmDetectEnabled": false,
  • "companyServices": {
    },
  • "ownerCredentials": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Company
Returns a resource representation of a company with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company 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/companies/{companyUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Company
Modifies a company managed in Veeam Service Provider Console.


Request 
path Parameters
companyUid
required
string <uuid> 
Company 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/companies/{companyUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Company
Deletes a company with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
query Parameters
removeAllAgents
required
boolean
Defines if all agents installed on the computers in the company infrastructure must be deleted.


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


Request 
path 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
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/companies/{companyUid}/welcomeEmail
Request samples 
application/json
{
  • "password": "Password1"
}
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Cloud Tenants Assigned to Company
Returns a collection resource representation of all cloud tenants assigned to a company with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company 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/companies/{companyUid}/siteResources
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Company Veeam Backup for Microsoft 356 Resources
Returns a collection resource representation of Veeam Backup for Microsoft 365 resources allocated to all companies.


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


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


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


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


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


 
isJobSchedulingEnabled
boolean
 Default:  false
Defines whether job schedule can be enabled.


 
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/companies/{companyUid}/hostedResources/vb365
Request samples 
application/json
{
  • "vb365ServerUid": "ae61e533-82c7-4cb6-a030-78ae589cf49d",
  • "friendlyName": "Alpha 365 Resource"
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Company Veeam Backup for Microsoft 365 Resource
Returns a resource representation of company Veeam Backup for Microsoft 365 resource with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vb365ResourceUid
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/companies/{companyUid}/hostedResources/vb365/{vb365ResourceUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Company Veeam Backup for Microsoft 365 Resource
Modifies a company Veeam Backup for Microsoft 365 resource with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vb365ResourceUid
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/companies/{companyUid}/hostedResources/vb365/{vb365ResourceUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Company Veeam Backup for Microsoft 365 Resource
Deletes a company Veeam Backup for Microsoft 365 resource with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vb365ResourceUid
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/companies/{companyUid}/hostedResources/vb365/{vb365ResourceUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Company Veeam Backup for Microsoft 365 Backup Resources
Returns a collection resource representation of all company Veeam Backup for Microsoft 365 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/companies/hostedResources/vb365/backupResources
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Veeam Backup for Microsoft 365 Backup Resources of Company
Returns a collection resource representation of all backup resources allocated to a company on a Veeam Backup for Microsoft 365 resource with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vb365ResourceUid
required
string <uuid> 
Veeam Backup for Microsoft 365 resource 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/companies/{companyUid}/hostedResources/vb365/{vb365ResourceUid}/backupResources
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Company Veeam Backup for Microsoft 365 Backup Resource
Allocates a new backup resource to a company on a Veeam Backup for Microsoft 365 resource with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vb365ResourceUid
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
Veeam Backup for Microsoft 365 backup resource properties.


repositoryUid
required
string <uuid> 
UID assigned to a backup repository.


 
proxyUid
string or null <uuid> 
UID assigned to a backup proxy.


 
proxyPoolUid
string or null <uuid> 
UID assigned to a backup proxy pool.


 
usersQuota
integer or null <int32>   [ 1 .. 999999 ] 
Maximum number of protected user accounts.


 
isUsersQuotaUnlimited
boolean
 Default:  true
Indicates whether a number of protected user accounts is unlimited.


 
storageQuota
integer or null <int64>   [ 1 .. 1048576 ] 
Maximum amount of Veeam Backup for Microsoft 365 repository storage space that a company is allowed to use, in GB.


 
isStorageQuotaUnlimited
boolean
 Default:  true
Indicates whether a storage quota 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/companies/{companyUid}/hostedResources/vb365/{vb365ResourceUid}/backupResources
Request samples 
application/json
{
  • "repositoryUid": "ae61e533-82c7-4cb6-a030-78ae589cf49d",
  • "proxyUid": "d60543b8-9a53-473a-8e4c-cfdc374286cf",
  • "proxyPoolUid": null,
  • "usersQuota": null,
  • "isUsersQuotaUnlimited": true,
  • "storageQuota": 214748,
  • "isStorageQuotaUnlimited": false
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Company Veeam Backup for Microsoft 365 Backup Resource
Returns a resource representation of a company Veeam Backup for Microsoft 365 backup resource with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vb365ResourceUid
required
string <uuid> 
Veeam Backup for Microsoft 365 resource UID.


 
vb365BackupResourceUid
required
string <uuid> 
Veeam Backup for Microsoft 365 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/companies/{companyUid}/hostedResources/vb365/{vb365ResourceUid}/backupResources/{vb365BackupResourceUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Company Veeam Backup for Microsoft 365 Backup Resource
Modifies a company Veeam Backup for Microsoft 365 backup resource with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vb365ResourceUid
required
string <uuid> 
Veeam Backup for Microsoft 365 resource UID.


 
vb365BackupResourceUid
required
string <uuid> 
Veeam Backup for Microsoft 365 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/companies/{companyUid}/hostedResources/vb365/{vb365ResourceUid}/backupResources/{vb365BackupResourceUid}
Request samples 
application/json
[
  • {
    },
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Company Veeam Backup for Microsoft 365 Backup Resource
Deletes a company Veeam Backup for Microsoft 365 backup resource with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vb365ResourceUid
required
string <uuid> 
Veeam Backup for Microsoft 365 resource UID.


 
vb365BackupResourceUid
required
string <uuid> 
Veeam Backup for Microsoft 365 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/companies/{companyUid}/hostedResources/vb365/{vb365ResourceUid}/backupResources/{vb365BackupResourceUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Company Hosted Server Resources
Returns a collection resource representation of hosted Veeam Backup & Replication server resources allocated to all companies.


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


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


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


serverUid
required
string <uuid> 
UID assigned to a Veeam Backup & Replication server that will provide resources to a company.


 
friendlyName
required
string  [ 1 .. 256 ] characters 
Friendly name of a company hosted resource.


 
isJobSchedulingEnabled
boolean
 Default:  false
Defines whether job schedule can be enabled.


 
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/companies/{companyUid}/hostedResources/vbr
Request samples 
application/json
{
  • "serverUid": "6f213654-b538-4695-ac69-aa677e41862e",
  • "friendlyName": "Alpha VBR 2",
  • "isJobSchedulingEnabled": false
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Company Hosted Server Resource
Returns a resource representation of a company hosted Veeam Backup & Replication server resource with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vbrHostedResourceUid
required
string <uuid> 
Hosted 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/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Company Hosted Server Resource
Modifies a company hosted Veeam Backup & Replication server resource with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vbrHostedResourceUid
required
string <uuid> 
Hosted 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/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Company Hosted Server Resource
Deletes a company hosted Veeam Backup & Replication server resource with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vbrHostedResourceUid
required
string <uuid> 
Hosted 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/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Company Hosted Repository Resources
Returns a collection resource representation of hosted Veeam Backup & Replication repository resources allocated to all companies.


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/companies/hostedResources/vbr/backupResources
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Hosted Repository Resources of Company
Returns a collection resource representation of all Veeam Backup & Replication repository resources allocated to a company on a hosted Veeam Backup & Replication server resource with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vbrHostedResourceUid
required
string <uuid> 
Hosted Veeam Backup & Replication server resource 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/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}/backupResources
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Company Hosted Repository Resource
Allocates a new Veeam Backup & Replication repository resource to a company on a hosted Veeam Backup & Replication server resource with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vbrHostedResourceUid
required
string <uuid> 
Hosted 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
Hosted Veeam Backup & Replication repository resource properties.


repositoryUid
required
string <uuid> 
UID assigned to a backup repository.


 
storageQuota
integer or null <int64>   [ 1 .. 1048576 ] 
Amount of space allocated to a company on a repository, in GB.


 
isStorageQuotaUnlimited
boolean
 Default:  true
Indicates whether a storage quota 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/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}/backupResources
Request samples 
application/json
{
  • "repositoryUid": "ae61e533-82c7-4cb6-a030-78ae589cf49d",
  • "storageQuota": 214748,
  • "isStorageQuotaUnlimited": false
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Company Hosted Repository Resource
Returns a resource representation of a company hosted Veeam Backup & Replication repository resource with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vbrHostedResourceUid
required
string <uuid> 
Hosted Veeam Backup & Replication server resource UID.


 
hostedVbrBackupResourceUid
required
string <uuid> 
Hosted Veeam Backup & Replication repository 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/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}/backupResources/{hostedVbrBackupResourceUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Company Hosted Repository Resource
Modifies a company hosted Veeam Backup & Replication repository resource with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vbrHostedResourceUid
required
string <uuid> 
Hosted Veeam Backup & Replication server resource UID.


 
hostedVbrBackupResourceUid
required
string <uuid> 
Hosted Veeam Backup & Replication repository 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/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}/backupResources/{hostedVbrBackupResourceUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}
Delete Company Hosted Repository Resource
Deletes a company hosted Veeam Backup & Replication repository resource with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vbrHostedResourceUid
required
string <uuid> 
Hosted Veeam Backup & Replication server resource UID.


 
hostedVbrBackupResourceUid
required
string <uuid> 
Hosted Veeam Backup & Replication repository 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/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}/backupResources/{hostedVbrBackupResourceUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Tag Resources on Company Hosted Server Resource
Returns a collection resource representation of all tag resources allocated to a company on a hosted Veeam Backup & Replication server resource with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vbrHostedResourceUid
required
string <uuid> 
Hosted Veeam Backup & Replication server resource 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/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}/tagResources
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Tag Resource on Company Hosted Server Resource
Allocates a new tag resource to a company on a hosted Veeam Backup & Replication server resource with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vbrHostedResourceUid
required
string <uuid> 
Hosted 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
Tag resource properties.


virtualCenterUid
required
string <uuid> 
vCenter Server UID.


 
required
object
vCenter Server tag.




You can retrieve all vCenter Server tags using the GetBackupServerVirtualServerTags operation.




 
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/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}/tagResources
Request samples 
application/json
{
  • "virtualCenterUid": "23c54529-5c14-4ebf-aa2c-64f3503a1070",
  • "virtualServerTag": {
    }
}
Response samples 
application/json
{
  • "data": {
    }
}
Get Company Tag Resource
Returns a resource representation of a company tag resource with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vbrHostedResourceUid
required
string <uuid> 
Hosted Veeam Backup & Replication resource UID.


 
hostedTagResourceUid
required
string <uuid> 
Tag 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/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}/tagResources/{hostedTagResourceUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Delete Company Tag Resource
Deletes a company tag resource with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vbrHostedResourceUid
required
string <uuid> 
Hosted Veeam Backup & Replication resource UID.


 
hostedTagResourceUid
required
string <uuid> 
Tag 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/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}/tagResources/{hostedTagResourceUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get All Company Tag Resources
Returns a collection resource representation of all company tag 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/companies/hostedResources/vbr/tagResources
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get All Mappings of VMware Cloud Director Organizations to Company with Assigned Hosted Resource
Returns a collection resource representation of all mappings of VMware Cloud Director organizations to a company with an assigned hosted resource with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vbrHostedResourceUid
required
string <uuid> 
Hosted Veeam Backup & Replication resource 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/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}/mappedVcdOrganizations
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create Mapping of VMware Cloud Director Organization to Company with Assigned Hosted Resource
Maps a VMware Cloud Director organization to a company with an assigned hosted resource with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vbrHostedResourceUid
required
string <uuid> 
Hosted Veeam Backup & Replication resource UID.


 
query Parameters
vcdOrganizationUid
required
string <uuid> 
VMware Cloud Director organization UID.


 
Array of objects or null (SelectParameter) 
Returns explicitly requested properties.


 
header Parameters
X-Request-id
string <uuid> 
Random UID that you can assign to a request for idempotence and async action progress tracking.




Note that an operation is idempotent only during 5 minute time interval.




 
 Example:  ba547d14-c556-42bb-b85c-eeeb16e2f5e7
X-Client-Version
string
Version of Veeam Service Provider Console RESTful API supported by client.


 
 Example:  3.6.1
Responses 
200
OK


202
Request has been queued for execution.


default
All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.


post/organizations/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}/mappedVcdOrganizations
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Get VMware Cloud Director Organization to Company Mapping
Returns a resource representation of a VMware Cloud Director organization to company mapping with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vbrHostedResourceUid
required
string <uuid> 
Hosted Veeam Backup & Replication server resource UID.


 
mappingUid
required
string <uuid> 
VMware Cloud Director organization to company mapping 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/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}/mappedVcdOrganizations/{mappingUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Delete VMware Cloud Director Organization to Company Mapping
Deletes a VMware Cloud Director organization to company mapping with the specified UID.


Request 
path Parameters
companyUid
required
string <uuid> 
Company UID.


 
vbrHostedResourceUid
required
string <uuid> 
Hosted Veeam Backup & Replication server resource UID.


 
mappingUid
required
string <uuid> 
VMware Cloud Director organization to company mapping 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/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}/mappedVcdOrganizations/{mappingUid}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "data": { },
  • "meta": {
    }
}
Get Mappings of VMware Cloud Director Organizations to All Companies with Assigned Hosted Resources
Returns a collection resource representation of mappings of VMware Cloud Director organizations to all companies with assigned hosted 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/companies/hostedResources/vbr/mappedVcdOrganizations
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Services Usage by All Companies
Returns a collection resource representation of services consumed by companies.


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


Request 
path Parameters
companyUid
required
string <uuid> 
Company 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/companies/{companyUid}/usage
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}
Get Permissions of Veeam Service Provider Console Entity
Returns a resource representation of permissions provided to a Veeam Service Provider Console entity with the specified UID.


Request 
path Parameters
entityUid
required
string <uuid> 
UID of a Veeam Service Provider Console entity.




In the current version it can only be company UID. 




 
query Parameters
entityType
required
any
Type of a Veeam Service Provider Console entity.


 
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/permissions/{entityUid}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}
Modify Veeam Service Provider Console Entity Permissions
Modifies permissions provided to a Veeam Service Provider Console entity with the specified UID.


Request 
path Parameters
entityUid
required
string <uuid> 
UID of a Veeam Service Provider Console entity.




In the current version it can only be company UID.




 
query Parameters
entityType
required
any
Type of a Veeam Service Provider Console entity.


 
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/permissions/{entityUid}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "data": {
    }
}

    
    

                                

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