Backup Files Controller Resource

The API allows you to view backup locations.

GET /backup-locations

Returns list of backup locations filtered by specified query parameters.

Request Parameters
name type description constraints
backup-rule query  
location-status query "FAILED" or "IN_PROGRESS" or "PRESENT" or "REMOVED"
protected-entity query  
Response Body
media type data type description
application/json array of BackupLocationListRecord (JSON) list of backup locations filtered by specified query parameters

Example

Request
GET /backup-locations
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "guid" : "...",
  "backup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "snapshotTime" : 12345,
  "backupDestination" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "roleType" : "PRIMARY",
  "backupDestinationType" : "DATAPROTECTOR",
  "status" : "IN_PROGRESS",
  "type" : "SYNCHRONIZATION",
  "statusInfo" : "...",
  "retentionHint" : "STANDARD_RETENTION"
} ]
                
              

GET /backup-locations/for-restore

Returns list of backup locations for restore filtered by specified query parameters.

Request Parameters
name type description constraints
backup-rule query  
location-status query "FAILED" or "IN_PROGRESS" or "PRESENT" or "REMOVED"
protected-entity query  
Response Body
media type data type description
application/json array of BackupLocationForRestoreListRecord (JSON) list of backup locations filtered by specified query parameters

Example

Request
GET /backup-locations/for-restore
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "guid" : "...",
  "backup" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "snapshotTime" : 12345,
  "backupDestination" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "roleType" : "PRIMARY",
  "status" : "IN_PROGRESS",
  "type" : "SYNTHETIC",
  "statusInfo" : "...",
  "retentionHint" : "ARCHIVE"
} ]
                
              

GET /backup-locations/{guid}

Return backup location with specified GUID

Request Parameters
name type description
guid path Guid of backup location
Response Body
media type data type description
application/json BackupLocationDetails (JSON) backup location details

Example

Request
GET /backup-locations/{guid}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "...",
  "backup" : {
    "backupTime" : 12345,
    "taskTimeStats" : {
      "queuedExportTime" : 12345,
      "exportTime" : 12345,
      "queuedStoreTime" : 12345,
      "storeTime" : 12345
    },
    "archiveExpire" : 12345,
    "statusInfo" : "...",
    "protectedEntity" : {
      "type" : { },
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "parentBackup" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "backupDestination" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "backupLocations" : [ {
      "guid" : "...",
      "backup" : { },
      "snapshotTime" : 12345,
      "backupDestination" : { },
      "roleType" : "PRIMARY",
      "backupDestinationType" : "S3",
      "status" : "IN_PROGRESS",
      "type" : "SYNCHRONIZATION",
      "statusInfo" : "...",
      "retentionHint" : "RECREATE"
    }, {
      "guid" : "...",
      "backup" : { },
      "snapshotTime" : 12345,
      "backupDestination" : { },
      "roleType" : "ARCHIVE",
      "backupDestinationType" : "S3",
      "status" : "FAILED",
      "type" : "FULL",
      "statusInfo" : "...",
      "retentionHint" : "DONT_TOUCH"
    } ],
    "networkInterfaceCards" : [ {
      "guid" : "...",
      "uuid" : "...",
      "name" : "...",
      "network" : { },
      "virtualMachine" : { },
      "backups" : [ { }, { } ]
    }, {
      "guid" : "...",
      "uuid" : "...",
      "name" : "...",
      "network" : { },
      "virtualMachine" : { },
      "backups" : [ { }, { } ]
    } ],
    "size" : 12345,
    "fileCount" : 12345,
    "effectiveBackupObjectsCount" : 12345,
    "effectiveBackupSize" : 12345,
    "vmExportImportMode" : "CHANGED_BLOCK_TRACKING",
    "warningsPresent" : true,
    "warnings" : [ "...", "..." ],
    "baseImage" : {
      "uuid" : "..."
    },
    "sourceProject" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "node" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "backupRule" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "hidden" : true,
    "retentionHint" : "RECREATE",
    "originEntity" : {
      "type" : { },
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "snapshotTime" : 1451649601000,
    "status" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    },
    "type" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    }
  },
  "backupDestination" : {
    "name" : "...",
    "nodeConfigs" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "projects" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "totalAvailableSpace" : 12345,
    "totalUsedSpace" : 12345,
    "totalDedupUsedSpace" : 12345,
    "totalDedupAvailableSpace" : 12345,
    "preAccessCmdArgs" : [ "...", "..." ],
    "postAccessCmdArgs" : [ "...", "..." ],
    "preAccessCmdExecEnabled" : true,
    "postAccessCmdExecEnabled" : true,
    "preAccessCmdExecTimeout" : 12345,
    "postAccessCmdExecTimeout" : 12345,
    "backupDestinationInitInfos" : [ {
      "node" : { },
      "backupDestination" : { },
      "initSuccessful" : true,
      "initError" : "...",
      "modificationTime" : 12345
    }, {
      "node" : { },
      "backupDestination" : { },
      "initSuccessful" : true,
      "initError" : "...",
      "modificationTime" : 12345
    } ],
    "initRequired" : true,
    "dedupEnabled" : true,
    "encryptionEnabled" : true,
    "defaultBackupDestination" : true,
    "description" : "...",
    "daysToKeepRetentionLock" : 12345,
    "visibleForAllVms" : true,
    "backupDestinationForCloud" : true,
    "objectTaggingEnabled" : true,
    "trustAllCerts" : true,
    "backupDestinationState" : "INITIALIZATION_FAILED",
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "type" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    },
    "modificationTime" : 1451649601000
  },
  "roleType" : "ARCHIVE",
  "status" : "PRESENT",
  "statusInfo" : "...",
  "retentionHint" : "ARCHIVE"
}
                
              

