Get All Company Backup Resources
You can get a collection resource representation of all company cloud 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 a representation of all company backup resources, send the GET HTTP request to the URL of the /organizations/companies/sites/backupResources collection.
HTTP Request
GET https://<hostname>:1280/api/v3/organizations/companies/sites/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 CompanySiteBackupResource schema.
Example 
The following request returns a representation of all backup resources configured for companies.
Request: GET https://localhost:1280/api/v3/organizations/companies/sites/backupResources
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "298c524d-b11e-4dec-a182-8e11b53d6c53", "companyUid": "afc14241-e3e7-4dec-9692-47ea7a30d47e", "siteUid": "7ac18520-6278-440b-a3cc-052805647187", "repositoryUid": "402f8e0c-4489-4322-9683-ffdafab537e1", "cloudRepositoryName": "Cloud repository 1", "storageQuota": 10737418240, "serversQuota": null, "isServersQuotaUnlimited": true, "workstationsQuota": null, "isWorkstationsQuotaUnlimited": true, "vmsQuota": null, "isVmsQuotaUnlimited": true, "isWanAccelerationEnabled": false, "wanAccelerationUid": "00000000-0000-0000-0000-000000000000" }, { "instanceUid": "111c1779-d67f-4192-b0bc-f956ea8353dc", "companyUid": "10c38b81-5132-460e-941f-4cfb1348b6c5", "siteUid": "7ac18520-6278-440b-a3cc-052805647187", "repositoryUid": "402f8e0c-4489-4322-9683-ffdafab537e1", "cloudRepositoryName": "Cloud repository 1", "storageQuota": 2147483648, "serversQuota": null, "isServersQuotaUnlimited": true, "workstationsQuota": null, "isWorkstationsQuotaUnlimited": true, "vmsQuota": null, "isVmsQuotaUnlimited": true, "isWanAccelerationEnabled": false, "wanAccelerationUid": "00000000-0000-0000-0000-000000000000" } ] } |
