This API can be used to ensure that the provided host id is valid.
This section includes the following topics:
- Input Parameters
- Output Parameters
Input Parameters
The following table provides the parameters and descriptions.
Parameter | Description |
id | Integer. Numeric host id, obtained via the Register API call, or after registration via the Get registered hosts API call. |
sessionId | String. Containing a GUID, obtained via a call to API Hyper-V Create Host Browsing Session. |
Example
{
"id": 2,
"sessionId": "5d05495f-39e5-4e4e-ad0c-e351cc2c78f3"
}
Output Parameters
Boolean (true or false), denoting the result of the operation (true when the host id points to a valid registered hosts, false otherwise)
Error Code
ErrorCode.HostNotInCatalog - if the provided host id integer from Input section does not point to a valid Hyper-V server (the correct ids can be obtained via get list of hosts)
Example POST
POST /v2/accounts/test_acc/computers/0000/restore/hyperv/host/connect
Input Parameters
{
"id": 1,
"sessionId": "string"
}
Output Parameters
Response status: 200 Accepted (for online operation)
Example Response
{
"data": {
"isConnected":true
}
}