This is an archive version of the document. To get the most up-to-date information, see the current version.Get Discovery Rule for Windows
You can get a resource representation of a discovery rule with the specified UID for Microsoft Windows computers.
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 a discovery rule for Microsoft Windows computers, send the GET HTTP request to the URL of the /discovery/rules/windows/{ruleUid} resource.
HTTP Request
GET https://<hostname>:1280/api/v3/discovery/rules/windows/{ruleUid} |
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 |
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 resource representation based on the WindowsDiscoveryRule schema.
Example 
The following request returns a representation of a discovery rule with UID ac754041-0aae-4836-84eb-bc5a01d0e796.
Request: GET https://localhost:1280/api/v3/discovery/rules/windows/ac754041-0aae-4836-84eb-bc5a01d0e796
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": { "instanceUid": "ac754041-0aae-4836-84eb-bc5a01d0e796", "method": "ad", "accessAccount": { "userName": "srv04\administrator", "password": null }, "deploymentSettings": { "isEnabled": false, "backupPolicyUid": null, "setReadOnlyAccess": true, "backupAgentSettings": { "backupAgentUid": "cb448d20-81ae-4d52-b5e8-778566a13e27", "disableScheduledBackups": false, "disableControlPanelNotification": false, "disableBackupOverMeteredConnection": false, "disableScheduleWakeup": false, "throttleBackupActivity": false, "restrictVpnConnections": false, "limitBandwidthConsumption": false, "bandwidthSpeedLimit": 1, "bandwidthSpeedLimitUnit": "mbitPerSec", "flrWithoutAdminPrivilegesAllowed": false } } } } |