This is an archive version of the document. To get the most up-to-date information, see the current version.(GET) /agents/discoveredComputers/{ID}
Returns a resource representation of a protected computer having the specified ID.
Request
To get a job session, you need to send the GET HTTP request to the URL of the /agents/discoveredComputers/{ID} resource.
HTTP Request
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 a protected computer, for example: 88b395e2-81ff-439c-558c-188d97274c15. | True | True |
Name | String | Name of a protected computer, for example: AgentProtected.local. | True | True |
BackupServerUid | URN | ID of the Veeam backup server parent to the protected computer resource. | True | True |
BackupServerName | String | Name of the Veeam backup server parent to the protected computer resource. | True | True |
AgentVersion | String | Version of Veeam Agent installed on the protected computer. | True | True |
AgentStatus | String | Veeam Agent installation status:
| True | True |
OsVersion | String | Version of the OS installed on the protected computer. | True | True |
IpAddress | String | IP address of the protected computer. | True | True |
ProtectionGroupUid | URN | ID of a protection group that contains the protected computer. | True | True |
ProtectionGroupName | String | Name of a protection group that contains the protected computer. | 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 /agents/discoveredComputers/{ID} resource.
Example
An example below returns an entity representation of the protected computer resource having ID b0ad8ec4-5f17-45e6-be9b-1334ea320af0.
Request: GET https://localhost:9398/api/agents/discoveredComputers/b0ad8ec4-5f17-45e6-be9b-1334ea320af0?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <DiscoveredComputer Href="http://local.host:9399/api/backupTaskSessions/b0ad8ec4-5f17-45e6-be9b-1334ea320af0?format=Entity" Type="DiscoveredComputer" Name="win7x86.local" UID="urn:veeam:DiscoveredComputer:b0ad8ec4-5f17-45e6-be9b-1334ea320af0" xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |
