This is an archive version of the document. To get the most up-to-date information, see the current version.

/querySvc

In this article

Represents a query service that you can use to paginate results returned by Veeam Backup Enterprise Manager.

In its resource representation, the /querySvc resource provides a set of links, or queries. By following a link from the list, the client executes a query and gets a list of entity resources of a specific type, paginated and sorted in the ascending order. For example, the client can get a list of job entities, 15 per page, displayed in the ascending order. Additionally, the /querySvc resource provides a link to the current logon session.

The queries in the /querySvc resource representation are pre-configured. The client can use the provided queries or construct its own query strings with custom criteria using the query syntax.

Resource URL

http://<Enterprise-Manager>:9399/api/querySvc

Related Resources

None.

Methods

The following methods are supported for the /querySvc resource:

(GET) /querySvc

Resource Representation

The /querySvc resource has a resource representation of the following type:

<QuerySvc xmlns="http://www.veeam.com/ent/v1.0" Type="QueryService" Href="http://localhost:9399/api/querySvc">
<Links>
<Link Rel="Up" Type="LogonSession" Href="http://localhost:9399/api/logonSessions/2af31079-173f-4005-bda8-b07b7b66b157" />
<Link Rel="Down" Type="VmRestorePointList" Href="http://localhost:9399/api/query?type=VmRestorePoint&format=Entities&sortAsc=name&pageSize=15&page=1&filter=" />
<Link Rel="Down" Type="VAppRestorePointList" Href="http://localhost:9399/api/query?type=VAppRestorePoint&format=Entities&sortAsc=name&pageSize=15&page=1&filter=" />
<Link Rel="Down" Type="VmReplicaPointList" Href="http://localhost:9399/api/query?type=VmReplicaPoint&format=Entities&sortAsc=name&pageSize=15&page=1&filter=" />
<Link Rel="Down" Type="TaskList" Href="http://localhost:9399/api/query?type=Task&format=Entities&sortAsc=TaskUid&pageSize=15&page=1&filter=" />
<Link Rel="Down" Type="JobList" Href="http://localhost:9399/api/query?type=Job&format=Entities&sortAsc=name&pageSize=15&page=1&filter=" />
<Link Rel="Down" Type="RestorePointList" Href="http://localhost:9399/api/query?type=RestorePoint&format=Entities&sortAsc=name&pageSize=15&page=1&filter=" />
<Link Rel="Down" Type="BackupTaskSessionList" Href="http://localhost:9399/api/query?type=BackupTaskSession&format=Entities&sortAsc=name&pageSize=15&page=1&filter=" />
<Link Rel="Down" Type="ReplicaTaskSessionList" Href="http://localhost:9399/api/query?type=ReplicaTaskSession&format=Entities&sortAsc=name&pageSize=15&page=1&filter=" />
<Link Rel="Down" Type="RestoreSessionList" Href="http://localhost:9399/api/query?type=RestoreSession&format=Entities&sortAsc=name&pageSize=15&page=1&filter=" />
<Link Rel="Down" Type="RepositoryList" Href="http://localhost:9399/api/query?type=Repository&format=Entities&sortAsc=name&pageSize=15&page=1&filter=" />
<Link Rel="Down" Type="BackupList" Href="http://localhost:9399/api/query?type=Backup&format=Entities&sortAsc=name&pageSize=15&page=1&filter=" />
<Link Rel="Down" Type="ReplicaList" Href="http://localhost:9399/api/query?type=Replica&format=Entities&sortAsc=name&pageSize=15&page=1&filter=" />
<Link Rel="Down" Type="HierarchyRootList" Href="http://localhost:9399/api/query?type=HierarchyRoot&format=Entities&sortAsc=name&pageSize=15&page=1&filter=" />
<Link Rel="Down" Type="BackupJobSessionList" Href="http://localhost:9399/api/query?type=BackupJobSession&format=Entities&sortAsc=name&pageSize=15&page=1&filter=" />
<Link Rel="Down" Type="ReplicaJobSessionList" Href="http://localhost:9399/api/query?type=ReplicaJobSession&format=Entities&sortAsc=name&pageSize=15&page=1&filter=" />
<Link Rel="Down" Type="BackupServerList" Href="http://localhost:9399/api/query?type=BackupServer&format=Entities&sortAsc=name&pageSize=15&page=1&filter=" />
<Link Rel="Down" Type="ManagedServerList" Href="http://localhost:9399/api/query?type=ManagedServer&format=Entities&sortAsc=name&pageSize=15&page=1&filter=" />
<Link Rel="Down" Type="FailoverPlanList" Href="http://localhost:9399/api/query?type=FailoverPlan&format=Entities&sortAsc=name&pageSize=15&page=1&filter=" />
<Link Rel="Down" Type="WanAcceleratorList" Href="http://localhost:9399/api/query?type=WanAccelerator&format=Entities&sortAsc=name&pageSize=15&page=1&filter=" />
<Link Rel="Down" Type="CloudGatewayList" Href="http://localhost:9399/api/query?type=CloudGateway&format=Entities&sortAsc=name&pageSize=15&page=1&filter=" />
<Link Rel="Down" Type="CloudTenantList" Href="http://localhost:9399/api/query?type=CloudTenant&format=Entities&sortAsc=name&pageSize=15&page=1&filter=" />
<Link Rel="Down" Type="PasswordKeyList" Href="http://localhost:9399/api/query?type=Passwords&format=Entities&sortAsc=BackupServerUid&pageSize=15&page=1&filter=" />
<Link Rel="Down" Type="CredentialsList" Href="http://localhost:9399/api/query?type=Credentials&format=Entities&sortAsc=BackupServerUid&pageSize=15&page=1&filter=" />
</Links>
</QuerySvc>