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

Logical AND/OR Operators

The query string may contain any number of "field=value" pairs. Multiple "field=value" pairs can be united using the following logical operators:

Logical Operator

Query syntax character

Description

AND

; (Semicolon)

All conditions specified in the filter parameter must be true.

OR

, (Comma)

Any of the conditions specified in the filter parameter must be true

For example, using the query below, the client can get a list of jobs of the Backup type that are created for VMs on the Hyper-V platform:

Request:

GET http://localhost:9399/api/query?type=job&filter=jobtype==backup;platform==hyperv

 

Response:

200 Success

 

Response Body:

<QueryResult xmlns="http://www.veeam.com/ent/v1.0">
 <Refs>
   <Ref Type="JobReference" Href="http://localhost:9399/api/jobs/de14a4c9-3fb9-419b-b622-c6e3ebda28cb" Name="Exchange Backup" UID="urn:veeam:Job:de14a4c9-3fb9-419b-b622-c6e3ebda28cb">
     <Links>
       <Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/15942270-fb56-4dcc-96e9-5f80e4725a15" Name="localhost" />
       <Link Rel="Alternate" Type="Job" Href="http://localhost:9399/api/jobs/de14a4c9-3fb9-419b-b622-c6e3ebda28cb?format=Entity" Name="Exchange Backup" />
       <Link Rel="Down" Type="BackupJobSessionReferenceList" Href="http://localhost:9399/api/jobs/de14a4c9-3fb9-419b-b622-c6e3ebda28cb/backupSessions" />
     </Links>
   </Ref>
   <Ref Type="JobReference" Href="http://localhost:9399/api/jobs/dce85686-59c8-42c4-8766-f1c00a5b8067" Name="SQL" UID="urn:veeam:Job:dce85686-59c8-42c4-8766-f1c00a5b8067">
     <Links>
       <Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/15942270-fb56-4dcc-96e9-5f80e4725a15" Name="localhost" />
       <Link Rel="Alternate" Type="Job" Href="http://localhost:9399/api/jobs/dce85686-59c8-42c4-8766-f1c00a5b8067?format=Entity" Name="SQL" />
       <Link Rel="Down" Type="BackupJobSessionReferenceList" Href="http://localhost:9399/api/jobs/dce85686-59c8-42c4-8766-f1c00a5b8067/backupSessions" />
     </Links>
   </Ref>
 </Refs>
 <PagingInfo PagesCount="1" PageSize="100" PageNum="1">
   <Links>
     <Link Rel="First" Href="http://localhost:9399/api/query?type=job&filter=jobtype%3d%3dbackup%3bplatform%3d%3dhyperv&pageSize=100&page=1" />
     <Link Rel="Last" Href="http://localhost:9399/api/query?type=job&filter=jobtype%3d%3dbackup%3bplatform%3d%3dhyperv&pageSize=100&page=1" />
   </Links>
 </PagingInfo>
</QueryResult>

 

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 Endpoint Backup Documentation

Veeam Management Pack Documentation