This is an archive version of the document. To get the most up-to-date information, see the
current version.
(GET) /backupServers
Returns a resource representation of a collection of all Veeam Backup Servers connected to Veeam Backup Enterprise Manager.
To get a list of Veeam backup servers connected to the Veeam Backup Enterprise Manager, you need to send the GET HTTP request to the URL of the /backupServers resource.
HTTP Request
GET http://<Enterprise-Manager>:9399/api/backupServers |
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. To learn more, see Authentication and Security. |
Request Body
None.
Query Parameters
None.
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 200 Success.
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: application/xml. |
Response Body
In the response body, Veeam Backup Enterprise Manager returns a representation of the /backupServers resource collection.
The example below returns a list of all Veeam backup servers that are currently connected to Veeam Backup Enterprise Manager.
Request: GET http://localhost:9399/api/backupServers Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj Response: 200 Success Response Body: <EntityReferences xmlns="http://www.veeam.com/ent/v1.0">
<Ref Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/1eb5b858-e557-43b3-8e79-386161b7ea44" Name="srv03.veeam.local" UID="urn:veeam:BackupServer:1eb5b858-e557-43b3-8e79-386161b7ea44">
<Links>
<Link Rel="Down" Type="JobReferenceList" Href="http://localhost:9399/api/backupServers/1eb5b858-e557-43b3-8e79-386161b7ea44/jobs" />
<Link Rel="Down" Type="RepositoryReferenceList" Href="http://localhost:9399/api/backupServers/1eb5b858-e557-43b3-8e79-386161b7ea44/repositories" />
<Link Rel="Down" Type="CredentialsList" Href="http://localhost:9399/api/backupServers/1eb5b858-e557-43b3-8e79-386161b7ea44/credentials" />
<Link Rel="Down" Type="PasswordKeyList" Href="http://localhost:9399/api/backupServers/1eb5b858-e557-43b3-8e79-386161b7ea44/passwords" />
<Link Rel="Alternate" Type="BackupServer" Href="http://localhost:9399/api/backupServers/1eb5b858-e557-43b3-8e79-386161b7ea44?format=Entity" Name="srv03.veeam.local" />
<Link Rel="Down" Type="ManagedServerReferenceList" Href="http://localhost:9399/api/backupServers/1eb5b858-e557-43b3-8e79-386161b7ea44/managedServers" />
</Links>
</Ref>
<Ref Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/6f17f70a-a61c-4ef0-ac7f-426a6ae1ec8b" Name="srv02.veeam.local" UID="urn:veeam:BackupServer:6f17f70a-a61c-4ef0-ac7f-426a6ae1ec8b">
<Links>
<Link Rel="Down" Type="JobReferenceList" Href="http://localhost:9399/api/backupServers/6f17f70a-a61c-4ef0-ac7f-426a6ae1ec8b/jobs" />
<Link Rel="Down" Type="RepositoryReferenceList" Href="http://localhost:9399/api/backupServers/6f17f70a-a61c-4ef0-ac7f-426a6ae1ec8b/repositories" />
<Link Rel="Down" Type="CredentialsList" Href="http://localhost:9399/api/backupServers/6f17f70a-a61c-4ef0-ac7f-426a6ae1ec8b/credentials" />
<Link Rel="Down" Type="PasswordKeyList" Href="http://localhost:9399/api/backupServers/6f17f70a-a61c-4ef0-ac7f-426a6ae1ec8b/passwords" />
<Link Rel="Alternate" Type="BackupServer" Href="http://localhost:9399/api/backupServers/6f17f70a-a61c-4ef0-ac7f-426a6ae1ec8b?format=Entity" Name="srv02.veeam.local" />
<Link Rel="Down" Type="ManagedServerReferenceList" Href="http://localhost:9399/api/backupServers/6f17f70a-a61c-4ef0-ac7f-426a6ae1ec8b/managedServers" />
</Links>
</Ref>
</EntityReferences> |
