Help Center
Choose product document...
Veeam Availability Console 2.0 Update 1
RESTful API Reference

Get Discovery Rules

You can get a representation of a collection of discovery rules configured in Veeam Availability Console.


To get a representation of all Veeam Availability Console discovery rules, send the GET HTTPS request to the URL of the /DiscoveryRules collection.

HTTPS Request

GET https://<Availability-Console>:1281/v2/DiscoveryRules

Request Headers

The request header must contain the authorization token for the current logon session.


The server returns the following response to the client.

Response Code

A successfully completed operation returns response code 200 Success.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.




The length of the response body.


The media type and syntax of the request body message: application/json; charset=utf-8

Response Body

In the response body, Veeam Availability Console returns a representation of the /DiscoveryRules collection.

Example Get Discovery Rules

The following request returns all discovery rules configured in Veeam Availability Console.


GET https://localhost:1281/v2/DiscoveryRules


Request Header:

Authorization: Bearer <Access-Token>


Response Code:

200 Success


Response Body:



   "id": 1,

   "name": "NetworkDiscovery",

   "companyId": 3,

   "locationId": 3,

   "accountName": "vac\\administrator",

   "instanceCount": 0,

   "onlineInstanceCount": 0,

   "offlineInstanceCount": 0,

   "state": "Running",

   "lastRun": "2017-08-31T16:38:11Z",

   "type": "NetworkBased",

   "exclusionMask": null,

   "_links": {

     "self": {

       "href": ""


     "tenants": {

       "href": ""





   "id": 7,

   "name": "AD Discovery",

   "companyId": 2,

   "locationId": 2,

   "accountName": "tech\\john.smith",

   "instanceCount": 60,

   "onlineInstanceCount": 27,

   "offlineInstanceCount": 33,

   "state": "Success",

   "lastRun": "2017-10-17T15:50:04.1563829Z",

   "type": "AD",

   "adType": "SearchFromOU",

   "command": null,

   "ignoreOfflineComputers": true,

   "exclusionMask": null,

   "_links": {

     "self": {

       "href": ""


     "tenants": {

       "href": ""





Veeam Large Logo

Deployment Guide

Administrator Guide for Service Providers

User Guide for Service Providers

Quick Start Guide for Service Providers

Administrator Guide for Enterprises

User Guide for Enterprises

Quick Start Guide for Enterprises

RESTful API Reference