/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 query links. 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 preconfigured. You can use the provided queries or construct your own query requests with custom criteria. For details, see Query Syntax.

    Resource URL

    https://<Enterprise-Manager>:9398/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="https://localhost:9398/api/querySvc">
     <Links>
       <Link Rel="Up" Type="LogonSession" Href="https://localhost:9398/api/logonSessions/ff9abda1-d795-437a-9f0a-6a343e1dc768" />
       <Link Rel="Down" Type="VmRestorePointList" Href="https://localhost:9398/api/query?type=VmRestorePoint&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="VAppRestorePointList" Href="https://localhost:9398/api/query?type=VAppRestorePoint&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="VmReplicaPointList" Href="https://localhost:9398/api/query?type=VmReplicaPoint&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="TaskList" Href="https://localhost:9398/api/query?type=Task&format=Entities&sortAsc=TaskUid&pageSize=15&page=1" />
       <Link Rel="Down" Type="JobList" Href="https://localhost:9398/api/query?type=Job&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="RestorePointList" Href="https://localhost:9398/api/query?type=RestorePoint&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="BackupTaskSessionList" Href="https://localhost:9398/api/query?type=BackupTaskSession&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="ReplicaTaskSessionList" Href="https://localhost:9398/api/query?type=ReplicaTaskSession&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="RestoreSessionList" Href="https://localhost:9398/api/query?type=RestoreSession&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="RepositoryList" Href="https://localhost:9398/api/query?type=Repository&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="BackupList" Href="https://localhost:9398/api/query?type=Backup&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="ReplicaList" Href="https://localhost:9398/api/query?type=Replica&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="HierarchyRootList" Href="https://localhost:9398/api/query?type=HierarchyRoot&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="BackupJobSessionList" Href="https://localhost:9398/api/query?type=BackupJobSession&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="ReplicaJobSessionList" Href="https://localhost:9398/api/query?type=ReplicaJobSession&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="BackupServerList" Href="https://localhost:9398/api/query?type=BackupServer&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="ManagedServerList" Href="https://localhost:9398/api/query?type=ManagedServer&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="FailoverPlanList" Href="https://localhost:9398/api/query?type=FailoverPlan&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="WanAcceleratorList" Href="https://localhost:9398/api/query?type=WanAccelerator&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="CloudGatewayList" Href="https://localhost:9398/api/query?type=CloudGateway&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="CloudTenantList" Href="https://localhost:9398/api/query?type=CloudTenant&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="PasswordKeyList" Href="https://localhost:9398/api/query?type=Passwords&format=Entities&sortAsc=BackupServerUid&pageSize=15&page=1" />
       <Link Rel="Down" Type="CredentialsList" Href="https://localhost:9398/api/query?type=Credentials&format=Entities&sortAsc=BackupServerUid&pageSize=15&page=1" />
       <Link Rel="Down" Type="CloudReplicaList" Href="https://localhost:9398/api/query?type=CloudReplica&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="BackupFileList" Href="https://localhost:9398/api/query?type=BackupFile&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="VCloudOrganizationConfigList" Href="https://localhost:9398/api/query?type=VCloudOrganizationConfig&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="CloudSubtenantList" Href="https://localhost:9398/api/query?type=CloudSubtenant&format=Entities&sortAsc=Name&pageSize=15&page=1" />
       <Link Rel="Down" Type="CloudHardwarePlanList" Href="https://localhost:9398/api/query?type=CloudHardwarePlan&format=Entities&sortAsc=Name&pageSize=15&page=1" />
       <Link Rel="Down" Type="CloudPublicIpAddressList" Href="https://localhost:9398/api/query?type=CloudPublicIpAddress&format=Entities&sortAsc=Name&pageSize=15&page=1" />
       <Link Rel="Down" Type="AgentBackupJobList" Href="https://localhost:9398/api/query?type=AgentBackupJob&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="AgentRestorePointList" Href="https://localhost:9398/api/query?type=AgentRestorePoint&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="AgentProtectionGroupList" Href="https://localhost:9398/api/query?type=AgentProtectionGroup&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="DiscoveredComputerList" Href="https://localhost:9398/api/query?type=DiscoveredComputer&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="CloudFailoverPlanList" Href="https://localhost:9398/api/query?type=CloudFailoverPlan&format=Entities&sortAsc=Name&pageSize=15&page=1" />
       <Link Rel="Down" Type="CloudGatewayPoolList" Href="https://localhost:9398/api/query?type=CloudGatewayPool&format=Entities&sortAsc=Name&pageSize=15&page=1" />
       <Link Rel="Down" Type="VSphereSelfServiceConfigList" Href="https://localhost:9398/api/query?type=VSphereSelfServiceConfig&format=Entities&sortAsc=Name&pageSize=15&page=1" />
       <Link Rel="Down" Type="ExternalRepositoryList" Href="https://localhost:9398/api/query?type=ExternalRepository&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="NasJobList" Href="https://localhost:9398/api/query?type=NasJob&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="FileServerList" Href="https://localhost:9398/api/query?type=FileServer&format=Entities&sortAsc=name&pageSize=15&page=1" />
       <Link Rel="Down" Type="VAppReplicaPointList" Href="https://localhost:9398/api/query?type=VAppReplicaPoint&format=Entities&sortAsc=name&pageSize=15&page=1" />
     </Links>
    </QuerySvc>