This is an archive version of the document. To get the most up-to-date information, see the current version.Create Network-Based Discovery Rule for Windows
You can create a network-based discovery rule 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 create a network-based discovery rule for Microsoft Windows computers, send the POST HTTP request to the URL of the /discovery/rules/windows/networkBased resource.
HTTP Request
POST https://<hostname>:1280/api/v3/discovery/rules/windows/networkBased |
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. |
Content-Type | Required | application/json | Identifies a media type that is used in the body of the request. |
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 |
|---|---|---|---|---|---|
Body | Body | Yes | — | Discovery rule settings |
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 created resource representation based on the WindowsNetworkBasedDiscoveryRule schema.
Example 
The following request creates a new network-based discovery rule for Microsoft Windows computers.
Request: POST https://localhost:1280/api/v3/discovery/rules/windows/networkBased
Request Header: Content-type: application/json Authorization: Bearer <Access-Token>
Request Body: { "name": "Alpha Discovery Rule", "masterAgentUid": "baa57d6f-1a51-4bef-8bae-25b073ac04cb", "networks": [ { "networkName": "Production", "firstIp": "172.17.53.1", "lastIp": "172.17.53.50" } ], "accessAccount": { "userName": "srv04\administrator", "password": "Password1" }, "filter": { "exclusionMask": [], "ignoreInaccessibleMachine": true, "osTypes": [ "Workstation" ], "applications": [ "OtherApp" ], "platforms": [ "Physical" ] }, "notificationSettings": { "scheduleType": "Days", "scheduleTime": "08:00 AM", "scheduleDay": "Sunday", "to": "administrator@vspc.com", "subject": "VSPC Discovery Results" }, "deploymentSettings": { "isEnabled": true, "backupPolicyUid": "fd305bd2-71fa-4c49-b08a-be79b3d7f477", "setReadOnlyAccess": true } }
Response Code: 200 OK
Response Body: { "data": { "instanceUid": "a79b14f8-85d8-4f7f-9f5d-08bfed366890", "networks": [ { "networkName": "Production", "firstIp": "172.17.53.1", "lastIp": "172.17.53.50" } ] } } |