Create Active Directory Discovery Rule for Windows
You can create an Active Directory 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 an Active Directory discovery rule for Microsoft Windows computers, send the POST HTTP request to the URL of the /discovery/windows/rules/adBased resource.
HTTP Request
POST https://<hostname>:1280/api/v3/discovery/windows/rules/adBased |
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 WindowsActiveDirectoryBasedDiscoveryRule schema.
Example 
The following request creates a new Active Directory discovery rule for Microsoft Windows computers.
Request: POST https://localhost:1280/api/v3/discovery/windows/rules/adBased
Request Header: Content-type: application/json Authorization: Bearer <Access-Token>
Request Body: { "name": "AD Rule", "masterAgentUid": "96419aa1-0961-4612-b5f4-a9cbad196f7e", "customQuery": "string", "adMethod": "search", "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": "3dcdcaa2-b4b5-4722-8a85-bec9868cae4e", "setReadOnlyAccess": true } }
Response Code: 200 OK
Response Body: { "data": { "instanceUid": "a00039c1-ce43-4b7d-9189-84523f77f9fb", "customQuery": "string", "adMethod": "search" } } |
