The API allows you to list, view, edit and create protected entity snapshots.
Returns list of protected entity snapshots filtered by specified query parameters.
name | type | description | constraints | multivalued |
---|---|---|---|---|
after | query | long | no | |
backup-rule | query | no | ||
direction | query | no | ||
filter | query | no | ||
from | query | long | no | |
nameLike | query | no | ||
orderBy | query | no | ||
page | query | no | ||
policy | query | no | ||
protected-entity | query | yes | ||
size | query | no | ||
stand-alone | query | boolean | no | |
status | query | "CREATING" or "FAILED" or "PRESENT" or "QUEUED" or "REMOVED" | no | |
to | query | long | no | |
uuid | query | no |
media type | data type | description |
---|---|---|
application/json | array of ProtectedEntitySnapshotDetails (JSON) | list of protected entity snapshots filtered by specified query parameters |
GET /snapshots
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"snapshotTime" : 12345,
"uuid" : "...",
"protectedEntity" : {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"rule" : {
"guid" : "...",
"name" : "...",
"retentionVersions" : 12345,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"retentionDays" : 12345,
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
},
"warnings" : [ "...", "..." ],
"warningsPresent" : true,
"metadata" : "...",
"status" : "REMOVED",
"standAlone" : true,
"lastStoredSnapshotAssignments" : [ {
"protectedEntitySnapshot" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}, {
"protectedEntitySnapshot" : {
"guid" : "...",
"name" : "..."
}
} ]
} ]
Set acknowledged warnings for specified protected entity snapshot batch.
media type | data type | description |
---|---|---|
application/json | WarningAcknowledgementRequest (JSON) | specify local unique identifiers batch for protected entity snapshots (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | array of ProtectedEntitySnapshotDetails (JSON) | protected entity snapshot details |
PUT /snapshots/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
[ {
"guid" : "...",
"snapshotTime" : 12345,
"uuid" : "...",
"protectedEntity" : {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"rule" : {
"guid" : "...",
"name" : "...",
"retentionVersions" : 12345,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"retentionDays" : 12345,
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
},
"warnings" : [ "...", "..." ],
"warningsPresent" : true,
"metadata" : "...",
"status" : "REMOVED",
"standAlone" : true,
"lastStoredSnapshotAssignments" : [ {
"protectedEntitySnapshot" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}, {
"protectedEntitySnapshot" : {
"guid" : "...",
"name" : "..."
}
} ]
} ]
Get a single protected entity snapshot.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for protected entity snapshot (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | ProtectedEntitySnapshotDetails (JSON) | a single protected entity snapshot details |
GET /snapshots/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"guid" : "...",
"snapshotTime" : 12345,
"uuid" : "...",
"protectedEntity" : {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"rule" : {
"guid" : "...",
"name" : "...",
"retentionVersions" : 12345,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"retentionDays" : 12345,
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
},
"warnings" : [ "...", "..." ],
"warningsPresent" : true,
"metadata" : "...",
"status" : "QUEUED",
"standAlone" : true,
"lastStoredSnapshotAssignments" : [ {
"protectedEntitySnapshot" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}, {
"protectedEntitySnapshot" : {
"guid" : "...",
"name" : "..."
}
} ]
}
name | type | description |
---|---|---|
guid | path |
media type | data type |
---|---|
application/json | string (JSON) |
media type | data type | description |
---|---|---|
application/json | ProtectedEntitySnapshotDetails (JSON) |
PUT /snapshots/{guid}/attempts
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
{
"guid" : "...",
"snapshotTime" : 12345,
"uuid" : "...",
"protectedEntity" : {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"rule" : {
"guid" : "...",
"name" : "...",
"retentionVersions" : 12345,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"retentionDays" : 12345,
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
},
"warnings" : [ "...", "..." ],
"warningsPresent" : true,
"metadata" : "...",
"status" : "REMOVED",
"standAlone" : true,
"lastStoredSnapshotAssignments" : [ {
"protectedEntitySnapshot" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}, {
"protectedEntitySnapshot" : {
"guid" : "...",
"name" : "..."
}
} ]
}
Set warnings for specified protected entity snapshot.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for protected entity snapshot (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | array of StringDTO (JSON) | specify warnings to add for specified protected entity snapshot |
media type | data type | description |
---|---|---|
application/json | ProtectedEntitySnapshotDetails (JSON) | protected entity snapshot details |
PUT /snapshots/{guid}/warnings
Content-Type: application/json
Accept: application/json
[ {
"value" : "..."
} ]
HTTP/1.1 204 No Content
Content-Type: application/json
{
"guid" : "...",
"snapshotTime" : 12345,
"uuid" : "...",
"protectedEntity" : {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"rule" : {
"guid" : "...",
"name" : "...",
"retentionVersions" : 12345,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"retentionDays" : 12345,
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
},
"warnings" : [ "...", "..." ],
"warningsPresent" : true,
"metadata" : "...",
"status" : "REMOVED",
"standAlone" : true,
"lastStoredSnapshotAssignments" : [ {
"protectedEntitySnapshot" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}, {
"protectedEntitySnapshot" : {
"guid" : "...",
"name" : "..."
}
} ]
}
Set acknowledged warnings for specified protected entity snapshot.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for protected entity snapshot (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | BooleanDTO (JSON) | specify whether warnings are acknowledged |
media type | data type | description |
---|---|---|
application/json | ProtectedEntitySnapshotDetails (JSON) | protected entity snapshot details |
PUT /snapshots/{guid}/warnings-acknowledged
Content-Type: application/json
Accept: application/json
{
"value" : true
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"guid" : "...",
"snapshotTime" : 12345,
"uuid" : "...",
"protectedEntity" : {
"type" : {
"name" : "ENUM_NAME",
"description" : "Enum description"
},
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"rule" : {
"guid" : "...",
"name" : "...",
"retentionVersions" : 12345,
"policy" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"schedules" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"retentionDays" : 12345,
"vmCount" : 12345,
"schedulesCount" : 12345,
"position" : 12345,
"active" : true,
"removable" : true,
"daysToKeepRetentionLock" : 12345
},
"warnings" : [ "...", "..." ],
"warningsPresent" : true,
"metadata" : "...",
"status" : "PRESENT",
"standAlone" : true,
"lastStoredSnapshotAssignments" : [ {
"protectedEntitySnapshot" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}, {
"protectedEntitySnapshot" : {
"guid" : "...",
"name" : "..."
}
} ]
}