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

Filter System Query Option ($filter)

The $filter System Query Option is used to filter resource collections to return a subset of resources in a response. The subset includes only those resources that satisfy conditions specified in the query.

For example, to return all users with the Company Administrator role, send the following request:

GET https://<Availability-Console>:1281/v2/users?$filter=role%20eq%20'Company%20Administrator'

The $filter system query option supports a set of built-in filter operations and built-in functions that can be used within these operations. For a full description of the syntax used for building requests, see the [OData‑URL] syntax rule.

Veeam Large Logo

Deployment Guide

Migration Guide

Administrator Guide for Service Providers

User Guide for Service Providers

Evaluator's Guide for Service Providers

Administrator Guide for Enterprises

User Guide for Enterprises

Evaluator's Guide for Enterprises

RESTful API Reference