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

General

The following properties are present in all resources from the /DiscoveryRules collection:

Property

Type

Description

id

integer

System ID assigned to a discovery rule in Veeam Availability Console RESTful API.

name

string

Name of a discovery rule configured in Veeam Availability Console.

companyId

integer

System ID of a company or department for which discovery rule was configured.

locationId

integer

System ID of a company or department location for which discovery rule was configured.

accountName

string

Account under which Veeam Availability Console connects to discovered computers.

instanceCount

integer

Number of discovered computers.

onlineInstanceCount

integer

Number of discovered computers currently online.

offlineInstanceCount

integer

Number of discovered computers currently offline.

state

string

Current status of a discovery rule.

Possible values:

  • Created
  • Running
  • Success
  • Canceled
  • Failed
  • CancellationRequested
  • CancellationRequestFailed

lastRun

string

Date and time when a discovery was last run.

Date and time string is formatted in accordance with ISO 8601.

type

string

Discovery method used.

Possible values:

  • NetworkBased
  • AD
  • CSVFile

exclusionMask

string

Mask for excluding computers from discovery scope.

Only present if the type property has value NetworkBased or AD.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

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