The API allows you to list, view and edit backups.
Returns list of backups filtered by specified query parameters.
name | type | description | constraints | multivalued |
---|---|---|---|---|
backup-destination | query | no | ||
backup-rule | query | no | ||
direction | query | no | ||
fail-on-non-successful | query | boolean | no | |
filter | query | no | ||
from | query | long | no | |
hypervisor | query | no | ||
hypervisor-manager | query | no | ||
in-progress | query | boolean | no | |
min-size | query | long | no | |
nameLike | query | no | ||
node | query | no | ||
only-mountable | query | boolean | no | |
orderBy | query | no | ||
page | query | no | ||
parent-backup | query | no | ||
protected-entity | query | no | ||
protected-entity-type | query | "APP" or "CLOUD" or "CLOUD_GROUP" or "CLOUD_SITE" or "CLOUD_TEAMS" or "CLOUD_USER" or "OS" or "OS_AGENT" or "STORAGE" or "VM" | no | |
root-backup | query | no | ||
size | query | no | ||
status | query | "FAILED" or "INPROGRESS" or "PARTIAL_SUCCESS" or "QUEUED" or "SUCCESS" or "SUCCESS_REMOVED" | yes | |
to | query | long | no | |
type | query | "FULL" or "INCREMENTAL" or "SYNCHRONIZATION" or "SYNTHETIC" | no | |
without-hidden | query | boolean | no |
media type | data type | description |
---|---|---|
application/json | array of BackupListRecord (JSON) | list of backups filtered by query parameters |
GET /backups
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"archiveExpire" : 12345,
"taskTimeStats" : {
"queuedExportTime" : 12345,
"exportTime" : 12345,
"queuedStoreTime" : 12345,
"storeTime" : 12345
},
"statusInfo" : "...",
"protectedEntity" : {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"parentBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"size" : 12345,
"effectiveBackupObjectsCount" : 12345,
"effectiveBackupSize" : 12345,
"vmExportImportMode" : "DISK_ATTACHMENT",
"warningsPresent" : true,
"warnings" : [ "...", "..." ],
"sourceProject" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"description" : "...",
"backupLocations" : [ {
"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" : "NETWORKER",
"status" : "REMOVED",
"type" : "INCREMENTAL",
"statusInfo" : "...",
"retentionHint" : "RECREATE"
}, {
"guid" : "...",
"backup" : {
"guid" : "...",
"name" : "..."
},
"snapshotTime" : 12345,
"backupDestination" : {
"guid" : "...",
"name" : "..."
},
"roleType" : "ARCHIVE",
"backupDestinationType" : "SWIFT",
"status" : "FAILED",
"type" : "SYNTHETIC",
"statusInfo" : "...",
"retentionHint" : "TO_REMOVE"
} ],
"originEntity" : {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hidden" : true,
"backupRule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"taskDurationTime" : 12345,
"sourceNameAndGuid" : {
"guid" : "...",
"name" : "...",
"type" : "DATA_CENTER"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"backupTime" : 1451677502000,
"snapshotTime" : 1451649601000,
"status" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
} ]
Returns detailed list of backups filtered by specified query parameters.
name | type | description | constraints | multivalued |
---|---|---|---|---|
backup-destination | query | no | ||
backup-rule | query | no | ||
direction | query | no | ||
fail-on-non-successful | query | boolean | no | |
filter | query | no | ||
from | query | long | no | |
hypervisor | query | no | ||
hypervisor-manager | query | no | ||
in-progress | query | boolean | no | |
min-size | query | long | no | |
nameLike | query | no | ||
node | query | no | ||
only-mountable | query | boolean | no | |
orderBy | query | no | ||
page | query | no | ||
parent-backup | query | no | ||
protected-entity | query | no | ||
protected-entity-type | query | "APP" or "CLOUD" or "CLOUD_GROUP" or "CLOUD_SITE" or "CLOUD_TEAMS" or "CLOUD_USER" or "OS" or "OS_AGENT" or "STORAGE" or "VM" | no | |
root-backup | query | no | ||
size | query | no | ||
status | query | "FAILED" or "INPROGRESS" or "PARTIAL_SUCCESS" or "QUEUED" or "SUCCESS" or "SUCCESS_REMOVED" | yes | |
to | query | long | no | |
type | query | "FULL" or "INCREMENTAL" or "SYNCHRONIZATION" or "SYNTHETIC" | no | |
without-hidden | query | boolean | no |
media type | data type | description |
---|---|---|
application/json | array of BackupDetails (JSON) | detailed list of backups filtered by query parameters |
GET /backups/detailed
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"backupTime" : 12345,
"taskTimeStats" : {
"queuedExportTime" : 12345,
"exportTime" : 12345,
"queuedStoreTime" : 12345,
"storeTime" : 12345
},
"archiveExpire" : 12345,
"statusInfo" : "...",
"protectedEntity" : {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"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" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"snapshotTime" : 12345,
"backupDestination" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"roleType" : "ARCHIVE",
"backupDestinationType" : "GCS",
"status" : "IN_PROGRESS",
"type" : "FULL",
"statusInfo" : "...",
"retentionHint" : "DONT_TOUCH"
}, {
"guid" : "...",
"backup" : {
"guid" : "...",
"name" : "..."
},
"snapshotTime" : 12345,
"backupDestination" : {
"guid" : "...",
"name" : "..."
},
"roleType" : "ARCHIVE",
"backupDestinationType" : "NETBACKUP",
"status" : "FAILED",
"type" : "FULL",
"statusInfo" : "...",
"retentionHint" : "RECREATE"
} ],
"networkInterfaceCards" : [ {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"network" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"virtualMachine" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backups" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}, {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"network" : {
"guid" : "...",
"name" : "..."
},
"virtualMachine" : {
"guid" : "...",
"name" : "..."
},
"backups" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ]
} ],
"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" : "DONT_TOUCH",
"originEntity" : {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"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"
}
} ]
Change acknowledged warnings for specified batch of backups.
media type | data type | description |
---|---|---|
application/json | WarningAcknowledgementRequest (JSON) | specify request for a batch update |
media type | data type | description |
---|---|---|
application/json | array of BackupDetails (JSON) |
PUT /backups/warnings-acknowledged
Content-Type: application/json
Accept: application/json
{
"protectedEntities" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"backups" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"snapshots" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"restoreJobs" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"backupDestinations" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}
HTTP/1.1 204 No Content
Content-Type: application/json
[ {
"backupTime" : 12345,
"taskTimeStats" : {
"queuedExportTime" : 12345,
"exportTime" : 12345,
"queuedStoreTime" : 12345,
"storeTime" : 12345
},
"archiveExpire" : 12345,
"statusInfo" : "...",
"protectedEntity" : {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"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" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"snapshotTime" : 12345,
"backupDestination" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"roleType" : "SECONDARY",
"backupDestinationType" : "ISP",
"status" : "PRESENT",
"type" : "FULL",
"statusInfo" : "...",
"retentionHint" : "STANDARD_RETENTION"
}, {
"guid" : "...",
"backup" : {
"guid" : "...",
"name" : "..."
},
"snapshotTime" : 12345,
"backupDestination" : {
"guid" : "...",
"name" : "..."
},
"roleType" : "ARCHIVE",
"backupDestinationType" : "S3",
"status" : "PRESENT",
"type" : "FULL",
"statusInfo" : "...",
"retentionHint" : "TO_REMOVE"
} ],
"networkInterfaceCards" : [ {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"network" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"virtualMachine" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backups" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}, {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"network" : {
"guid" : "...",
"name" : "..."
},
"virtualMachine" : {
"guid" : "...",
"name" : "..."
},
"backups" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ]
} ],
"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" : "DONT_TOUCH",
"originEntity" : {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"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"
}
} ]
Returns extended details of a backup.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for backup (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | BackupExtendedDetails (JSON) | extended details of a backup |
GET /backups/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"iscsiMountable" : true,
"fileFormats" : [ "QCOW2", "RAW" ],
"backupTime" : 12345,
"taskTimeStats" : {
"queuedExportTime" : 12345,
"exportTime" : 12345,
"queuedStoreTime" : 12345,
"storeTime" : 12345
},
"archiveExpire" : 12345,
"statusInfo" : "...",
"protectedEntity" : {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"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" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"snapshotTime" : 12345,
"backupDestination" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"roleType" : "SECONDARY",
"backupDestinationType" : "RUBRIK",
"status" : "FAILED",
"type" : "FULL",
"statusInfo" : "...",
"retentionHint" : "DONT_TOUCH"
}, {
"guid" : "...",
"backup" : {
"guid" : "...",
"name" : "..."
},
"snapshotTime" : 12345,
"backupDestination" : {
"guid" : "...",
"name" : "..."
},
"roleType" : "SECONDARY",
"backupDestinationType" : "FILESYSTEM",
"status" : "IN_PROGRESS",
"type" : "FULL",
"statusInfo" : "...",
"retentionHint" : "RECREATE"
} ],
"networkInterfaceCards" : [ {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"network" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"virtualMachine" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backups" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}, {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"network" : {
"guid" : "...",
"name" : "..."
},
"virtualMachine" : {
"guid" : "...",
"name" : "..."
},
"backups" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ]
} ],
"size" : 12345,
"fileCount" : 12345,
"effectiveBackupObjectsCount" : 12345,
"effectiveBackupSize" : 12345,
"vmExportImportMode" : "SSH_TRANSFER",
"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" : "STANDARD_RETENTION",
"originEntity" : {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"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"
}
}
Returns extended details of a backup without RBAC filtering.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for backup (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | BackupExtendedDetails (JSON) | extended details of a backup |
GET /backups/for-restore/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"iscsiMountable" : true,
"fileFormats" : [ "QCOW2", "RAW" ],
"backupTime" : 12345,
"taskTimeStats" : {
"queuedExportTime" : 12345,
"exportTime" : 12345,
"queuedStoreTime" : 12345,
"storeTime" : 12345
},
"archiveExpire" : 12345,
"statusInfo" : "...",
"protectedEntity" : {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"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" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"snapshotTime" : 12345,
"backupDestination" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"roleType" : "SECONDARY",
"backupDestinationType" : "NETWORKER",
"status" : "PRESENT",
"type" : "INCREMENTAL",
"statusInfo" : "...",
"retentionHint" : "ARCHIVE"
}, {
"guid" : "...",
"backup" : {
"guid" : "...",
"name" : "..."
},
"snapshotTime" : 12345,
"backupDestination" : {
"guid" : "...",
"name" : "..."
},
"roleType" : "PRIMARY",
"backupDestinationType" : "FILESYSTEM",
"status" : "FAILED",
"type" : "INCREMENTAL",
"statusInfo" : "...",
"retentionHint" : "TO_REMOVE"
} ],
"networkInterfaceCards" : [ {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"network" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"virtualMachine" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backups" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}, {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"network" : {
"guid" : "...",
"name" : "..."
},
"virtualMachine" : {
"guid" : "...",
"name" : "..."
},
"backups" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ]
} ],
"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" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"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"
}
}
Get the transfer rate for backups
name | type | description | constraints |
---|---|---|---|
task-type | path | required |
media type | data type | description |
---|---|---|
application/json | TransferRateQueryParameters (JSON) | specified query parameters (from, to, protected entity) |
media type | data type | description |
---|---|---|
application/json | array of BackupTransferRateResponse (JSON) |
POST /backups/transfer-rate/{task-type}
Content-Type: application/json
Accept: application/json
{
"dateTimeRange" : {
"from" : 12345,
"to" : 12345
},
"protectedEntityGuid" : "...",
"hypervisor" : "...",
"hypervisorManager" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
[ {
"guid" : "...",
"backupTime" : 12345,
"transferRateResponses" : [ {
"taskType" : "...",
"transferSize" : 12345,
"transferTimestampStart" : 12345,
"transferTimestampEnd" : 12345
}, {
"taskType" : "...",
"transferSize" : 12345,
"transferTimestampStart" : 12345,
"transferTimestampEnd" : 12345
} ]
} ]
name | type | description |
---|---|---|
guid | path |
media type | data type |
---|---|
application/json | StringDTO (JSON) |
media type | data type | description |
---|---|---|
application/json | BackupListRecord (JSON) |
PUT /backups/{guid}/description
Content-Type: application/json
Accept: application/json
{
"value" : "..."
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"archiveExpire" : 12345,
"taskTimeStats" : {
"queuedExportTime" : 12345,
"exportTime" : 12345,
"queuedStoreTime" : 12345,
"storeTime" : 12345
},
"statusInfo" : "...",
"protectedEntity" : {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"parentBackup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"size" : 12345,
"effectiveBackupObjectsCount" : 12345,
"effectiveBackupSize" : 12345,
"vmExportImportMode" : "DISK_ATTACHMENT_CHANGED_BLOCK_TRACKING",
"warningsPresent" : true,
"warnings" : [ "...", "..." ],
"sourceProject" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"description" : "...",
"backupLocations" : [ {
"guid" : "...",
"backup" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"snapshotTime" : 12345,
"backupDestination" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"roleType" : "ARCHIVE",
"backupDestinationType" : "NETWORKER",
"status" : "REMOVED",
"type" : "SYNCHRONIZATION",
"statusInfo" : "...",
"retentionHint" : "STANDARD_RETENTION"
}, {
"guid" : "...",
"backup" : {
"guid" : "...",
"name" : "..."
},
"snapshotTime" : 12345,
"backupDestination" : {
"guid" : "...",
"name" : "..."
},
"roleType" : "SECONDARY",
"backupDestinationType" : "ISP",
"status" : "PRESENT",
"type" : "SYNTHETIC",
"statusInfo" : "...",
"retentionHint" : "DONT_TOUCH"
} ],
"originEntity" : {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"hidden" : true,
"backupRule" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"taskDurationTime" : 12345,
"sourceNameAndGuid" : {
"guid" : "...",
"name" : "...",
"type" : "OS_AGENT"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"backupTime" : 1451677502000,
"snapshotTime" : 1451649601000,
"status" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
}
}
Change warnings for specified backup.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for backup (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | array of StringDTO (JSON) | specify warnings for backup to change |
media type | data type | description |
---|---|---|
application/json | BackupDetails (JSON) |
PUT /backups/{guid}/warnings
Content-Type: application/json
Accept: application/json
[ {
"value" : "..."
} ]
HTTP/1.1 204 No Content
Content-Type: application/json
{
"backupTime" : 12345,
"taskTimeStats" : {
"queuedExportTime" : 12345,
"exportTime" : 12345,
"queuedStoreTime" : 12345,
"storeTime" : 12345
},
"archiveExpire" : 12345,
"statusInfo" : "...",
"protectedEntity" : {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"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" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"snapshotTime" : 12345,
"backupDestination" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"roleType" : "SECONDARY",
"backupDestinationType" : "SYNTHETICXFS",
"status" : "IN_PROGRESS",
"type" : "INCREMENTAL",
"statusInfo" : "...",
"retentionHint" : "STANDARD_RETENTION"
}, {
"guid" : "...",
"backup" : {
"guid" : "...",
"name" : "..."
},
"snapshotTime" : 12345,
"backupDestination" : {
"guid" : "...",
"name" : "..."
},
"roleType" : "ARCHIVE",
"backupDestinationType" : "S3",
"status" : "PRESENT",
"type" : "SYNTHETIC",
"statusInfo" : "...",
"retentionHint" : "TO_REMOVE"
} ],
"networkInterfaceCards" : [ {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"network" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"virtualMachine" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backups" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}, {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"network" : {
"guid" : "...",
"name" : "..."
},
"virtualMachine" : {
"guid" : "...",
"name" : "..."
},
"backups" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ]
} ],
"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" : "TO_REMOVE",
"originEntity" : {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"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"
}
}
Change acknowledged warnings for specified backup.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for backup (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | BooleanDTO (JSON) | specify whether backup is acknowledged |
media type | data type | description |
---|---|---|
application/json | BackupDetails (JSON) |
PUT /backups/{guid}/warnings-acknowledged
Content-Type: application/json
Accept: application/json
{
"value" : true
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"backupTime" : 12345,
"taskTimeStats" : {
"queuedExportTime" : 12345,
"exportTime" : 12345,
"queuedStoreTime" : 12345,
"storeTime" : 12345
},
"archiveExpire" : 12345,
"statusInfo" : "...",
"protectedEntity" : {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"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" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"snapshotTime" : 12345,
"backupDestination" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"roleType" : "SECONDARY",
"backupDestinationType" : "AZURE",
"status" : "IN_PROGRESS",
"type" : "INCREMENTAL",
"statusInfo" : "...",
"retentionHint" : "RECREATE"
}, {
"guid" : "...",
"backup" : {
"guid" : "...",
"name" : "..."
},
"snapshotTime" : 12345,
"backupDestination" : {
"guid" : "...",
"name" : "..."
},
"roleType" : "SECONDARY",
"backupDestinationType" : "SYNTHETICDDBOOST",
"status" : "IN_PROGRESS",
"type" : "FULL",
"statusInfo" : "...",
"retentionHint" : "STANDARD_RETENTION"
} ],
"networkInterfaceCards" : [ {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"network" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"virtualMachine" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"backups" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}, {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"network" : {
"guid" : "...",
"name" : "..."
},
"virtualMachine" : {
"guid" : "...",
"name" : "..."
},
"backups" : [ {
"guid" : "...",
"name" : "..."
}, {
"guid" : "...",
"name" : "..."
} ]
} ],
"size" : 12345,
"fileCount" : 12345,
"effectiveBackupObjectsCount" : 12345,
"effectiveBackupSize" : 12345,
"vmExportImportMode" : "SSH_TRANSFER",
"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" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"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"
}
}