Help Center
Choose product document...
Veeam Backup & Replication 9.5
RESTful API Reference

filter

The filter parameter lets you filter the query results to limit a set of displayed items.

By default, the query results are not filtered: Veeam Backup Enterprise Manager displays all items as a list. Using the filter parameter, you can display only those items that match the necessary criteria.

The filter component in the query string has the following format:

&filter=field==value

where the filter criteria are specified as the "field=value" pairs.

For example, using the query below, you can get a backup job with the Exchange Backup name:

Request:

GET http://localhost:9399/api/query?type=job&filter=name=="Exchange Backup"

 

Response:

200 Success

 

Response Body:

<QueryResult xmlns="http://www.veeam.com/ent/v1.0">
 <Refs>
   <Ref Type="JobReference" Href="http://localhost:9399/api/jobs/568c42ce-eb11-4140-92cf-39ab36712bf5" Name="Exchange Backup" UID="urn:veeam:Job:568c42ce-eb11-4140-92cf-39ab36712bf5">
     <Links>
       <Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/21a631e0-af7f-46ba-afbd-273de2e6fd4a" Name="localhost" />
       <Link Rel="Alternate" Type="Job" Href="http://localhost:9399/api/jobs/568c42ce-eb11-4140-92cf-39ab36712bf5?format=Entity" Name="Exchange Backup" />
       <Link Rel="Down" Type="BackupJobSessionReferenceList" Href="http://localhost:9399/api/jobs/568c42ce-eb11-4140-92cf-39ab36712bf5/backupSessions" />
     </Links>
   </Ref>
 </Refs>
 <PagingInfo PagesCount="1" PageSize="100" PageNum="1">
   <Links>
     <Link Rel="First" Href="http://localhost:9399/api/query?type=job&filter=(name%3d%3d%22Exchange+Backup%22)&pageSize=100&page=1" />
     <Link Rel="Last" Href="http://localhost:9399/api/query?type=job&filter=(name%3d%3d%22Exchange+Backup%22)&pageSize=100&page=1" />
   </Links>
 </PagingInfo>
</QueryResult>

 

Related Topics

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation