GET /query?type=ManagedServer

Returns a resource representation of a collection of servers that are managed by backup servers connected to Veeam Backup Enterprise Manager.

Request

To get a list of managed servers, send the GET HTTP request to the query with the type parameter set to ManagedServer.

HTTP Request

GET https://<Enterprise-Manager>:9398/api/query?type=ManagedServer

Request Headers

The request contains the following headers:

Header	Required	Description
X-RestSvcSessionId	True	The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. For details, see Authentication and Security.
Accept	False	Identifies the format of the response. Possible values: application/xml — the client can send this value in the header to accept response in the XML format. application/json — the client must send this value in the header to accept the request in the JSON format. If the request does not contain the header, the server will return the response in the XML format.

Header

Required

Description

X-RestSvcSessionId

True

The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. For details, see Authentication and Security.

False

Identifies the format of the response. Possible values:

application/xml — the client can send this value in the header to accept response in the XML format.
application/json — the client must send this value in the header to accept the request in the JSON format.

If the request does not contain the header, the server will return the response in the XML format.

Request Body

None.

Optional Parameters

In the query, you can use the following parameters for filtering and sorting.

Parameter	Type	Description
UID	UidType	UID of the server connected to Veeam Backup & Replication, for example: urn:veeam:ManagedServer:15942270-fb56-4dcc-96e9-5f80e4725a15.
Name	String	Full DNS name or IP address of the server connected to Veeam Backup & Replication. for example: 172.16.1.102.
Description	String	Description specified for the server in Veeam Backup & Replication.
ManagedServerType	String	Type of the server connected to Veeam Backup & Replication. Possible values: ESX VC Linux Local Windows ESXi HvServer HvCluster Scvmm BackupServer SanHost SmbServer SmbCluster VcdSystem Cloud AzureWinServer VmSnapshotStorageHost ConfigurationService ExternalInfrastructureProxy NdmpServer ExternalInfrastructureServer

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns response code 200 OK.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header	Description
Content-length	The length of the response body.
Content-type	The media type and syntax of the request body message. Possible values: application/xml application/json

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message. Possible values:

application/xml
application/json

Response Body

In the response body, the REST API returns a representation of the /ManagedServers resource collection.

Example

The example below returns an entity resource representation of a collection of VMware vCenter Servers managed by backup servers that are connected to Enterprise Manager. The results are ordered in the acceding order by the Name parameter.

Request:

GET https://localhost:9398/api/query?type=ManagedServer&format=Entities&sortAsc=name&filter=ManagedServerType==VC

Request Header:

X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

Response:

200 OK

Response Body:

<QueryResult xmlns="http://www.veeam.com/ent/v1.0">
<Entities>
<ManagedServers>
<ManagedServer Type="ManagedServer" Href="https://localhost:9398/api/managedServers/bd8e5927-9406-4019-85a5-ef90d314a8c7?format=Entity" Name="vcenter03.tech.local" UID="urn:veeam:ManagedServer:bd8e5927-9406-4019-85a5-ef90d314a8c7">
<Links>
<Link Rel="Up" Type="BackupServer" Href="https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563?format=Entity" Name="enterprise06.tech.local" />
<Link Rel="Alternate" Type="ManagedServerReference" Href="https://localhost:9398/api/managedServers/bd8e5927-9406-4019-85a5-ef90d314a8c7" Name="vcenter03.tech.local" />
<Link Rel="Related" Type="HierarchyRoot" Href="https://localhost:9398/api/hierarchyRoots/bd8e5927-9406-4019-85a5-ef90d314a8c7?format=Entity" Name="vcenter03.tech.local" />
</Links>
<Description />
<ManagedServerType>VC</ManagedServerType>
</ManagedServer>
<ManagedServer Type="ManagedServer" Href="https://localhost:9398/api/managedServers/095585e0-6a9a-4bb8-8433-a1d815687ce9?format=Entity" Name="vcenter01.tech.local" UID="urn:veeam:ManagedServer:095585e0-6a9a-4bb8-8433-a1d815687ce9">
<Links>
<Link Rel="Up" Type="BackupServer" Href="https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563?format=Entity" Name="enterprise06.tech.local" />
<Link Rel="Alternate" Type="ManagedServerReference" Href="https://localhost:9398/api/managedServers/095585e0-6a9a-4bb8-8433-a1d815687ce9" Name="vcenter01.tech.local" />
<Link Rel="Related" Type="HierarchyRoot" Href="https://localhost:9398/api/hierarchyRoots/095585e0-6a9a-4bb8-8433-a1d815687ce9?format=Entity" Name="vcenter01.tech.local" />
</Links>
<Description>Created by TECH\administrator</Description>
<ManagedServerType>VC</ManagedServerType>
</ManagedServer>
<ManagedServer Type="ManagedServer" Href="https://localhost:9398/api/managedServers/6edb23da-560b-4759-951f-1da6aca08169?format=Entity" Name="vcentercdp-virt.tech.local" UID="urn:veeam:ManagedServer:6edb23da-560b-4759-951f-1da6aca08169">
<Links>
<Link Rel="Up" Type="BackupServer" Href="https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563?format=Entity" Name="enterprise06.tech.local" />
<Link Rel="Alternate" Type="ManagedServerReference" Href="https://localhost:9398/api/managedServers/6edb23da-560b-4759-951f-1da6aca08169" Name="vcentercdp-virt.tech.local" />
<Link Rel="Related" Type="HierarchyRoot" Href="https://localhost:9398/api/hierarchyRoots/6edb23da-560b-4759-951f-1da6aca08169?format=Entity" Name="vcentercdp-virt.tech.local" />
</Links>
<Description>Created by ENTERPRISE06\Administrator</Description>
<ManagedServerType>VC</ManagedServerType>
</ManagedServer>
</ManagedServers>
</Entities>
<PagingInfo PagesCount="1" PageSize="100" PageNum="1">
<Links>
<Link Rel="First" Href="https://localhost:9398/api/query?type=ManagedServer&format=Entities&sortAsc=name&filter=ManagedServerType==VC&UID=="urn:veeam:BackupServer:7445e6ce-86f5-4171-b909-dac209c66563"&pageSize=100&page=1" />
<Link Rel="Last" Href="https://localhost:9398/api/query?type=ManagedServer&format=Entities&sortAsc=name&filter=ManagedServerType==VC&UID=="urn:veeam:BackupServer:7445e6ce-86f5-4171-b909-dac209c66563"&pageSize=100&page=1" />
</Links>
</PagingInfo>
</QueryResult>