This is an archive version of the document. To get the most up-to-date information, see the current version.Get Usage of All Backup Resources Allocated to Company on Specific Site
You can a resource representation of a cloud backup resource usage by a company on a site with the specified UID.
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 a cloud backup resource usage by a company on a specific site, send the GET HTTP request to the URL of the /organizations/companies/{companyUid}/sites/{siteUid}/backupResources/usage collection.
HTTP Request
GET https://<hostname>:1280/api/v3/organizations/companies/{companyUid}/sites/{siteUid}/backupResources/usage |
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 |
|---|---|---|---|---|---|
companyUid | Path | String (uuid) | Yes | — | Company UID |
siteUid | Path | String (uuid) | Yes | — | Site UID |
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 CompanySiteBackupResourceUsage schema.
Example 
The following request returns a representation of a cloud backup resource usage by a company with UID 4834d98d-6bdd-4629-89d2-ebd9c8efa650 on a site with UID 30a2116c-1133-4a6c-a092-672cc202982a.
Request: GET https://localhost:1280/api/v3/organizations/companies/4834d98d-6bdd-4629-89d2-ebd9c8efa650/sites/30a2116c-1133-4a6c-a092-672cc202982a/backupResources/usage
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "backupResourceUid": "33d8e602-2b3c-4743-bf4e-83e687ef611a", "usedStorageQuota": 1073418240 }, { "backupResourceUid": "bdbfa700-fdc7-4cdf-a7a1-d5610ab968d0", "usedStorageQuota": 702738190 } ] } |