Veeam Backup & Replication 10
Veeam RESTful API Reference
Related documents

(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 https://<Enterprise-Manager>:9398/api/backupservers/{ID}

or

GET https://<Enterprise-Manager>:9398/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.

Accept

False

Identifies the format of the response. Possible values:

  • application/xml — the client can sent 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.

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. Possible values:

  • application/xml
  • application/json

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 https://localhost:9398/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="https://localhost:9398/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018?format=Entity" Name="srv02.tech.local" UID="urn:veeam:BackupServer:ce15a8c7-aa49-495e-b05b-ee3398c91018">
 <Links>
   <Link Rel="Alternate" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.tech.local" />
   <Link Rel="Edit" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" />
   <Link Rel="Delete" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" />
   <Link Rel="Down" Type="JobReferenceList" Href="https://localhost:9398/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018/jobs" />
   <Link Rel="Down" Type="ManagedServerReferenceList" Href="https://localhost:9398/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018/managedServers" />
   <Link Rel="Down" Type="RepositoryReferenceList" Href="https://localhost:9398/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018/repositories" />
   <Link Rel="Down" Type="CredentialsList" Href="https://localhost:9398/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018/credentials" />
   <Link Rel="Create" Href="https://localhost:9398/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018/credentials?action=create" />
   <Link Rel="Down" Type="PasswordKeyList" Href="https://localhost:9398/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018/passwords" />
   <Link Rel="Create" Href="https://localhost:9398/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018/passwords?action=create" />
   <Link Rel="VeeamZip" Href="https://localhost:9398/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018?action=veeamzip" />
   <Link Rel="QuickBackup" Href="https://localhost:9398/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018?action=quickbackup" />
   <Link Rel="Start" Href="https://localhost:9398/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018?action=collect" />
 </Links>
 <Description />
 <Port>9392</Port>
 <Version>8.0</Version>
</BackupServer>

 

This Document Help Center
User Guide for VMware vSphereUser Guide for Microsoft Hyper-VVeeam Backup Enterprise Manager GuideVeeam Agent Management GuideVeeam Cloud Connect GuideVeeam Explorers User GuideVeeam Plug-ins for Enterprise Applications GuideVeeam PowerShell ReferenceVeeam Explorers PowerShell ReferenceVeeam RESTful API ReferenceRequired Permissions for VMware vSphereQuick Start Guide for VMware vSphereQuick Start Guide for Microsoft Hyper-VVeeam Backup for AWS DocumentationVeeam Availability for Nutanix AHV DocumentationVeeam Backup for Microsoft Office 365 DocumentationVeeam ONE DocumentationVeeam Agent for Windows DocumentationVeeam Agent for Linux DocumentationVeeam Management Pack Documentation
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.