Get All Backup Sets

This operation returns a list of backup sets for a client.

More Details

Either clientId or clientName is required

Query Parameters

• clientId int32

  The client ID for the client. If the client ID is not known, use the GET Client Id API to retrieve it

• clientName string

  The client name for the client. If the client name is not known, use the GET Client API to retrieve it

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• backupsetProperties object[]

  List of backup sets in the client

  modifiedTime integer

  Last modified time

  indexSettings object

  fsBackupSet object

  preserveFileAccessTimes boolean

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

  useDCserviceForScan boolean

  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.

  planEntity object

  Plan Details

  planId integer

  planName string

  backupSetEntity object

  Backup Set Details

  clientId integer

  Client ID

  clientName string

  Client Name

  instanceName string

  Instance Name of backupset

  appName string

  Application name

  backupsetId integer

  Id et

  _type_ integer

  Internal field

  instanceId integer

  The system-generated ID assigned to the instance.

  backupsetName string

  Backupset name

  applicationId integer

  application ID

{
  "backupsetProperties": [
    {
      "modifiedTime": 0,
      "indexSettings": {},
      "fsBackupSet": {
        "preserveFileAccessTimes": true,
        "useDCserviceForScan": true
      },
      "planEntity": {
        "planId": 0,
        "planName": "string"
      },
      "backupSetEntity": {
        "clientId": 0,
        "clientName": "string",
        "instanceName": "string",
        "appName": "string",
        "backupsetId": 0,
        "_type_": 0,
        "instanceId": 0,
        "backupsetName": "string",
        "applicationId": 0
      }
    }
  ]
}

{
  "backupsetProperties": [
    {
      "modifiedTime": 1487014530,
      "indexSettings": {},
      "fsBackupSet": {
        "preserveFileAccessTimes": false,
        "useDCserviceForScan": true
      },
      "planEntity": {},
      "backupSetEntity": {
        "clientId": 2,
        "clientName": "greenvalley",
        "instanceName": "DefaultInstanceName",
        "appName": "Windows File System",
        "backupsetId": 3,
        "_type_": 6,
        "instanceId": 1,
        "backupsetName": "defaultBackupSet",
        "applicationId": 33
      }
    }
  ]
}

Loading...