Get Discovery Rules

In this article

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


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

    HTTPS Request

    GET https://<hostname>:1281/v2/discoveryRules

    Request Headers

    The request header must contain the authorization token.


    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.




    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 Service Provider Console returns a representation of the /discoveryRules collection.

    Example Get Discovery Rules

    The following request returns all discovery rules configured in Veeam Service Provider 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",

       "ignoreOfflineComputers": true,

       "exclusionMask": null,

       "adType": "SearchFromOU",

       "command": null,

       "_links": {

         "self": {

           "href": ""


         "tenants": {

           "href": ""