Get All Computers Discovered with Specific Rule
You can get a collection resource representation of all computers discovered with a rule 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 all computers discovered with a specific rule, send the GET HTTP request to the URL of the /discovery/rules/{ruleUid}/computers collection.
HTTP Request
GET https://<hostname>:1280/api/v3/discovery/rules/{ruleUid}/computers |
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 |
---|---|---|---|---|---|
ruleUid | Path | String (uuid) | Yes | — | Discovery rule 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 DiscoveredComputer schema.
Example
The following request returns a representation of all computers discovered with a rule with UID b1735ae2-2368-4438-958c-e39507bb6710.
Request: GET https://localhost:1280/api/v3/discovery/rules/b1735ae2-2368-4438-958c-e39507bb6710/computers
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 2, "count": 2, "offset": 0 } }, "data": [ { "instanceUid": "564131d5-a04c-4e70-850a-b6e1b26ce113", "ruleUid": "b1735ae2-2368-4438-958c-e39507bb6710", "managementAgentUid": "96405a83-d838-4a9d-ada9-80fca4a667a8", "discoveredTime": "2020-03-08T04:19:01.6144435+03:00", "backupAgentInstallationStatus": "Installed", "backupAgentVersion": "4.0.0.1811", "backupAgentManagementStatus": "ManagedByConsole", "info": { "uniqueUid": "d4aa60ab-db8e-4012-a450-8a8ad6205fc1", "biosUuid": "e77a8297-5e28-48d1-9c26-2a82ae8ecf23", "hostName": "srv03", "fqdn": "srv03.prod.local", "guestOs": "Microsoft Windows Server 2016 Standard", "guestOsType": "server", "guestOsVersion": "10.0.14393", "guestOsSku": 7, "platformType": "vSphere", "ipAddresses": [ "172.24.145.33" ], "macAddresses": [ "00:50:56:BB:1C:E8" ] } }, { "instanceUid": "73954acf-e4aa-4947-8be3-269d43d50c8a", "ruleUid": "b1735ae2-2368-4438-958c-e39507bb6710", "managementAgentUid": "9daed829-c3a4-479d-94ea-af0b5607beab", "discoveredTime": "2020-03-08T03:54:04.3151227+03:00", "backupAgentInstallationStatus": "Installed", "backupAgentVersion": "4.0.0.1811", "backupAgentManagementStatus": "ManagedByConsole", "info": { "uniqueUid": "fe679450-4f67-4ef9-af82-1891fd22292d", "biosUuid": "362f4b14-6968-4f5a-aa39-214227185fec", "hostName": "srv14", "fqdn": "srv14.prod.local", "guestOs": "Microsoft Windows Server 2016 Standard", "guestOsType": "server", "guestOsVersion": "10.0.14393", "guestOsSku": 7, "platformType": "vSphere", "ipAddresses": [ "172.24.152.9" ], "macAddresses": [ "00:50:56:BB:02:37" ] } } ] } |