PUT /backup-locations/{guid}

Returns updated backuplocation.

Request Parameters
name type description
guid path
Request Body
media type data type description
application/json BackupLocationRequest (JSON) guid and new status for backuplocation
Response Body
media type data type description
application/json BackupLocationDetails (JSON) updated backup location details

Example

Request
PUT /backup-locations/{guid}
Content-Type: application/json
Accept: application/json

                
{
  "backupLocationStatus" : "FAILED",
  "statusInfo" : "...",
  "type" : "SYNCHRONIZATION"
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "...",
  "backup" : {
    "backupTime" : 12345,
    "taskTimeStats" : {
      "queuedExportTime" : 12345,
      "exportTime" : 12345,
      "queuedStoreTime" : 12345,
      "storeTime" : 12345
    },
    "archiveExpire" : 12345,
    "statusInfo" : "...",
    "protectedEntity" : {
      "type" : { },
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "parentBackup" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "backupDestination" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "backupLocations" : [ {
      "guid" : "...",
      "backup" : { },
      "snapshotTime" : 12345,
      "backupDestination" : { },
      "roleType" : "PRIMARY",
      "backupDestinationType" : "GCS",
      "status" : "FAILED",
      "type" : "SYNCHRONIZATION",
      "statusInfo" : "...",
      "retentionHint" : "ARCHIVE"
    }, {
      "guid" : "...",
      "backup" : { },
      "snapshotTime" : 12345,
      "backupDestination" : { },
      "roleType" : "ARCHIVE",
      "backupDestinationType" : "AZURE",
      "status" : "IN_PROGRESS",
      "type" : "SYNCHRONIZATION",
      "statusInfo" : "...",
      "retentionHint" : "DONT_TOUCH"
    } ],
    "networkInterfaceCards" : [ {
      "guid" : "...",
      "uuid" : "...",
      "name" : "...",
      "network" : { },
      "virtualMachine" : { },
      "backups" : [ { }, { } ]
    }, {
      "guid" : "...",
      "uuid" : "...",
      "name" : "...",
      "network" : { },
      "virtualMachine" : { },
      "backups" : [ { }, { } ]
    } ],
    "size" : 12345,
    "fileCount" : 12345,
    "effectiveBackupObjectsCount" : 12345,
    "effectiveBackupSize" : 12345,
    "vmExportImportMode" : "VM_IMAGE_PLUS_INCREMENTAL_DISKS",
    "warningsPresent" : true,
    "warnings" : [ "...", "..." ],
    "baseImage" : {
      "uuid" : "..."
    },
    "sourceProject" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "node" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "backupRule" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "hidden" : true,
    "retentionHint" : "ARCHIVE",
    "originEntity" : {
      "type" : { },
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "snapshotTime" : 1451649601000,
    "status" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    },
    "type" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    }
  },
  "backupDestination" : {
    "name" : "...",
    "nodeConfigs" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "projects" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "totalAvailableSpace" : 12345,
    "totalUsedSpace" : 12345,
    "totalDedupUsedSpace" : 12345,
    "totalDedupAvailableSpace" : 12345,
    "preAccessCmdArgs" : [ "...", "..." ],
    "postAccessCmdArgs" : [ "...", "..." ],
    "preAccessCmdExecEnabled" : true,
    "postAccessCmdExecEnabled" : true,
    "preAccessCmdExecTimeout" : 12345,
    "postAccessCmdExecTimeout" : 12345,
    "backupDestinationInitInfos" : [ {
      "node" : { },
      "backupDestination" : { },
      "initSuccessful" : true,
      "initError" : "...",
      "modificationTime" : 12345
    }, {
      "node" : { },
      "backupDestination" : { },
      "initSuccessful" : true,
      "initError" : "...",
      "modificationTime" : 12345
    } ],
    "initRequired" : true,
    "dedupEnabled" : true,
    "encryptionEnabled" : true,
    "defaultBackupDestination" : true,
    "description" : "...",
    "daysToKeepRetentionLock" : 12345,
    "visibleForAllVms" : true,
    "backupDestinationForCloud" : true,
    "objectTaggingEnabled" : true,
    "trustAllCerts" : true,
    "backupDestinationState" : "INITIALIZATION_FAILED",
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "type" : {
      "name" : "ENUM_NAME",
      "description" : "Enum description"
    },
    "modificationTime" : 1451649601000
  },
  "roleType" : "ARCHIVE",
  "status" : "PRESENT",
  "statusInfo" : "...",
  "retentionHint" : "ARCHIVE"
}