This is an archive version of the document. To get the most up-to-date information, see the current version.Get All Hardware Plans Configured on Site
You can get a collection resource representation of all hardware plans configured 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.
Request
To a representation of all hardware plans configured on a site, send the GET HTTP request to the URL of the /infrastructure/sites/{siteUid}/hardwarePlans collection.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/sites/{siteUid}/hardwarePlans |
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 |
|---|---|---|---|---|---|
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 BackupHardwarePlan schema.
Example 
The following request returns a representation of all hardware plans configured on a site with UID 365be228-b14d-421a-9a0e-a15434e2195c.
Request: GET https://localhost:1280/api/v3/infrastructure/sites/365be228-b14d-421a-9a0e-a15434e2195c/hardwarePlans
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "c3254747-7851-4533-bc03-a7fd5a2e0fdb", "name": "Alpha hardware plan", "backupServerUid": "365be228-b14d-421a-9a0e-a15434e2195c", "cpuQuota": 3077, "isCpuQuotaUnlimited": false, "memoryQuota": 39888879616, "isMemoryQuotaUnlimited": false, "networkWithInternetQuota": 1, "networkWithoutInternetQuota": 0 }, { "instanceUid": "6da84b55-6348-4656-88ab-d8016e9385f6", "name": "Beta hardware plan", "backupServerUid": "365be228-b14d-421a-9a0e-a15434e2195c", "cpuQuota": 1000, "isCpuQuotaUnlimited": false, "memoryQuota": 2097152000, "isMemoryQuotaUnlimited": false, "networkWithInternetQuota": 0, "networkWithoutInternetQuota": 1 } ] } |