This is an archive version of the document. To get the most up-to-date information, see the current version.(GET) /cloud/hardwarePlans/{ID}
Returns a resource representation of a hardware plan that has the specified ID.
Request
To get a resource representation of the hardware plan, you need to send the GET HTTP request to the URL of the /cloud/hardwarePlans/{ID} resource:
HTTP Request
or
Request Headers
The request contains the following headers:
Header | Required | Description |
|---|---|---|
X-RestSvcSessionId | True | The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. To learn more, see Authentication and Security. |
Accept | False | Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
Query Parameters
The following parameters can be used in queries:
Parameter | Type | Description | Can Be Used for Filtering | Can Be Used for Sorting |
|---|---|---|---|---|
Uid | URN | ID of the hardware plan, for example: urn:veeam:CloudHardwarePlan:127e652e-e02e-4951-99e7-03280edfe536. | True | True |
Name | String | Name of the hardware plan, for example: Hyper-V Silver. | True | True |
Platform | Boolean | Virtualization platform for which the hardware plan is configured. Possible values:
| True | True |
BackupServerUId | URN | ID of the Veeam backup server parent to the hardware plan resource. | True | True |
BackupServerName | String | Name of the Veeam backup server parent to the hardware plan resource. | True | True |
Response
The server returns the following response to the client.
Response Codes
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. Possible values:
|
Response Body
In the response body, Veeam Backup Enterprise Manager returns a representation of the /cloud/hardwarePlans/{ID} resource.
Example
The example below returns an entity representation of the hardware plan that has ID 127e652e-e02e-4951-99e7-03280edfe536.
Request: GET https://localhost:9398/api/cloud/hardwarePlans/127e652e-e02e-4951-99e7-03280edfe536?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <CloudHardwarePlan xmlns="http://www.veeam.com/ent/v1.0" Type="CloudHardwarePlan" Href="https://localhost:9398/api/cloud/hardwarePlans/127e652e-e02e-4951-99e7-03280edfe536?format=Entity" Name="Hyper-V Silver" UID="urn:veeam:CloudHardwarePlan:127e652e-e02e-4951-99e7-03280edfe536"> |
