This is an archive version of the document. To get the most up-to-date information, see the current version.Get Discovery Rule
You can get a resource representation of a discovery 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 a discovery rule, send the GET HTTP request to the URL of the /discovery/rules/{ruleUid} resource.
HTTP Request
GET https://<hostname>:1280/api/v3/discovery/rules/{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 DiscoveryRule schema.
Example 
The following request returns a representation of a discovery rule with UID 18d1b24d-0a32-4072-9ccc-1fab5176fd7a.
Request: GET https://localhost:1280/api/v3/discovery/rules
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": { "instanceUid": "18d1b24d-0a32-4072-9ccc-1fab5176fd7a", "name": "Alpha Discovery Rule", "masterAgentUid": "db978369-1db4-46ce-b99b-f48df9f466ed", "locationUid": "eb0dffac-bb53-488d-a4f2-c58f408b23aa", "companyUid": "6be72c9d-ce04-428a-8618-6354fd03a388", "status": "success", "lastRun": "2020-03-08T04:07:05.5902613+03:00", "filter": { "exclusionMask": null, "ignoreInaccessibleMachine": false, "osTypes": [], "applications": [], "platforms": [] }, "notificationSettings": { "isEnabled": false, "scheduleType": "days", "scheduleTime": "12:00 AM", "scheduleDay": "sunday", "to": null, "subject": null } } } |