/backupServers/{ID}

Represents a backup server having the specified ID.

Resource URL

The URL of the reference resource representation:

https://<Enterprise-Manager>:9398/api/backupServers/{ID}

The URL of the entity resource representation:

https://<Enterprise-Manager>:9398/api/backupServers/{ID}?format=Entity

Related Resources

Methods

The following methods are supported for the /backupServers/{ID} resource:

Resource Representation

The /backupServers/{ID} resource has a resource representation of the following types.

Entity reference resource representation:

<EntityRef xmlns="http://www.veeam.com/ent/v1.0" Type="BackupServerReference" Href="https://localhost:9398/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.tech.local" UID="urn:veeam:BackupServer:ce15a8c7-aa49-495e-b05b-ee3398c91018">
 <Links>
   <Link Rel="Alternate" Type="BackupServer" Href="https://localhost:9398/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018?format=Entity" Name="srv02.tech.local" />
   <Link Rel="Down" Type="JobReferenceList" Href="https://localhost:9398/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018/jobs" />
   <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="Down" Type="PasswordKeyList" Href="https://localhost:9398/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018/passwords" />
 </Links>
</EntityRef>

Entity resource representation:

<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>

 

Page updated 1/25/2024

Page content applies to build 12.3.0.310