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

(GET) /backupServers/{ID}

Returns a resource representation of the Veeam backup server having the specified ID.

Request

To get a resource representation of the Veeam backup server, you need to send the GET HTTP request to the URL of the /backupServers/{ID} resource:

HTTP Request

GET http://<Enterprise-Manager>:9399/api/backupservers/{ID}

or

GET http://<Enterprise-Manager>:9399/api/backupServers/{ID}?format=Entity

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

The following parameters can be used in queries:

Parameter

Type

Description

Can Be Used for Filtering

Can Be Used for Sorting

UID

URN

ID of the Veeam backup server connected to Veeam Backup Enterprise Manager, for example: urn:veeam:BackupServer:15942270-fb56-4dcc-96e9-5f80e4725a15.

True

True

Name

String

Name of the Veeam backup server connected to Veeam Backup Enterprise Manager. for example: BACKUPSERVER.

True

True

Description

String

Description specified for the Veeam backup server in Veeam Backup Enterprise Manager.

True

True

IpOrDnsName

IP address or String

IP or DNS name that has been used for adding the Veeam backup server to Veeam Backup Enterprise Manager. for example, 172.16.11.22.

True

True

Port

Int64

Port used by Veeam Backup Enterprise Manager for collecting data from Veeam backup servers. By default, port 9392 is used.

True

True

Version

String

Version of Veeam Backup & Replication installed on the Veeam backup server, for example: 9.5.

True

True

Response

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/{ID} resource.

Example

The example below returns an entity representation of the Veeam backup server having ID f62624c1-8462-4747-8bd4-d686f99b0540.

Request:

GET http://localhost:9399/api/backupServers/f62624c1-8462-4747-8bd4-d686f99b0540?format=Entity

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<BackupServer xmlns="http://www.veeam.com/ent/v1.0" Type="BackupServer" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018?format=Entity" Name="srv02.veeam.local" UID="urn:veeam:BackupServer:ce15a8c7-aa49-495e-b05b-ee3398c91018">
 <Links>
   <Link Rel="Alternate" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.veeam.local" />
   <Link Rel="Edit" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" />
   <Link Rel="Delete" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" />
   <Link Rel="Down" Type="JobReferenceList" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018/jobs" />
   <Link Rel="Down" Type="ManagedServerReferenceList" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018/managedServers" />
   <Link Rel="Down" Type="RepositoryReferenceList" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018/repositories" />
   <Link Rel="Down" Type="CredentialsList" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018/credentials" />
   <Link Rel="Create" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018/credentials?action=create" />
   <Link Rel="Down" Type="PasswordKeyList" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018/passwords" />
   <Link Rel="Create" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018/passwords?action=create" />
   <Link Rel="VeeamZip" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018?action=veeamzip" />
   <Link Rel="QuickBackup" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018?action=quickbackup" />
   <Link Rel="Start" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018?action=collect" />
 </Links>
 <Description />
 <Port>9392</Port>
 <Version>8.0</Version>
</BackupServer>

 

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 Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation