> Expert > Tools & Utilities > Developer Tools > REST API > REST API Reference > Backup Set Operations

REST API - GET Backup Set Properties

Updated

This operation returns the properties associated with a backup set.

Request

Syntax

GET <webservice>/Backupset/{backupsetId} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name

Description

Required

backupsetId

The backup set ID for the backup set. If the backup set ID is not known, use the GET Backup Set API to retrieve it.

Yes

Request Headers

Name

Description

Host

The host name of the Web Server or Web Console used in the API request.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter

Description

Element

_type_

The CommCell objects associated with the backup set.

Valid value is BACKUPSET_ENTITY.

backupSetEntity

appName

The name of the application.

Valid values for the applicationId and appName parameters:

  • 41, Active Directory

  • 21, AIX File System

  • 64, Big Data Apps

  • 134, Cloud Apps

  • 37, DB2

  • 103, DB2 MultiNode

  • 62, DB2 on Unix

  • 128, Documentum

  • 90, Domino Mailbox Archiver

  • 91, DPM

  • 67, Exchange Compliance Archiver

  • 53, Exchange Database

  • 45, Exchange Mailbox

  • 54, Exchange Mailbox (Classic)

  • 56, Exchange Mailbox Archiver

  • 82, Exchange PF Archiver

  • 35, Exchange Public Folder

  • 73, File Share Archiver

  • 33, File System

  • 74, FreeBSD

  • 71, GroupWise DB

  • 17, HP-UX Files System

  • 65, Image Level

  • 75, Image Level On Unix

  • 76, Image Level ProxyHost

  • 87, Image Level ProxyHost on Unix

  • 3, Informix Database

  • 29, Linux File System

  • 89, MS SharePoint Archiver

  • 104, MySQL

  • 13, NAS

  • 83, Netware File Archiver

  • 12, Netware File System

  • 10, Novell Directory Services

  • 124, Object Link

  • 131, Object Store

  • 86, OES File System on Linux

  • 22, Oracle

  • 80, Oracle RAC

  • 130, Other External Agent

  • 125, PostgreSQL

  • 38, Proxy Client File System

  • 87, ProxyHost on Unix

  • 61, SAP for Oracle

  • 135, SAP HANA

  • 78, SharePoint Server

  • 20, Solaris 64bit File System

  • 19, Solaris File System

  • 81, SQL Server

  • 5, Sybase Database

  • 66, Unix File Archiver

  • 36, Unix Tru64 64-bit File System

  • 106, Virtual Server

  • 58, Windows File Archiver

backupSetEntity

applicationId

The ID of the application. For a list of application IDs, see the valid values for the appName parameter.

backupSetEntity

backupsetId

The system-generated ID assigned to the backup set.

backupSetEntity

backupsetName

The name of the backup set.

backupSetEntity

clientId

The system-generated ID assigned to the client.

backupSetEntity

clientName

The name of the client.

backupSetEntity

instanceId

The system-generated ID assigned to the instance.

backupSetEntity

instanceName

The name of the instance, for example: DefaultInstanceName.

backupSetEntity

_type_

The CommCell objects associated with the backup set security.

Valid value is USERGROUP_ENTITY.

associatedUserGroups

userGroupId

The system-generated ID assigned to the user group associated with the backup set.

associatedUserGroups

userGroupName

The name of the user group associated with the backup set.

associatedUserGroups

ownerCapabilities

The capabilities of the client computer owners associated with the backup set.

backupsetSecurity

associatedsubclientPolicy

The system-generated subclient policy ID.

commonBackupSet

cDRFSDMBackupset

Valid values are True/False.

commonBackupSet

dataMigratorILMCLASS

Valid values are True/False.

commonBackupSet

decompressData

The option to decompress data that is in a compressed format on the backup media.

Valid values are True/False.

commonBackupSet

isDedupBackupset

The option to set the backup set as the deduplication backup set.

Valid values are True/False.

commonBackupSet

isDefaultBackupSet

The option to set the backup set as the default backup set.

Valid values are True/False.

commonBackupSet

isDeleted

The option to delete the backup set.

Valid values are True/False.

commonBackupSet

isFanInBackupSet

The option to support fan-in.

Valid values are True/False.

commonBackupSet

isHidden

The option to set the backup set storage policy as hidden.

Valid values are True/False.

commonBackupSet

isMining

The option to use the backup set for IntelliSnap mining.

Valid values are True/False.

commonBackupSet

isMyBackupSet

The option to use the backup set for my backup set.

Valid values are True/False.

commonBackupSet

isNasTurboBackupSet

The option to use the backup set for a NAS turbo restore.

Valid values are True/False.

commonBackupSet

isUSeDCForBackup

The option to use data classification for file system backups.

Valid values are True/False.

commonBackupSet

isWildCardContentBackupSet

The option for the backup set to support wildcards.

Valid values are True/False.

commonBackupSet

newBackupSetName

The new name of the backup set if the name should be updated.

commonBackupSet

onDemandBackupset

The option to set the backup set as an on demand backup set.

Valid values are True/False.

commonBackupSet

siloCopyId

The system-generated ID assigned to the silo copy.

commonBackupSet

fLRrepSetId

fsBackupSet

netAppImageBackup

Valid values are True/False.

fsBackupSet

pre70SystemStateArchiveFilesExist

Valid values are True/False.

fsBackupSet

preserveFileAccessTimes

The option to prevent the file access time from being changed as a result of running data protection operations.

Valid values are True/False.

fsBackupSet

useArchiveBit

The option to check whether files are considered modified and therefore backed up based on either the state of the archive bit or the file modification time.

Valid values are True/False.

fsBackupSet

useChangeJournal

The option to backup all of the new or changed data since the last incremental or full backup, ignoring any differential backups performed prior to the current backup.

Valid values are True/False.

fsBackupSet

useDCserviceForScan

The option to maintain a separate database to track changes in the files. Use this option when scanning a large number of files and folders for the backup.

Valid values are True/False.

fsBackupSet

Examples

Sample Request

GET <webservice>/Backupset/7 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
 <App_GetBackupsetPropertiesResponse>
   <backupsetProperties>
     <backupSetEntity _type_="BACKUPSET_ENTITY" appName="Windows File System" applicationId="33" backupsetId="7" backupsetName="On Demand" clientId="2" clientName="client001" instanceId="1" instanceName="DefaultInstanceName"/>
     <backupsetSecurity>
       <associatedUserGroups _type_="USERGROUP_ENTITY" userGroupId="1" userGroupName="master"/>
       <associatedUserGroups _type_="USERGROUP_ENTITY" userGroupId="3" userGroupName="View All"/>
       <ownerCapabilities/>
     </backupsetSecurity>
     <commonBackupSet associatedsubclientPolicy="0" cDRFSDMBackupset="false" dataMigratorILMCLASS="false" decompressData="false" isDedupBackupset="false" isDefaultBackupSet="false" isDeleted="false" isFanInBackupSet="false" isHidden="false" isMining="false" isMyBackupSet="false" isNasTurboBackupSet="false" isUSeDCForBackup="false" isWildCardContentBackupSet="false" newBackupSetName="On Demand" onDemandBackupset="true" siloCopyId="0"/>
     <fsBackupSet fLRrepSetId="0" netAppImageBackup="false" pre70SystemStateArchiveFilesExist="false" preserveFileAccessTimes="false" useArchiveBit="false" useChangeJournal="true" useDCserviceForScan="false"/>
   </backupsetProperties>
 </App_GetBackupsetPropertiesResponse>