This is an archive version of the document. To get the most up-to-date information, see the current version.Get All User Backup Resources
You can get collection resource representation of all subtenant user backup resources.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator, Company Owner, Company Administrator.
Request
To get user backup resources, send the GET HTTP request to the URL of the /users/backupResources collection.
HTTP Request
GET https://<hostname>:1280/api/v3/users/backupResources |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
limit | Query | Integer (int32) | No | 100 | Specifies the first N resources that must be returned in the output |
offset | Query | Integer (int32) | No | 0 | Excludes the first N resources from the query output |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message: application/json; charset=utf-8 |
Response Body
In the response body, Veeam Service Provider Console returns a collection resource representation based on the UserBackupResource schema.
Example 
The following request returns a representation of all subtenant user backup resources.
Request: GET https://localhost:1280/api/v3/users/backupResources
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "userUid": "8db6e24f-cb3d-404b-8214-2d3f2948bac9", "description": "Alpha", "subtenantUid": "ba6c2ba3-89cd-4c17-6b8a-13c5bfd39bcf", "vcdUserId": null, "companySiteBackupResourceUid": "b2d3f59e-5061-44f3-a6ed-c5a17dbb35a6", "resourceFriendlyName": "Alpha", "storageQuota": 53687091200, "storageQuotaUsage": 0, "isStorageQuotaUnlimited": true }, { "userUid": "bb626067-04ac-4dae-97bd-d2a5ccacb463", "description": "Beta", "subtenantUid": "5b47a760-e676-4004-a40e-2ad594af1f04", "vcdUserId": null, "companySiteBackupResourceUid": "b2d33e9e-5061-44f3-a6ed-c5a17dbb35a6", "resourceFriendlyName": "Beta", "storageQuota": 53687091200, "storageQuotaUsage": 0, "isStorageQuotaUnlimited": true } ] } |